keychain.go

Documentation: github.com/google/go-containerregistry/pkg/authn/github

     1  // Copyright 2022 Google LLC All Rights Reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //    http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package github provides a keychain for the GitHub Container Registry.
    16  package github
    17  
    18  import (
    19  	"net/url"
    20  	"os"
    21  
    22  	"github.com/google/go-containerregistry/pkg/authn"
    23  )
    24  
    25  const ghcrHostname = "ghcr.io"
    26  
    27  // Keychain exports an instance of the GitHub Keychain.
    28  //
    29  // This keychain matches on requests for ghcr.io and provides the value of the
    30  // environment variable $GITHUB_TOKEN, if it's set.
    31  var Keychain authn.Keychain = githubKeychain{}
    32  
    33  type githubKeychain struct{}
    34  
    35  func (githubKeychain) Resolve(r authn.Resource) (authn.Authenticator, error) {
    36  	serverURL, err := url.Parse("https://" + r.String())
    37  	if err != nil {
    38  		return authn.Anonymous, nil
    39  	}
    40  	if serverURL.Hostname() == ghcrHostname {
    41  		username := os.Getenv("GITHUB_ACTOR")
    42  		if username == "" {
    43  			username = "unset"
    44  		}
    45  		if tok := os.Getenv("GITHUB_TOKEN"); tok != "" {
    46  			return githubAuthenticator{username, tok}, nil
    47  		}
    48  	}
    49  	return authn.Anonymous, nil
    50  }
    51  
    52  type githubAuthenticator struct{ username, password string }
    53  
    54  func (g githubAuthenticator) Authorization() (*authn.AuthConfig, error) {
    55  	return &authn.AuthConfig{
    56  		Username: g.username,
    57  		Password: g.password,
    58  	}, nil
    59  }
    60
View as plain text