interop: attach per-RPC creds to TLS channel creds in the interop client (#9571)

With --use_tls, the interop client added the per-RPC credentials for
compute_engine_creds, service_account_creds, jwt_token_creds, and
oauth2_auth_token with grpc.WithPerRPCCredentials. Those aren't part of
the channel's credentials, so channels the client creates internally
don't inherit them. In particular, the RLS control channel copies only
DialCreds or CredsBundle, so RouteLookup calls went out without OAuth
and were rejected by RLS servers that require authentication.

This wraps the TLS transport credentials and the per-RPC credentials in
a credentials.Bundle. The RLS control channel takes the CredsBundle path
and keeps the per-RPC credentials. The bundle always returns the same
TLS transport credentials, regardless of mode.

This matches the C++ interop client, which attaches call credentials to
the channel credentials (CompositeChannelCredentials(SslCredentials,
call_creds)), so its RLS lookups carry OAuth with TLS. Java's equivalent
is CompositeChannelCredentials(TlsChannelCredentials, CallCredentials).

Tested with a target that uses RLS, where the RLS server requires OAuth:
before, the RLS lookup failed with Unauthenticated and returned no
targets; after, targets are returned and the RPC proceeds. Calls to TLS
backends without RLS are unaffected.

RELEASE NOTES: n/a
1 file changed
tree: 68670c892eae6acb1625438ceadd9764119cabcc
  1. .gemini/
  2. .github/
  3. admin/
  4. attributes/
  5. authz/
  6. backoff/
  7. balancer/
  8. benchmark/
  9. binarylog/
  10. channelz/
  11. cmd/
  12. codes/
  13. connectivity/
  14. credentials/
  15. Documentation/
  16. encoding/
  17. examples/
  18. experimental/
  19. gcp/
  20. grpclog/
  21. health/
  22. internal/
  23. interop/
  24. keepalive/
  25. mem/
  26. metadata/
  27. orca/
  28. peer/
  29. profiling/
  30. reflection/
  31. resolver/
  32. scripts/
  33. security/
  34. serviceconfig/
  35. stats/
  36. status/
  37. tap/
  38. test/
  39. testdata/
  40. xds/
  41. AUTHORS
  42. backoff.go
  43. balancer_wrapper.go
  44. balancer_wrapper_test.go
  45. call.go
  46. clientconn.go
  47. clientconn_authority_test.go
  48. clientconn_disconnect_reason_noplan9.go
  49. clientconn_disconnect_reason_plan9.go
  50. clientconn_parsed_target_test.go
  51. clientconn_provider.go
  52. clientconn_test.go
  53. CODE-OF-CONDUCT.md
  54. codec.go
  55. codec_test.go
  56. CONTRIBUTING.md
  57. default_dial_option_server_option_test.go
  58. dial_test.go
  59. dialoptions.go
  60. doc.go
  61. go.mod
  62. go.sum
  63. GOVERNANCE.md
  64. grpc_test.go
  65. interceptor.go
  66. LICENSE
  67. MAINTAINERS.md
  68. Makefile
  69. NOTICE.txt
  70. picker_wrapper.go
  71. picker_wrapper_test.go
  72. preloader.go
  73. producer_ext_test.go
  74. README.md
  75. resolver_balancer_ext_test.go
  76. resolver_test.go
  77. resolver_wrapper.go
  78. rpc_util.go
  79. rpc_util_test.go
  80. SECURITY.md
  81. server.go
  82. server_ext_test.go
  83. server_test.go
  84. service_config.go
  85. service_config_test.go
  86. stream.go
  87. stream_interfaces.go
  88. stream_test.go
  89. trace.go
  90. trace_notrace.go
  91. trace_test.go
  92. trace_withtrace.go
  93. version.go
README.md

gRPC-Go

GoDoc GoReportCard codecov

The Go implementation of gRPC: A high performance, open source, general RPC framework that puts mobile and HTTP/2 first. For more information see the Go gRPC docs, or jump directly into the quick start.

Prerequisites

Installation

Simply add the following import to your code, and then go [build|run|test] will automatically fetch the necessary dependencies:

import "google.golang.org/grpc"

Note: If you are trying to access grpc-go from China, see the FAQ below.

Learn more

FAQ

I/O Timeout Errors

The golang.org domain may be blocked from some countries. go get usually produces an error like the following when this happens:

$ go get -u google.golang.org/grpc
package google.golang.org/grpc: unrecognized import path "google.golang.org/grpc" (https fetch: Get https://google.golang.org/grpc?go-get=1: dial tcp 216.239.37.1:443: i/o timeout)

To build Go code, there are several options:

  • Set up a VPN and access google.golang.org through that.

  • With Go module support: it is possible to use the replace feature of go mod to create aliases for golang.org packages. In your project's directory:

    go mod edit -replace=google.golang.org/grpc=github.com/grpc/grpc-go@latest
    go mod tidy
    go mod vendor
    go build -mod=vendor
    

    Again, this will need to be done for all transitive dependencies hosted on golang.org as well. For details, refer to golang/go issue #28652.

Compiling error, undefined: grpc.SupportPackageIsVersion

Please update to the latest version of gRPC-Go using go get google.golang.org/grpc.

How to turn on logging

The default logger is controlled by environment variables. Turn everything on like this:

$ export GRPC_GO_LOG_VERBOSITY_LEVEL=99
$ export GRPC_GO_LOG_SEVERITY_LEVEL=info

The RPC failed with error "code = Unavailable desc = transport is closing"

This error means the connection the RPC is using was closed, and there are many possible reasons, including:

  1. mis-configured transport credentials, connection failed on handshaking
  2. bytes disrupted, possibly by a proxy in between
  3. server shutdown
  4. Keepalive parameters caused connection shutdown, for example if you have configured your server to terminate connections regularly to trigger DNS lookups. If this is the case, you may want to increase your MaxConnectionAgeGrace, to allow longer RPC calls to finish.

It can be tricky to debug this because the error happens on the client side but the root cause of the connection being closed is on the server side. Turn on logging on both client and server, and see if there are any transport errors.