/* * * Copyright 2018 gRPC 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 google defines credentials for google cloud services. package google import ( "context" "fmt" "time" "google.golang.org/grpc/credentials" "google.golang.org/grpc/credentials/alts" "google.golang.org/grpc/credentials/oauth" "google.golang.org/grpc/grpclog" "google.golang.org/grpc/internal" ) const tokenRequestTimeout = 30 * time.Second var logger = grpclog.Component("credentials") // NewDefaultCredentials returns a credentials bundle that is configured to work // with google services. // // This API is experimental. func NewDefaultCredentials() credentials.Bundle { c := &creds{ newPerRPCCreds: func() credentials.PerRPCCredentials { ctx, cancel := context.WithTimeout(context.Background(), tokenRequestTimeout) defer cancel() perRPCCreds, err := oauth.NewApplicationDefault(ctx) if err != nil { logger.Warningf("google default creds: failed to create application oauth: %v", err) } return perRPCCreds }, } bundle, err := c.NewWithMode(internal.CredsBundleModeFallback) if err != nil { logger.Warningf("google default creds: failed to create new creds: %v", err) } return bundle } // NewComputeEngineCredentials returns a credentials bundle that is configured to work // with google services. This API must only be used when running on GCE. Authentication configured // by this API represents the GCE VM's default service account. // // This API is experimental. func NewComputeEngineCredentials() credentials.Bundle { c := &creds{ newPerRPCCreds: func() credentials.PerRPCCredentials { return oauth.NewComputeEngine() }, } bundle, err := c.NewWithMode(internal.CredsBundleModeFallback) if err != nil { logger.Warningf("compute engine creds: failed to create new creds: %v", err) } return bundle } // creds implements credentials.Bundle. type creds struct { // Supported modes are defined in internal/internal.go. mode string // The transport credentials associated with this bundle. transportCreds credentials.TransportCredentials // The per RPC credentials associated with this bundle. perRPCCreds credentials.PerRPCCredentials // Creates new per RPC credentials newPerRPCCreds func() credentials.PerRPCCredentials } func (c *creds) TransportCredentials() credentials.TransportCredentials { return c.transportCreds } func (c *creds) PerRPCCredentials() credentials.PerRPCCredentials { if c == nil { return nil } return c.perRPCCreds } var ( newTLS = func() credentials.TransportCredentials { return credentials.NewTLS(nil) } newALTS = func() credentials.TransportCredentials { return alts.NewClientCreds(alts.DefaultClientOptions()) } ) // NewWithMode should make a copy of Bundle, and switch mode. Modifying the // existing Bundle may cause races. func (c *creds) NewWithMode(mode string) (credentials.Bundle, error) { newCreds := &creds{ mode: mode, newPerRPCCreds: c.newPerRPCCreds, } // Create transport credentials. switch mode { case internal.CredsBundleModeFallback: newCreds.transportCreds = newClusterTransportCreds(newTLS(), newALTS()) case internal.CredsBundleModeBackendFromBalancer, internal.CredsBundleModeBalancer: // Only the clients can use google default credentials, so we only need // to create new ALTS client creds here. newCreds.transportCreds = newALTS() default: return nil, fmt.Errorf("unsupported mode: %v", mode) } if mode == internal.CredsBundleModeFallback || mode == internal.CredsBundleModeBackendFromBalancer { newCreds.perRPCCreds = newCreds.newPerRPCCreds() } return newCreds, nil }