opensource/grpc-go
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rename Credentials to PerRPCCredentials

Browse Source
This commit is contained in:
Menghan Li
2016-06-06 17:28:10 -07:00
parent 926d2eddee
commit 3ffbd8e030
5 changed files with 26 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
clientconn.go
View File

@ -178,9 +178,9 @@ func WithTransportCredentials(auth credentials.TransportAuthenticator) DialOptio
// WithPerRPCCredentials returns a DialOption which sets // WithPerRPCCredentials returns a DialOption which sets
// credentials which will place auth state on each outbound RPC. // credentials which will place auth state on each outbound RPC.
func WithPerRPCCredentials(creds credentials.Credentials) DialOption { func WithPerRPCCredentials(creds credentials.PerRPCCredentials) DialOption {
return func(o *dialOptions) { return func(o *dialOptions) {
o.copts.Credentials = append(o.copts.Credentials, creds) o.copts.PerRPCCredentials = append(o.copts.PerRPCCredentials, creds)
} }
} }
@ -376,7 +376,7 @@ func (cc *ClientConn) newAddrConn(addr Address, skipWait bool) error {
if ac.dopts.copts.Authenticator != nil { if ac.dopts.copts.Authenticator != nil {
return errCredentialsMisuse return errCredentialsMisuse
} }
for _, cd := range ac.dopts.copts.Credentials { for _, cd := range ac.dopts.copts.PerRPCCredentials {
if cd.RequireTransportSecurity() { if cd.RequireTransportSecurity() {
return errCredentialsMisuse return errCredentialsMisuse
} }

4
credentials/credentials.go
View File

@ -54,9 +54,9 @@ var (
alpnProtoStr = []string{"h2"} alpnProtoStr = []string{"h2"}
) )
// Credentials defines the common interface all supported credentials must // PerRPCCredentials defines the common interface all supported per RPC credentials must
// implement. // implement.
type Credentials interface { type PerRPCCredentials interface {
// GetRequestMetadata gets the current request metadata, refreshing // GetRequestMetadata gets the current request metadata, refreshing
// tokens if required. This should be called by the transport layer on // tokens if required. This should be called by the transport layer on
// each request, and the data should be populated in headers or other // each request, and the data should be populated in headers or other

31
credentials/oauth/oauth.go
View File

@ -45,7 +45,7 @@ import (
"google.golang.org/grpc/credentials" "google.golang.org/grpc/credentials"
) )
// TokenSource supplies credentials from an oauth2.TokenSource. // TokenSource supplies PerRPCCredentials from an oauth2.TokenSource.
type TokenSource struct { type TokenSource struct {
oauth2.TokenSource oauth2.TokenSource
} }
@ -61,6 +61,7 @@ func (ts TokenSource) GetRequestMetadata(ctx context.Context, uri ...string) (ma
}, nil }, nil
} }
// RequireTransportSecurity indicates whether the credentails requires transport security.
func (ts TokenSource) RequireTransportSecurity() bool { func (ts TokenSource) RequireTransportSecurity() bool {
return true return true
} }
@ -69,7 +70,8 @@ type jwtAccess struct {
jsonKey []byte jsonKey []byte
} }
func NewJWTAccessFromFile(keyFile string) (credentials.Credentials, error) { // NewJWTAccessFromFile creates PerRPCCredentials from the given keyFile.
func NewJWTAccessFromFile(keyFile string) (credentials.PerRPCCredentials, error) {
jsonKey, err := ioutil.ReadFile(keyFile) jsonKey, err := ioutil.ReadFile(keyFile)
if err != nil { if err != nil {
return nil, fmt.Errorf("credentials: failed to read the service account key file: %v", err) return nil, fmt.Errorf("credentials: failed to read the service account key file: %v", err)
@ -77,7 +79,8 @@ func NewJWTAccessFromFile(keyFile string) (credentials.Credentials, error) {
return NewJWTAccessFromKey(jsonKey) return NewJWTAccessFromKey(jsonKey)
} }
func NewJWTAccessFromKey(jsonKey []byte) (credentials.Credentials, error) { // NewJWTAccessFromKey creates PerRPCCredentials from the given jsonKey.
func NewJWTAccessFromKey(jsonKey []byte) (credentials.PerRPCCredentials, error) {
return jwtAccess{jsonKey}, nil return jwtAccess{jsonKey}, nil
} }
@ -99,13 +102,13 @@ func (j jwtAccess) RequireTransportSecurity() bool {
return true return true
} }
// oauthAccess supplies credentials from a given token. // oauthAccess supplies PerRPCCredentials from a given token.
type oauthAccess struct { type oauthAccess struct {
token oauth2.Token token oauth2.Token
} }
// NewOauthAccess constructs the credentials using a given token. // NewOauthAccess constructs the PerRPCCredentials using a given token.
func NewOauthAccess(token *oauth2.Token) credentials.Credentials { func NewOauthAccess(token *oauth2.Token) credentials.PerRPCCredentials {
return oauthAccess{token: *token} return oauthAccess{token: *token}
} }
@ -119,15 +122,15 @@ func (oa oauthAccess) RequireTransportSecurity() bool {
return true return true
} }
// NewComputeEngine constructs the credentials that fetches access tokens from // NewComputeEngine constructs the PerRPCCredentials that fetches access tokens from
// Google Compute Engine (GCE)'s metadata server. It is only valid to use this // Google Compute Engine (GCE)'s metadata server. It is only valid to use this
// if your program is running on a GCE instance. // if your program is running on a GCE instance.
// TODO(dsymonds): Deprecate and remove this. // TODO(dsymonds): Deprecate and remove this.
func NewComputeEngine() credentials.Credentials { func NewComputeEngine() credentials.PerRPCCredentials {
return TokenSource{google.ComputeTokenSource("")} return TokenSource{google.ComputeTokenSource("")}
} }
// serviceAccount represents credentials via JWT signing key. // serviceAccount represents PerRPCCredentials via JWT signing key.
type serviceAccount struct { type serviceAccount struct {
config *jwt.Config config *jwt.Config
} }
@ -146,9 +149,9 @@ func (s serviceAccount) RequireTransportSecurity() bool {
return true return true
} }
// NewServiceAccountFromKey constructs the credentials using the JSON key slice // NewServiceAccountFromKey constructs the PerRPCCredentials using the JSON key slice
// from a Google Developers service account. // from a Google Developers service account.
func NewServiceAccountFromKey(jsonKey []byte, scope ...string) (credentials.Credentials, error) { func NewServiceAccountFromKey(jsonKey []byte, scope ...string) (credentials.PerRPCCredentials, error) {
config, err := google.JWTConfigFromJSON(jsonKey, scope...) config, err := google.JWTConfigFromJSON(jsonKey, scope...)
if err != nil { if err != nil {
return nil, err return nil, err
@ -156,9 +159,9 @@ func NewServiceAccountFromKey(jsonKey []byte, scope ...string) (credentials.Cred
return serviceAccount{config: config}, nil return serviceAccount{config: config}, nil
} }
// NewServiceAccountFromFile constructs the credentials using the JSON key file // NewServiceAccountFromFile constructs the PerRPCCredentials using the JSON key file
// of a Google Developers service account. // of a Google Developers service account.
func NewServiceAccountFromFile(keyFile string, scope ...string) (credentials.Credentials, error) { func NewServiceAccountFromFile(keyFile string, scope ...string) (credentials.PerRPCCredentials, error) {
jsonKey, err := ioutil.ReadFile(keyFile) jsonKey, err := ioutil.ReadFile(keyFile)
if err != nil { if err != nil {
return nil, fmt.Errorf("credentials: failed to read the service account key file: %v", err) return nil, fmt.Errorf("credentials: failed to read the service account key file: %v", err)
@ -168,7 +171,7 @@ func NewServiceAccountFromFile(keyFile string, scope ...string) (credentials.Cre
// NewApplicationDefault returns "Application Default Credentials". For more // NewApplicationDefault returns "Application Default Credentials". For more
// detail, see https://developers.google.com/accounts/docs/application-default-credentials. // detail, see https://developers.google.com/accounts/docs/application-default-credentials.
func NewApplicationDefault(ctx context.Context, scope ...string) (credentials.Credentials, error) { func NewApplicationDefault(ctx context.Context, scope ...string) (credentials.PerRPCCredentials, error) {
t, err := google.DefaultTokenSource(ctx, scope...) t, err := google.DefaultTokenSource(ctx, scope...)
if err != nil { if err != nil {
return nil, err return nil, err

4
transport/http2_client.go
View File

@ -88,7 +88,7 @@ type http2Client struct {
// The scheme used: https if TLS is on, http otherwise. // The scheme used: https if TLS is on, http otherwise.
scheme string scheme string
creds []credentials.Credentials creds []credentials.PerRPCCredentials
mu sync.Mutex // guard the following variables mu sync.Mutex // guard the following variables
state transportState // the state of underlying connection state transportState // the state of underlying connection
@ -156,7 +156,7 @@ func newHTTP2Client(addr string, opts *ConnectOptions) (_ ClientTransport, err e
scheme: scheme, scheme: scheme,
state: reachable, state: reachable,
activeStreams: make(map[uint32]*Stream), activeStreams: make(map[uint32]*Stream),
creds: opts.Credentials, creds: opts.PerRPCCredentials,
maxStreams: math.MaxInt32, maxStreams: math.MaxInt32,
streamSendQuota: defaultWindowSize, streamSendQuota: defaultWindowSize,
} }

4
transport/transport.go
View File

@ -336,8 +336,8 @@ type ConnectOptions struct {
UserAgent string UserAgent string
// Dialer specifies how to dial a network address. // Dialer specifies how to dial a network address.
Dialer func(string, time.Duration) (net.Conn, error) Dialer func(string, time.Duration) (net.Conn, error)
// Credentials stores the credentials required to issue RPCs. // PerRPCCredentials stores the PerRPCCredentials required to issue RPCs.
Credentials []credentials.Credentials PerRPCCredentials []credentials.PerRPCCredentials
// Authenticator stores the Authenticator required to setup a client connection. // Authenticator stores the Authenticator required to setup a client connection.
Authenticator credentials.TransportAuthenticator Authenticator credentials.TransportAuthenticator
// Timeout specifies the timeout for dialing a ClientTransport. // Timeout specifies the timeout for dialing a ClientTransport.