-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmtls_test.go
More file actions
288 lines (256 loc) · 8.18 KB
/
mtls_test.go
File metadata and controls
288 lines (256 loc) · 8.18 KB
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
// Copyright 2025 The Rivaas 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.
//go:build !integration
package app
import (
"crypto/ecdsa"
"crypto/elliptic"
"crypto/rand"
"crypto/tls"
"crypto/x509"
"crypto/x509/pkix"
"errors"
"math/big"
"net/http"
"net/http/httptest"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// errNoTLSConfig is a sentinel for GetConfigForClient returning no custom config (nilnil).
var errNoTLSConfig = errors.New("no TLS config")
// mustGenServerCert returns a minimal tls.Certificate and x509.CertPool for unit tests.
func mustGenServerCert(t *testing.T) (tls.Certificate, *x509.CertPool) {
t.Helper()
key, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
require.NoError(t, err)
template := &x509.Certificate{
SerialNumber: big.NewInt(1),
Subject: pkix.Name{CommonName: "test"},
NotBefore: time.Now(),
NotAfter: time.Now().Add(24 * time.Hour),
KeyUsage: x509.KeyUsageKeyEncipherment | x509.KeyUsageDigitalSignature,
ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth},
BasicConstraintsValid: true,
}
certDER, err := x509.CreateCertificate(rand.Reader, template, template, &key.PublicKey, key)
require.NoError(t, err)
cert, err := x509.ParseCertificate(certDER)
require.NoError(t, err)
pool := x509.NewCertPool()
pool.AddCert(cert)
tlsCert := tls.Certificate{
Certificate: [][]byte{certDER},
PrivateKey: key,
}
return tlsCert, pool
}
func TestNewMTLSConfig_defaults(t *testing.T) {
t.Parallel()
serverCert, pool := mustGenServerCert(t)
cfg := newMTLSConfig(serverCert, WithClientCAs(pool))
require.NotNil(t, cfg)
assert.EqualValues(t, tls.VersionTLS13, cfg.minVersion)
assert.NotNil(t, cfg.clientCAs)
assert.Nil(t, cfg.authorize)
assert.Nil(t, cfg.getCertificate)
assert.Nil(t, cfg.getConfigForClient)
}
func TestNewMTLSConfig_withMinVersion(t *testing.T) {
t.Parallel()
serverCert, pool := mustGenServerCert(t)
cfg := newMTLSConfig(serverCert, WithClientCAs(pool), WithMinVersion(tls.VersionTLS12))
require.NotNil(t, cfg)
assert.EqualValues(t, tls.VersionTLS12, cfg.minVersion)
}
func TestNewMTLSConfig_withMinVersionClampsToTLS12(t *testing.T) {
t.Parallel()
serverCert, pool := mustGenServerCert(t)
cfg := newMTLSConfig(serverCert, WithClientCAs(pool), WithMinVersion(0))
require.NotNil(t, cfg)
assert.EqualValues(t, tls.VersionTLS12, cfg.minVersion)
}
func TestNewMTLSConfig_withAuthorize(t *testing.T) {
t.Parallel()
serverCert, pool := mustGenServerCert(t)
called := false
authorize := func(*x509.Certificate) (string, bool) {
called = true
return "principal", true
}
cfg := newMTLSConfig(serverCert, WithClientCAs(pool), WithAuthorize(authorize))
require.NotNil(t, cfg)
require.NotNil(t, cfg.authorize)
principal, allowed := cfg.authorize(nil)
assert.True(t, called)
assert.Equal(t, "principal", principal)
assert.True(t, allowed)
}
func TestNewMTLSConfig_withSNI(t *testing.T) {
t.Parallel()
serverCert, pool := mustGenServerCert(t)
called := false
sniFn := func(*tls.ClientHelloInfo) (*tls.Certificate, error) {
called = true
return &serverCert, nil
}
cfg := newMTLSConfig(serverCert, WithClientCAs(pool), WithSNI(sniFn))
require.NotNil(t, cfg)
require.NotNil(t, cfg.getCertificate)
cert, err := cfg.getCertificate(nil)
require.NoError(t, err)
assert.True(t, called)
assert.NotNil(t, cert)
}
func TestNewMTLSConfig_withConfigForClient(t *testing.T) {
t.Parallel()
serverCert, pool := mustGenServerCert(t)
called := false
configFn := func(*tls.ClientHelloInfo) (*tls.Config, error) {
called = true
return nil, errNoTLSConfig
}
cfg := newMTLSConfig(serverCert, WithClientCAs(pool), WithConfigForClient(configFn))
require.NotNil(t, cfg)
require.NotNil(t, cfg.getConfigForClient)
_, err := cfg.getConfigForClient(nil)
require.ErrorIs(t, err, errNoTLSConfig)
assert.True(t, called)
}
func TestMTLSConfig_validate(t *testing.T) {
t.Parallel()
serverCert, pool := mustGenServerCert(t)
tests := []struct {
name string
cfg *mtlsConfig
wantErr bool
contains string
}{
{
name: "empty server certificate returns error",
cfg: &mtlsConfig{clientCAs: pool},
wantErr: true,
contains: "server certificate is required",
},
{
name: "nil ClientCAs returns error",
cfg: &mtlsConfig{serverCert: serverCert},
wantErr: true,
contains: "ClientCAs is required",
},
{
name: "valid config returns nil",
cfg: newMTLSConfig(serverCert, WithClientCAs(pool)),
wantErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
err := tt.cfg.validate()
if tt.wantErr {
require.Error(t, err)
assert.ErrorContains(t, err, tt.contains)
return
}
require.NoError(t, err)
})
}
}
func TestMTLSConfig_buildTLSConfig(t *testing.T) {
t.Parallel()
serverCert, pool := mustGenServerCert(t)
cfg := newMTLSConfig(serverCert, WithClientCAs(pool))
tlsCfg := cfg.buildTLSConfig()
require.NotNil(t, tlsCfg)
assert.Equal(t, tls.RequireAndVerifyClientCert, tlsCfg.ClientAuth)
assert.EqualValues(t, tls.VersionTLS13, tlsCfg.MinVersion)
assert.Len(t, tlsCfg.Certificates, 1)
assert.Equal(t, cfg.clientCAs, tlsCfg.ClientCAs)
assert.Nil(t, tlsCfg.GetCertificate)
assert.Nil(t, tlsCfg.GetConfigForClient)
}
func TestMTLSConfig_buildTLSConfig_TLS12SetsCipherSuites(t *testing.T) {
t.Parallel()
serverCert, pool := mustGenServerCert(t)
cfg := newMTLSConfig(serverCert, WithClientCAs(pool), WithMinVersion(tls.VersionTLS12))
tlsCfg := cfg.buildTLSConfig()
require.NotNil(t, tlsCfg)
assert.EqualValues(t, tls.VersionTLS12, tlsCfg.MinVersion)
assert.NotEmpty(t, tlsCfg.CipherSuites)
}
func TestMTLSConfig_buildTLSConfig_withGetCertificate(t *testing.T) {
t.Parallel()
serverCert, pool := mustGenServerCert(t)
sniFn := func(*tls.ClientHelloInfo) (*tls.Certificate, error) { return &serverCert, nil }
cfg := newMTLSConfig(serverCert, WithClientCAs(pool), WithSNI(sniFn))
tlsCfg := cfg.buildTLSConfig()
require.NotNil(t, tlsCfg)
assert.NotNil(t, tlsCfg.GetCertificate)
}
func TestMTLSConfig_buildTLSConfig_withGetConfigForClient(t *testing.T) {
t.Parallel()
serverCert, pool := mustGenServerCert(t)
configFn := func(*tls.ClientHelloInfo) (*tls.Config, error) { return nil, errNoTLSConfig }
cfg := newMTLSConfig(serverCert, WithClientCAs(pool), WithConfigForClient(configFn))
tlsCfg := cfg.buildTLSConfig()
require.NotNil(t, tlsCfg)
assert.NotNil(t, tlsCfg.GetConfigForClient)
}
func TestGetMTLSCertificate(t *testing.T) {
t.Parallel()
_, pool := mustGenServerCert(t)
key, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
require.NoError(t, err)
template := &x509.Certificate{
SerialNumber: big.NewInt(2),
Subject: pkix.Name{CommonName: "client"},
NotBefore: time.Now(),
NotAfter: time.Now().Add(24 * time.Hour),
}
certDER, err := x509.CreateCertificate(rand.Reader, template, template, &key.PublicKey, key)
require.NoError(t, err)
peerCert, err := x509.ParseCertificate(certDER)
require.NoError(t, err)
_ = pool
tests := []struct {
name string
req *http.Request
want *x509.Certificate
}{
{
name: "nil TLS returns nil",
req: httptest.NewRequest(http.MethodGet, "/", nil),
want: nil,
},
{
name: "empty PeerCertificates returns nil",
req: &http.Request{TLS: &tls.ConnectionState{PeerCertificates: nil}},
want: nil,
},
{
name: "one peer cert returns first cert",
req: &http.Request{TLS: &tls.ConnectionState{PeerCertificates: []*x509.Certificate{peerCert}}},
want: peerCert,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
got := GetMTLSCertificate(tt.req)
assert.Equal(t, tt.want, got)
})
}
}