-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
credentials: support google default creds (#2315)
Google default creds is a combo of ALTS, TLS and OAuth2. The right set of creds will be picked to use based on environment. This PR contains: - A new `creds.Bundle` type - changes to use it in ClientConn and transport - dial option to set the bundle for a ClientConn - balancer options and NewSubConnOption to set it for SubConn - Google default creds implementation by @cesarghali - grpclb changes to use different creds mode for different servers - interop client changes for google default creds testing
- Loading branch information
Showing
16 changed files
with
559 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| /* | ||
| * | ||
| * 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 | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "golang.org/x/net/context" | ||
| "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 | ||
|
|
||
| // NewDefaultCredentials returns a credentials bundle that is configured to work | ||
| // with google services. | ||
| // | ||
| // This API is experimental. | ||
| func NewDefaultCredentials() credentials.Bundle { | ||
| c := &creds{} | ||
| bundle, err := c.NewWithMode(internal.CredsBundleModeFallback) | ||
| if err != nil { | ||
| grpclog.Warningf("google default 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 | ||
| } | ||
|
|
||
| func (c *creds) TransportCredentials() credentials.TransportCredentials { | ||
| return c.transportCreds | ||
| } | ||
|
|
||
| func (c *creds) PerRPCCredentials() credentials.PerRPCCredentials { | ||
| if c == nil { | ||
| return nil | ||
| } | ||
| return c.perRPCCreds | ||
| } | ||
|
|
||
| // 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} | ||
|
|
||
| // Create transport credentials. | ||
| switch mode { | ||
| case internal.CredsBundleModeFallback: | ||
| newCreds.transportCreds = credentials.NewTLS(nil) | ||
| 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 = alts.NewClientCreds(alts.DefaultClientOptions()) | ||
| default: | ||
| return nil, fmt.Errorf("google default creds: unsupported mode: %v", mode) | ||
| } | ||
|
|
||
| if mode == internal.CredsBundleModeFallback || mode == internal.CredsBundleModeBackendFromBalancer { | ||
| // Create per RPC credentials. | ||
| // For the time being, we required per RPC credentials for both TLS and | ||
| // ALTS. In the future, this will only be required for TLS. | ||
| ctx, cancel := context.WithTimeout(context.Background(), tokenRequestTimeout) | ||
| defer cancel() | ||
| var err error | ||
| newCreds.perRPCCreds, err = oauth.NewApplicationDefault(ctx) | ||
| if err != nil { | ||
| grpclog.Warningf("google default creds: failed to create application oauth: %v", err) | ||
| } | ||
| } | ||
|
|
||
| return newCreds, nil | ||
| } |
Oops, something went wrong.