1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
package grpctool_test
import (
"context"
"os"
"testing"
"time"
"github.com/golang-jwt/jwt/v5"
"github.com/golang/mock/gomock"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/grpctool"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/testing/mock_rpc"
"go.uber.org/zap"
"go.uber.org/zap/zaptest"
"google.golang.org/grpc"
"google.golang.org/grpc/metadata"
)
const (
jwtAudience = "valid_audience"
jwtIssuer = "valid_issuer"
jwtValidFor = 5 * time.Second
jwtNotBefore = 1 * time.Second
expectedReq int32 = 345
expectedResult int16 = 125
expectedSrv int32 = 13123
)
var (
secret = []byte("some random secret")
)
func TestJWTServerAuth(t *testing.T) {
unaryInfo := &grpc.UnaryServerInfo{
FullMethod: "bla",
}
streamInfo := &grpc.StreamServerInfo{
FullMethod: "bla",
}
t.Run("happy path", func(t *testing.T) {
jwtAuther := setupAuther(t)
now := time.Now()
claims := validClams(now)
signedClaims, err := jwt.NewWithClaims(jwt.SigningMethodHS256, claims).SignedString(secret)
require.NoError(t, err)
ctx := metadata.NewIncomingContext(context.Background(), metadata.Pairs("authorization", "bearer "+signedClaims))
result, err := jwtAuther.UnaryServerInterceptor(ctx, expectedReq, unaryInfo, unaryHandler(ctx, t))
require.NoError(t, err)
assert.Equal(t, expectedResult, result)
ctrl := gomock.NewController(t)
stream := mock_rpc.NewMockServerStream(ctrl)
stream.EXPECT().Context().Return(ctx)
err = jwtAuther.StreamServerInterceptor(expectedSrv, stream, streamInfo, streamHandler(stream, t))
require.NoError(t, err)
})
t.Run("missing header", func(t *testing.T) {
jwtAuther := setupAuther(t)
_, err := jwtAuther.UnaryServerInterceptor(context.Background(), expectedReq, unaryInfo, unaryMustNotBeCalled(t))
require.EqualError(t, err, "rpc error: code = Unauthenticated desc = Request unauthenticated with bearer")
ctrl := gomock.NewController(t)
stream := mock_rpc.NewMockServerStream(ctrl)
stream.EXPECT().Context().Return(context.Background())
err = jwtAuther.StreamServerInterceptor(expectedSrv, stream, streamInfo, streamMustNotBeCalled(t))
require.EqualError(t, err, "rpc error: code = Unauthenticated desc = Request unauthenticated with bearer")
})
t.Run("invalid token type", func(t *testing.T) {
jwtAuther := setupAuther(t)
now := time.Now()
claims := validClams(now)
signedClaims, err := jwt.NewWithClaims(jwt.SigningMethodHS256, claims).SignedString(secret)
require.NoError(t, err)
ctx := metadata.NewIncomingContext(context.Background(), metadata.Pairs("authorization", "weird_type "+signedClaims))
_, err = jwtAuther.UnaryServerInterceptor(ctx, expectedReq, unaryInfo, unaryMustNotBeCalled(t))
require.EqualError(t, err, "rpc error: code = Unauthenticated desc = Request unauthenticated with bearer")
ctrl := gomock.NewController(t)
stream := mock_rpc.NewMockServerStream(ctrl)
stream.EXPECT().Context().Return(ctx)
err = jwtAuther.StreamServerInterceptor(expectedSrv, stream, streamInfo, streamMustNotBeCalled(t))
require.EqualError(t, err, "rpc error: code = Unauthenticated desc = Request unauthenticated with bearer")
})
t.Run("unexpected signing algorithm", func(t *testing.T) {
jwtAuther := setupAuther(t)
now := time.Now()
claims := validClams(now)
keyData, err := os.ReadFile("testdata/sample_key")
require.NoError(t, err)
rsaKey, err := jwt.ParseRSAPrivateKeyFromPEM(keyData)
require.NoError(t, err)
signedClaims, err := jwt.NewWithClaims(jwt.SigningMethodRS256, claims).SignedString(rsaKey)
require.NoError(t, err)
assertValidationFailed(t, signedClaims, jwtAuther)
})
t.Run("none signing algorithm", func(t *testing.T) {
jwtAuther := setupAuther(t)
now := time.Now()
claims := validClams(now)
signedClaims, err := jwt.NewWithClaims(jwt.SigningMethodNone, claims).SignedString(jwt.UnsafeAllowNoneSignatureType)
require.NoError(t, err)
assertValidationFailed(t, signedClaims, jwtAuther)
})
t.Run("unexpected audience", func(t *testing.T) {
jwtAuther := setupAuther(t)
now := time.Now()
claims := validClams(now)
claims.Audience = jwt.ClaimStrings{"blablabla"}
signedClaims, err := jwt.NewWithClaims(jwt.SigningMethodHS256, claims).SignedString(secret)
require.NoError(t, err)
assertValidationFailed(t, signedClaims, jwtAuther)
})
t.Run("unexpected issuer", func(t *testing.T) {
jwtAuther := setupAuther(t)
now := time.Now()
claims := validClams(now)
claims.Issuer = "blablabla"
signedClaims, err := jwt.NewWithClaims(jwt.SigningMethodHS256, claims).SignedString(secret)
require.NoError(t, err)
assertValidationFailed(t, signedClaims, jwtAuther)
})
}
func setupAuther(t *testing.T) *grpctool.JWTAuther {
return grpctool.NewJWTAuther(secret, jwtIssuer, jwtAudience, func(ctx context.Context) *zap.Logger {
return zaptest.NewLogger(t)
})
}
func assertValidationFailed(t *testing.T, signedClaims string, jwtAuther *grpctool.JWTAuther) {
unaryInfo := &grpc.UnaryServerInfo{
FullMethod: "bla",
}
streamInfo := &grpc.StreamServerInfo{
FullMethod: "bla",
}
ctx := metadata.NewIncomingContext(context.Background(), metadata.Pairs("authorization", "bearer "+signedClaims))
_, err := jwtAuther.UnaryServerInterceptor(ctx, expectedReq, unaryInfo, unaryMustNotBeCalled(t))
require.EqualError(t, err, "rpc error: code = Unauthenticated desc = JWT validation failed")
ctrl := gomock.NewController(t)
stream := mock_rpc.NewMockServerStream(ctrl)
stream.EXPECT().Context().Return(ctx)
err = jwtAuther.StreamServerInterceptor(expectedSrv, stream, streamInfo, streamMustNotBeCalled(t))
require.EqualError(t, err, "rpc error: code = Unauthenticated desc = JWT validation failed")
}
func validClams(now time.Time) jwt.RegisteredClaims {
claims := jwt.RegisteredClaims{
Issuer: jwtIssuer,
Audience: jwt.ClaimStrings{jwtAudience},
ExpiresAt: jwt.NewNumericDate(now.Add(jwtValidFor)),
NotBefore: jwt.NewNumericDate(now.Add(-jwtNotBefore)),
IssuedAt: jwt.NewNumericDate(now),
}
return claims
}
func unaryHandler(expectedCtx context.Context, t *testing.T) grpc.UnaryHandler {
return func(ctx context.Context, req interface{}) (interface{}, error) {
assert.Equal(t, expectedReq, req)
assert.Equal(t, expectedCtx, ctx)
return expectedResult, nil
}
}
func streamHandler(expectedStream grpc.ServerStream, t *testing.T) grpc.StreamHandler {
return func(srv interface{}, stream grpc.ServerStream) error {
assert.Equal(t, expectedSrv, srv)
assert.Equal(t, expectedStream, stream)
return nil
}
}
func unaryMustNotBeCalled(t *testing.T) grpc.UnaryHandler {
return func(ctx context.Context, req interface{}) (interface{}, error) {
require.FailNow(t, "handler must not be called")
return nil, nil
}
}
func streamMustNotBeCalled(t *testing.T) grpc.StreamHandler {
return func(srv interface{}, stream grpc.ServerStream) error {
require.FailNow(t, "handler must not be called")
return nil
}
}
|
