mirror of https://github.com/grpc/grpc-go.git
333 lines
11 KiB
Go
333 lines
11 KiB
Go
/*
|
|
*
|
|
* Copyright 2025 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 credentials_test
|
|
|
|
import (
|
|
"context"
|
|
"crypto/tls"
|
|
"fmt"
|
|
"net"
|
|
"testing"
|
|
"time"
|
|
|
|
"google.golang.org/grpc"
|
|
"google.golang.org/grpc/codes"
|
|
"google.golang.org/grpc/credentials"
|
|
"google.golang.org/grpc/credentials/insecure"
|
|
"google.golang.org/grpc/internal/stubserver"
|
|
"google.golang.org/grpc/metadata"
|
|
"google.golang.org/grpc/status"
|
|
"google.golang.org/grpc/testdata"
|
|
|
|
testgrpc "google.golang.org/grpc/interop/grpc_testing"
|
|
testpb "google.golang.org/grpc/interop/grpc_testing"
|
|
)
|
|
|
|
func authorityChecker(ctx context.Context, wantAuthority string) error {
|
|
md, ok := metadata.FromIncomingContext(ctx)
|
|
if !ok {
|
|
return status.Error(codes.InvalidArgument, "failed to parse metadata")
|
|
}
|
|
auths, ok := md[":authority"]
|
|
if !ok {
|
|
return status.Error(codes.InvalidArgument, "no authority header")
|
|
}
|
|
if len(auths) != 1 {
|
|
return status.Errorf(codes.InvalidArgument, "expected exactly one authority header, got %v", auths)
|
|
}
|
|
if auths[0] != wantAuthority {
|
|
return status.Errorf(codes.InvalidArgument, "invalid authority header %q, want %q", auths[0], wantAuthority)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Tests the `grpc.CallAuthority` option with TLS credentials. This test verifies
|
|
// that the provided authority is correctly propagated to the server when a
|
|
// correct authority is used.
|
|
func (s) TestCorrectAuthorityWithTLSCreds(t *testing.T) {
|
|
cert, err := tls.LoadX509KeyPair(testdata.Path("x509/server1_cert.pem"), testdata.Path("x509/server1_key.pem"))
|
|
if err != nil {
|
|
t.Fatalf("Failed to load key pair: %s", err)
|
|
}
|
|
creds, err := credentials.NewClientTLSFromFile(testdata.Path("x509/server_ca_cert.pem"), "x.test.example.com")
|
|
if err != nil {
|
|
t.Fatalf("Failed to create credentials %v", err)
|
|
}
|
|
const authority = "auth.test.example.com"
|
|
ss := &stubserver.StubServer{
|
|
EmptyCallF: func(ctx context.Context, _ *testpb.Empty) (*testpb.Empty, error) {
|
|
if err := authorityChecker(ctx, authority); err != nil {
|
|
return nil, err
|
|
}
|
|
return &testpb.Empty{}, nil
|
|
},
|
|
}
|
|
if err := ss.StartServer(grpc.Creds(credentials.NewServerTLSFromCert(&cert))); err != nil {
|
|
t.Fatalf("Error starting endpoint server: %v", err)
|
|
}
|
|
defer ss.Stop()
|
|
|
|
cc, err := grpc.NewClient(ss.Address, grpc.WithTransportCredentials(creds))
|
|
if err != nil {
|
|
t.Fatalf("grpc.NewClient(%q) = %v", ss.Address, err)
|
|
}
|
|
defer cc.Close()
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
|
|
defer cancel()
|
|
|
|
if _, err = testgrpc.NewTestServiceClient(cc).EmptyCall(ctx, &testpb.Empty{}, grpc.CallAuthority(authority)); status.Code(err) != codes.OK {
|
|
t.Fatalf("EmptyCall() returned status %v, want %v", status.Code(err), codes.OK)
|
|
}
|
|
|
|
}
|
|
|
|
// Tests the `grpc.CallAuthority` option with TLS credentials. This test verifies
|
|
// that the RPC fails with `UNAVAILABLE` status code and doesn't reach the server
|
|
// when an incorrect authority is used.
|
|
func (s) TestIncorrectAuthorityWithTLS(t *testing.T) {
|
|
cert, err := tls.LoadX509KeyPair(testdata.Path("x509/server1_cert.pem"), testdata.Path("x509/server1_key.pem"))
|
|
if err != nil {
|
|
t.Fatalf("Failed to load key pair: %s", err)
|
|
}
|
|
creds, err := credentials.NewClientTLSFromFile(testdata.Path("x509/server_ca_cert.pem"), "x.test.example.com")
|
|
if err != nil {
|
|
t.Fatalf("Failed to create credentials %v", err)
|
|
}
|
|
|
|
serverCalled := make(chan struct{})
|
|
ss := &stubserver.StubServer{
|
|
EmptyCallF: func(ctx context.Context, _ *testpb.Empty) (*testpb.Empty, error) {
|
|
close(serverCalled)
|
|
return nil, nil
|
|
},
|
|
}
|
|
if err := ss.StartServer(grpc.Creds(credentials.NewServerTLSFromCert(&cert))); err != nil {
|
|
t.Fatalf("Error starting endpoint server: %v", err)
|
|
}
|
|
defer ss.Stop()
|
|
|
|
cc, err := grpc.NewClient(ss.Address, grpc.WithTransportCredentials(creds))
|
|
if err != nil {
|
|
t.Fatalf("grpc.NewClient(%q) = %v", ss.Address, err)
|
|
}
|
|
defer cc.Close()
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
|
|
defer cancel()
|
|
|
|
const authority = "auth.example.com"
|
|
if _, err = testgrpc.NewTestServiceClient(cc).EmptyCall(ctx, &testpb.Empty{}, grpc.CallAuthority(authority)); status.Code(err) != codes.Unavailable {
|
|
t.Fatalf("EmptyCall() returned status %v, want %v", status.Code(err), codes.Unavailable)
|
|
}
|
|
select {
|
|
case <-serverCalled:
|
|
t.Fatalf("Server handler should not have been called")
|
|
case <-time.After(defaultTestShortTimeout):
|
|
}
|
|
}
|
|
|
|
// Tests the scenario where the `grpc.CallAuthority` call option is used with
|
|
// insecure transport credentials. The test verifies that the specified
|
|
// authority is correctly propagated to the server.
|
|
func (s) TestAuthorityCallOptionWithInsecureCreds(t *testing.T) {
|
|
const authority = "test.server.name"
|
|
|
|
ss := &stubserver.StubServer{
|
|
EmptyCallF: func(ctx context.Context, _ *testpb.Empty) (*testpb.Empty, error) {
|
|
if err := authorityChecker(ctx, authority); err != nil {
|
|
return nil, err
|
|
}
|
|
return &testpb.Empty{}, nil
|
|
},
|
|
}
|
|
if err := ss.Start(nil); err != nil {
|
|
t.Fatalf("Error starting endpoint server: %v", err)
|
|
}
|
|
defer ss.Stop()
|
|
|
|
cc, err := grpc.NewClient(ss.Address, grpc.WithTransportCredentials(insecure.NewCredentials()))
|
|
if err != nil {
|
|
t.Fatalf("grpc.NewClient(%q) = %v", ss.Address, err)
|
|
}
|
|
defer cc.Close()
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
|
|
defer cancel()
|
|
if _, err = testgrpc.NewTestServiceClient(cc).EmptyCall(ctx, &testpb.Empty{}, grpc.CallAuthority(authority)); err != nil {
|
|
t.Fatalf("EmptyCall() rpc failed: %v", err)
|
|
}
|
|
}
|
|
|
|
// testAuthInfoNoValidator implements only credentials.AuthInfo and not
|
|
// credentials.AuthorityValidator.
|
|
type testAuthInfoNoValidator struct{}
|
|
|
|
// AuthType returns the authentication type.
|
|
func (testAuthInfoNoValidator) AuthType() string {
|
|
return "test"
|
|
}
|
|
|
|
// testAuthInfoWithValidator implements both credentials.AuthInfo and
|
|
// credentials.AuthorityValidator.
|
|
type testAuthInfoWithValidator struct {
|
|
validAuthority string
|
|
}
|
|
|
|
// AuthType returns the authentication type.
|
|
func (testAuthInfoWithValidator) AuthType() string {
|
|
return "test"
|
|
}
|
|
|
|
// ValidateAuthority implements credentials.AuthorityValidator.
|
|
func (v testAuthInfoWithValidator) ValidateAuthority(authority string) error {
|
|
if authority == v.validAuthority {
|
|
return nil
|
|
}
|
|
return fmt.Errorf("invalid authority %q, want %q", authority, v.validAuthority)
|
|
}
|
|
|
|
// testCreds is a test TransportCredentials that can optionally support
|
|
// authority validation.
|
|
type testCreds struct {
|
|
authority string
|
|
}
|
|
|
|
// ClientHandshake performs the client-side handshake.
|
|
func (c *testCreds) ClientHandshake(ctx context.Context, authority string, rawConn net.Conn) (net.Conn, credentials.AuthInfo, error) {
|
|
if c.authority != "" {
|
|
return rawConn, testAuthInfoWithValidator{validAuthority: c.authority}, nil
|
|
}
|
|
return rawConn, testAuthInfoNoValidator{}, nil
|
|
}
|
|
|
|
// ServerHandshake performs the server-side handshake.
|
|
func (c *testCreds) ServerHandshake(rawConn net.Conn) (net.Conn, credentials.AuthInfo, error) {
|
|
if c.authority != "" {
|
|
return rawConn, testAuthInfoWithValidator{validAuthority: c.authority}, nil
|
|
}
|
|
return rawConn, testAuthInfoNoValidator{}, nil
|
|
}
|
|
|
|
// Clone creates a copy of testCreds.
|
|
func (c *testCreds) Clone() credentials.TransportCredentials {
|
|
return &testCreds{authority: c.authority}
|
|
}
|
|
|
|
// Info provides protocol information.
|
|
func (c *testCreds) Info() credentials.ProtocolInfo {
|
|
return credentials.ProtocolInfo{}
|
|
}
|
|
|
|
// OverrideServerName overrides the server name used for verification.
|
|
func (c *testCreds) OverrideServerName(serverName string) error {
|
|
return nil
|
|
}
|
|
|
|
// TestAuthorityValidationFailureWithCustomCreds tests the `grpc.CallAuthority`
|
|
// call option using custom credentials. It covers two failure scenarios:
|
|
// - The credentials implement AuthorityValidator but authority used to override
|
|
// is not valid.
|
|
// - The credentials do not implement AuthorityValidator, but an authority
|
|
// override is specified.
|
|
// In both cases, the RPC is expected to fail with an `UNAVAILABLE` status code.
|
|
func (s) TestAuthorityValidationFailureWithCustomCreds(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
creds credentials.TransportCredentials
|
|
authority string
|
|
}{
|
|
{
|
|
name: "IncorrectAuthorityWithFakeCreds",
|
|
authority: "auth.example.com",
|
|
creds: &testCreds{authority: "auth.test.example.com"},
|
|
},
|
|
{
|
|
name: "FakeCredsWithNoAuthValidator",
|
|
creds: &testCreds{},
|
|
authority: "auth.test.example.com",
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
serverCalled := make(chan struct{})
|
|
ss := stubserver.StubServer{
|
|
EmptyCallF: func(ctx context.Context, _ *testpb.Empty) (*testpb.Empty, error) {
|
|
close(serverCalled)
|
|
return nil, nil
|
|
},
|
|
}
|
|
if err := ss.StartServer(); err != nil {
|
|
t.Fatalf("Failed to start stub server: %v", err)
|
|
}
|
|
defer ss.Stop()
|
|
|
|
cc, err := grpc.NewClient(ss.Address, grpc.WithTransportCredentials(tt.creds))
|
|
if err != nil {
|
|
t.Fatalf("grpc.NewClient(%q) = %v", ss.Address, err)
|
|
}
|
|
defer cc.Close()
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
|
|
defer cancel()
|
|
if _, err = testgrpc.NewTestServiceClient(cc).EmptyCall(ctx, &testpb.Empty{}, grpc.CallAuthority(tt.authority)); status.Code(err) != codes.Unavailable {
|
|
t.Fatalf("EmptyCall() returned status %v, want %v", status.Code(err), codes.Unavailable)
|
|
}
|
|
select {
|
|
case <-serverCalled:
|
|
t.Fatalf("Server should not have been called")
|
|
case <-time.After(defaultTestShortTimeout):
|
|
}
|
|
})
|
|
}
|
|
|
|
}
|
|
|
|
// TestCorrectAuthorityWithCustomCreds tests the `grpc.CallAuthority` call
|
|
// option using custom credentials. It verifies that the provided authority is
|
|
// correctly propagated to the server when a correct authority is used.
|
|
func (s) TestCorrectAuthorityWithCustomCreds(t *testing.T) {
|
|
const authority = "auth.test.example.com"
|
|
creds := &testCreds{authority: "auth.test.example.com"}
|
|
ss := stubserver.StubServer{
|
|
EmptyCallF: func(ctx context.Context, _ *testpb.Empty) (*testpb.Empty, error) {
|
|
if err := authorityChecker(ctx, authority); err != nil {
|
|
return nil, err
|
|
}
|
|
return &testpb.Empty{}, nil
|
|
},
|
|
}
|
|
if err := ss.StartServer(); err != nil {
|
|
t.Fatalf("Failed to start stub server: %v", err)
|
|
}
|
|
defer ss.Stop()
|
|
|
|
cc, err := grpc.NewClient(ss.Address, grpc.WithTransportCredentials(creds))
|
|
if err != nil {
|
|
t.Fatalf("grpc.NewClient(%q) = %v", ss.Address, err)
|
|
}
|
|
defer cc.Close()
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
|
|
defer cancel()
|
|
if _, err = testgrpc.NewTestServiceClient(cc).EmptyCall(ctx, &testpb.Empty{}, grpc.CallAuthority(authority)); status.Code(err) != codes.OK {
|
|
t.Fatalf("EmptyCall() returned status %v, want %v", status.Code(err), codes.OK)
|
|
}
|
|
}
|