Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

oauth: Allow access to Google API regional endpoints via Google Default Credentials #4713

Merged
merged 4 commits into from Sep 7, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 18 additions & 1 deletion credentials/oauth/oauth.go
Expand Up @@ -23,6 +23,7 @@ import (
"context"
"fmt"
"io/ioutil"
"net/url"
"sync"

"golang.org/x/oauth2"
Expand Down Expand Up @@ -56,6 +57,16 @@ func (ts TokenSource) RequireTransportSecurity() bool {
return true
}

// removeServiceNameFromJWTURI removes RPC service name from URI.
func removeServiceNameFromJWTURI(uri string) (string, error) {
parsed, err := url.Parse(uri)
if err != nil {
return "", err
}
parsed.Path = "/"
return parsed.String(), nil
}

type jwtAccess struct {
jsonKey []byte
}
Expand All @@ -75,9 +86,15 @@ func NewJWTAccessFromKey(jsonKey []byte) (credentials.PerRPCCredentials, error)
}

func (j jwtAccess) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error) {
// Remove RPC service name from URI that will be used as audience
// in a self-signed JWT token. It follows https://google.aip.dev/auth/4111.
aud, err := removeServiceNameFromJWTURI(uri[0])
if err != nil {
return nil, err
}
// TODO: the returned TokenSource is reusable. Store it in a sync.Map, with
// uri as the key, to avoid recreating for every RPC.
ts, err := google.JWTAccessTokenSourceFromJSON(j.jsonKey, uri[0])
ts, err := google.JWTAccessTokenSourceFromJSON(j.jsonKey, aud)
if err != nil {
return nil, err
}
Expand Down
62 changes: 62 additions & 0 deletions credentials/oauth/oauth_test.go
@@ -0,0 +1,62 @@
/*
*
* Copyright 2020 gRPC authors.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2021 now

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

*
* 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 oauth

import (
"strings"
"testing"
)

func checkErrorMsg(err error, msg string) bool {
if err == nil && msg == "" {
return true
} else if err != nil {
return strings.Contains(err.Error(), msg)
}
return false
}

func TestRemoveServiceNameFromJwtURI(t *testing.T) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*JWT

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

tests := []struct {
name string
uri string
wantedURI string
wantedErrMsg string
}{
{
name: "invalid URI",
uri: "ht tp://foo.com",
wantedURI: "",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: no need to set this since empty string is zero value. Same with wantedErrMsg below.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

wantedErrMsg: "first path segment in URL cannot contain colon",
},
{
name: "valid URI",
uri: "https://foo.com/go/",
wantedURI: "https://foo.com/",
wantedErrMsg: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got, err := removeServiceNameFromJWTURI(tt.uri); got != tt.wantedURI || !checkErrorMsg(err, tt.wantedErrMsg) {
t.Errorf("RemoveServiceNameFromJWTURI() = %s, %v, want %s, %v", got, err, tt.wantedURI, tt.wantedErrMsg)
}
})
}
}
4 changes: 3 additions & 1 deletion internal/credentials/util.go
Expand Up @@ -18,7 +18,9 @@

package credentials

import "crypto/tls"
import (
"crypto/tls"
)

const alpnProtoStrH2 = "h2"

Expand Down