diff --git a/go.mod b/go.mod index f39d43038a..5641cc74db 100644 --- a/go.mod +++ b/go.mod @@ -11,7 +11,7 @@ require ( github.com/container-orchestrated-devices/container-device-interface v0.5.3 github.com/containernetworking/cni v1.1.2 github.com/containernetworking/plugins v1.2.0 - github.com/containers/buildah v1.29.3 + github.com/containers/buildah v1.29.5 github.com/containers/common v0.51.3 github.com/containers/conmon v2.0.20+incompatible github.com/containers/image/v5 v5.24.1 diff --git a/go.sum b/go.sum index 7b4185a413..eb7c0299f7 100644 --- a/go.sum +++ b/go.sum @@ -270,8 +270,8 @@ github.com/containernetworking/plugins v0.8.6/go.mod h1:qnw5mN19D8fIwkqW7oHHYDHV github.com/containernetworking/plugins v0.9.1/go.mod h1:xP/idU2ldlzN6m4p5LmGiwRDjeJr6FLK6vuiUwoH7P8= github.com/containernetworking/plugins v1.2.0 h1:SWgg3dQG1yzUo4d9iD8cwSVh1VqI+bP7mkPDoSfP9VU= github.com/containernetworking/plugins v1.2.0/go.mod h1:/VjX4uHecW5vVimFa1wkG4s+r/s9qIfPdqlLF4TW8c4= -github.com/containers/buildah v1.29.3 h1:OMHme3lsXULrGzWGsU2i/UzXgcCuwNTJmnNja0VRdrM= -github.com/containers/buildah v1.29.3/go.mod h1:VSGsuTRlvCEHjRGki6drxhEagZ7HzEJJBGIsHg5AHVM= +github.com/containers/buildah v1.29.5 h1:CWKNK1HuQluwGiH3n04rCBwGLkEos2k1Xax9v4XZito= +github.com/containers/buildah v1.29.5/go.mod h1:VSGsuTRlvCEHjRGki6drxhEagZ7HzEJJBGIsHg5AHVM= github.com/containers/common v0.51.3 h1:wwFXpQd0FtDWmaMZpnYYfEQvQB6dPGChRQfm71znzeY= github.com/containers/common v0.51.3/go.mod h1:3W2WIdalgQfrsX/T5tjX+6CxgT3ThJVN2G9sNuFjuCM= github.com/containers/conmon v2.0.20+incompatible h1:YbCVSFSCqFjjVwHTPINGdMX1F6JXHGTUje2ZYobNrkg= diff --git a/vendor/github.com/containers/buildah/CHANGELOG.md b/vendor/github.com/containers/buildah/CHANGELOG.md index 6972c48b18..b12ebe1d6c 100644 --- a/vendor/github.com/containers/buildah/CHANGELOG.md +++ b/vendor/github.com/containers/buildah/CHANGELOG.md @@ -2,6 +2,24 @@ # Changelog +## v1.29.5 (2025-02-06) + + Backport testing of CVE-2024-9407 fix + Changes based on review feedback + Disable windows cross-build in CI + Fix TOCTOU error when bind and cache mounts use "src" values + define.TempDirForURL(): always use an intermediate subdirectory + internal/volume.GetBindMount(): discard writes in bind mounts + pkg/overlay: add a MountLabel flag to Options + pkg/overlay: add a ForceMount flag to Options + Add internal/volumes.bindFromChroot() + Add an internal/open package + Allow cache mounts to be stages or additional build contexts + +## v1.29.4 (2024-10-17) + + Properly validate cache IDs and sources + ## v1.29.3 (2024-03-26) [release-1.29] Bump google.golang.org/protobuf to v1.33.0 diff --git a/vendor/github.com/containers/buildah/Makefile b/vendor/github.com/containers/buildah/Makefile index 729456d948..114bbbd17c 100644 --- a/vendor/github.com/containers/buildah/Makefile +++ b/vendor/github.com/containers/buildah/Makefile @@ -79,7 +79,8 @@ buildah: bin/buildah ALL_CROSS_TARGETS := $(addprefix bin/buildah.,$(subst /,.,$(shell $(GO) tool dist list | grep -v loong64))) LINUX_CROSS_TARGETS := $(filter bin/buildah.linux.%,$(ALL_CROSS_TARGETS)) DARWIN_CROSS_TARGETS := $(filter bin/buildah.darwin.%,$(ALL_CROSS_TARGETS)) -WINDOWS_CROSS_TARGETS := $(addsuffix .exe,$(filter bin/buildah.windows.%,$(ALL_CROSS_TARGETS))) +#WINDOWS_CROSS_TARGETS := $(addsuffix .exe,$(filter bin/buildah.windows.%,$(ALL_CROSS_TARGETS))) +WINDOWS_CROSS_TARGETS := FREEBSD_CROSS_TARGETS := $(filter bin/buildah.freebsd.%,$(ALL_CROSS_TARGETS)) .PHONY: cross cross: $(LINUX_CROSS_TARGETS) $(DARWIN_CROSS_TARGETS) $(WINDOWS_CROSS_TARGETS) $(FREEBSD_CROSS_TARGETS) diff --git a/vendor/github.com/containers/buildah/changelog.txt b/vendor/github.com/containers/buildah/changelog.txt index 58fa54b7f2..14a3307a10 100644 --- a/vendor/github.com/containers/buildah/changelog.txt +++ b/vendor/github.com/containers/buildah/changelog.txt @@ -1,3 +1,19 @@ +- Changelog for v1.29.5 (2025-02-06) + * Backport testing of CVE-2024-9407 fix + * Changes based on review feedback + * Disable windows cross-build in CI + * Fix TOCTOU error when bind and cache mounts use "src" values + * define.TempDirForURL(): always use an intermediate subdirectory + * internal/volume.GetBindMount(): discard writes in bind mounts + * pkg/overlay: add a MountLabel flag to Options + * pkg/overlay: add a ForceMount flag to Options + * Add internal/volumes.bindFromChroot() + * Add an internal/open package + * Allow cache mounts to be stages or additional build contexts + +- Changelog for v1.29.4 (2024-10-17) + * Properly validate cache IDs and sources + - Changelog for v1.29.3 (2024-03-26) * [release-1.29] Bump google.golang.org/protobuf to v1.33.0 * [release-1.29] conformance tests: don't break on trailing zeroes diff --git a/vendor/github.com/containers/buildah/define/types.go b/vendor/github.com/containers/buildah/define/types.go index a1a0775bce..21bdb7a275 100644 --- a/vendor/github.com/containers/buildah/define/types.go +++ b/vendor/github.com/containers/buildah/define/types.go @@ -30,7 +30,7 @@ const ( Package = "buildah" // Version for the Package. Bump version in contrib/rpm/buildah.spec // too. - Version = "1.29.3" + Version = "1.29.5" // DefaultRuntime if containers.conf fails. DefaultRuntime = "runc" @@ -106,13 +106,13 @@ type BuildOutputOption struct { IsStdout bool } -// TempDirForURL checks if the passed-in string looks like a URL or -. If it is, -// TempDirForURL creates a temporary directory, arranges for its contents to be -// the contents of that URL, and returns the temporary directory's path, along -// with the name of a subdirectory which should be used as the build context -// (which may be empty or "."). Removal of the temporary directory is the -// responsibility of the caller. If the string doesn't look like a URL, -// TempDirForURL returns empty strings and a nil error code. +// TempDirForURL checks if the passed-in string looks like a URL or "-". If it +// is, TempDirForURL creates a temporary directory, arranges for its contents +// to be the contents of that URL, and returns the temporary directory's path, +// along with the relative name of a subdirectory which should be used as the +// build context (which may be empty or "."). Removal of the temporary +// directory is the responsibility of the caller. If the string doesn't look +// like a URL or "-", TempDirForURL returns empty strings and a nil error code. func TempDirForURL(dir, prefix, url string) (name string, subdir string, err error) { if !strings.HasPrefix(url, "http://") && !strings.HasPrefix(url, "https://") && @@ -125,19 +125,24 @@ func TempDirForURL(dir, prefix, url string) (name string, subdir string, err err if err != nil { return "", "", fmt.Errorf("creating temporary directory for %q: %w", url, err) } + downloadDir := filepath.Join(name, "download") + if err = os.MkdirAll(downloadDir, 0o700); err != nil { + return "", "", fmt.Errorf("creating directory %q for %q: %w", downloadDir, url, err) + } urlParsed, err := urlpkg.Parse(url) if err != nil { return "", "", fmt.Errorf("parsing url %q: %w", url, err) } if strings.HasPrefix(url, "git://") || strings.HasSuffix(urlParsed.Path, ".git") { - combinedOutput, gitSubDir, err := cloneToDirectory(url, name) + combinedOutput, gitSubDir, err := cloneToDirectory(url, downloadDir) if err != nil { if err2 := os.RemoveAll(name); err2 != nil { logrus.Debugf("error removing temporary directory %q: %v", name, err2) } return "", "", fmt.Errorf("cloning %q to %q:\n%s: %w", url, name, string(combinedOutput), err) } - return name, gitSubDir, nil + logrus.Debugf("Build context is at %q", downloadDir) + return name, filepath.Join(filepath.Base(downloadDir), gitSubDir), nil } if strings.HasPrefix(url, "github.com/") { ghurl := url @@ -146,28 +151,29 @@ func TempDirForURL(dir, prefix, url string) (name string, subdir string, err err subdir = path.Base(ghurl) + "-master" } if strings.HasPrefix(url, "http://") || strings.HasPrefix(url, "https://") { - err = downloadToDirectory(url, name) + err = downloadToDirectory(url, downloadDir) if err != nil { if err2 := os.RemoveAll(name); err2 != nil { logrus.Debugf("error removing temporary directory %q: %v", name, err2) } - return "", subdir, err + return "", "", err } - return name, subdir, nil + logrus.Debugf("Build context is at %q", filepath.Join(downloadDir, subdir)) + return name, filepath.Join(filepath.Base(downloadDir), subdir), nil } if url == "-" { - err = stdinToDirectory(name) + err = stdinToDirectory(downloadDir) if err != nil { if err2 := os.RemoveAll(name); err2 != nil { logrus.Debugf("error removing temporary directory %q: %v", name, err2) } - return "", subdir, err + return "", "", err } - logrus.Debugf("Build context is at %q", name) - return name, subdir, nil + logrus.Debugf("Build context is at %q", filepath.Join(downloadDir, subdir)) + return name, filepath.Join(filepath.Base(downloadDir), subdir), nil } logrus.Debugf("don't know how to retrieve %q", url) - if err2 := os.Remove(name); err2 != nil { + if err2 := os.RemoveAll(name); err2 != nil { logrus.Debugf("error removing temporary directory %q: %v", name, err2) } return "", "", errors.New("unreachable code reached") diff --git a/vendor/github.com/containers/buildah/imagebuildah/stage_executor.go b/vendor/github.com/containers/buildah/imagebuildah/stage_executor.go index 03bbe6b990..3c1c9ddac6 100644 --- a/vendor/github.com/containers/buildah/imagebuildah/stage_executor.go +++ b/vendor/github.com/containers/buildah/imagebuildah/stage_executor.go @@ -517,7 +517,12 @@ func (s *StageExecutor) runStageMountPoints(mountList []string) (map[string]inte // to `mountPoint` replaced from additional // build-context. Reason: Parser will use this // `from` to refer from stageMountPoints map later. - stageMountPoints[from] = internal.StageMountDetails{IsStage: false, DidExecute: true, MountPoint: mountPoint} + stageMountPoints[from] = internal.StageMountDetails{ + IsAdditionalBuildContext: true, + DidExecute: true, + IsImage: true, + MountPoint: mountPoint, + } break } else { // Most likely this points to path on filesystem @@ -549,7 +554,11 @@ func (s *StageExecutor) runStageMountPoints(mountList []string) (map[string]inte mountPoint = additionalBuildContext.DownloadedCache } } - stageMountPoints[from] = internal.StageMountDetails{IsStage: true, DidExecute: true, MountPoint: mountPoint} + stageMountPoints[from] = internal.StageMountDetails{ + IsAdditionalBuildContext: true, + DidExecute: true, + MountPoint: mountPoint, + } break } } @@ -560,14 +569,22 @@ func (s *StageExecutor) runStageMountPoints(mountList []string) (map[string]inte return nil, err } if otherStage, ok := s.executor.stages[from]; ok && otherStage.index < s.index { - stageMountPoints[from] = internal.StageMountDetails{IsStage: true, DidExecute: otherStage.didExecute, MountPoint: otherStage.mountPoint} + stageMountPoints[from] = internal.StageMountDetails{ + IsStage: true, + DidExecute: otherStage.didExecute, + MountPoint: otherStage.mountPoint, + } break } else { mountPoint, err := s.getImageRootfs(s.ctx, from) if err != nil { return nil, fmt.Errorf("%s from=%s: no stage or image found with that name", flag, from) } - stageMountPoints[from] = internal.StageMountDetails{IsStage: false, DidExecute: true, MountPoint: mountPoint} + stageMountPoints[from] = internal.StageMountDetails{ + IsImage: true, + DidExecute: true, + MountPoint: mountPoint, + } break } default: diff --git a/vendor/github.com/containers/buildah/internal/open/open.go b/vendor/github.com/containers/buildah/internal/open/open.go new file mode 100644 index 0000000000..863dc79f21 --- /dev/null +++ b/vendor/github.com/containers/buildah/internal/open/open.go @@ -0,0 +1,39 @@ +package open + +import ( + "errors" + "fmt" + "syscall" +) + +// InChroot opens the file at `path` after chrooting to `root` and then +// changing its working directory to `wd`. Both `wd` and `path` are evaluated +// in the chroot. +// Returns a file handle, an Errno value if there was an error and the +// underlying error was a standard library error code, and a non-empty error if +// one was detected. +func InChroot(root, wd, path string, mode int, perm uint32) (fd int, errno syscall.Errno, err error) { + requests := requests{ + Root: root, + Wd: wd, + Open: []request{ + { + Path: path, + Mode: mode, + Perms: perm, + }, + }, + } + results := inChroot(requests) + if len(results.Open) != 1 { + return -1, 0, fmt.Errorf("got %d results back instead of 1", len(results.Open)) + } + if results.Open[0].Err != "" { + if results.Open[0].Errno != 0 { + err = fmt.Errorf("%s: %w", results.Open[0].Err, results.Open[0].Errno) + } else { + err = errors.New(results.Open[0].Err) + } + } + return int(results.Open[0].Fd), results.Open[0].Errno, err +} diff --git a/vendor/github.com/containers/buildah/internal/open/open_linux.go b/vendor/github.com/containers/buildah/internal/open/open_linux.go new file mode 100644 index 0000000000..3d9d608b5f --- /dev/null +++ b/vendor/github.com/containers/buildah/internal/open/open_linux.go @@ -0,0 +1,88 @@ +package open + +import ( + "bytes" + "encoding/json" + "errors" + "fmt" + "os" + "strings" + + "github.com/containers/storage/pkg/reexec" + "github.com/sirupsen/logrus" + "golang.org/x/sys/unix" +) + +const ( + bindFdToPathCommand = "buildah-bind-fd-to-path" +) + +func init() { + reexec.Register(bindFdToPathCommand, bindFdToPathMain) +} + +// BindFdToPath creates a bind mount from the open file (which is actually a +// directory) to the specified location. If it succeeds, the caller will need +// to unmount the targetPath when it's finished using it. Regardless, it +// closes the passed-in descriptor. +func BindFdToPath(fd uintptr, targetPath string) error { + f := os.NewFile(fd, "passed-in directory descriptor") + defer func() { + if err := f.Close(); err != nil { + logrus.Debugf("closing descriptor %d after attempting to bind to %q: %v", fd, targetPath, err) + } + }() + pipeReader, pipeWriter, err := os.Pipe() + if err != nil { + return err + } + cmd := reexec.Command(bindFdToPathCommand) + cmd.Stdin = pipeReader + var stdout bytes.Buffer + var stderr bytes.Buffer + cmd.Stdout, cmd.Stderr = &stdout, &stderr + cmd.ExtraFiles = append(cmd.ExtraFiles, f) + + err = cmd.Start() + pipeReader.Close() + if err != nil { + pipeWriter.Close() + return fmt.Errorf("starting child: %w", err) + } + + encoder := json.NewEncoder(pipeWriter) + if err := encoder.Encode(&targetPath); err != nil { + return fmt.Errorf("sending target path to child: %w", err) + } + pipeWriter.Close() + err = cmd.Wait() + trimmedOutput := strings.TrimSpace(stdout.String()) + strings.TrimSpace(stderr.String()) + if err != nil { + if len(trimmedOutput) > 0 { + err = fmt.Errorf("%s: %w", trimmedOutput, err) + } + } else { + if len(trimmedOutput) > 0 { + err = errors.New(trimmedOutput) + } + } + return err +} + +func bindFdToPathMain() { + var targetPath string + decoder := json.NewDecoder(os.Stdin) + if err := decoder.Decode(&targetPath); err != nil { + fmt.Fprintf(os.Stderr, "error decoding target path") + os.Exit(1) + } + if err := unix.Fchdir(3); err != nil { + fmt.Fprintf(os.Stderr, "fchdir(): %v", err) + os.Exit(1) + } + if err := unix.Mount(".", targetPath, "bind", unix.MS_BIND, ""); err != nil { + fmt.Fprintf(os.Stderr, "bind-mounting passed-in directory to %q: %v", targetPath, err) + os.Exit(1) + } + os.Exit(0) +} diff --git a/vendor/github.com/containers/buildah/internal/open/open_types.go b/vendor/github.com/containers/buildah/internal/open/open_types.go new file mode 100644 index 0000000000..11dbe38db9 --- /dev/null +++ b/vendor/github.com/containers/buildah/internal/open/open_types.go @@ -0,0 +1,28 @@ +package open + +import ( + "syscall" +) + +type request struct { + Path string + Mode int + Perms uint32 +} + +type requests struct { + Root string + Wd string + Open []request +} + +type result struct { + Fd uintptr // as returned by open() + Err string // if err was not `nil`, err.Error() + Errno syscall.Errno // if err was not `nil` and included a syscall.Errno, its value +} + +type results struct { + Err string + Open []result +} diff --git a/vendor/github.com/containers/buildah/internal/open/open_unix.go b/vendor/github.com/containers/buildah/internal/open/open_unix.go new file mode 100644 index 0000000000..fd254e8745 --- /dev/null +++ b/vendor/github.com/containers/buildah/internal/open/open_unix.go @@ -0,0 +1,168 @@ +//go:build linux || freebsd || darwin + +package open + +import ( + "bytes" + "encoding/json" + "errors" + "fmt" + "os" + "syscall" + + "github.com/containers/storage/pkg/reexec" + "golang.org/x/sys/unix" +) + +const ( + inChrootCommand = "buildah-open-in-chroot" +) + +func init() { + reexec.Register(inChrootCommand, inChrootMain) +} + +func inChroot(requests requests) results { + sock, err := unix.Socketpair(unix.AF_UNIX, unix.SOCK_STREAM, 0) + if err != nil { + return results{Err: fmt.Errorf("creating socket pair: %w", err).Error()} + } + parentSock := sock[0] + childSock := sock[1] + parentEnd := os.NewFile(uintptr(parentSock), "parent end of socket pair") + childEnd := os.NewFile(uintptr(childSock), "child end of socket pair") + cmd := reexec.Command(inChrootCommand) + cmd.ExtraFiles = append(cmd.ExtraFiles, childEnd) + err = cmd.Start() + childEnd.Close() + defer parentEnd.Close() + if err != nil { + return results{Err: err.Error()} + } + encoder := json.NewEncoder(parentEnd) + if err := encoder.Encode(&requests); err != nil { + return results{Err: fmt.Errorf("sending request down socket: %w", err).Error()} + } + if err := unix.Shutdown(parentSock, unix.SHUT_WR); err != nil { + return results{Err: fmt.Errorf("finishing sending request down socket: %w", err).Error()} + } + b := make([]byte, 65536) + oob := make([]byte, 65536) + n, oobn, _, _, err := unix.Recvmsg(parentSock, b, oob, 0) + if err != nil { + return results{Err: fmt.Errorf("receiving message: %w", err).Error()} + } + if err := unix.Shutdown(parentSock, unix.SHUT_RD); err != nil { + return results{Err: fmt.Errorf("finishing socket: %w", err).Error()} + } + if n > len(b) { + return results{Err: fmt.Errorf("too much regular data: %d > %d", n, len(b)).Error()} + } + if oobn > len(oob) { + return results{Err: fmt.Errorf("too much OOB data: %d > %d", oobn, len(oob)).Error()} + } + scms, err := unix.ParseSocketControlMessage(oob[:oobn]) + if err != nil { + return results{Err: fmt.Errorf("parsing control message: %w", err).Error()} + } + var receivedFds []int + for i := range scms { + fds, err := unix.ParseUnixRights(&scms[i]) + if err != nil { + return results{Err: fmt.Errorf("parsing rights message %d: %w", i, err).Error()} + } + receivedFds = append(receivedFds, fds...) + } + decoder := json.NewDecoder(bytes.NewReader(b[:n])) + var result results + if err := decoder.Decode(&result); err != nil { + return results{Err: fmt.Errorf("decoding results: %w", err).Error()} + } + j := 0 + for i := range result.Open { + if result.Open[i].Err == "" { + if j >= len(receivedFds) { + for _, fd := range receivedFds { + unix.Close(fd) + } + return results{Err: fmt.Errorf("didn't receive enough FDs").Error()} + } + result.Open[i].Fd = uintptr(receivedFds[j]) + j++ + } + } + return result +} + +func inChrootMain() { + var theseRequests requests + var theseResults results + sockFd := 3 + sock := os.NewFile(uintptr(sockFd), "socket connection to parent process") + defer sock.Close() + encoder := json.NewEncoder(sock) + decoder := json.NewDecoder(sock) + if err := decoder.Decode(&theseRequests); err != nil { + if err := encoder.Encode(results{Err: fmt.Errorf("decoding request: %w", err).Error()}); err != nil { + os.Exit(1) + } + } + if theseRequests.Root != "" { + if err := os.Chdir(theseRequests.Root); err != nil { + if err := encoder.Encode(results{Err: fmt.Errorf("changing to %q: %w", theseRequests.Root, err).Error()}); err != nil { + os.Exit(1) + } + os.Exit(1) + } + if err := unix.Chroot(theseRequests.Root); err != nil { + if err := encoder.Encode(results{Err: fmt.Errorf("chrooting to %q: %w", theseRequests.Root, err).Error()}); err != nil { + os.Exit(1) + } + os.Exit(1) + } + if err := os.Chdir("/"); err != nil { + if err := encoder.Encode(results{Err: fmt.Errorf("changing to new root: %w", err).Error()}); err != nil { + os.Exit(1) + } + os.Exit(1) + } + } + if theseRequests.Wd != "" { + if err := os.Chdir(theseRequests.Wd); err != nil { + if err := encoder.Encode(results{Err: fmt.Errorf("changing to %q in chroot: %w", theseRequests.Wd, err).Error()}); err != nil { + os.Exit(1) + } + os.Exit(1) + } + } + var fds []int + for _, request := range theseRequests.Open { + fd, err := unix.Open(request.Path, request.Mode, request.Perms) + thisResult := result{Fd: uintptr(fd)} + if err == nil { + fds = append(fds, fd) + } else { + var errno syscall.Errno + thisResult.Err = err.Error() + if errors.As(err, &errno) { + thisResult.Errno = errno + } + } + theseResults.Open = append(theseResults.Open, thisResult) + } + rights := unix.UnixRights(fds...) + inband, err := json.Marshal(&theseResults) + if err != nil { + if err := encoder.Encode(results{Err: fmt.Errorf("sending response: %w", err).Error()}); err != nil { + os.Exit(1) + } + os.Exit(1) + } + if err := unix.Sendmsg(sockFd, inband, rights, nil, 0); err != nil { + if err := encoder.Encode(results{Err: fmt.Errorf("sending response: %w", err).Error()}); err != nil { + os.Exit(1) + } + os.Exit(1) + } + os.Exit(0) +} diff --git a/vendor/github.com/containers/buildah/internal/open/open_unsupported.go b/vendor/github.com/containers/buildah/internal/open/open_unsupported.go new file mode 100644 index 0000000000..111056a18b --- /dev/null +++ b/vendor/github.com/containers/buildah/internal/open/open_unsupported.go @@ -0,0 +1,7 @@ +//go:build !linux && !freebsd && !darwin + +package open + +func inChroot(requests requests) results { + return results{Err: "open-in-chroot not available on this platform"} +} diff --git a/vendor/github.com/containers/buildah/internal/parse/parse.go b/vendor/github.com/containers/buildah/internal/parse/parse.go index e3c7ad8d82..fadb5d63c1 100644 --- a/vendor/github.com/containers/buildah/internal/parse/parse.go +++ b/vendor/github.com/containers/buildah/internal/parse/parse.go @@ -11,18 +11,23 @@ import ( "errors" - "github.com/containers/buildah/copier" + "github.com/containers/buildah/copier" "github.com/containers/buildah/define" "github.com/containers/buildah/internal" internalUtil "github.com/containers/buildah/internal/util" + internalVolumes "github.com/containers/buildah/internal/volumes" + "github.com/containers/buildah/pkg/overlay" "github.com/containers/common/pkg/parse" "github.com/containers/image/v5/types" "github.com/containers/storage" "github.com/containers/storage/pkg/idtools" "github.com/containers/storage/pkg/lockfile" "github.com/containers/storage/pkg/unshare" + "github.com/containers/storage/pkg/mount" + digest "github.com/opencontainers/go-digest" specs "github.com/opencontainers/runtime-spec/specs-go" selinux "github.com/opencontainers/selinux/go-selinux" + "github.com/sirupsen/logrus" ) const ( @@ -49,15 +54,23 @@ var ( ) // GetBindMount parses a single bind mount entry from the --mount flag. -// Returns specifiedMount and a string which contains name of image that we mounted otherwise its empty. -// Caller is expected to perform unmount of any mounted images -func GetBindMount(ctx *types.SystemContext, args []string, contextDir string, store storage.Store, imageMountLabel string, additionalMountPoints map[string]internal.StageMountDetails, workDir string) (specs.Mount, string, error) { +// +// Returns a Mount to add to the runtime spec's list of mounts, the ID of the +// image we mounted if we mounted one, the path of a mounted location if one +// needs to be unmounted and removed, and the path of an overlay mount if one +// needs to be cleaned up, or an error. +// +// The caller is expected to, after the command which uses the mount exits, +// clean up the overlay filesystem (if we provided a path to it), unmount and +// remove the mountpoint for the mounted filesystem (if we provided the path to +// its mountpoint), and then unmount the image (if we mounted one). +func GetBindMount(sys *types.SystemContext, args []string, contextDir string, store storage.Store, mountLabel string, additionalMountPoints map[string]internal.StageMountDetails, workDir, tmpDir string) (specs.Mount, string, string, string, error) { newMount := specs.Mount{ Type: define.TypeBind, } - mountReadability := false - setDest := false + mountReadability := "" + setDest := "" bindNonRecursive := false fromImage := "" @@ -70,64 +83,69 @@ func GetBindMount(ctx *types.SystemContext, args []string, contextDir string, st case "bind-nonrecursive": newMount.Options = append(newMount.Options, "bind") bindNonRecursive = true - case "ro", "nosuid", "nodev", "noexec": + case "nosuid", "nodev", "noexec": // TODO: detect duplication of these options. // (Is this necessary?) newMount.Options = append(newMount.Options, kv[0]) - mountReadability = true case "rw", "readwrite": newMount.Options = append(newMount.Options, "rw") - mountReadability = true - case "readonly": - // Alias for "ro" + mountReadability = "rw" + case "ro", "readonly": newMount.Options = append(newMount.Options, "ro") - mountReadability = true + mountReadability = "ro" case "shared", "rshared", "private", "rprivate", "slave", "rslave", "Z", "z", "U": newMount.Options = append(newMount.Options, kv[0]) case "from": if len(kv) == 1 { - return newMount, "", fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + return newMount, "", "", "", fmt.Errorf("%v: %w", kv[0], errBadOptionArg) } fromImage = kv[1] case "bind-propagation": if len(kv) == 1 { - return newMount, "", fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + return newMount, "", "", "", fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + } + switch kv[1] { + default: + return newMount, "", "", "", fmt.Errorf("%v: %q: %w", kv[0], kv[1], errBadMntOption) + case "shared", "rshared", "private", "rprivate", "slave", "rslave": + // this should be the relevant parts of the same list of options we accepted above } newMount.Options = append(newMount.Options, kv[1]) case "src", "source": if len(kv) == 1 { - return newMount, "", fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + return newMount, "", "", "", fmt.Errorf("%v: %w", kv[0], errBadOptionArg) } newMount.Source = kv[1] case "target", "dst", "destination": if len(kv) == 1 { - return newMount, "", fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + return newMount, "", "", "", fmt.Errorf("%v: %w", kv[0], errBadOptionArg) } targetPath := kv[1] + setDest = targetPath if !path.IsAbs(targetPath) { targetPath = filepath.Join(workDir, targetPath) } if err := parse.ValidateVolumeCtrDir(targetPath); err != nil { - return newMount, "", err + return newMount, "", "", "", err } newMount.Destination = targetPath - setDest = true case "consistency": // Option for OS X only, has no meaning on other platforms // and can thus be safely ignored. // See also the handling of the equivalent "delegated" and "cached" in ValidateVolumeOpts default: - return newMount, "", fmt.Errorf("%v: %w", kv[0], errBadMntOption) + return newMount, "", "", "", fmt.Errorf("%v: %w", kv[0], errBadMntOption) } } // default mount readability is always readonly - if !mountReadability { + if mountReadability == "" { newMount.Options = append(newMount.Options, "ro") } // Following variable ensures that we return imagename only if we did additional mount - isImageMounted := false + succeeded := false + mountedImage := "" if fromImage != "" { mountPoint := "" if additionalMountPoints != nil { @@ -138,16 +156,23 @@ func GetBindMount(ctx *types.SystemContext, args []string, contextDir string, st // if mountPoint of image was not found in additionalMap // or additionalMap was nil, try mounting image if mountPoint == "" { - image, err := internalUtil.LookupImage(ctx, store, fromImage) + image, err := internalUtil.LookupImage(sys, store, fromImage) if err != nil { - return newMount, "", err + return newMount, "", "", "", err } - mountPoint, err = image.Mount(context.Background(), nil, imageMountLabel) + mountPoint, err = image.Mount(context.Background(), nil, mountLabel) if err != nil { - return newMount, "", err - } - isImageMounted = true + return newMount, "", "", "", err + } + mountedImage = image.ID() + defer func() { + if !succeeded { + if _, err := store.UnmountImage(mountedImage, false); err != nil { + logrus.Debugf("unmounting bind-mounted image %q: %v", fromImage, err) + } + } + }() } contextDir = mountPoint } @@ -158,42 +183,62 @@ func GetBindMount(ctx *types.SystemContext, args []string, contextDir string, st newMount.Options = append(newMount.Options, "rbind") } - if !setDest { - return newMount, fromImage, errBadVolDest + if setDest == "" { + return newMount, "", "", "", errBadVolDest } // buildkit parity: support absolute path for sources from current build context if contextDir != "" { // path should be /contextDir/specified path - evaluated, err := copier.Eval(contextDir, newMount.Source, copier.EvalOptions{}) + evaluated, err := copier.Eval(contextDir, contextDir+string(filepath.Separator)+newMount.Source, copier.EvalOptions{}) if err != nil { - return newMount, "", err + return newMount, "", "", "", err } newMount.Source = evaluated } else { // looks like its coming from `build run --mount=type=bind` allow using absolute path // error out if no source is set if newMount.Source == "" { - return newMount, "", errBadVolSrc + return newMount, "", "", "", errBadVolSrc } if err := parse.ValidateVolumeHostDir(newMount.Source); err != nil { - return newMount, "", err + return newMount, "", "", "", err } } opts, err := parse.ValidateVolumeOpts(newMount.Options) if err != nil { - return newMount, fromImage, err + return newMount, "", "", "", err } newMount.Options = opts - if !isImageMounted { - // we don't want any cleanups if image was not mounted explicitly - // so dont return anything - fromImage = "" + var intermediateMount string + if contextDir != "" && newMount.Source != contextDir { + rel, err := filepath.Rel(contextDir, newMount.Source) + if err != nil { + return newMount, "", "", "", fmt.Errorf("computing pathname of bind subdirectory: %w", err) + } + if rel != "." && rel != "/" { + mnt, err := internalVolumes.BindFromChroot(contextDir, rel, tmpDir) + if err != nil { + return newMount, "", "", "", fmt.Errorf("sanitizing bind subdirectory %q: %w", newMount.Source, err) + } + logrus.Debugf("bind-mounted %q under %q to %q", rel, contextDir, mnt) + intermediateMount = mnt + newMount.Source = intermediateMount + } } - return newMount, fromImage, nil + overlayDir := "" + if mountedImage != "" || mountIsReadWrite(newMount) { + if newMount, overlayDir, err = convertToOverlay(newMount, store, mountLabel, tmpDir, 0, 0); err != nil { + return newMount, "", "", "", err + } + } + + succeeded = true + + return newMount, mountedImage, intermediateMount, overlayDir, nil } // CleanCacheMount gets the cache parent created by `--mount=type=cache` and removes it. @@ -202,10 +247,77 @@ func CleanCacheMount() error { return os.RemoveAll(cacheParent) } +func mountIsReadWrite(m specs.Mount) bool { + // in case of conflicts, the last one wins, so it's not enough + // to check for the presence of either "rw" or "ro" anywhere + // with e.g. slices.Contains() + rw := true + for _, option := range m.Options { + switch option { + case "rw": + rw = true + case "ro": + rw = false + } + } + return rw +} + +func convertToOverlay(m specs.Mount, store storage.Store, mountLabel, tmpDir string, uid, gid int) (specs.Mount, string, error) { + overlayDir, err := overlay.TempDir(tmpDir, uid, gid) + if err != nil { + return specs.Mount{}, "", fmt.Errorf("setting up overlay for %q: %w", m.Destination, err) + } + graphOptions := store.GraphOptions() + graphOptsCopy := make([]string, len(graphOptions)) + copy(graphOptsCopy, graphOptions) + options := overlay.Options{GraphOpts: graphOptsCopy, ForceMount: true, MountLabel: mountLabel} + fileInfo, err := os.Stat(m.Source) + if err != nil { + return specs.Mount{}, "", fmt.Errorf("setting up overlay of %q: %w", m.Source, err) + } + // we might be trying to "overlay" for a non-directory, and the kernel doesn't like that very much + var mountThisInstead specs.Mount + if fileInfo.IsDir() { + // do the normal thing of mounting this directory as a lower with a temporary upper + mountThisInstead, err = overlay.MountWithOptions(overlayDir, m.Source, m.Destination, &options) + if err != nil { + return specs.Mount{}, "", fmt.Errorf("setting up overlay of %q: %w", m.Source, err) + } + } else { + // mount the parent directory as the lower with a temporary upper, and return a + // bind mount from the non-directory in the merged directory to the destination + sourceDir := filepath.Dir(m.Source) + sourceBase := filepath.Base(m.Source) + destination := m.Destination + mountedOverlay, err := overlay.MountWithOptions(overlayDir, sourceDir, destination, &options) + if err != nil { + return specs.Mount{}, "", fmt.Errorf("setting up overlay of %q: %w", sourceDir, err) + } + if mountedOverlay.Type != define.TypeBind { + if err2 := overlay.RemoveTemp(overlayDir); err2 != nil { + return specs.Mount{}, "", fmt.Errorf("cleaning up after failing to set up overlay: %v, while setting up overlay for %q: %w", err2, destination, err) + } + return specs.Mount{}, "", fmt.Errorf("setting up overlay for %q at %q: %w", mountedOverlay.Source, destination, err) + } + mountThisInstead = mountedOverlay + mountThisInstead.Source = filepath.Join(mountedOverlay.Source, sourceBase) + mountThisInstead.Destination = destination + } + return mountThisInstead, overlayDir, nil +} + + // GetCacheMount parses a single cache mount entry from the --mount flag. // -// If this function succeeds and returns a non-nil *lockfile.LockFile, the caller must unlock it (when??). -func GetCacheMount(args []string, store storage.Store, imageMountLabel string, additionalMountPoints map[string]internal.StageMountDetails, workDir string) (specs.Mount, *lockfile.LockFile, error) { +// Returns a Mount to add to the runtime spec's list of mounts, the path of a +// mounted filesystem if one needs to be unmounted, and an optional lock that +// needs to be released, or an error. +// +// The caller is expected to, after the command which uses the mount exits, +// unmount and remove the mountpoint of the mounted filesystem (if we provided +// the path to its mountpoint). +func GetCacheMount(args []string, additionalMountPoints map[string]internal.StageMountDetails, workDir, tmpDir string) (specs.Mount, string, *lockfile.LockFile, error) { var err error var mode uint64 var buildahLockFilesDir string @@ -256,63 +368,69 @@ func GetCacheMount(args []string, store storage.Store, imageMountLabel string, a sharing = kv[1] case "bind-propagation": if len(kv) == 1 { - return newMount, nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + return newMount, "", nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + } + switch kv[1] { + default: + return newMount, "", nil, fmt.Errorf("%v: %w", kv[0], errBadMntOption) + case "shared", "rshared", "private", "rprivate", "slave", "rslave": + // this should be the relevant parts of the same list of options we accepted above } newMount.Options = append(newMount.Options, kv[1]) case "id": if len(kv) == 1 { - return newMount, nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + return newMount, "", nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) } id = kv[1] case "from": if len(kv) == 1 { - return newMount, nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + return newMount, "", nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) } fromStage = kv[1] case "target", "dst", "destination": if len(kv) == 1 { - return newMount, nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + return newMount, "", nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) } targetPath := kv[1] if !path.IsAbs(targetPath) { targetPath = filepath.Join(workDir, targetPath) } if err := parse.ValidateVolumeCtrDir(targetPath); err != nil { - return newMount, nil, err + return newMount, "", nil, err } newMount.Destination = targetPath setDest = true case "src", "source": if len(kv) == 1 { - return newMount, nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + return newMount, "", nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) } newMount.Source = kv[1] case "mode": if len(kv) == 1 { - return newMount, nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + return newMount, "", nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) } mode, err = strconv.ParseUint(kv[1], 8, 32) if err != nil { - return newMount, nil, fmt.Errorf("unable to parse cache mode: %w", err) + return newMount, "", nil, fmt.Errorf("unable to parse cache mode: %w", err) } case "uid": if len(kv) == 1 { - return newMount, nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + return newMount, "", nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) } uid, err = strconv.Atoi(kv[1]) if err != nil { - return newMount, nil, fmt.Errorf("unable to parse cache uid: %w", err) + return newMount, "", nil, fmt.Errorf("unable to parse cache uid: %w", err) } case "gid": if len(kv) == 1 { - return newMount, nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) + return newMount, "", nil, fmt.Errorf("%v: %w", kv[0], errBadOptionArg) } gid, err = strconv.Atoi(kv[1]) if err != nil { - return newMount, nil, fmt.Errorf("unable to parse cache gid: %w", err) + return newMount, "", nil, fmt.Errorf("unable to parse cache gid: %w", err) } default: - return newMount, nil, fmt.Errorf("%v: %w", kv[0], errBadMntOption) + return newMount, "", nil, fmt.Errorf("%v: %w", kv[0], errBadMntOption) } } @@ -323,16 +441,18 @@ func GetCacheMount(args []string, store storage.Store, imageMountLabel string, a } if !setDest { - return newMount, nil, errBadVolDest + return newMount, "", nil, errBadVolDest } + thisCacheRoot := "" if fromStage != "" { - // do not create cache on host - // instead use read-only mounted stage as cache + // do not create and use a cache directory on the host, + // instead use the location in the mounted stage or + // temporary directory as the cache mountPoint := "" if additionalMountPoints != nil { if val, ok := additionalMountPoints[fromStage]; ok { - if val.IsStage { + if !val.IsImage { mountPoint = val.MountPoint } } @@ -340,10 +460,9 @@ func GetCacheMount(args []string, store storage.Store, imageMountLabel string, a // Cache does not supports using image so if not stage found // return with error if mountPoint == "" { - return newMount, nil, fmt.Errorf("no stage found with name %s", fromStage) + return newMount, "", nil, fmt.Errorf("no stage or additional build context found with name %s", fromStage) } - // path should be /contextDir/specified path - newMount.Source = filepath.Join(mountPoint, filepath.Clean(string(filepath.Separator)+newMount.Source)) + thisCacheRoot = mountPoint } else { // we need to create cache on host if no image is being used @@ -356,34 +475,45 @@ func GetCacheMount(args []string, store storage.Store, imageMountLabel string, a // create cache on host if not present err = os.MkdirAll(cacheParent, os.FileMode(0755)) if err != nil { - return newMount, nil, fmt.Errorf("unable to create build cache directory: %w", err) + return newMount, "", nil, fmt.Errorf("unable to create build cache directory: %w", err) } if id != "" { - newMount.Source = filepath.Join(cacheParent, filepath.Clean(id)) - buildahLockFilesDir = filepath.Join(BuildahCacheLockfileDir, filepath.Clean(id)) + // Don't let the user control where we place the directory. + dirID := digest.FromString(id).Encoded()[:16] + thisCacheRoot = filepath.Join(cacheParent, dirID) + buildahLockFilesDir = filepath.Join(BuildahCacheLockfileDir, dirID) } else { - newMount.Source = filepath.Join(cacheParent, filepath.Clean(newMount.Destination)) - buildahLockFilesDir = filepath.Join(BuildahCacheLockfileDir, filepath.Clean(newMount.Destination)) + // Don't let the user control where we place the directory. + dirID := digest.FromString(newMount.Destination).Encoded()[:16] + thisCacheRoot = filepath.Join(cacheParent, dirID) + buildahLockFilesDir = filepath.Join(BuildahCacheLockfileDir, dirID) } idPair := idtools.IDPair{ UID: uid, GID: gid, } - //buildkit parity: change uid and gid if specified otheriwise keep `0` - err = idtools.MkdirAllAndChownNew(newMount.Source, os.FileMode(mode), idPair) + // buildkit parity: change uid and gid if specified otheriwise keep `0` + err = idtools.MkdirAllAndChownNew(thisCacheRoot, os.FileMode(mode), idPair) if err != nil { - return newMount, nil, fmt.Errorf("unable to change uid,gid of cache directory: %w", err) + return newMount, "", nil, fmt.Errorf("unable to change uid,gid of cache directory: %w", err) } // create a subdirectory inside `cacheParent` just to store lockfiles buildahLockFilesDir = filepath.Join(cacheParent, buildahLockFilesDir) err = os.MkdirAll(buildahLockFilesDir, os.FileMode(0700)) if err != nil { - return newMount, nil, fmt.Errorf("unable to create build cache lockfiles directory: %w", err) + return newMount, "", nil, fmt.Errorf("unable to create build cache lockfiles directory: %w", err) } } + // path should be /mountPoint/specified path + evaluated, err := copier.Eval(thisCacheRoot, thisCacheRoot+string(filepath.Separator)+newMount.Source, copier.EvalOptions{}) + if err != nil { + return newMount, "", nil, err + } + newMount.Source = evaluated + var targetLock *lockfile.LockFile // = nil succeeded := false defer func() { @@ -396,17 +526,22 @@ func GetCacheMount(args []string, store storage.Store, imageMountLabel string, a // lock parent cache lockfile, err := lockfile.GetLockFile(filepath.Join(buildahLockFilesDir, BuildahCacheLockfile)) if err != nil { - return newMount, nil, fmt.Errorf("unable to acquire lock when sharing mode is locked: %w", err) + return newMount, "", nil, fmt.Errorf("unable to acquire lock when sharing mode is locked: %w", err) } // Will be unlocked after the RUN step is executed. lockfile.Lock() targetLock = lockfile + defer func() { + if !succeeded { + targetLock.Unlock() + } + }() case "shared": // do nothing since default is `shared` break default: // error out for unknown values - return newMount, nil, fmt.Errorf("unrecognized value %q for field `sharing`: %w", sharing, err) + return newMount, "", nil, fmt.Errorf("unrecognized value %q for field `sharing`: %w", sharing, err) } // buildkit parity: default sharing should be shared @@ -424,12 +559,29 @@ func GetCacheMount(args []string, store storage.Store, imageMountLabel string, a opts, err := parse.ValidateVolumeOpts(newMount.Options) if err != nil { - return newMount, nil, err + return newMount, "", nil, err } newMount.Options = opts + var intermediateMount string + if newMount.Source != thisCacheRoot { + rel, err := filepath.Rel(thisCacheRoot, newMount.Source) + if err != nil { + return newMount, "", nil, fmt.Errorf("computing pathname of cache subdirectory: %w", err) + } + if rel != "." && rel != "/" { + mnt, err := internalVolumes.BindFromChroot(thisCacheRoot, rel, tmpDir) + if err != nil { + return newMount, "", nil, fmt.Errorf("sanitizing cache subdirectory %q: %w", newMount.Source, err) + } + logrus.Debugf("bind-mounted %q under %q to %q", rel, thisCacheRoot, mnt) + intermediateMount = mnt + newMount.Source = intermediateMount + } + } + succeeded = true - return newMount, targetLock, nil + return newMount, intermediateMount, targetLock, nil } // ValidateVolumeMountHostDir validates the host path of buildah --volume @@ -516,34 +668,52 @@ func Volume(volume string) (specs.Mount, error) { return mount, nil } -// UnlockLockArray is a helper for cleaning up after GetVolumes and the like. -func UnlockLockArray(locks []*lockfile.LockFile) { - for _, lock := range locks { - lock.Unlock() - } -} - -// GetVolumes gets the volumes from --volume and --mount +// GetVolumes gets the volumes from --volume and --mount flags. // -// If this function succeeds, the caller must unlock the returned *lockfile.LockFile s if any (when??). -func GetVolumes(ctx *types.SystemContext, store storage.Store, volumes []string, mounts []string, contextDir string, workDir string) ([]specs.Mount, []string, []*lockfile.LockFile, error) { - unifiedMounts, mountedImages, targetLocks, err := getMounts(ctx, store, mounts, contextDir, workDir) +// Returns a slice of Mounts to add to the runtime spec's list of mounts, the +// IDs of any images we mounted, a slice of bind-mounted paths, a slice of +// overlay directories and a slice of locks that we acquired, or an error. +// +// The caller is expected to, after the command which uses the mounts and +// volumes exits, clean up the overlay directories, unmount and remove the +// mountpoints for the bind-mounted paths, unmount any images we mounted, and +// release the locks we returned if any. +func GetVolumes(ctx *types.SystemContext, store storage.Store, mountLabel string, volumes []string, mounts []string, contextDir, workDir, tmpDir string) ([]specs.Mount, []string, []string, []string, []*lockfile.LockFile, error) { + unifiedMounts, mountedImages, intermediateMounts, overlayMounts, targetLocks, err := getMounts(ctx, store, mountLabel, mounts, contextDir, workDir, tmpDir) if err != nil { - return nil, mountedImages, nil, err + return nil, nil, nil, nil, nil, err } succeeded := false defer func() { if !succeeded { + for _, overlayMount := range overlayMounts { + if err := overlay.RemoveTemp(overlayMount); err != nil { + logrus.Debugf("unmounting overlay mount at %q: %v", overlayMount, err) + } + } + for _, intermediateMount := range intermediateMounts { + if err := mount.Unmount(intermediateMount); err != nil { + logrus.Debugf("unmounting intermediate mount point %q: %v", intermediateMount, err) + } + if err := os.Remove(intermediateMount); err != nil { + logrus.Debugf("removing should-be-empty directory %q: %v", intermediateMount, err) + } + } + for _, image := range mountedImages { + if _, err := store.UnmountImage(image, false); err != nil { + logrus.Debugf("unmounting image %q: %v", image, err) + } + } UnlockLockArray(targetLocks) } }() volumeMounts, err := getVolumeMounts(volumes) if err != nil { - return nil, mountedImages, nil, err + return nil, nil, nil, nil, nil, err } for dest, mount := range volumeMounts { if _, ok := unifiedMounts[dest]; ok { - return nil, mountedImages, nil, fmt.Errorf("%v: %w", dest, errDuplicateDest) + return nil, nil, nil, nil, nil, fmt.Errorf("%v: %w", dest, errDuplicateDest) } unifiedMounts[dest] = mount } @@ -553,24 +723,52 @@ func GetVolumes(ctx *types.SystemContext, store storage.Store, volumes []string, finalMounts = append(finalMounts, mount) } succeeded = true - return finalMounts, mountedImages, targetLocks, nil + return finalMounts, mountedImages, intermediateMounts, overlayMounts, targetLocks, nil } -// getMounts takes user-provided input from the --mount flag and creates OCI -// spec mounts. -// buildah run --mount type=bind,src=/etc/resolv.conf,target=/etc/resolv.conf ... -// buildah run --mount type=tmpfs,target=/dev/shm ... +// getMounts takes user-provided inputs from the --mount flag and returns a +// slice of OCI spec mounts, a slice of mounted image IDs, a slice of other +// mount locations, a slice of overlay mounts, and a slice of locks, or an +// error. // -// If this function succeeds, the caller must unlock the returned *lockfile.LockFile s if any (when??). -func getMounts(ctx *types.SystemContext, store storage.Store, mounts []string, contextDir string, workDir string) (map[string]specs.Mount, []string, []*lockfile.LockFile, error) { +// buildah run --mount type=bind,src=/etc/resolv.conf,target=/etc/resolv.conf ... +// buildah run --mount type=cache,target=/var/cache ... +// buildah run --mount type=tmpfs,target=/dev/shm ... +// +// The caller is expected to, after the command which uses the mounts exits, +// unmount the overlay filesystems (if we mounted any), unmount the other +// mounted filesystems and remove their mountpoints (if we provided any paths +// to mountpoints), unmount any mounted images (if we provided the IDs of any), +// and then unlock the locks we returned if any. +func getMounts(ctx *types.SystemContext, store storage.Store, mountLabel string, mounts []string, contextDir, workDir, tmpDir string) (map[string]specs.Mount, []string, []string, []string, []*lockfile.LockFile, error) { // If `type` is not set default to "bind" mountType := define.TypeBind - finalMounts := make(map[string]specs.Mount) - mountedImages := make([]string, 0) + finalMounts := make(map[string]specs.Mount, len(mounts)) + mountedImages := make([]string, 0, len(mounts)) + intermediateMounts := make([]string, 0, len(mounts)) + overlayMounts := make([]string, 0, len(mounts)) targetLocks := make([]*lockfile.LockFile, 0) succeeded := false defer func() { if !succeeded { + for _, overlayDir := range overlayMounts { + if err := overlay.RemoveTemp(overlayDir); err != nil { + logrus.Debugf("unmounting overlay mount at %q: %v", overlayDir, err) + } + } + for _, intermediateMount := range intermediateMounts { + if err := mount.Unmount(intermediateMount); err != nil { + logrus.Debugf("unmounting intermediate mount point %q: %v", intermediateMount, err) + } + if err := os.Remove(intermediateMount); err != nil { + logrus.Debugf("removing should-be-empty directory %q: %v", intermediateMount, err) + } + } + for _, image := range mountedImages { + if _, err := store.UnmountImage(image, false); err != nil { + logrus.Debugf("unmounting image %q: %v", image, err) + } + } UnlockLockArray(targetLocks) } }() @@ -583,56 +781,67 @@ func getMounts(ctx *types.SystemContext, store storage.Store, mounts []string, c for _, mount := range mounts { tokens := strings.Split(mount, ",") if len(tokens) < 2 { - return nil, mountedImages, nil, fmt.Errorf("%q: %w", mount, errInvalidSyntax) + return nil, nil, nil, nil, nil, fmt.Errorf("%q: %w", mount, errInvalidSyntax) } for _, field := range tokens { if strings.HasPrefix(field, "type=") { kv := strings.Split(field, "=") if len(kv) != 2 { - return nil, mountedImages, nil, fmt.Errorf("%q: %w", mount, errInvalidSyntax) + return nil, nil, nil, nil, nil, fmt.Errorf("%q: %w", mount, errInvalidSyntax) } mountType = kv[1] } } switch mountType { case define.TypeBind: - mount, image, err := GetBindMount(ctx, tokens, contextDir, store, "", nil, workDir) + mount, image, intermediateMount, overlayMount, err := GetBindMount(ctx, tokens, contextDir, store, mountLabel, nil, workDir, tmpDir) if err != nil { - return nil, mountedImages, nil, err + return nil, nil, nil, nil, nil, err + } + if image != "" { + mountedImages = append(mountedImages, image) + } + if intermediateMount != "" { + intermediateMounts = append(intermediateMounts, intermediateMount) + } + if overlayMount != "" { + overlayMounts = append(overlayMounts, overlayMount) } if _, ok := finalMounts[mount.Destination]; ok { - return nil, mountedImages, nil, fmt.Errorf("%v: %w", mount.Destination, errDuplicateDest) + return nil, nil, nil, nil, nil, fmt.Errorf("%v: %w", mount.Destination, errDuplicateDest) } finalMounts[mount.Destination] = mount - mountedImages = append(mountedImages, image) case TypeCache: - mount, tl, err := GetCacheMount(tokens, store, "", nil, workDir) + mount, intermediateMount, tl, err := GetCacheMount(tokens, nil, workDir, tmpDir) if err != nil { - return nil, mountedImages, nil, err + return nil, nil, nil, nil, nil, err + } + if intermediateMount != "" { + intermediateMounts = append(intermediateMounts, intermediateMount) } if tl != nil { targetLocks = append(targetLocks, tl) } if _, ok := finalMounts[mount.Destination]; ok { - return nil, mountedImages, nil, fmt.Errorf("%v: %w", mount.Destination, errDuplicateDest) + return nil, nil, nil, nil, nil, fmt.Errorf("%v: %w", mount.Destination, errDuplicateDest) } finalMounts[mount.Destination] = mount case TypeTmpfs: mount, err := GetTmpfsMount(tokens) if err != nil { - return nil, mountedImages, nil, err + return nil, nil, nil, nil, nil, err } if _, ok := finalMounts[mount.Destination]; ok { - return nil, mountedImages, nil, fmt.Errorf("%v: %w", mount.Destination, errDuplicateDest) + return nil, nil, nil, nil, nil, fmt.Errorf("%v: %w", mount.Destination, errDuplicateDest) } finalMounts[mount.Destination] = mount default: - return nil, mountedImages, nil, fmt.Errorf("invalid filesystem type %q", mountType) + return nil, nil, nil, nil, nil, fmt.Errorf("invalid filesystem type %q", mountType) } } succeeded = true - return finalMounts, mountedImages, targetLocks, nil + return finalMounts, mountedImages, intermediateMounts, overlayMounts, targetLocks, nil } // GetTmpfsMount parses a single tmpfs mount entry from the --mount flag @@ -690,3 +899,10 @@ func GetTmpfsMount(args []string) (specs.Mount, error) { return newMount, nil } + +// UnlockLockArray is a helper for cleaning up after GetVolumes and the like. +func UnlockLockArray(locks []*lockfile.LockFile) { + for _, lock := range locks { + lock.Unlock() + } +} diff --git a/vendor/github.com/containers/buildah/internal/types.go b/vendor/github.com/containers/buildah/internal/types.go index ee87eca225..9d58754ee3 100644 --- a/vendor/github.com/containers/buildah/internal/types.go +++ b/vendor/github.com/containers/buildah/internal/types.go @@ -13,6 +13,8 @@ const ( // automatically clean them up. type StageMountDetails struct { DidExecute bool // tells if the stage which is being mounted was freshly executed or was part of older cache - IsStage bool // tells if mountpoint returned from stage executor is stage or image - MountPoint string // mountpoint of stage/image + IsStage bool // true if the mountpoint is a stage's rootfs + IsImage bool // true if the mountpoint is an image's rootfs + IsAdditionalBuildContext bool // true if the mountpoint is an additional build context + MountPoint string // mountpoint of the stage or image's root directory or path of the additional build context } diff --git a/vendor/github.com/containers/buildah/internal/volumes/bind_linux.go b/vendor/github.com/containers/buildah/internal/volumes/bind_linux.go new file mode 100644 index 0000000000..af2e7f23aa --- /dev/null +++ b/vendor/github.com/containers/buildah/internal/volumes/bind_linux.go @@ -0,0 +1,102 @@ +package volumes + +import ( + "errors" + "fmt" + "os" + + "github.com/containers/buildah/internal/open" + "github.com/containers/storage/pkg/mount" + "github.com/sirupsen/logrus" + "golang.org/x/sys/unix" +) + +// BindFromChroot opens "path" inside of "root" using a chrooted subprocess +// that returns a descriptor, then creates a uniquely-named temporary directory +// or file under "tmp" and bind-mounts the opened descriptor to it, returning +// the path of the temporary file or directory. The caller is responsible for +// unmounting and removing the temporary. +func BindFromChroot(root, path, tmp string) (string, error) { + fd, _, err := open.InChroot(root, "", path, unix.O_DIRECTORY|unix.O_RDONLY, 0) + if err != nil { + if !errors.Is(err, unix.ENOTDIR) { + return "", fmt.Errorf("opening directory %q under %q: %w", path, root, err) + } + fd, _, err = open.InChroot(root, "", path, unix.O_RDWR, 0) + if err != nil { + return "", fmt.Errorf("opening non-directory %q under %q: %w", path, root, err) + } + } + defer func() { + if err := unix.Close(fd); err != nil { + logrus.Debugf("closing %q under %q: %v", path, root, err) + } + }() + + succeeded := false + var dest string + var destF *os.File + defer func() { + if !succeeded { + if destF != nil { + if err := destF.Close(); err != nil { + logrus.Debugf("closing bind target %q: %v", dest, err) + } + } + if dest != "" { + if err := os.Remove(dest); err != nil { + logrus.Debugf("removing bind target %q: %v", dest, err) + } + } + } + }() + + var st unix.Stat_t + if err = unix.Fstat(fd, &st); err != nil { + return "", fmt.Errorf("checking if %q under %q was a directory: %w", path, root, err) + } + + if st.Mode&unix.S_IFDIR == unix.S_IFDIR { + if dest, err = os.MkdirTemp(tmp, "bind"); err != nil { + return "", fmt.Errorf("creating a bind target directory: %w", err) + } + } else { + if destF, err = os.CreateTemp(tmp, "bind"); err != nil { + return "", fmt.Errorf("creating a bind target non-directory: %w", err) + } + if err := destF.Close(); err != nil { + logrus.Debugf("closing bind target %q: %v", dest, err) + } + dest = destF.Name() + } + defer func() { + if !succeeded { + if err := os.Remove(dest); err != nil { + logrus.Debugf("removing bind target %q: %v", dest, err) + } + } + }() + + if err := unix.Mount(fmt.Sprintf("/proc/self/fd/%d", fd), dest, "bind", unix.MS_BIND, ""); err != nil { + return "", fmt.Errorf("bind-mounting passed-in descriptor to %q: %w", dest, err) + } + defer func() { + if !succeeded { + if err := mount.Unmount(dest); err != nil { + logrus.Debugf("unmounting bound target %q: %v", dest, err) + } + } + }() + + var st2 unix.Stat_t + if err = unix.Stat(dest, &st2); err != nil { + return "", fmt.Errorf("looking up device/inode of newly-bind-mounted %q: %w", dest, err) + } + + if st2.Dev != st.Dev || st2.Ino != st.Ino { + return "", fmt.Errorf("device/inode weren't what we expected after bind mounting: %w", err) + } + + succeeded = true + return dest, nil +} diff --git a/vendor/github.com/containers/buildah/internal/volumes/bind_notlinux.go b/vendor/github.com/containers/buildah/internal/volumes/bind_notlinux.go new file mode 100644 index 0000000000..c95500f815 --- /dev/null +++ b/vendor/github.com/containers/buildah/internal/volumes/bind_notlinux.go @@ -0,0 +1,15 @@ +//go:build !linux + +package volumes + +import "errors" + +// BindFromChroot would open "path" inside of "root" using a chrooted +// subprocess that returns a descriptor, then would create a uniquely-named +// temporary directory or file under "tmp" and bind-mount the opened descriptor +// to it, returning the path of the temporary file or directory. The caller +// would be responsible for unmounting and removing the temporary. For now, +// this just returns an error because it is not implemented for this platform. +func BindFromChroot(root, path, tmp string) (string, error) { + return "", errors.New("not available on this system") +} diff --git a/vendor/github.com/containers/buildah/pkg/overlay/overlay.go b/vendor/github.com/containers/buildah/pkg/overlay/overlay.go index 81810d28d2..eed4c01f29 100644 --- a/vendor/github.com/containers/buildah/pkg/overlay/overlay.go +++ b/vendor/github.com/containers/buildah/pkg/overlay/overlay.go @@ -11,9 +11,11 @@ import ( "errors" "github.com/containers/storage/pkg/idtools" + "github.com/containers/storage/pkg/mount" "github.com/containers/storage/pkg/system" "github.com/containers/storage/pkg/unshare" "github.com/opencontainers/runtime-spec/specs-go" + "github.com/opencontainers/selinux/go-selinux/label" "github.com/sirupsen/logrus" "golang.org/x/sys/unix" ) @@ -50,6 +52,12 @@ type Options struct { RootUID int // RootGID is not used yet but keeping it here for legacy reasons. RootGID int + // Force overlay mounting and return a bind mount, rather than + // attempting to optimize by having the runtime actually mount and + // manage the overlay filesystem. + ForceMount bool + // MountLabel is a label to force for the overlay filesystem. + MountLabel string } // TempDir generates an overlay Temp directory in the container content @@ -187,6 +195,9 @@ func MountWithOptions(contentDir, source, dest string, opts *Options) (mount spe } overlayOptions = fmt.Sprintf("lowerdir=%s,upperdir=%s,workdir=%s,private", escapeColon(source), upperDir, workDir) } + if opts.MountLabel != "" { + overlayOptions = overlayOptions + "," + label.FormatMountLabel("", opts.MountLabel) + } mountProgram := findMountProgram(opts.GraphOpts) if mountProgram != "" { @@ -211,9 +222,27 @@ func MountWithOptions(contentDir, source, dest string, opts *Options) (mount spe mount.Type = "overlay" mount.Options = strings.Split(overlayOptions, ",") + if opts.ForceMount { + if err := mountNatively(overlayOptions, mergeDir); err != nil { + return mount, err + } + + mount.Source = mergeDir + mount.Destination = dest + mount.Type = "bind" + mount.Options = []string{"bind", "slave"} + return mount, nil + } + return mount, nil } +// mountNatively mounts an overlay at mergeDir using the kernel's mount() +// system call. +func mountNatively(overlayOptions, mergeDir string) error { + return mount.Mount("overlay", mergeDir, "overlay", overlayOptions) +} + // Convert ":" to "\:", the path which will be overlay mounted need to be escaped func escapeColon(source string) string { return strings.ReplaceAll(source, ":", "\\:") diff --git a/vendor/github.com/containers/buildah/run.go b/vendor/github.com/containers/buildah/run.go index 4473bef0eb..3aba2e6dd6 100644 --- a/vendor/github.com/containers/buildah/run.go +++ b/vendor/github.com/containers/buildah/run.go @@ -167,18 +167,22 @@ type RunOptions struct { // RunMountArtifacts are the artifacts created when using a run mount. type runMountArtifacts struct { - // RunMountTargets are the run mount targets inside the container + // RunMountTargets are the run mount targets inside the container which should be removed RunMountTargets []string + // RunOverlayDirs are overlay directories which will need to be cleaned up using overlay.RemoveTemp() + RunOverlayDirs []string // TmpFiles are artifacts that need to be removed outside the container TmpFiles []string - // Any external images which were mounted inside container + // Any images which were mounted, which should be unmounted MountedImages []string - // Agents are the ssh agents started + // Agents are the ssh agents started, which should have their Shutdown() methods called Agents []*sshagent.AgentServer // SSHAuthSock is the path to the ssh auth sock inside the container SSHAuthSock string - // TargetLocks to be unlocked if there are any. + // Lock files, which should have their Unlock() methods called TargetLocks []*lockfile.LockFile + // Intermediate mount points, which should be Unmount()ed and Removed()d + IntermediateMounts []string } // RunMountInfo are the available run mounts for this run diff --git a/vendor/github.com/containers/buildah/run_common.go b/vendor/github.com/containers/buildah/run_common.go index bcfd70e1a7..3f3767496d 100644 --- a/vendor/github.com/containers/buildah/run_common.go +++ b/vendor/github.com/containers/buildah/run_common.go @@ -27,7 +27,6 @@ import ( "github.com/containers/buildah/define" "github.com/containers/buildah/internal" internalParse "github.com/containers/buildah/internal/parse" - internalUtil "github.com/containers/buildah/internal/util" "github.com/containers/buildah/pkg/overlay" "github.com/containers/buildah/pkg/sshagent" "github.com/containers/buildah/util" @@ -42,9 +41,9 @@ import ( "github.com/containers/storage/pkg/idtools" "github.com/containers/storage/pkg/ioutils" "github.com/containers/storage/pkg/lockfile" + "github.com/containers/storage/pkg/mount" "github.com/containers/storage/pkg/reexec" "github.com/containers/storage/pkg/unshare" - storageTypes "github.com/containers/storage/types" "github.com/opencontainers/go-digest" "github.com/opencontainers/runtime-spec/specs-go" spec "github.com/opencontainers/runtime-spec/specs-go" @@ -1269,8 +1268,10 @@ func init() { reexec.Register(runUsingRuntimeCommand, runUsingRuntimeMain) } -// If this succeeds, the caller must call cleanupMounts(). -func (b *Builder) setupMounts(mountPoint string, spec *specs.Spec, bundlePath string, optionMounts []specs.Mount, bindFiles map[string]string, builtinVolumes, volumeMounts []string, runFileMounts []string, runMountInfo runMountInfo) (*runMountArtifacts, error) { +// If this succeeds, after the command which uses the spec finishes running, +// the caller must call b.cleanupRunMounts() on the returned runMountArtifacts +// structure. +func (b *Builder) setupMounts(mountPoint string, spec *specs.Spec, bundlePath string, optionMounts []specs.Mount, bindFiles map[string]string, builtinVolumes []string, volumeMounts []string, runFileMounts []string, runMountInfo runMountInfo) (*runMountArtifacts, error) { // Start building a new list of mounts. var mounts []specs.Mount haveMount := func(destination string) bool { @@ -1328,14 +1329,16 @@ func (b *Builder) setupMounts(mountPoint string, spec *specs.Spec, bundlePath st processGID: int(processGID), } // Get the list of mounts that are just for this Run() call. - runMounts, mountArtifacts, err := b.runSetupRunMounts(runFileMounts, runMountInfo, idMaps) + runMounts, mountArtifacts, err := b.runSetupRunMounts(bundlePath, runFileMounts, runMountInfo, idMaps) if err != nil { return nil, err } succeeded := false defer func() { if !succeeded { - internalParse.UnlockLockArray(mountArtifacts.TargetLocks) + if err := b.cleanupRunMounts(mountPoint, mountArtifacts); err != nil { + b.Logger.Debugf("cleaning up run mounts: %v", err) + } } }() // Add temporary copies of the contents of volume locations at the @@ -1464,27 +1467,59 @@ func cleanableDestinationListFromMounts(mounts []spec.Mount) []string { return mountDest } -// runSetupRunMounts sets up mounts that exist only in this RUN, not in subsequent runs -// -// If this function succeeds, the caller must unlock runMountArtifacts.TargetLocks (when??) -func (b *Builder) runSetupRunMounts(mounts []string, sources runMountInfo, idMaps IDMaps) ([]spec.Mount, *runMountArtifacts, error) { +// If this function succeeds, the caller must free the returned +// runMountArtifacts by calling b.cleanupRunMounts() after the command being +// executed with those mounts has finished. +func (b *Builder) runSetupRunMounts(bundlePath string, mounts []string, sources runMountInfo, idMaps IDMaps) ([]spec.Mount, *runMountArtifacts, error) { // If `type` is not set default to TypeBind mountType := define.TypeBind - mountTargets := make([]string, 0, 10) + mountTargets := make([]string, 0, len(mounts)) tmpFiles := make([]string, 0, len(mounts)) - mountImages := make([]string, 0, 10) + mountImages := make([]string, 0, len(mounts)) + intermediateMounts := make([]string, 0, len(mounts)) finalMounts := make([]specs.Mount, 0, len(mounts)) agents := make([]*sshagent.AgentServer, 0, len(mounts)) - sshCount := 0 defaultSSHSock := "" targetLocks := []*lockfile.LockFile{} + var overlayDirs []string succeeded := false defer func() { if !succeeded { + for _, agent := range agents { + servePath := agent.ServePath() + if err := agent.Shutdown(); err != nil { + b.Logger.Errorf("shutting down SSH agent at %q: %v", servePath, err) + } + } + for _, overlayDir := range overlayDirs { + if err := overlay.RemoveTemp(overlayDir); err != nil { + b.Logger.Error(err.Error()) + } + } + for _, intermediateMount := range intermediateMounts { + if err := mount.Unmount(intermediateMount); err != nil { + b.Logger.Errorf("unmounting %q: %v", intermediateMount, err) + } + if err := os.Remove(intermediateMount); err != nil { + b.Logger.Errorf("removing should-be-empty directory %q: %v", intermediateMount, err) + } + } + for _, mountImage := range mountImages { + if _, err := b.store.UnmountImage(mountImage, false); err != nil { + b.Logger.Error(err.Error()) + } + } + for _, tmpFile := range tmpFiles { + if err := os.Remove(tmpFile); err != nil && !errors.Is(err, os.ErrNotExist) { + b.Logger.Error(err.Error()) + } + } internalParse.UnlockLockArray(targetLocks) } }() for _, mount := range mounts { + var err error + var bundleMountsDir string tokens := strings.Split(mount, ",") for _, field := range tokens { if strings.HasPrefix(field, "type=") { @@ -1509,31 +1544,37 @@ func (b *Builder) runSetupRunMounts(mounts []string, sources runMountInfo, idMap } } case "ssh": - mount, agent, err := b.getSSHMount(tokens, sshCount, sources.SSHSources, idMaps) + mount, agent, err := b.getSSHMount(tokens, len(agents), sources.SSHSources, idMaps) if err != nil { return nil, nil, err } if mount != nil { finalMounts = append(finalMounts, *mount) mountTargets = append(mountTargets, mount.Destination) - agents = append(agents, agent) - if sshCount == 0 { + if len(agents) == 0 { defaultSSHSock = mount.Destination } - // Count is needed as the default destination of the ssh sock inside the container is /run/buildkit/ssh_agent.{i} - sshCount++ + agents = append(agents, agent) } case define.TypeBind: - mount, image, err := b.getBindMount(tokens, sources.SystemContext, sources.ContextDir, sources.StageMountPoints, idMaps, sources.WorkDir) + if bundleMountsDir, err = os.MkdirTemp(bundlePath, "mounts"); err != nil { + return nil, nil, err + } + mount, image, intermediateMount, overlayDir, err := b.getBindMount(tokens, sources.SystemContext, sources.ContextDir, sources.StageMountPoints, idMaps, sources.WorkDir, bundleMountsDir) if err != nil { return nil, nil, err } - finalMounts = append(finalMounts, *mount) - mountTargets = append(mountTargets, mount.Destination) - // only perform cleanup if image was mounted ignore everything else if image != "" { mountImages = append(mountImages, image) } + if overlayDir != "" { + overlayDirs = append(overlayDirs, overlayDir) + } + if intermediateMount != "" { + intermediateMounts = append(intermediateMounts, intermediateMount) + } + finalMounts = append(finalMounts, *mount) + mountTargets = append(mountTargets, mount.Destination) case "tmpfs": mount, err := b.getTmpfsMount(tokens, idMaps) if err != nil { @@ -1542,46 +1583,56 @@ func (b *Builder) runSetupRunMounts(mounts []string, sources runMountInfo, idMap finalMounts = append(finalMounts, *mount) mountTargets = append(mountTargets, mount.Destination) case "cache": - mount, tl, err := b.getCacheMount(tokens, sources.StageMountPoints, idMaps, sources.WorkDir) + if bundleMountsDir == "" { + if bundleMountsDir, err = os.MkdirTemp(bundlePath, "mounts"); err != nil { + return nil, nil, err + } + } + mount, intermediateMount, tl, err := b.getCacheMount(tokens, sources.StageMountPoints, idMaps, sources.WorkDir, bundleMountsDir) if err != nil { return nil, nil, err } - finalMounts = append(finalMounts, *mount) - mountTargets = append(mountTargets, mount.Destination) + if intermediateMount != "" { + intermediateMounts = append(intermediateMounts, intermediateMount) + } if tl != nil { targetLocks = append(targetLocks, tl) } + finalMounts = append(finalMounts, *mount) + mountTargets = append(mountTargets, mount.Destination) default: return nil, nil, fmt.Errorf("invalid mount type %q", mountType) } } succeeded = true artifacts := &runMountArtifacts{ - RunMountTargets: mountTargets, - TmpFiles: tmpFiles, - Agents: agents, - MountedImages: mountImages, - SSHAuthSock: defaultSSHSock, - TargetLocks: targetLocks, + RunMountTargets: mountTargets, + RunOverlayDirs: overlayDirs, + TmpFiles: tmpFiles, + Agents: agents, + MountedImages: mountImages, + SSHAuthSock: defaultSSHSock, + TargetLocks: targetLocks, + IntermediateMounts: intermediateMounts, } return finalMounts, artifacts, nil } -func (b *Builder) getBindMount(tokens []string, context *imageTypes.SystemContext, contextDir string, stageMountPoints map[string]internal.StageMountDetails, idMaps IDMaps, workDir string) (*spec.Mount, string, error) { +func (b *Builder) getBindMount(tokens []string, sys *imageTypes.SystemContext, contextDir string, stageMountPoints map[string]internal.StageMountDetails, idMaps IDMaps, workDir, tmpDir string) (*spec.Mount, string, string, string, error) { if contextDir == "" { - return nil, "", errors.New("Context Directory for current run invocation is not configured") + return nil, "", "", "", errors.New("context directory for current run invocation is not configured") } var optionMounts []specs.Mount - mount, image, err := internalParse.GetBindMount(context, tokens, contextDir, b.store, b.MountLabel, stageMountPoints, workDir) + mount, image, intermediateMount, overlayDir, err := internalParse.GetBindMount(sys, tokens, contextDir, b.store, b.MountLabel, stageMountPoints, workDir, tmpDir) if err != nil { - return nil, image, err + return nil, "", "", "", err } optionMounts = append(optionMounts, mount) volumes, err := b.runSetupVolumeMounts(b.MountLabel, nil, optionMounts, idMaps) if err != nil { - return nil, image, err + return nil, "", "", "", err } - return &volumes[0], image, nil + return &volumes[0], image, intermediateMount, overlayDir, nil } func (b *Builder) getTmpfsMount(tokens []string, idMaps IDMaps) (*spec.Mount, error) { @@ -1850,50 +1901,51 @@ func (b *Builder) cleanupTempVolumes() { } // cleanupRunMounts cleans up run mounts so they only appear in this run. -func (b *Builder) cleanupRunMounts(context *imageTypes.SystemContext, mountpoint string, artifacts *runMountArtifacts) error { +func (b *Builder) cleanupRunMounts(mountpoint string, artifacts *runMountArtifacts) error { for _, agent := range artifacts.Agents { - err := agent.Shutdown() - if err != nil { - return err + servePath := agent.ServePath() + if err := agent.Shutdown(); err != nil { + return fmt.Errorf("shutting down SSH agent at %q: %v", servePath, err) } } - //cleanup any mounted images for this run - for _, image := range artifacts.MountedImages { - if image != "" { - // if flow hits here some image was mounted for this run - i, err := internalUtil.LookupImage(context, b.store, image) - if err == nil { - // silently try to unmount and do nothing - // if image is being used by something else - _ = i.Unmount(false) - } - if errors.Is(err, storageTypes.ErrImageUnknown) { - // Ignore only if ErrImageUnknown - // Reason: Image is already unmounted do nothing - continue - } + // cleanup any overlays we mounted + for _, overlayDirectory := range artifacts.RunOverlayDirs { + if err := overlay.RemoveTemp(overlayDirectory); err != nil { return err } } - + // unmount anything that needs unmounting + for _, intermediateMount := range artifacts.IntermediateMounts { + if err := mount.Unmount(intermediateMount); err != nil && !errors.Is(err, os.ErrNotExist) { + return fmt.Errorf("unmounting %q: %w", intermediateMount, err) + } + if err := os.Remove(intermediateMount); err != nil && !errors.Is(err, os.ErrNotExist) { + return fmt.Errorf("removing should-be-empty directory %q: %w", intermediateMount, err) + } + } + // unmount any images we mounted for this run + for _, image := range artifacts.MountedImages { + if _, err := b.store.UnmountImage(image, false); err != nil { + logrus.Debugf("umounting image %q: %v", image, err) + } + } + // remove mount targets that were created for this run opts := copier.RemoveOptions{ All: true, } for _, path := range artifacts.RunMountTargets { - err := copier.Remove(mountpoint, path, opts) - if err != nil { - return err + if err := copier.Remove(mountpoint, path, opts); err != nil { + return fmt.Errorf("removing mount target %q %q: %w", mountpoint, path, err) } } var prevErr error for _, path := range artifacts.TmpFiles { - err := os.Remove(path) - if !errors.Is(err, os.ErrNotExist) { + if err := os.Remove(path); err != nil && !errors.Is(err, os.ErrNotExist) { if prevErr != nil { logrus.Error(prevErr) } - prevErr = err + prevErr = fmt.Errorf("removing temporary file: %w", err) } } // unlock if any locked files from this RUN statement diff --git a/vendor/github.com/containers/buildah/run_freebsd.go b/vendor/github.com/containers/buildah/run_freebsd.go index ba58982ce7..ccd01ab24e 100644 --- a/vendor/github.com/containers/buildah/run_freebsd.go +++ b/vendor/github.com/containers/buildah/run_freebsd.go @@ -231,7 +231,7 @@ func (b *Builder) Run(command []string, options RunOptions) error { } defer func() { - if err := b.cleanupRunMounts(options.SystemContext, mountPoint, runArtifacts); err != nil { + if err := b.cleanupRunMounts(mountPoint, runArtifacts); err != nil { options.Logger.Errorf("unable to cleanup run mounts %v", err) } }() @@ -305,8 +305,8 @@ func setupSpecialMountSpecChanges(spec *spec.Spec, shmSize string) ([]specs.Moun } // If this function succeeds and returns a non-nil *lockfile.LockFile, the caller must unlock it (when??). -func (b *Builder) getCacheMount(tokens []string, stageMountPoints map[string]internal.StageMountDetails, idMaps IDMaps, workDir string) (*spec.Mount, *lockfile.LockFile, error) { - return nil, nil, errors.New("cache mounts not supported on freebsd") +func (b *Builder) getCacheMount(tokens []string, stageMountPoints map[string]internal.StageMountDetails, idMaps IDMaps, workDir, tmpDir string) (*spec.Mount, string, *lockfile.LockFile, error) { + return nil, "", nil, errors.New("cache mounts not supported on freebsd") } func (b *Builder) runSetupVolumeMounts(mountLabel string, volumeMounts []string, optionMounts []specs.Mount, idMaps IDMaps) (mounts []specs.Mount, Err error) { diff --git a/vendor/github.com/containers/buildah/run_linux.go b/vendor/github.com/containers/buildah/run_linux.go index 714cc2eb26..f1e7d75059 100644 --- a/vendor/github.com/containers/buildah/run_linux.go +++ b/vendor/github.com/containers/buildah/run_linux.go @@ -34,6 +34,7 @@ import ( "github.com/containers/storage/pkg/idtools" "github.com/containers/storage/pkg/ioutils" "github.com/containers/storage/pkg/lockfile" + "github.com/containers/storage/pkg/mount" "github.com/containers/storage/pkg/stringid" "github.com/containers/storage/pkg/unshare" "github.com/docker/go-units" @@ -347,7 +348,7 @@ rootless=%d } defer func() { - if err := b.cleanupRunMounts(options.SystemContext, mountPoint, runArtifacts); err != nil { + if err := b.cleanupRunMounts(mountPoint, runArtifacts); err != nil { options.Logger.Errorf("unable to cleanup run mounts %v", err) } }() @@ -910,12 +911,18 @@ func (b *Builder) runSetupVolumeMounts(mountLabel string, volumeMounts []string, return specs.Mount{}, fmt.Errorf("failed to create TempDir in the %s directory: %w", containerDir, err) } + graphOptions := b.store.GraphOptions() + graphOptsCopy := make([]string, len(graphOptions)) + copy(graphOptsCopy, graphOptions) overlayOpts := overlay.Options{ RootUID: idMaps.rootUID, RootGID: idMaps.rootGID, UpperDirOptionFragment: upperDir, WorkDirOptionFragment: workDir, - GraphOpts: b.store.GraphOptions(), + // Backport note: Cannot use `GraphOpts: slices.Clone(b.store.GraphOptions()),` + // here because "golang.org/x/exp/slices" requires golang 1.18+ which is not + // compatible with the targets of this release branch. + GraphOpts: graphOptsCopy, } overlayMount, err := overlay.MountWithOptions(contentDir, host, container, &overlayOpts) @@ -924,7 +931,7 @@ func (b *Builder) runSetupVolumeMounts(mountLabel string, volumeMounts []string, } // If chown true, add correct ownership to the overlay temp directories. - if foundU { + if err == nil && foundU { if err := chown.ChangeHostPathOwnership(contentDir, true, idMaps.processUID, idMaps.processGID); err != nil { return specs.Mount{}, err } @@ -1202,26 +1209,41 @@ func checkIdsGreaterThan5(ids []spec.LinuxIDMapping) bool { return false } -// If this function succeeds and returns a non-nil *lockfile.LockFile, the caller must unlock it (when??). -func (b *Builder) getCacheMount(tokens []string, stageMountPoints map[string]internal.StageMountDetails, idMaps IDMaps, workDir string) (*spec.Mount, *lockfile.LockFile, error) { +// Returns a Mount to add to the runtime spec's list of mounts, an optional +// path of a mounted filesystem, unmounted, and an optional lock, or an error. +// +// The caller is expected to, after the command which uses the mount exits, +// unmount the mounted filesystem (if we provided the path to its mountpoint) +// and remove its mountpoint, , and release the lock (if we took one). +func (b *Builder) getCacheMount(tokens []string, stageMountPoints map[string]internal.StageMountDetails, idMaps IDMaps, workDir, tmpDir string) (*spec.Mount, string, *lockfile.LockFile, error) { var optionMounts []specs.Mount - mount, targetLock, err := internalParse.GetCacheMount(tokens, b.store, b.MountLabel, stageMountPoints, workDir) + optionMount, intermediateMount, targetLock, err := internalParse.GetCacheMount(tokens, stageMountPoints, workDir, tmpDir) if err != nil { - return nil, nil, err + return nil, "", nil, err } succeeded := false defer func() { - if !succeeded && targetLock != nil { - targetLock.Unlock() + if !succeeded { + if intermediateMount != "" { + if err := mount.Unmount(intermediateMount); err != nil { + b.Logger.Debugf("ummounting %q: %v", intermediateMount, err) + } + if err := os.Remove(intermediateMount); err != nil { + b.Logger.Debugf("removing should-be-empty directory %q: %v", intermediateMount, err) + } + } + if targetLock != nil { + targetLock.Unlock() + } } }() - optionMounts = append(optionMounts, mount) + optionMounts = append(optionMounts, optionMount) volumes, err := b.runSetupVolumeMounts(b.MountLabel, nil, optionMounts, idMaps) if err != nil { - return nil, nil, err + return nil, "", nil, err } succeeded = true - return &volumes[0], targetLock, nil + return &volumes[0], intermediateMount, targetLock, nil } // setPdeathsig sets a parent-death signal for the process diff --git a/vendor/modules.txt b/vendor/modules.txt index ff45a64c3f..506c10305b 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -106,7 +106,7 @@ github.com/containernetworking/cni/pkg/version # github.com/containernetworking/plugins v1.2.0 ## explicit; go 1.17 github.com/containernetworking/plugins/pkg/ns -# github.com/containers/buildah v1.29.3 +# github.com/containers/buildah v1.29.5 ## explicit; go 1.17 github.com/containers/buildah github.com/containers/buildah/bind @@ -116,8 +116,10 @@ github.com/containers/buildah/define github.com/containers/buildah/docker github.com/containers/buildah/imagebuildah github.com/containers/buildah/internal +github.com/containers/buildah/internal/open github.com/containers/buildah/internal/parse github.com/containers/buildah/internal/util +github.com/containers/buildah/internal/volumes github.com/containers/buildah/pkg/blobcache github.com/containers/buildah/pkg/chrootuser github.com/containers/buildah/pkg/cli