VictoriaMetrics/vendor/google.golang.org/api/internal/creds.go

156 lines
4.5 KiB
Go
Raw Normal View History

// Copyright 2017 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package internal
import (
"context"
"encoding/json"
2021-06-24 14:33:31 +00:00
"errors"
"fmt"
"io/ioutil"
"golang.org/x/oauth2"
2020-09-16 22:43:19 +00:00
"google.golang.org/api/internal/impersonate"
"golang.org/x/oauth2/google"
)
// Creds returns credential information obtained from DialSettings, or if none, then
// it returns default credential information.
func Creds(ctx context.Context, ds *DialSettings) (*google.Credentials, error) {
2020-09-16 22:43:19 +00:00
creds, err := baseCreds(ctx, ds)
if err != nil {
return nil, err
}
if ds.ImpersonationConfig != nil {
return impersonateCredentials(ctx, creds, ds)
}
return creds, nil
}
func baseCreds(ctx context.Context, ds *DialSettings) (*google.Credentials, error) {
if ds.Credentials != nil {
return ds.Credentials, nil
}
if ds.CredentialsJSON != nil {
2020-12-03 18:16:30 +00:00
return credentialsFromJSON(ctx, ds.CredentialsJSON, ds)
}
if ds.CredentialsFile != "" {
data, err := ioutil.ReadFile(ds.CredentialsFile)
if err != nil {
return nil, fmt.Errorf("cannot read credentials file: %v", err)
}
2020-12-03 18:16:30 +00:00
return credentialsFromJSON(ctx, data, ds)
}
if ds.TokenSource != nil {
return &google.Credentials{TokenSource: ds.TokenSource}, nil
}
2020-12-03 18:16:30 +00:00
cred, err := google.FindDefaultCredentials(ctx, ds.GetScopes()...)
if err != nil {
return nil, err
}
if len(cred.JSON) > 0 {
2020-12-03 18:16:30 +00:00
return credentialsFromJSON(ctx, cred.JSON, ds)
}
// For GAE and GCE, the JSON is empty so return the default credentials directly.
return cred, nil
}
// JSON key file type.
const (
serviceAccountKey = "service_account"
)
2021-06-24 14:33:31 +00:00
// credentialsFromJSON returns a google.Credentials from the JSON data
//
2021-06-24 14:33:31 +00:00
// - A self-signed JWT flow will be executed if the following conditions are
// met:
// (1) At least one of the following is true:
// (a) No scope is provided
// (b) Scope for self-signed JWT flow is enabled
// (c) Audiences are explicitly provided by users
// (2) No service account impersontation
2021-02-01 17:39:00 +00:00
//
2021-06-24 14:33:31 +00:00
// - Otherwise, executes standard OAuth 2.0 flow
// More details: google.aip.dev/auth/4111
2020-12-03 18:16:30 +00:00
func credentialsFromJSON(ctx context.Context, data []byte, ds *DialSettings) (*google.Credentials, error) {
2021-06-24 14:33:31 +00:00
// By default, a standard OAuth 2.0 token source is created
2020-12-03 18:16:30 +00:00
cred, err := google.CredentialsFromJSON(ctx, data, ds.GetScopes()...)
if err != nil {
return nil, err
}
2021-02-01 17:39:00 +00:00
2021-06-24 14:33:31 +00:00
// Override the token source to use self-signed JWT if conditions are met
isJWTFlow, err := isSelfSignedJWTFlow(data, ds)
if err != nil {
2021-02-01 17:39:00 +00:00
return nil, err
}
2021-06-24 14:33:31 +00:00
if isJWTFlow {
ts, err := selfSignedJWTTokenSource(data, ds)
2021-02-01 17:39:00 +00:00
if err != nil {
return nil, err
}
2021-02-01 17:39:00 +00:00
cred.TokenSource = ts
}
2021-06-24 14:33:31 +00:00
return cred, err
}
2021-06-24 14:33:31 +00:00
func isSelfSignedJWTFlow(data []byte, ds *DialSettings) (bool, error) {
2021-07-07 13:05:04 +00:00
if (ds.EnableJwtWithScope || ds.HasCustomAudience()) &&
2021-06-24 14:33:31 +00:00
ds.ImpersonationConfig == nil {
// Check if JSON is a service account and if so create a self-signed JWT.
var f struct {
Type string `json:"type"`
// The rest JSON fields are omitted because they are not used.
}
2021-06-24 14:33:31 +00:00
if err := json.Unmarshal(data, &f); err != nil {
return false, err
}
return f.Type == serviceAccountKey, nil
}
return false, nil
}
func selfSignedJWTTokenSource(data []byte, ds *DialSettings) (oauth2.TokenSource, error) {
if len(ds.GetScopes()) > 0 && !ds.HasCustomAudience() {
// Scopes are preferred in self-signed JWT unless the scope is not available
// or a custom audience is used.
return google.JWTAccessTokenSourceWithScope(data, ds.GetScopes()...)
} else if ds.GetAudience() != "" {
// Fallback to audience if scope is not provided
return google.JWTAccessTokenSourceFromJSON(data, ds.GetAudience())
} else {
return nil, errors.New("neither scopes or audience are available for the self-signed JWT")
}
}
2020-02-10 21:28:15 +00:00
// QuotaProjectFromCreds returns the quota project from the JSON blob in the provided credentials.
//
// NOTE(cbro): consider promoting this to a field on google.Credentials.
func QuotaProjectFromCreds(cred *google.Credentials) string {
var v struct {
QuotaProject string `json:"quota_project_id"`
}
if err := json.Unmarshal(cred.JSON, &v); err != nil {
return ""
}
return v.QuotaProject
}
2020-09-16 22:43:19 +00:00
func impersonateCredentials(ctx context.Context, creds *google.Credentials, ds *DialSettings) (*google.Credentials, error) {
if len(ds.ImpersonationConfig.Scopes) == 0 {
2020-12-03 18:16:30 +00:00
ds.ImpersonationConfig.Scopes = ds.GetScopes()
2020-09-16 22:43:19 +00:00
}
ts, err := impersonate.TokenSource(ctx, creds.TokenSource, ds.ImpersonationConfig)
if err != nil {
return nil, err
}
return &google.Credentials{
TokenSource: ts,
ProjectID: creds.ProjectID,
}, nil
}