-
-
Notifications
You must be signed in to change notification settings - Fork 24
Expand file tree
/
Copy pathauth_test.go
More file actions
575 lines (498 loc) · 14.8 KB
/
auth_test.go
File metadata and controls
575 lines (498 loc) · 14.8 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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
// Zaparoo Core
// Copyright (c) 2026 The Zaparoo Project Contributors.
// SPDX-License-Identifier: GPL-3.0-or-later
//
// This file is part of Zaparoo Core.
//
// Zaparoo Core is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Zaparoo Core is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Zaparoo Core. If not, see <http://www.gnu.org/licenses/>.
package middleware
import (
"context"
"net/http"
"net/http/httptest"
"testing"
"github.com/stretchr/testify/assert"
)
// keysProvider wraps a slice as an APIKeyProvider for testing.
func keysProvider(keys []string) APIKeyProvider {
return func() []string { return keys }
}
func TestNewAuthConfig(t *testing.T) {
t.Parallel()
tests := []struct {
name string
keys []string
wantEnabled bool
}{
{
name: "no keys - auth disabled",
keys: nil,
wantEnabled: false,
},
{
name: "empty slice - auth disabled",
keys: []string{},
wantEnabled: false,
},
{
name: "with keys - auth enabled",
keys: []string{"key1", "key2"},
wantEnabled: true,
},
{
name: "empty strings filtered out",
keys: []string{"", "key1", ""},
wantEnabled: true,
},
{
name: "all empty strings - auth disabled",
keys: []string{"", "", ""},
wantEnabled: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
cfg := NewAuthConfig(keysProvider(tt.keys))
assert.NotNil(t, cfg)
assert.Equal(t, tt.wantEnabled, cfg.Enabled())
})
}
}
func TestAuthConfig_IsValidKey(t *testing.T) {
t.Parallel()
tests := []struct {
name string
checkKey string
keys []string
expected bool
}{
{
name: "valid key",
keys: []string{"secret-key-123"},
checkKey: "secret-key-123",
expected: true,
},
{
name: "invalid key",
keys: []string{"secret-key-123"},
checkKey: "wrong-key",
expected: false,
},
{
name: "empty key rejected",
keys: []string{"secret-key-123"},
checkKey: "",
expected: false,
},
{
name: "multiple keys, first matches",
keys: []string{"key1", "key2", "key3"},
checkKey: "key1",
expected: true,
},
{
name: "multiple keys, last matches",
keys: []string{"key1", "key2", "key3"},
checkKey: "key3",
expected: true,
},
{
name: "multiple keys, none match",
keys: []string{"key1", "key2", "key3"},
checkKey: "key4",
expected: false,
},
{
name: "no keys configured",
keys: []string{},
checkKey: "any-key",
expected: false,
},
{
name: "key with special characters",
keys: []string{"key!@#$%^&*()_+-="},
checkKey: "key!@#$%^&*()_+-=",
expected: true,
},
{
name: "case sensitive",
keys: []string{"SecretKey"},
checkKey: "secretkey",
expected: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
cfg := NewAuthConfig(keysProvider(tt.keys))
result := cfg.IsValidKey(tt.checkKey)
assert.Equal(t, tt.expected, result,
"IsValidKey(%q) with keys %v: expected %v, got %v",
tt.checkKey, tt.keys, tt.expected, result)
})
}
}
func TestHTTPAuthMiddleware(t *testing.T) {
t.Parallel()
tests := []struct {
name string
authHeader string
queryParam string
expectedBody string
keys []string
expectedStatus int
}{
{
name: "no keys configured - pass through",
keys: []string{},
authHeader: "",
queryParam: "",
expectedStatus: http.StatusOK,
expectedBody: "OK",
},
{
name: "keys configured, no key provided",
keys: []string{"secret"},
authHeader: "",
queryParam: "",
expectedStatus: http.StatusUnauthorized,
expectedBody: "Unauthorized: API key required\n",
},
{
name: "keys configured, invalid key via header",
keys: []string{"secret"},
authHeader: "Bearer wrong-key",
queryParam: "",
expectedStatus: http.StatusUnauthorized,
expectedBody: "Unauthorized: Invalid API key\n",
},
{
name: "keys configured, valid key via header",
keys: []string{"secret"},
authHeader: "Bearer secret",
queryParam: "",
expectedStatus: http.StatusOK,
expectedBody: "OK",
},
{
name: "keys configured, valid key via query param",
keys: []string{"secret"},
authHeader: "",
queryParam: "secret",
expectedStatus: http.StatusOK,
expectedBody: "OK",
},
{
name: "keys configured, invalid key via query param",
keys: []string{"secret"},
authHeader: "",
queryParam: "wrong",
expectedStatus: http.StatusUnauthorized,
expectedBody: "Unauthorized: Invalid API key\n",
},
{
name: "header takes precedence over query param",
keys: []string{"secret"},
authHeader: "Bearer secret",
queryParam: "wrong",
expectedStatus: http.StatusOK,
expectedBody: "OK",
},
{
name: "wrong auth scheme - falls back to query param",
keys: []string{"secret"},
authHeader: "Basic secret",
queryParam: "",
expectedStatus: http.StatusUnauthorized,
expectedBody: "Unauthorized: API key required\n",
},
{
name: "multiple keys, second key valid",
keys: []string{"key1", "key2", "key3"},
authHeader: "Bearer key2",
queryParam: "",
expectedStatus: http.StatusOK,
expectedBody: "OK",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
cfg := NewAuthConfig(keysProvider(tt.keys))
middleware := HTTPAuthMiddleware(cfg)
handler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte("OK"))
})
wrapped := middleware(handler)
url := "/test"
if tt.queryParam != "" {
url += "?key=" + tt.queryParam
}
req := httptest.NewRequestWithContext(context.Background(), http.MethodGet, url, http.NoBody)
if tt.authHeader != "" {
req.Header.Set("Authorization", tt.authHeader)
}
recorder := httptest.NewRecorder()
wrapped.ServeHTTP(recorder, req)
assert.Equal(t, tt.expectedStatus, recorder.Code,
"expected status %d, got %d", tt.expectedStatus, recorder.Code)
assert.Equal(t, tt.expectedBody, recorder.Body.String(),
"expected body %q, got %q", tt.expectedBody, recorder.Body.String())
})
}
}
func TestWebSocketAuthHandler(t *testing.T) {
t.Parallel()
tests := []struct {
name string
authHeader string
queryParam string
keys []string
expected bool
}{
{
name: "no keys configured - allowed",
keys: []string{},
authHeader: "",
queryParam: "",
expected: true,
},
{
name: "keys configured, no key provided",
keys: []string{"secret"},
authHeader: "",
queryParam: "",
expected: false,
},
{
name: "keys configured, valid key via header",
keys: []string{"secret"},
authHeader: "Bearer secret",
queryParam: "",
expected: true,
},
{
name: "keys configured, valid key via query param",
keys: []string{"secret"},
authHeader: "",
queryParam: "secret",
expected: true,
},
{
name: "keys configured, invalid key",
keys: []string{"secret"},
authHeader: "Bearer wrong",
queryParam: "",
expected: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
cfg := NewAuthConfig(keysProvider(tt.keys))
url := "/ws"
if tt.queryParam != "" {
url += "?key=" + tt.queryParam
}
req := httptest.NewRequestWithContext(context.Background(), http.MethodGet, url, http.NoBody)
if tt.authHeader != "" {
req.Header.Set("Authorization", tt.authHeader)
}
result := WebSocketAuthHandler(cfg, req)
assert.Equal(t, tt.expected, result,
"WebSocketAuthHandler expected %v, got %v", tt.expected, result)
})
}
}
func TestHTTPAuthMiddleware_Integration(t *testing.T) {
t.Parallel()
cfg := NewAuthConfig(keysProvider([]string{"valid-key"}))
authMiddleware := HTTPAuthMiddleware(cfg)
callCount := 0
testMiddleware := func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
callCount++
next.ServeHTTP(w, r)
})
}
handler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte("OK"))
})
// Chain: auth -> testMiddleware -> handler
wrapped := authMiddleware(testMiddleware(handler))
// Test valid key - should reach all middlewares and handler
callCount = 0
req := httptest.NewRequestWithContext(context.Background(), http.MethodGet, "/test", http.NoBody)
req.Header.Set("Authorization", "Bearer valid-key")
recorder := httptest.NewRecorder()
wrapped.ServeHTTP(recorder, req)
assert.Equal(t, http.StatusOK, recorder.Code)
assert.Equal(t, 1, callCount, "testMiddleware should be called once")
// Test invalid key - should not reach subsequent middlewares or handler
callCount = 0
req = httptest.NewRequestWithContext(context.Background(), http.MethodGet, "/test", http.NoBody)
req.Header.Set("Authorization", "Bearer invalid-key")
recorder = httptest.NewRecorder()
wrapped.ServeHTTP(recorder, req)
assert.Equal(t, http.StatusUnauthorized, recorder.Code)
assert.Equal(t, 0, callCount, "testMiddleware should not be called for invalid key")
// Test no key - should not reach subsequent middlewares or handler
callCount = 0
req = httptest.NewRequestWithContext(context.Background(), http.MethodGet, "/test", http.NoBody)
recorder = httptest.NewRecorder()
wrapped.ServeHTTP(recorder, req)
assert.Equal(t, http.StatusUnauthorized, recorder.Code)
assert.Equal(t, 0, callCount, "testMiddleware should not be called for missing key")
}
func TestHTTPAuthMiddleware_LocalhostExempt(t *testing.T) {
t.Parallel()
tests := []struct {
name string
remoteAddr string
expectedStatus int
}{
{
name: "IPv4 loopback allowed without key",
remoteAddr: "127.0.0.1:12345",
expectedStatus: http.StatusOK,
},
{
name: "IPv6 loopback allowed without key",
remoteAddr: "[::1]:12345",
expectedStatus: http.StatusOK,
},
{
name: "non-loopback requires key",
remoteAddr: "192.168.1.100:12345",
expectedStatus: http.StatusUnauthorized,
},
{
name: "public IP requires key",
remoteAddr: "8.8.8.8:12345",
expectedStatus: http.StatusUnauthorized,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
cfg := NewAuthConfig(keysProvider([]string{"secret-key"}))
middleware := HTTPAuthMiddleware(cfg)
handler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte("OK"))
})
wrapped := middleware(handler)
req := httptest.NewRequestWithContext(context.Background(), http.MethodGet, "/test", http.NoBody)
req.RemoteAddr = tt.remoteAddr
recorder := httptest.NewRecorder()
wrapped.ServeHTTP(recorder, req)
assert.Equal(t, tt.expectedStatus, recorder.Code)
})
}
}
func TestWebSocketAuthHandler_LocalhostExempt(t *testing.T) {
t.Parallel()
tests := []struct {
name string
remoteAddr string
expected bool
}{
{
name: "IPv4 loopback allowed without key",
remoteAddr: "127.0.0.1:12345",
expected: true,
},
{
name: "IPv6 loopback allowed without key",
remoteAddr: "[::1]:12345",
expected: true,
},
{
name: "non-loopback requires key",
remoteAddr: "192.168.1.100:12345",
expected: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
cfg := NewAuthConfig(keysProvider([]string{"secret-key"}))
req := httptest.NewRequestWithContext(context.Background(), http.MethodGet, "/ws", http.NoBody)
req.RemoteAddr = tt.remoteAddr
result := WebSocketAuthHandler(cfg, req)
assert.Equal(t, tt.expected, result)
})
}
}
func TestAuthConfig_HotReload(t *testing.T) {
t.Parallel()
// Mutable key store to simulate config reload
keys := []string{"initial-key"}
provider := func() []string { return keys }
cfg := NewAuthConfig(provider)
// Initial state: "initial-key" is valid
assert.True(t, cfg.Enabled())
assert.True(t, cfg.IsValidKey("initial-key"))
assert.False(t, cfg.IsValidKey("new-key"))
// Simulate config reload: add new key
keys = []string{"initial-key", "new-key"}
// Both keys should now be valid without recreating AuthConfig
assert.True(t, cfg.IsValidKey("initial-key"))
assert.True(t, cfg.IsValidKey("new-key"))
// Simulate config reload: remove initial key
keys = []string{"new-key"}
// Only new-key should be valid now
assert.False(t, cfg.IsValidKey("initial-key"))
assert.True(t, cfg.IsValidKey("new-key"))
// Simulate config reload: remove all keys (disable auth)
keys = []string{}
assert.False(t, cfg.Enabled())
}
func TestHTTPAuthMiddleware_HotReload(t *testing.T) {
t.Parallel()
keys := []string{"secret"}
provider := func() []string { return keys }
cfg := NewAuthConfig(provider)
middleware := HTTPAuthMiddleware(cfg)
handler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusOK)
})
wrapped := middleware(handler)
// Request with valid key should succeed
req := httptest.NewRequestWithContext(context.Background(), http.MethodGet, "/test", http.NoBody)
req.RemoteAddr = "192.168.1.100:12345" // Non-localhost to require auth
req.Header.Set("Authorization", "Bearer secret")
recorder := httptest.NewRecorder()
wrapped.ServeHTTP(recorder, req)
assert.Equal(t, http.StatusOK, recorder.Code)
// Simulate config reload: change the key
keys = []string{"new-secret"}
// Old key should now fail
req = httptest.NewRequestWithContext(context.Background(), http.MethodGet, "/test", http.NoBody)
req.RemoteAddr = "192.168.1.100:12345"
req.Header.Set("Authorization", "Bearer secret")
recorder = httptest.NewRecorder()
wrapped.ServeHTTP(recorder, req)
assert.Equal(t, http.StatusUnauthorized, recorder.Code)
// New key should succeed
req = httptest.NewRequestWithContext(context.Background(), http.MethodGet, "/test", http.NoBody)
req.RemoteAddr = "192.168.1.100:12345"
req.Header.Set("Authorization", "Bearer new-secret")
recorder = httptest.NewRecorder()
wrapped.ServeHTTP(recorder, req)
assert.Equal(t, http.StatusOK, recorder.Code)
}