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.

Sign up for GitHub

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

Jump to bottom

feat: generate a default audience for clients #475

Merged
merged 3 commits into from
Dec 3, 2020
Merged

feat: generate a default audience for clients #475

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
462f53d
feat: generate a default audience for clients
codyoss Nov 3, 2020
e67ea50
codereview comments
codyoss Nov 4, 2020
b949d4d
Merge branch 'master' into default-aud
codyoss Dec 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion internal/gengapic/client_init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,9 @@ func (g *generator) clientOptions(serv *descriptor.ServiceDescriptorProto, servN
p(" return []option.ClientOption{")
p(" internaloption.WithDefaultEndpoint(%q),", host)
p(" internaloption.WithDefaultMTLSEndpoint(%q),", generateDefaultMTLSEndpoint(host))
p(" internaloption.WithDefaultAudience(%q),", generateDefaultAudience(host))
p(" internaloption.WithDefaultScopes(DefaultAuthScopes()...),")
codyoss marked this conversation as resolved.
Show resolved Hide resolved
p(" option.WithGRPCDialOption(grpc.WithDisableServiceConfig()),")
p(" option.WithScopes(DefaultAuthScopes()...),")
p(" option.WithGRPCDialOption(grpc.WithDefaultCallOptions(")
p(" grpc.MaxCallRecvMsgSize(math.MaxInt32))),")
p(" }")
Expand Down Expand Up @@ -310,3 +311,24 @@ func generateDefaultMTLSEndpoint(defaultEndpoint string) string {
}
return defaultEndpoint
}

// generateDefaultAudience transforms a host into a an audience that can be used
// as the `aud` claim in a JWT.
func generateDefaultAudience(host string) string {
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we guaranteed that the host is a proper host (ie doesn't have a path)? I'd be inclined to defensively remove it (and include that in tests).

Copy link
Member Author

Choose a reason for hiding this comment

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

Guaranteed, no. But it does not happen today I can fairly certainly say. On L63 of this file we append :443 to the the end of the host. If there were path fragments this should be an invalid host and the client would not be able to talk to the backend.

aud := host
// Add a scheme if not present.
if !strings.Contains(aud, "://") {
aud = "https://" + aud
}
// Remove port, and everything after, if present.
if strings.Count(aud, ":") > 1 {
firstIndex := strings.Index(aud, ":")
secondIndex := strings.Index(aud[firstIndex+1:], ":") + firstIndex + 1
aud = aud[:secondIndex]
}
// Add trailing slash if not present.
if !strings.HasSuffix(aud, "/") {
aud = aud + "/"
}
return aud
}
24 changes: 24 additions & 0 deletions internal/gengapic/client_init_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,3 +208,27 @@ func TestClientInit(t *testing.T) {
txtdiff.Diff(t, tst.tstName, g.pt.String(), filepath.Join("testdata", tst.tstName+".want"))
}
}

func TestGenerateDefaultAudience(t *testing.T) {
tests := []struct {
name string
host string
want string
}{
{name: "plain host", host: "foo.googleapis.com", want: "https://foo.googleapis.com/"},
{name: "host with port", host: "foo.googleapis.com:443", want: "https://foo.googleapis.com/"},
{name: "host with scheme", host: "https://foo.googleapis.com", want: "https://foo.googleapis.com/"},
{name: "host with scheme and port", host: "https://foo.googleapis.com:1234", want: "https://foo.googleapis.com/"},
{name: "host is a proper audience", host: "https://foo.googleapis.com/", want: "https://foo.googleapis.com/"},
{name: "host with non-http scheme", host: "ftp://foo.googleapis.com", want: "ftp://foo.googleapis.com/"},
{name: "host with path", host: "foo.googleapis.com:443/extra/path", want: "https://foo.googleapis.com/"},
}

for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
if got := generateDefaultAudience(tc.host); got != tc.want {
t.Errorf("generateDefaultAudience(%q) = %q, want %q", tc.host, got, tc.want)
}
})
}
}
3 changes: 2 additions & 1 deletion internal/gengapic/testdata/empty_opt.want
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ func defaultClientOptions() []option.ClientOption {
return []option.ClientOption{
internaloption.WithDefaultEndpoint("foo.googleapis.com:443"),
internaloption.WithDefaultMTLSEndpoint("foo.mtls.googleapis.com:443"),
internaloption.WithDefaultAudience("https://foo.googleapis.com/"),
internaloption.WithDefaultScopes(DefaultAuthScopes()...),
option.WithGRPCDialOption(grpc.WithDisableServiceConfig()),
option.WithScopes(DefaultAuthScopes()...),
option.WithGRPCDialOption(grpc.WithDefaultCallOptions(
grpc.MaxCallRecvMsgSize(math.MaxInt32))),
}
Expand Down
3 changes: 2 additions & 1 deletion internal/gengapic/testdata/foo_opt.want
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ func defaultFooClientOptions() []option.ClientOption {
return []option.ClientOption{
internaloption.WithDefaultEndpoint("foo.googleapis.com:443"),
internaloption.WithDefaultMTLSEndpoint("foo.mtls.googleapis.com:443"),
internaloption.WithDefaultAudience("https://foo.googleapis.com/"),
internaloption.WithDefaultScopes(DefaultAuthScopes()...),
option.WithGRPCDialOption(grpc.WithDisableServiceConfig()),
option.WithScopes(DefaultAuthScopes()...),
option.WithGRPCDialOption(grpc.WithDefaultCallOptions(
grpc.MaxCallRecvMsgSize(math.MaxInt32))),
}
Expand Down
3 changes: 2 additions & 1 deletion internal/gengapic/testdata/host_port_opt.want
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ func defaultBarClientOptions() []option.ClientOption {
return []option.ClientOption{
internaloption.WithDefaultEndpoint("foo.googleapis.com:1234"),
internaloption.WithDefaultMTLSEndpoint("foo.mtls.googleapis.com:1234"),
internaloption.WithDefaultAudience("https://foo.googleapis.com/"),
internaloption.WithDefaultScopes(DefaultAuthScopes()...),
option.WithGRPCDialOption(grpc.WithDisableServiceConfig()),
option.WithScopes(DefaultAuthScopes()...),
option.WithGRPCDialOption(grpc.WithDefaultCallOptions(
grpc.MaxCallRecvMsgSize(math.MaxInt32))),
}
Expand Down