1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
// Copyright (c) Contributors to the Apptainer project, established as
// Apptainer a Series of LF Projects LLC.
// For website terms of use, trademark policy, privacy policy and other
// project policies see https://lfprojects.org/policies
// Copyright (c) 2020-2023, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package oras
import (
"context"
"fmt"
"os"
"github.com/apptainer/apptainer/internal/pkg/cache"
"github.com/apptainer/apptainer/internal/pkg/client"
"github.com/apptainer/apptainer/internal/pkg/util/fs"
"github.com/apptainer/apptainer/pkg/sylog"
"github.com/google/go-containerregistry/pkg/authn"
)
// contextKey is a custom type for context keys to avoid collisions
type contextKey string
// TmpDirKey is the context key for passing tmpDir
const TmpDirKey contextKey = "tmpDir"
// pull will pull an oras image into the cache if directTo="", or a specific file if directTo is set.
func pull(ctx context.Context, imgCache *cache.Handle, directTo, pullFrom string, ociAuth *authn.AuthConfig, noHTTPS bool, reqAuthFile string) (imagePath string, err error) {
hash, err := RefHash(ctx, pullFrom, ociAuth, noHTTPS, reqAuthFile)
if err != nil {
return "", fmt.Errorf("failed to get checksum for %s: %s", pullFrom, err)
}
if directTo != "" {
sylog.Infof("Downloading oras image")
if err := DownloadImage(ctx, directTo, pullFrom, ociAuth, noHTTPS, reqAuthFile); err != nil {
return "", fmt.Errorf("unable to Download Image: %v", err)
}
imagePath = directTo
} else {
cacheEntry, err := imgCache.GetEntry(cache.OrasCacheType, hash.String())
if err != nil {
return "", fmt.Errorf("unable to check if %v exists in cache: %v", hash, err)
}
defer cacheEntry.CleanTmp()
if !cacheEntry.Exists {
sylog.Infof("Downloading oras image")
if err := DownloadImage(ctx, cacheEntry.TmpPath, pullFrom, ociAuth, noHTTPS, reqAuthFile); err != nil {
return "", fmt.Errorf("unable to Download Image: %v", err)
}
if cacheFileHash, err := ImageHash(cacheEntry.TmpPath); err != nil {
return "", fmt.Errorf("error getting ImageHash: %v", err)
} else if cacheFileHash != hash {
return "", fmt.Errorf("cached file hash(%s) and expected hash(%s) does not match", cacheFileHash, hash)
}
err = cacheEntry.Finalize()
if err != nil {
return "", err
}
} else {
sylog.Infof("Using cached SIF image")
}
imagePath = cacheEntry.Path
}
return imagePath, nil
}
// Pull will pull an oras image to the cache or direct to a temporary file if cache is disabled
func Pull(ctx context.Context, imgCache *cache.Handle, pullFrom, tmpDir string, ociAuth *authn.AuthConfig, noHTTPS bool, reqAuthFile string) (imagePath string, err error) {
directTo := ""
if imgCache.IsDisabled() {
file, err := os.CreateTemp(tmpDir, "sbuild-tmp-cache-")
if err != nil {
return "", fmt.Errorf("unable to create tmp file: %v", err)
}
directTo = file.Name()
sylog.Infof("Downloading oras image to tmp cache: %s", directTo)
}
// always pass the tmpDir through context down to DownloadImage
ctx = context.WithValue(ctx, TmpDirKey, tmpDir)
return pull(ctx, imgCache, directTo, pullFrom, ociAuth, noHTTPS, reqAuthFile)
}
// PullToFile will pull an oras image to the specified location, through the cache, or directly if cache is disabled
func PullToFile(ctx context.Context, imgCache *cache.Handle, pullTo, pullFrom string, ociAuth *authn.AuthConfig, noHTTPS bool, reqAuthFile string, sandbox bool) (imagePath string, err error) {
directTo := ""
if imgCache.IsDisabled() {
directTo = pullTo
sylog.Debugf("Cache disabled, pulling directly to: %s", directTo)
}
src, err := pull(ctx, imgCache, directTo, pullFrom, ociAuth, noHTTPS, reqAuthFile)
if err != nil {
return "", fmt.Errorf("error fetching image to cache: %v", err)
}
if directTo == "" && !sandbox {
// mode is before umask if pullTo doesn't exist
err = fs.CopyFileAtomic(src, pullTo, 0o777)
if err != nil {
return "", fmt.Errorf("error copying image out of cache: %v", err)
}
}
if sandbox {
if err := client.ConvertSifToSandbox(directTo, src, pullTo); err != nil {
return "", err
}
}
return pullTo, nil
}
|
