visor/pkg/sentry/fsimpl/user/path.go

// Copyright 2020 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package user

import (
	"fmt"
	"path"
	"strings"

	"gvisor.dev/gvisor/pkg/abi/linux"
	"gvisor.dev/gvisor/pkg/context"
	"gvisor.dev/gvisor/pkg/errors/linuxerr"
	"gvisor.dev/gvisor/pkg/fspath"
	"gvisor.dev/gvisor/pkg/log"
	"gvisor.dev/gvisor/pkg/sentry/kernel"
	"gvisor.dev/gvisor/pkg/sentry/kernel/auth"
	"gvisor.dev/gvisor/pkg/sentry/vfs"
)

// ExecutableResolveError represents a failure to resolve the executable
// in ResolveExecutablePath.
type ExecutableResolveError struct {
	msg string
}

// Error implements the error interface.
func (e ExecutableResolveError) Error() string {
	return e.msg
}

// ResolveExecutablePath resolves the given executable name given the working
// dir and environment.
// Returns *ExecutableResolveError when the executable cannot be resolved.
func ResolveExecutablePath(ctx context.Context, args *kernel.CreateProcessArgs) (string, error) {
	name := args.Filename
	if len(name) == 0 {
		if len(args.Argv) == 0 {
			return "", fmt.Errorf("no filename or command provided")
		}
		name = args.Argv[0]
	}

	// Absolute paths can be used directly.
	if path.IsAbs(name) {
		return name, nil
	}

	// Paths with '/' in them should be joined to the working directory, or
	// to the root if working directory is not set.
	if strings.IndexByte(name, '/') > 0 {
		wd := args.WorkingDirectory
		if wd == "" {
			wd = "/"
		}
		if !path.IsAbs(wd) {
			return "", fmt.Errorf("working directory %q must be absolute", wd)
		}
		return path.Join(wd, name), nil
	}

	// Otherwise, We must lookup the name in the paths.
	paths := getPath(args.Envv)
	f, err := resolve(ctx, args.Credentials, args.MountNamespace, paths, name)
	if err != nil {
		return "", ExecutableResolveError{fmt.Sprintf("error finding executable %q in PATH %v: %v", name, paths, err)}
	}
	return f, nil
}

// resolve searches for an executable in the given PATH directories.
// Error handling follows glibc execvpe() (posix/execvpe.c).
func resolve(ctx context.Context, creds *auth.Credentials, mns *vfs.MountNamespace, paths []string, name string) (string, error) {
	root := mns.Root(ctx)
	defer root.DecRef(ctx)
	gotEACCES := false
	lastErr := error(linuxerr.ENOENT)
	for _, p := range paths {
		if !path.IsAbs(p) {
			// Relative paths aren't safe, no one should be using them.
			log.Warningf("Skipping relative path %q in $PATH", p)
			continue
		}

		binPath := path.Join(p, name)
		pop := &vfs.PathOperation{
			Root:               root,
			Start:              root,
			Path:               fspath.Parse(binPath),
			FollowFinalSymlink: true,
		}
		opts := &vfs.OpenOptions{
			FileExec: true,
			Flags:    linux.O_RDONLY,
		}
		dentry, err := root.Mount().Filesystem().VirtualFilesystem().OpenAt(ctx, creds, pop, opts)
		if err == nil {
			dentry.DecRef(ctx)
			return binPath, nil
		}

		// Preserve the last error, matching glibc's errno semantics.
		lastErr = err
		switch {
		case linuxerr.Equals(linuxerr.EACCES, err):
			gotEACCES = true
		case linuxerr.Equals(linuxerr.ENOENT, err),
			linuxerr.Equals(linuxerr.ESTALE, err),
			linuxerr.Equals(linuxerr.ENOTDIR, err),
			linuxerr.Equals(linuxerr.ENODEV, err),
			linuxerr.Equals(linuxerr.ETIMEDOUT, err):
			// Skip to next PATH entry.
		default:
			return "", err
		}
	}

	if gotEACCES {
		return "", linuxerr.EACCES
	}
	return "", lastErr
}

// getPath returns the PATH as a slice of strings given the environment
// variables.
func getPath(env []string) []string {
	const prefix = "PATH="
	for _, e := range env {
		if strings.HasPrefix(e, prefix) {
			return strings.Split(strings.TrimPrefix(e, prefix), ":")
		}
	}
	return nil
}