1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
|
package gcputil
import (
"context"
"crypto/x509"
"encoding/base64"
"encoding/json"
"encoding/pem"
"errors"
"fmt"
"io/ioutil"
"net/http"
"net/url"
"os"
"path/filepath"
"strings"
"github.com/hashicorp/go-cleanhttp"
"github.com/mitchellh/go-homedir"
"golang.org/x/oauth2"
"golang.org/x/oauth2/google"
"golang.org/x/oauth2/jwt"
"google.golang.org/api/googleapi"
)
const (
defaultHomeCredentialsFile = ".gcp/credentials"
// Default service endpoint for interaction with Google APIs
// https://cloud.google.com/apis/design/glossary#api_service_endpoint
defaultGoogleAPIsEndpoint = "https://www.googleapis.com"
// serviceAccountPublicKeyURLPathTemplate is a templated URL path for obtaining the
// public keys associated with a service account. See details at
// - https://cloud.google.com/iam/docs/creating-managing-service-account-keys
// - https://cloud.google.com/iam/docs/reference/credentials/rest/v1/projects.serviceAccounts/signJwt#response-body
serviceAccountPublicKeyURLPathTemplate = "/service_accounts/v1/metadata/x509/%s?alt=json"
// googleOAuthProviderX509CertURLPath is a URL path to Google's public OAuth keys.
// Using v1 returns the keys in X.509 certificate format.
googleOAuthProviderX509CertURLPath = "/oauth2/v1/certs"
)
// GcpCredentials represents a simplified version of the Google Cloud Platform credentials file format.
type GcpCredentials struct {
ClientEmail string `json:"client_email" structs:"client_email" mapstructure:"client_email"`
ClientId string `json:"client_id" structs:"client_id" mapstructure:"client_id"`
PrivateKeyId string `json:"private_key_id" structs:"private_key_id" mapstructure:"private_key_id"`
PrivateKey string `json:"private_key" structs:"private_key" mapstructure:"private_key"`
ProjectId string `json:"project_id" structs:"project_id" mapstructure:"project_id"`
}
// FindCredentials attempts to obtain GCP credentials in the
// following ways:
// * Parse JSON from provided credentialsJson
// * Parse JSON from the environment variables GOOGLE_CREDENTIALS or GOOGLE_CLOUD_KEYFILE_JSON
// * Parse JSON file ~/.gcp/credentials
// * Google Application Default Credentials (see https://developers.google.com/identity/protocols/application-default-credentials)
func FindCredentials(credsJson string, ctx context.Context, scopes ...string) (*GcpCredentials, oauth2.TokenSource, error) {
var creds *GcpCredentials
var err error
// 1. Parse JSON from provided credentialsJson
if credsJson == "" {
// 2. JSON from env var GOOGLE_CREDENTIALS
credsJson = os.Getenv("GOOGLE_CREDENTIALS")
}
if credsJson == "" {
// 3. JSON from env var GOOGLE_CLOUD_KEYFILE_JSON
credsJson = os.Getenv("GOOGLE_CLOUD_KEYFILE_JSON")
}
if credsJson == "" {
// 4. JSON from ~/.gcp/credentials
home, err := homedir.Dir()
if err != nil {
return nil, nil, errors.New("could not find home directory")
}
credBytes, err := ioutil.ReadFile(filepath.Join(home, defaultHomeCredentialsFile))
if err == nil {
credsJson = string(credBytes)
}
}
// Parse JSON into credentials.
if credsJson != "" {
creds, err = Credentials(credsJson)
if err == nil {
conf := jwt.Config{
Email: creds.ClientEmail,
PrivateKey: []byte(creds.PrivateKey),
Scopes: scopes,
TokenURL: "https://accounts.google.com/o/oauth2/token",
}
return creds, conf.TokenSource(ctx), nil
}
}
// 5. Use Application default credentials.
defaultCreds, err := google.FindDefaultCredentials(ctx, scopes...)
if err != nil {
return nil, nil, err
}
if defaultCreds.JSON != nil {
creds, err = Credentials(string(defaultCreds.JSON))
if err != nil {
return nil, nil, errors.New("could not read credentials from application default credential JSON")
}
}
return creds, defaultCreds.TokenSource, nil
}
// Credentials attempts to parse GcpCredentials from a JSON string.
func Credentials(credentialsJson string) (*GcpCredentials, error) {
credentials := &GcpCredentials{}
if err := json.Unmarshal([]byte(credentialsJson), &credentials); err != nil {
return nil, err
}
return credentials, nil
}
// GetHttpClient creates an HTTP client from the given Google credentials and scopes.
func GetHttpClient(credentials *GcpCredentials, clientScopes ...string) (*http.Client, error) {
conf := jwt.Config{
Email: credentials.ClientEmail,
PrivateKey: []byte(credentials.PrivateKey),
Scopes: clientScopes,
TokenURL: "https://accounts.google.com/o/oauth2/token",
}
ctx := context.WithValue(context.Background(), oauth2.HTTPClient, cleanhttp.DefaultClient())
client := conf.Client(ctx)
return client, nil
}
// PublicKey returns a public key from a Google PEM key file (type TYPE_X509_PEM_FILE).
func PublicKey(pemString string) (interface{}, error) {
// Attempt to base64 decode
pemBytes := []byte(pemString)
if b64decoded, err := base64.StdEncoding.DecodeString(pemString); err == nil {
pemBytes = b64decoded
}
block, _ := pem.Decode(pemBytes)
if block == nil {
return nil, errors.New("unable to find pem block in key")
}
cert, err := x509.ParseCertificate(block.Bytes)
if err != nil {
return nil, err
}
return cert.PublicKey, nil
}
// ServiceAccountPublicKey returns the public key with the given key ID for
// the given service account if it exists. If the key does not exist, an error
// is returned.
func ServiceAccountPublicKey(serviceAccount string, keyId string) (interface{}, error) {
return ServiceAccountPublicKeyWithEndpoint(context.Background(), serviceAccount, keyId, "")
}
// ServiceAccountPublicKeyWithEndpoint returns the public key with the given key
// ID for the given service account if it exists. If endpoint is provided, it will
// be used as the service endpoint for the request. If endpoint is not provided,
// a default of "https://www.googleapis.com" will be used. If the key does not exist,
// an error is returned.
func ServiceAccountPublicKeyWithEndpoint(ctx context.Context, serviceAccount, keyID, endpoint string) (interface{}, error) {
if endpoint == "" {
endpoint = defaultGoogleAPIsEndpoint
}
keyURLPath := fmt.Sprintf(serviceAccountPublicKeyURLPathTemplate, url.PathEscape(serviceAccount))
keyURL := strings.TrimSuffix(endpoint, "/") + keyURLPath
req, err := http.NewRequestWithContext(ctx, http.MethodGet, keyURL, nil)
if err != nil {
return nil, err
}
resp, err := cleanhttp.DefaultClient().Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if err := googleapi.CheckResponse(resp); err != nil {
return nil, err
}
jwks := map[string]interface{}{}
if err := json.NewDecoder(resp.Body).Decode(&jwks); err != nil {
return nil, fmt.Errorf("unable to decode JSON response: %v", err)
}
kRaw, ok := jwks[keyID]
if !ok {
return nil, fmt.Errorf("service account %q key %q not found at GET %q", keyID, serviceAccount, keyURL)
}
kStr, ok := kRaw.(string)
if !ok {
return nil, fmt.Errorf("unexpected error - decoded JSON key value %v is not string", kRaw)
}
return PublicKey(kStr)
}
// OAuth2RSAPublicKey returns the public key with the given key ID from Google's
// public set of OAuth 2.0 keys. If the key does not exist, an error is returned.
func OAuth2RSAPublicKey(ctx context.Context, keyID string) (interface{}, error) {
return OAuth2RSAPublicKeyWithEndpoint(ctx, keyID, "")
}
// OAuth2RSAPublicKeyWithEndpoint returns the public key with the given key ID from
// Google's public set of OAuth 2.0 keys. If endpoint is provided, it will be used as
// the service endpoint for the request. If endpoint is not provided, a default of
// "https://www.googleapis.com" will be used. If the key does not exist, an error is
// returned.
func OAuth2RSAPublicKeyWithEndpoint(ctx context.Context, keyID, endpoint string) (interface{}, error) {
if endpoint == "" {
endpoint = defaultGoogleAPIsEndpoint
}
certUrl := strings.TrimSuffix(endpoint, "/") + googleOAuthProviderX509CertURLPath
req, err := http.NewRequestWithContext(ctx, http.MethodGet, certUrl, nil)
if err != nil {
return nil, err
}
resp, err := cleanhttp.DefaultClient().Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if err := googleapi.CheckResponse(resp); err != nil {
return nil, err
}
jwks := map[string]interface{}{}
if err := json.NewDecoder(resp.Body).Decode(&jwks); err != nil {
return nil, fmt.Errorf("unable to decode JSON response: %v", err)
}
kRaw, ok := jwks[keyID]
if !ok {
return nil, fmt.Errorf("key %q not found (GET %q)", keyID, certUrl)
}
kStr, ok := kRaw.(string)
if !ok {
return nil, fmt.Errorf("unexpected error - decoded JSON key value %v is not string", kRaw)
}
return PublicKey(kStr)
}
|