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
|
// 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) 2020-2022, 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 library
import (
"context"
"errors"
"fmt"
"os"
"time"
"github.com/apptainer/apptainer/internal/pkg/cache"
"github.com/apptainer/apptainer/internal/pkg/client"
"github.com/apptainer/apptainer/internal/pkg/signature"
"github.com/apptainer/apptainer/internal/pkg/util/fs"
"github.com/apptainer/apptainer/pkg/sylog"
keyClient "github.com/apptainer/container-key-client/client"
libClient "github.com/apptainer/container-library-client/client"
"golang.org/x/term"
)
// ErrLibraryPullUnsigned indicates that the interactive portion of the pull was aborted.
var ErrLibraryPullUnsigned = errors.New("failed to verify container")
type PullOptions struct {
LibraryConfig *libClient.Config
KeyClientOpts []keyClient.Option
}
// pull will pull a library image into the cache if directTo="", or a specific file if directTo is set.
func pull(ctx context.Context, imgCache *cache.Handle, directTo string, imageRef *libClient.Ref, arch string, opts PullOptions) (string, error) {
c, err := libClient.NewClient(opts.LibraryConfig)
if err != nil {
return "", fmt.Errorf("unable to initialize client library: %v", err)
}
ref := fmt.Sprintf("%s:%s", imageRef.Path, imageRef.Tags[0])
libraryImage, err := c.GetImage(ctx, arch, ref)
if err != nil {
if errors.Is(err, libClient.ErrNotFound) {
return "", fmt.Errorf("image does not exist in the library: %s (%s)", ref, arch)
}
return "", err
}
var progressBar libClient.ProgressBar
if term.IsTerminal(2) {
progressBar = &client.DownloadProgressBar{}
}
if directTo != "" {
// Download direct to file
if err := downloadWrapper(ctx, c, directTo, arch, imageRef, progressBar); err != nil {
return "", fmt.Errorf("unable to download image: %v", err)
}
return directTo, nil
}
cacheEntry, err := imgCache.GetEntry(cache.LibraryCacheType, libraryImage.Hash)
if err != nil {
return "", fmt.Errorf("unable to check if %v exists in cache: %v", libraryImage.Hash, err)
}
defer cacheEntry.CleanTmp()
if !cacheEntry.Exists {
if err := downloadWrapper(ctx, c, cacheEntry.TmpPath, arch, imageRef, progressBar); err != nil {
return "", fmt.Errorf("unable to download image: %v", err)
}
if cacheFileHash, err := libClient.ImageHash(cacheEntry.TmpPath); err != nil {
return "", fmt.Errorf("error getting image hash: %v", err)
} else if cacheFileHash != libraryImage.Hash {
return "", fmt.Errorf("cached file hash(%s) and expected hash(%s) does not match", cacheFileHash, libraryImage.Hash)
}
if err := cacheEntry.Finalize(); err != nil {
return "", err
}
} else {
sylog.Infof("Using cached image")
}
return cacheEntry.Path, nil
}
// downloadWrapper calls DownloadImage() and outputs download summary if progressBar not specified.
func downloadWrapper(ctx context.Context, c *libClient.Client, imagePath, arch string, libraryRef *libClient.Ref, pb libClient.ProgressBar) error {
sylog.Infof("Downloading library image")
defer func(t time.Time) {
if pb == nil {
if fi, err := os.Stat(imagePath); err == nil {
// Progress bar interface not specified; output summary to stdout
sylog.Infof("Downloaded %d bytes in %v\n", fi.Size(), time.Since(t))
}
}
}(time.Now())
return DownloadImage(ctx, c, imagePath, arch, libraryRef, pb)
}
// Pull will pull a library image to the cache or direct to a temporary file if cache is disabled
func Pull(ctx context.Context, imgCache *cache.Handle, pullFrom *libClient.Ref, arch string, tmpDir string, opts PullOptions) (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 library image to tmp cache: %s", directTo)
}
return pull(ctx, imgCache, directTo, pullFrom, arch, opts)
}
// PullToFile will pull a library image to the specified location, through the cache, or directly if cache is disabled
func PullToFile(ctx context.Context, imgCache *cache.Handle, pullTo string, pullFrom *libClient.Ref, arch string, _ string, opts PullOptions, 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, arch, opts)
if err != nil {
return "", fmt.Errorf("error fetching image: %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 err := signature.Verify(ctx, src, signature.OptVerifyWithPGP(opts.KeyClientOpts...)); err != nil {
sylog.Warningf("%v", err)
return pullTo, ErrLibraryPullUnsigned
}
if sandbox {
if err := client.ConvertSifToSandbox(directTo, src, pullTo); err != nil {
return "", err
}
}
return pullTo, nil
}
|
