package trust import ( "context" "encoding/json" "errors" "fmt" "io" "net" "net/http" "net/url" "os" "path" "path/filepath" "strconv" "time" "github.com/distribution/reference" "github.com/docker/cli/cli/config" "github.com/docker/cli/internal/registry" "github.com/docker/distribution/registry/client/auth" "github.com/docker/distribution/registry/client/auth/challenge" "github.com/docker/distribution/registry/client/transport" "github.com/docker/go-connections/tlsconfig" registrytypes "github.com/moby/moby/api/types/registry" "github.com/opencontainers/go-digest" "github.com/sirupsen/logrus" "github.com/theupdateframework/notary" "github.com/theupdateframework/notary/client" "github.com/theupdateframework/notary/passphrase" "github.com/theupdateframework/notary/storage" "github.com/theupdateframework/notary/trustmanager" "github.com/theupdateframework/notary/trustpinning" "github.com/theupdateframework/notary/tuf/data" "github.com/theupdateframework/notary/tuf/signed" ) var ( // ReleasesRole is the role named "releases" ReleasesRole = data.RoleName(path.Join(data.CanonicalTargetsRole.String(), "releases")) // ActionsPullOnly defines the actions for read-only interactions with a Notary Repository ActionsPullOnly = []string{"pull"} // ActionsPushAndPull defines the actions for read-write interactions with a Notary Repository ActionsPushAndPull = []string{"pull", "push"} ) // Enabled returns whether content-trust is enabled through the DOCKER_CONTENT_TRUST env-var. // // IMPORTANT: this function is for internal use, and may be removed at any moment. func Enabled() bool { var enabled bool if e := os.Getenv("DOCKER_CONTENT_TRUST"); e != "" { if t, err := strconv.ParseBool(e); t || err != nil { // treat any other value as true enabled = true } } return enabled } // NotaryServer is the endpoint serving the Notary trust server const NotaryServer = "https://notary.docker.io" // GetTrustDirectory returns the base trust directory name func GetTrustDirectory() string { return filepath.Join(config.Dir(), "trust") } // certificateDirectory returns the directory containing // TLS certificates for the given server. An error is // returned if there was an error parsing the server string. func certificateDirectory(server string) (string, error) { u, err := url.Parse(server) if err != nil { return "", err } return filepath.Join(config.Dir(), "tls", u.Host), nil } // Server returns the base URL for the trust server. func Server(indexName string) (string, error) { if s := os.Getenv("DOCKER_CONTENT_TRUST_SERVER"); s != "" { urlObj, err := url.Parse(s) if err != nil || urlObj.Scheme != "https" { return "", fmt.Errorf("valid https URL required for trust server, got %s", s) } return s, nil } if indexName == "docker.io" || indexName == "index.docker.io" { return NotaryServer, nil } return "https://" + indexName, nil } type simpleCredentialStore struct { auth registrytypes.AuthConfig } func (scs simpleCredentialStore) Basic(*url.URL) (string, string) { return scs.auth.Username, scs.auth.Password } func (scs simpleCredentialStore) RefreshToken(*url.URL, string) string { return scs.auth.IdentityToken } func (simpleCredentialStore) SetRefreshToken(*url.URL, string, string) {} const dctDeprecation = `WARNING: Docker is retiring DCT for Docker Official Images (DOI). For details, refer to https://docs.docker.com/go/dct-deprecation/ ` // GetNotaryRepository returns a NotaryRepository which stores all the // information needed to operate on a notary repository. // It creates an HTTP transport providing authentication support. func GetNotaryRepository(in io.Reader, out io.Writer, userAgent string, repoInfo *RepositoryInfo, authConfig *registrytypes.AuthConfig, actions ...string) (client.Repository, error) { server, err := Server(repoInfo.Index.Name) if err != nil { return nil, err } if server == NotaryServer { _, _ = fmt.Fprint(os.Stderr, dctDeprecation) } cfg := tlsconfig.ClientDefault() cfg.InsecureSkipVerify = !repoInfo.Index.Secure // Get certificate base directory certDir, err := certificateDirectory(server) if err != nil { return nil, err } logrus.Debugf("reading certificate directory: %s", certDir) if err := registry.ReadCertsDirectory(cfg, certDir); err != nil { return nil, err } base := &http.Transport{ Proxy: http.ProxyFromEnvironment, Dial: (&net.Dialer{ Timeout: 30 * time.Second, KeepAlive: 30 * time.Second, }).Dial, TLSHandshakeTimeout: 10 * time.Second, TLSClientConfig: cfg, DisableKeepAlives: true, } // Skip configuration headers since request is not going to Docker daemon modifiers := registry.Headers(userAgent, http.Header{}) authTransport := transport.NewTransport(base, modifiers...) pingClient := &http.Client{ Transport: authTransport, Timeout: 5 * time.Second, } endpointStr := server + "/v2/" req, err := http.NewRequest(http.MethodGet, endpointStr, nil) if err != nil { return nil, err } challengeManager := challenge.NewSimpleManager() resp, err := pingClient.Do(req) if err != nil { // Ignore error on ping to operate in offline mode logrus.Debugf("Error pinging notary server %q: %s", endpointStr, err) } else { defer resp.Body.Close() // Add response to the challenge manager to parse out // authentication header and register authentication method if err := challengeManager.AddResponse(resp); err != nil { return nil, err } } tokenHandler := auth.NewTokenHandlerWithOptions(auth.TokenHandlerOptions{ Transport: authTransport, Credentials: simpleCredentialStore{auth: *authConfig}, Scopes: []auth.Scope{auth.RepositoryScope{ Repository: repoInfo.Name.Name(), Actions: actions, }}, ClientID: registry.AuthClientID, }) basicHandler := auth.NewBasicHandler(simpleCredentialStore{auth: *authConfig}) modifiers = append(modifiers, auth.NewAuthorizer(challengeManager, tokenHandler, basicHandler)) return client.NewFileCachedRepository( GetTrustDirectory(), data.GUN(repoInfo.Name.Name()), server, transport.NewTransport(base, modifiers...), GetPassphraseRetriever(in, out), trustpinning.TrustPinConfig{}) } // GetPassphraseRetriever returns a passphrase retriever that utilizes Content Trust env vars func GetPassphraseRetriever(in io.Reader, out io.Writer) notary.PassRetriever { aliasMap := map[string]string{ "root": "root", "snapshot": "repository", "targets": "repository", "default": "repository", } baseRetriever := passphrase.PromptRetrieverWithInOut(in, out, aliasMap) env := map[string]string{ "root": os.Getenv("DOCKER_CONTENT_TRUST_ROOT_PASSPHRASE"), "snapshot": os.Getenv("DOCKER_CONTENT_TRUST_REPOSITORY_PASSPHRASE"), "targets": os.Getenv("DOCKER_CONTENT_TRUST_REPOSITORY_PASSPHRASE"), "default": os.Getenv("DOCKER_CONTENT_TRUST_REPOSITORY_PASSPHRASE"), } return func(keyName string, alias string, createNew bool, numAttempts int) (string, bool, error) { if v := env[alias]; v != "" { return v, numAttempts > 1, nil } // For non-root roles, we can also try the "default" alias if it is specified if v := env["default"]; v != "" && alias != data.CanonicalRootRole.String() { return v, numAttempts > 1, nil } return baseRetriever(keyName, alias, createNew, numAttempts) } } // NotaryError formats an error message received from the notary service func NotaryError(repoName string, err error) error { switch err.(type) { case *json.SyntaxError: logrus.Debugf("Notary syntax error: %s", err) return fmt.Errorf("error: no trust data available for remote repository %s. Try running notary server and setting DOCKER_CONTENT_TRUST_SERVER to its HTTPS address", repoName) case signed.ErrExpired: return fmt.Errorf("error: remote repository %s out-of-date: %v", repoName, err) case trustmanager.ErrKeyNotFound: return fmt.Errorf("error: signing keys for remote repository %s not found: %v", repoName, err) case storage.NetworkError: return fmt.Errorf("error: error contacting notary server: %v", err) case storage.ErrMetaNotFound: return fmt.Errorf("error: trust data missing for remote repository %s or remote repository not found: %v", repoName, err) case trustpinning.ErrRootRotationFail, trustpinning.ErrValidationFail, signed.ErrInvalidKeyType: return fmt.Errorf("warning: potential malicious behavior - trust data mismatch for remote repository %s: %v", repoName, err) case signed.ErrNoKeys: return fmt.Errorf("error: could not find signing keys for remote repository %s, or could not decrypt signing key: %v", repoName, err) case signed.ErrLowVersion: return fmt.Errorf("warning: potential malicious behavior - trust data version is lower than expected for remote repository %s: %v", repoName, err) case signed.ErrRoleThreshold: return fmt.Errorf("warning: potential malicious behavior - trust data has insufficient signatures for remote repository %s: %v", repoName, err) case client.ErrRepositoryNotExist: return fmt.Errorf("error: remote trust data does not exist for %s: %v", repoName, err) case signed.ErrInsufficientSignatures: return fmt.Errorf("error: could not produce valid signature for %s. If Yubikey was used, was touch input provided?: %v", repoName, err) default: return err } } // AddToAllSignableRoles attempts to add the image target to all the top level // delegation roles we can (based on whether we have the signing key and whether // the role's path allows us to). // // If there are no delegation roles, we add to the targets role. func AddToAllSignableRoles(repo client.Repository, target *client.Target) error { signableRoles, err := GetSignableRoles(repo, target) if err != nil { return err } return repo.AddTarget(target, signableRoles...) } // GetSignableRoles returns a list of roles for which we have valid signing // keys, given a notary repository and a target func GetSignableRoles(repo client.Repository, target *client.Target) ([]data.RoleName, error) { var signableRoles []data.RoleName // translate the full key names, which includes the GUN, into just the key IDs allCanonicalKeyIDs := make(map[string]struct{}) for fullKeyID := range repo.GetCryptoService().ListAllKeys() { allCanonicalKeyIDs[path.Base(fullKeyID)] = struct{}{} } allDelegationRoles, err := repo.GetDelegationRoles() if err != nil { return signableRoles, err } // if there are no delegation roles, then just try to sign it into the targets role if len(allDelegationRoles) == 0 { signableRoles = append(signableRoles, data.CanonicalTargetsRole) return signableRoles, nil } // there are delegation roles, find every delegation role we have a key for, // and attempt to sign in to all those roles. for _, delegationRole := range allDelegationRoles { // We do not support signing any delegation role that isn't a direct child of the targets role. // Also don't bother checking the keys if we can't add the target // to this role due to path restrictions if path.Dir(delegationRole.Name.String()) != data.CanonicalTargetsRole.String() || !delegationRole.CheckPaths(target.Name) { continue } for _, canonicalKeyID := range delegationRole.KeyIDs { if _, ok := allCanonicalKeyIDs[canonicalKeyID]; ok { signableRoles = append(signableRoles, delegationRole.Name) break } } } if len(signableRoles) == 0 { return signableRoles, errors.New("no valid signing keys for delegation roles") } return signableRoles, nil } // ImageRefAndAuth contains all reference information and the auth config for an image request type ImageRefAndAuth struct { original string authConfig *registrytypes.AuthConfig reference reference.Named repoInfo *RepositoryInfo tag string digest digest.Digest } // RepositoryInfo describes a repository type RepositoryInfo struct { Name reference.Named // Index points to registry information Index *registrytypes.IndexInfo } // GetImageReferencesAndAuth retrieves the necessary reference and auth information for an image name // as an ImageRefAndAuth struct func GetImageReferencesAndAuth(ctx context.Context, authResolver func(ctx context.Context, index *registrytypes.IndexInfo) registrytypes.AuthConfig, imgName string, ) (ImageRefAndAuth, error) { ref, err := reference.ParseNormalizedNamed(imgName) if err != nil { return ImageRefAndAuth{}, err } // Resolve the Repository name from fqn to RepositoryInfo, and create an // IndexInfo. Docker Content Trust uses the IndexInfo.Official field to // select the right domain for Docker Hub's Notary server; // https://github.com/docker/cli/blob/v28.4.0/cli/trust/trust.go#L65-L79 indexInfo := registry.NewIndexInfo(ref) authConfig := authResolver(ctx, indexInfo) return ImageRefAndAuth{ original: imgName, authConfig: &authConfig, reference: ref, repoInfo: &RepositoryInfo{ Name: reference.TrimNamed(ref), Index: indexInfo, }, tag: getTag(ref), digest: getDigest(ref), }, nil } func getTag(ref reference.Named) string { switch x := ref.(type) { case reference.Digested: return "" // TODO(thaJeztah): is it intentional to discard the tag when "Tagged+Digested"? case reference.Tagged: return x.Tag() default: return "" } } func getDigest(ref reference.Named) digest.Digest { switch x := ref.(type) { case reference.Digested: return x.Digest() default: return "" } } // AuthConfig returns the auth information (username, etc) for a given ImageRefAndAuth func (imgRefAuth *ImageRefAndAuth) AuthConfig() *registrytypes.AuthConfig { return imgRefAuth.authConfig } // Reference returns the Image reference for a given ImageRefAndAuth func (imgRefAuth *ImageRefAndAuth) Reference() reference.Named { return imgRefAuth.reference } // RepoInfo returns the repository information for a given ImageRefAndAuth func (imgRefAuth *ImageRefAndAuth) RepoInfo() *RepositoryInfo { return imgRefAuth.repoInfo } // Tag returns the Image tag for a given ImageRefAndAuth func (imgRefAuth *ImageRefAndAuth) Tag() string { return imgRefAuth.tag } // Digest returns the Image digest for a given ImageRefAndAuth func (imgRefAuth *ImageRefAndAuth) Digest() digest.Digest { return imgRefAuth.digest } // Name returns the image name used to initialize the ImageRefAndAuth func (imgRefAuth *ImageRefAndAuth) Name() string { return imgRefAuth.original }