Files
zeekay 103b77b3bb gate gRPC behind //go:build grpc
The reasoner-admin gRPC service, its middleware, and the
generated *_grpc.pb.go now require -tags grpc to compile.

Default builds use only the ZAP-native admin path. The
adminpb stub keeps `UnimplementedAdminReasonerServiceServer`
available as a zero-field struct so embedders compile.

Generated file regen via protoc will erase the build
constraint — inline comment in reasoner_admin_grpc.pb.go
flags this for the next person who runs the codegen.
2026-05-10 15:37:37 -07:00

353 lines
10 KiB
Go

//go:build grpc
package middleware
import (
"context"
"testing"
"github.com/hanzoai/agents/control-plane/pkg/auth"
"github.com/stretchr/testify/assert"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
)
// grpcFakeValidator mirrors fakeValidator in auth_test.go for the
// gRPC interceptor's bound-org path. Kept in this file to avoid
// cross-test-file globals.
type grpcFakeValidator struct {
want string
key *auth.APIKey
err error
}
func (f *grpcFakeValidator) Validate(_ context.Context, raw string) (*auth.APIKey, error) {
if f.err != nil {
return nil, f.err
}
if raw != f.want {
return nil, auth.ErrKeyInvalid
}
return f.key, nil
}
// mockHandler is a simple handler for testing
func mockHandler(ctx context.Context, req interface{}) (interface{}, error) {
return "success", nil
}
// mockServerInfo for interceptor testing
var mockServerInfo = &grpc.UnaryServerInfo{
FullMethod: "/test.Service/TestMethod",
}
func TestAPIKeyUnaryInterceptor_NoAuthConfigured(t *testing.T) {
// When no API key is configured, all requests should be allowed
interceptor := APIKeyUnaryInterceptor("")
ctx := context.Background()
resp, err := interceptor(ctx, "request", mockServerInfo, mockHandler)
assert.NoError(t, err)
assert.Equal(t, "success", resp)
}
func TestAPIKeyUnaryInterceptor_ValidXAPIKeyMetadata(t *testing.T) {
interceptor := APIKeyUnaryInterceptor("secret-key")
md := metadata.Pairs("x-api-key", "secret-key")
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "request", mockServerInfo, mockHandler)
assert.NoError(t, err)
assert.Equal(t, "success", resp)
}
func TestAPIKeyUnaryInterceptor_ValidBearerToken(t *testing.T) {
interceptor := APIKeyUnaryInterceptor("secret-key")
md := metadata.Pairs("authorization", "Bearer secret-key")
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "request", mockServerInfo, mockHandler)
assert.NoError(t, err)
assert.Equal(t, "success", resp)
}
func TestAPIKeyUnaryInterceptor_MissingMetadata(t *testing.T) {
interceptor := APIKeyUnaryInterceptor("secret-key")
// Context without any metadata
ctx := context.Background()
resp, err := interceptor(ctx, "request", mockServerInfo, mockHandler)
assert.Nil(t, resp)
assert.Error(t, err)
st, ok := status.FromError(err)
assert.True(t, ok)
assert.Equal(t, codes.Unauthenticated, st.Code())
assert.Equal(t, "missing metadata", st.Message())
}
func TestAPIKeyUnaryInterceptor_InvalidAPIKey(t *testing.T) {
interceptor := APIKeyUnaryInterceptor("secret-key")
md := metadata.Pairs("x-api-key", "wrong-key")
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "request", mockServerInfo, mockHandler)
assert.Nil(t, resp)
assert.Error(t, err)
st, ok := status.FromError(err)
assert.True(t, ok)
assert.Equal(t, codes.Unauthenticated, st.Code())
assert.Equal(t, "invalid or missing api key", st.Message())
}
func TestAPIKeyUnaryInterceptor_InvalidBearerToken(t *testing.T) {
interceptor := APIKeyUnaryInterceptor("secret-key")
md := metadata.Pairs("authorization", "Bearer wrong-key")
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "request", mockServerInfo, mockHandler)
assert.Nil(t, resp)
assert.Error(t, err)
st, ok := status.FromError(err)
assert.True(t, ok)
assert.Equal(t, codes.Unauthenticated, st.Code())
}
func TestAPIKeyUnaryInterceptor_MalformedBearerToken(t *testing.T) {
interceptor := APIKeyUnaryInterceptor("secret-key")
tests := []struct {
name string
auth string
}{
{"no Bearer prefix", "secret-key"},
{"Basic auth instead", "Basic secret-key"},
{"malformed Bearer", "Bearersecret-key"},
{"empty Bearer", "Bearer "},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
md := metadata.Pairs("authorization", tt.auth)
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "request", mockServerInfo, mockHandler)
assert.Nil(t, resp)
assert.Error(t, err)
st, ok := status.FromError(err)
assert.True(t, ok)
assert.Equal(t, codes.Unauthenticated, st.Code())
})
}
}
func TestAPIKeyUnaryInterceptor_XAPIKeyTakesPrecedence(t *testing.T) {
interceptor := APIKeyUnaryInterceptor("secret-key")
// Both headers set, x-api-key is valid
md := metadata.Pairs(
"x-api-key", "secret-key",
"authorization", "Bearer wrong-key",
)
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "request", mockServerInfo, mockHandler)
assert.NoError(t, err)
assert.Equal(t, "success", resp)
}
func TestAPIKeyUnaryInterceptor_FallbackToBearer(t *testing.T) {
interceptor := APIKeyUnaryInterceptor("secret-key")
// Only bearer token set, should work as fallback
md := metadata.Pairs("authorization", "Bearer secret-key")
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "request", mockServerInfo, mockHandler)
assert.NoError(t, err)
assert.Equal(t, "success", resp)
}
func TestAPIKeyUnaryInterceptor_EmptyMetadata(t *testing.T) {
interceptor := APIKeyUnaryInterceptor("secret-key")
// Empty metadata (not nil, just no entries)
md := metadata.MD{}
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "request", mockServerInfo, mockHandler)
assert.Nil(t, resp)
assert.Error(t, err)
st, ok := status.FromError(err)
assert.True(t, ok)
assert.Equal(t, codes.Unauthenticated, st.Code())
}
func TestAPIKeyUnaryInterceptor_CaseSensitivity(t *testing.T) {
interceptor := APIKeyUnaryInterceptor("secret-key")
// gRPC metadata keys are lowercased, but let's verify behavior
tests := []struct {
name string
key string
value string
want bool
}{
{"lowercase x-api-key", "x-api-key", "secret-key", true},
// gRPC auto-lowercases keys, so these should work the same
{"uppercase would be lowercased", "x-api-key", "secret-key", true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
md := metadata.Pairs(tt.key, tt.value)
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "request", mockServerInfo, mockHandler)
if tt.want {
assert.NoError(t, err)
assert.Equal(t, "success", resp)
} else {
assert.Error(t, err)
}
})
}
}
func TestAPIKeyUnaryInterceptor_MultipleValues(t *testing.T) {
interceptor := APIKeyUnaryInterceptor("secret-key")
// Multiple x-api-key values - should use first one
md := metadata.Pairs(
"x-api-key", "secret-key",
"x-api-key", "another-key",
)
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "request", mockServerInfo, mockHandler)
assert.NoError(t, err)
assert.Equal(t, "success", resp)
}
// ---- Bound-org tests (Red 2026-04-27 P0-2) -------------------------
// orgEchoHandler reads the bound OrgID off the ctx pinned by the
// interceptor and echoes it as the response. Lets the bound-org
// tests assert on the "key wins" property.
func orgEchoHandler(ctx context.Context, _ interface{}) (interface{}, error) {
return auth.OrgID(ctx), nil
}
func TestAPIKeyUnaryInterceptor_BoundKey_MatchingOrg(t *testing.T) {
v := &grpcFakeValidator{
want: "hk-good",
key: &auth.APIKey{ID: "k1", OrgID: "hanzo", UserID: "u1"},
}
interceptor := APIKeyUnaryInterceptor("", WithValidator(v))
md := metadata.Pairs("x-api-key", "hk-good", "x-org-id", "hanzo")
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "req", mockServerInfo, orgEchoHandler)
assert.NoError(t, err)
assert.Equal(t, "hanzo", resp)
}
func TestAPIKeyUnaryInterceptor_BoundKey_MismatchedOrg_403(t *testing.T) {
v := &grpcFakeValidator{
want: "hk-good",
key: &auth.APIKey{ID: "k1", OrgID: "hanzo", UserID: "u1"},
}
interceptor := APIKeyUnaryInterceptor("", WithValidator(v))
md := metadata.Pairs("x-api-key", "hk-good", "x-org-id", "victim")
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "req", mockServerInfo, mockHandler)
assert.Nil(t, resp)
st, ok := status.FromError(err)
assert.True(t, ok)
assert.Equal(t, codes.PermissionDenied, st.Code())
assert.Contains(t, st.Message(), "different org")
}
func TestAPIKeyUnaryInterceptor_BoundKey_NoOrgHeader_KeyWins(t *testing.T) {
v := &grpcFakeValidator{
want: "hk-good",
key: &auth.APIKey{ID: "k1", OrgID: "hanzo", UserID: "u1"},
}
interceptor := APIKeyUnaryInterceptor("", WithValidator(v))
md := metadata.Pairs("x-api-key", "hk-good")
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "req", mockServerInfo, orgEchoHandler)
assert.NoError(t, err)
assert.Equal(t, "hanzo", resp)
}
func TestAPIKeyUnaryInterceptor_BoundKey_Revoked_401(t *testing.T) {
v := &grpcFakeValidator{want: "hk-good", err: auth.ErrKeyRevoked}
interceptor := APIKeyUnaryInterceptor("", WithValidator(v))
md := metadata.Pairs("x-api-key", "hk-good")
ctx := metadata.NewIncomingContext(context.Background(), md)
_, err := interceptor(ctx, "req", mockServerInfo, mockHandler)
st, ok := status.FromError(err)
assert.True(t, ok)
assert.Equal(t, codes.Unauthenticated, st.Code())
}
func TestAPIKeyUnaryInterceptor_BoundKey_Expired_401(t *testing.T) {
v := &grpcFakeValidator{want: "hk-good", err: auth.ErrKeyExpired}
interceptor := APIKeyUnaryInterceptor("", WithValidator(v))
md := metadata.Pairs("x-api-key", "hk-good")
ctx := metadata.NewIncomingContext(context.Background(), md)
_, err := interceptor(ctx, "req", mockServerInfo, mockHandler)
st, ok := status.FromError(err)
assert.True(t, ok)
assert.Equal(t, codes.Unauthenticated, st.Code())
}
func TestAPIKeyUnaryInterceptor_StaticKey_DefersOrgToGateway(t *testing.T) {
// Legacy single-key shape: APIKeyUnaryInterceptor("hk-static")
// auto-wraps as a StaticValidator. No org binding → no PD on
// org-mismatch (the gateway-trust path handles org).
interceptor := APIKeyUnaryInterceptor("hk-static")
md := metadata.Pairs("x-api-key", "hk-static", "x-org-id", "any-org")
ctx := metadata.NewIncomingContext(context.Background(), md)
resp, err := interceptor(ctx, "req", mockServerInfo, orgEchoHandler)
assert.NoError(t, err)
// Static path: org context not pinned by the interceptor —
// auth.OrgID returns whatever was in ctx before, which is "".
assert.Equal(t, "", resp)
}