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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
// 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, Control Command Inc. All rights reserved.
// Copyright (c) 2018-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 oci
import (
"context"
"fmt"
"os"
"reflect"
"strings"
"github.com/apptainer/apptainer/internal/pkg/build"
"github.com/apptainer/apptainer/internal/pkg/build/oci"
"github.com/apptainer/apptainer/internal/pkg/cache"
"github.com/apptainer/apptainer/internal/pkg/client"
"github.com/apptainer/apptainer/internal/pkg/ociimage"
"github.com/apptainer/apptainer/internal/pkg/util/fs"
"github.com/apptainer/apptainer/internal/pkg/util/ociauth"
buildtypes "github.com/apptainer/apptainer/pkg/build/types"
"github.com/apptainer/apptainer/pkg/sylog"
useragent "github.com/apptainer/apptainer/pkg/util/user-agent"
"github.com/google/go-containerregistry/pkg/authn"
v1 "github.com/google/go-containerregistry/pkg/v1"
)
type PullOptions struct {
TmpDir string
OciAuth *authn.AuthConfig
DockerHost string
NoHTTPS bool
NoCleanUp bool
Pullarch string
ReqAuthFile string
Platform v1.Platform
}
// transportOptions maps PullOptions to OCI image transport options
func transportOptions(opts PullOptions) *ociimage.TransportOptions {
return &ociimage.TransportOptions{
AuthConfig: opts.OciAuth,
AuthFilePath: ociauth.ChooseAuthFile(opts.ReqAuthFile),
Insecure: opts.NoHTTPS,
TmpDir: opts.TmpDir,
UserAgent: useragent.Value(),
DockerDaemonHost: opts.DockerHost,
Platform: opts.Platform,
}
}
// pull will build a SIF 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, opts PullOptions) (imagePath string, err error) {
// DockerInsecureSkipTLSVerify is set only if --no-https is specified to honor
// configuration from /etc/containers/registries.conf because DockerInsecureSkipTLSVerify
// can have three possible values true/false and undefined, so we left it as undefined instead
// of forcing it to false in order to delegate decision to /etc/containers/registries.conf:
// https://github.com/apptainer/singularity/issues/5172
to := transportOptions(opts)
if opts.Pullarch != "" {
if arch, ok := oci.ArchMap[opts.Pullarch]; ok {
to.Platform = v1.Platform{
Architecture: arch.Arch,
Variant: arch.Var,
}
} else {
keys := reflect.ValueOf(oci.ArchMap).MapKeys()
return "", fmt.Errorf("failed to parse the arch value: %s, should be one of %v", opts.Pullarch, keys)
}
}
hash, err := oci.ImageDigest(ctx, pullFrom, to)
if err != nil {
return "", fmt.Errorf("failed to get checksum for %s: %s", pullFrom, err)
}
if directTo != "" {
sylog.Infof("Converting OCI blobs to SIF format")
if err := convertOciToSIF(ctx, imgCache, pullFrom, directTo, opts); err != nil {
return "", fmt.Errorf("while building SIF from layers: %v", err)
}
imagePath = directTo
} else {
cacheEntry, err := imgCache.GetEntry(cache.OciTempCacheType, hash)
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("Converting OCI blobs to SIF format")
if err := convertOciToSIF(ctx, imgCache, pullFrom, cacheEntry.TmpPath, opts); err != nil {
return "", fmt.Errorf("while building SIF from layers: %v", err)
}
err = cacheEntry.Finalize()
if err != nil {
return "", err
}
} else {
sylog.Infof("Using cached SIF image")
}
imagePath = cacheEntry.Path
}
return imagePath, nil
}
// convertOciToSIF will convert an OCI source into a SIF using the build routines
func convertOciToSIF(ctx context.Context, imgCache *cache.Handle, image, cachedImgPath string, opts PullOptions) error {
if imgCache == nil {
return fmt.Errorf("image cache is undefined")
}
b, err := build.NewBuild(
image,
build.Config{
Dest: cachedImgPath,
Format: "sif",
NoCleanUp: opts.NoCleanUp,
Opts: buildtypes.Options{
TmpDir: opts.TmpDir,
NoCache: imgCache.IsDisabled(),
NoTest: true,
NoHTTPS: opts.NoHTTPS,
OCIAuthConfig: opts.OciAuth,
DockerDaemonHost: opts.DockerHost,
ImgCache: imgCache,
Arch: opts.Pullarch,
ReqAuthFile: opts.ReqAuthFile,
Platform: opts.Platform,
},
},
)
if err != nil {
return fmt.Errorf("unable to create new build: %v", err)
}
return b.Full(ctx)
}
// Pull will build a SIF image to the cache or direct to a temporary file if cache is disabled
func Pull(ctx context.Context, imgCache *cache.Handle, pullFrom string, opts PullOptions) (imagePath string, err error) {
directTo := ""
if imgCache.IsDisabled() {
file, err := os.CreateTemp(opts.TmpDir, "sbuild-tmp-cache-")
if err != nil {
return "", fmt.Errorf("unable to create tmp file: %v", err)
}
directTo = file.Name()
sylog.Infof("Downloading library image to tmp cache: %s", directTo)
}
return pull(ctx, imgCache, directTo, pullFrom, opts)
}
// PullToFile will build a SIF image from the specified oci URI and place it at the specified dest
func PullToFile(ctx context.Context, imgCache *cache.Handle, pullTo, pullFrom string, sandbox bool, opts PullOptions) (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, opts)
if err != nil {
if strings.Contains(err.Error(), "unsupported image-specific operation on artifact with type \"application/vnd.unknown.config.v1+json\"") {
return "", fmt.Errorf("%v; try changing the protocol to oras://", err)
}
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
}
|
