forked from adamlaska/boulder
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathva_test.go
More file actions
768 lines (678 loc) · 24 KB
/
va_test.go
File metadata and controls
768 lines (678 loc) · 24 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
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
package va
import (
"context"
"crypto/rsa"
"encoding/base64"
"errors"
"fmt"
"math/big"
"net"
"net/http"
"net/http/httptest"
"os"
"strings"
"sync"
"syscall"
"testing"
"time"
"github.com/jmhodges/clock"
"github.com/letsencrypt/boulder/bdns"
"github.com/letsencrypt/boulder/cmd"
"github.com/letsencrypt/boulder/core"
corepb "github.com/letsencrypt/boulder/core/proto"
"github.com/letsencrypt/boulder/features"
"github.com/letsencrypt/boulder/identifier"
blog "github.com/letsencrypt/boulder/log"
"github.com/letsencrypt/boulder/metrics"
"github.com/letsencrypt/boulder/probs"
"github.com/letsencrypt/boulder/test"
vapb "github.com/letsencrypt/boulder/va/proto"
"github.com/prometheus/client_golang/prometheus"
"google.golang.org/grpc"
"gopkg.in/square/go-jose.v2"
)
var expectedToken = "LoqXcYV8q5ONbJQxbmR7SCTNo3tiAXDfowyjxAjEuX0"
var expectedKeyAuthorization = "LoqXcYV8q5ONbJQxbmR7SCTNo3tiAXDfowyjxAjEuX0.9jg46WB3rR_AHD-EBXdN7cBkH1WOu0tA3M9fm21mqTI"
func bigIntFromB64(b64 string) *big.Int {
bytes, _ := base64.URLEncoding.DecodeString(b64)
x := big.NewInt(0)
x.SetBytes(bytes)
return x
}
func intFromB64(b64 string) int {
return int(bigIntFromB64(b64).Int64())
}
var n = bigIntFromB64("n4EPtAOCc9AlkeQHPzHStgAbgs7bTZLwUBZdR8_KuKPEHLd4rHVTeT-O-XV2jRojdNhxJWTDvNd7nqQ0VEiZQHz_AJmSCpMaJMRBSFKrKb2wqVwGU_NsYOYL-QtiWN2lbzcEe6XC0dApr5ydQLrHqkHHig3RBordaZ6Aj-oBHqFEHYpPe7Tpe-OfVfHd1E6cS6M1FZcD1NNLYD5lFHpPI9bTwJlsde3uhGqC0ZCuEHg8lhzwOHrtIQbS0FVbb9k3-tVTU4fg_3L_vniUFAKwuCLqKnS2BYwdq_mzSnbLY7h_qixoR7jig3__kRhuaxwUkRz5iaiQkqgc5gHdrNP5zw==")
var e = intFromB64("AQAB")
var d = bigIntFromB64("bWUC9B-EFRIo8kpGfh0ZuyGPvMNKvYWNtB_ikiH9k20eT-O1q_I78eiZkpXxXQ0UTEs2LsNRS-8uJbvQ-A1irkwMSMkK1J3XTGgdrhCku9gRldY7sNA_AKZGh-Q661_42rINLRCe8W-nZ34ui_qOfkLnK9QWDDqpaIsA-bMwWWSDFu2MUBYwkHTMEzLYGqOe04noqeq1hExBTHBOBdkMXiuFhUq1BU6l-DqEiWxqg82sXt2h-LMnT3046AOYJoRioz75tSUQfGCshWTBnP5uDjd18kKhyv07lhfSJdrPdM5Plyl21hsFf4L_mHCuoFau7gdsPfHPxxjVOcOpBrQzwQ==")
var p = bigIntFromB64("uKE2dh-cTf6ERF4k4e_jy78GfPYUIaUyoSSJuBzp3Cubk3OCqs6grT8bR_cu0Dm1MZwWmtdqDyI95HrUeq3MP15vMMON8lHTeZu2lmKvwqW7anV5UzhM1iZ7z4yMkuUwFWoBvyY898EXvRD-hdqRxHlSqAZ192zB3pVFJ0s7pFc=")
var q = bigIntFromB64("uKE2dh-cTf6ERF4k4e_jy78GfPYUIaUyoSSJuBzp3Cubk3OCqs6grT8bR_cu0Dm1MZwWmtdqDyI95HrUeq3MP15vMMON8lHTeZu2lmKvwqW7anV5UzhM1iZ7z4yMkuUwFWoBvyY898EXvRD-hdqRxHlSqAZ192zB3pVFJ0s7pFc=")
var TheKey = rsa.PrivateKey{
PublicKey: rsa.PublicKey{N: n, E: e},
D: d,
Primes: []*big.Int{p, q},
}
var accountKey = &jose.JSONWebKey{Key: TheKey.Public()}
// Return an ACME DNS identifier for the given hostname
func dnsi(hostname string) identifier.ACMEIdentifier {
return identifier.DNSIdentifier(hostname)
}
var ctx context.Context
func TestMain(m *testing.M) {
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(context.Background(), 10*time.Minute)
ret := m.Run()
cancel()
os.Exit(ret)
}
var accountURIPrefixes = []string{"http://boulder:4000/acme/reg/"}
func createValidationRequest(domain string, challengeType core.AcmeChallenge) *vapb.PerformValidationRequest {
return &vapb.PerformValidationRequest{
Domain: domain,
Challenge: &corepb.Challenge{
Type: string(challengeType),
Status: string(core.StatusPending),
Token: expectedToken,
Validationrecords: nil,
KeyAuthorization: expectedKeyAuthorization,
},
Authz: &vapb.AuthzMeta{
Id: "",
RegID: 0,
},
}
}
func createChallenge(challengeType core.AcmeChallenge) core.Challenge {
return core.Challenge{
Type: challengeType,
Status: core.StatusPending,
Token: expectedToken,
ValidationRecord: []core.ValidationRecord{},
ProvidedKeyAuthorization: expectedKeyAuthorization,
}
}
// setChallengeToken sets the token value, and sets the ProvidedKeyAuthorization
// to match.
func setChallengeToken(ch *core.Challenge, token string) {
ch.Token = token
ch.ProvidedKeyAuthorization = token + ".9jg46WB3rR_AHD-EBXdN7cBkH1WOu0tA3M9fm21mqTI"
}
func setup(srv *httptest.Server, maxRemoteFailures int, userAgent string, remoteVAs []RemoteVA) (*ValidationAuthorityImpl, *blog.Mock) {
features.Reset()
fc := clock.NewFake()
logger := blog.NewMock()
if userAgent == "" {
userAgent = "user agent 1.0"
}
var portConfig cmd.PortConfig
if srv != nil {
port := getPort(srv)
portConfig = cmd.PortConfig{
HTTPPort: port,
TLSPort: port,
}
}
va, err := NewValidationAuthorityImpl(
// Use the test server's port as both the HTTPPort and the TLSPort for the VA
&portConfig,
&bdns.MockClient{Log: logger},
nil,
maxRemoteFailures,
userAgent,
"letsencrypt.org",
metrics.NoopRegisterer,
fc,
logger,
accountURIPrefixes,
)
if err != nil {
panic(fmt.Sprintf("Failed to create validation authority: %v", err))
}
if remoteVAs != nil {
va.remoteVAs = remoteVAs
}
return va, logger
}
func setupRemote(srv *httptest.Server, maxRemoteFailures int, userAgent string) (vapb.VAClient, *blog.Mock) {
innerVA, mockLog := setup(srv, maxRemoteFailures, userAgent, nil)
res := localRemoteVA{
remote: *innerVA,
}
return &res, mockLog
}
type multiSrv struct {
*httptest.Server
mu sync.Mutex
allowedUAs map[string]bool
}
func (s *multiSrv) setAllowedUAs(allowedUAs map[string]bool) {
s.mu.Lock()
defer s.mu.Unlock()
s.allowedUAs = allowedUAs
}
const slowRemoteSleepMillis = 1000
func httpMultiSrv(t *testing.T, token string, allowedUAs map[string]bool) *multiSrv {
m := http.NewServeMux()
server := httptest.NewUnstartedServer(m)
ms := &multiSrv{server, sync.Mutex{}, allowedUAs}
m.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
if r.UserAgent() == "slow remote" {
time.Sleep(slowRemoteSleepMillis)
}
ms.mu.Lock()
defer ms.mu.Unlock()
if ms.allowedUAs[r.UserAgent()] {
ch := core.Challenge{Token: token}
keyAuthz, _ := ch.ExpectedKeyAuthorization(accountKey)
fmt.Fprint(w, keyAuthz, "\n\r \t")
} else {
fmt.Fprint(w, "???")
}
})
ms.Start()
return ms
}
// cancelledVA is a mock that always returns context.Canceled for
// PerformValidation calls
type cancelledVA struct{}
func (v cancelledVA) PerformValidation(_ context.Context, _ *vapb.PerformValidationRequest, _ ...grpc.CallOption) (*vapb.ValidationResult, error) {
return nil, context.Canceled
}
// brokenRemoteVA is a mock for the vapb.VAClient interface mocked to
// always return errors.
type brokenRemoteVA struct{}
// errBrokenRemoteVA is the error returned by a brokenRemoteVA's
// PerformValidation and IsSafeDomain functions.
var errBrokenRemoteVA = errors.New("brokenRemoteVA is broken")
// PerformValidation returns errBrokenRemoteVA unconditionally
func (b brokenRemoteVA) PerformValidation(_ context.Context, _ *vapb.PerformValidationRequest, _ ...grpc.CallOption) (*vapb.ValidationResult, error) {
return nil, errBrokenRemoteVA
}
// localRemoteVA is a wrapper which fulfills the VAClient interface, but then
// forwards requests directly to its inner ValidationAuthorityImpl rather than
// over the network. This lets a local in-memory mock VA act like a remote VA.
type localRemoteVA struct {
remote ValidationAuthorityImpl
}
func (lrva localRemoteVA) PerformValidation(ctx context.Context, req *vapb.PerformValidationRequest, _ ...grpc.CallOption) (*vapb.ValidationResult, error) {
return lrva.remote.PerformValidation(ctx, req)
}
func TestValidateMalformedChallenge(t *testing.T) {
va, _ := setup(nil, 0, "", nil)
_, prob := va.validateChallenge(ctx, dnsi("example.com"), createChallenge("fake-type-01"))
test.AssertEquals(t, prob.Type, probs.MalformedProblem)
}
func TestPerformValidationInvalid(t *testing.T) {
va, _ := setup(nil, 0, "", nil)
req := createValidationRequest("foo.com", core.ChallengeTypeDNS01)
res, _ := va.PerformValidation(context.Background(), req)
test.Assert(t, res.Problems != nil, "validation succeeded")
test.AssertMetricWithLabelsEquals(t, va.metrics.validationTime, prometheus.Labels{
"type": "dns-01",
"result": "invalid",
"problem_type": "unauthorized",
}, 1)
}
func TestPerformValidationValid(t *testing.T) {
va, mockLog := setup(nil, 0, "", nil)
// create a challenge with well known token
req := createValidationRequest("good-dns01.com", core.ChallengeTypeDNS01)
res, _ := va.PerformValidation(context.Background(), req)
test.Assert(t, res.Problems == nil, fmt.Sprintf("validation failed: %#v", res.Problems))
test.AssertMetricWithLabelsEquals(t, va.metrics.validationTime, prometheus.Labels{
"type": "dns-01",
"result": "valid",
"problem_type": "",
}, 1)
resultLog := mockLog.GetAllMatching(`Validation result`)
if len(resultLog) != 1 {
t.Fatalf("Wrong number of matching lines for 'Validation result'")
}
if !strings.Contains(resultLog[0], `"Hostname":"good-dns01.com"`) {
t.Error("PerformValidation didn't log validation hostname.")
}
}
// TestPerformValidationWildcard tests that the VA properly strips the `*.`
// prefix from a wildcard name provided to the PerformValidation function.
func TestPerformValidationWildcard(t *testing.T) {
va, mockLog := setup(nil, 0, "", nil)
// create a challenge with well known token
req := createValidationRequest("*.good-dns01.com", core.ChallengeTypeDNS01)
// perform a validation for a wildcard name
res, _ := va.PerformValidation(context.Background(), req)
test.Assert(t, res.Problems == nil, fmt.Sprintf("validation failed: %#v", res.Problems))
test.AssertMetricWithLabelsEquals(t, va.metrics.validationTime, prometheus.Labels{
"type": "dns-01",
"result": "valid",
"problem_type": "",
}, 1)
resultLog := mockLog.GetAllMatching(`Validation result`)
if len(resultLog) != 1 {
t.Fatalf("Wrong number of matching lines for 'Validation result'")
}
// We expect that the top level Hostname reflect the wildcard name
if !strings.Contains(resultLog[0], `"Hostname":"*.good-dns01.com"`) {
t.Errorf("PerformValidation didn't log correct validation hostname.")
}
// We expect that the ValidationRecord contain the correct non-wildcard
// hostname that was validated
if !strings.Contains(resultLog[0], `"hostname":"good-dns01.com"`) {
t.Errorf("PerformValidation didn't log correct validation record hostname.")
}
}
func TestMultiVA(t *testing.T) {
// Create a new challenge to use for the httpSrv
req := createValidationRequest("localhost", core.ChallengeTypeHTTP01)
const (
remoteUA1 = "remote 1"
remoteUA2 = "remote 2"
localUA = "local 1"
)
allowedUAs := map[string]bool{
localUA: true,
remoteUA1: true,
remoteUA2: true,
}
// Create an IPv4 test server
ms := httpMultiSrv(t, expectedToken, allowedUAs)
defer ms.Close()
remoteVA1, _ := setupRemote(ms.Server, 0, remoteUA1)
remoteVA2, _ := setupRemote(ms.Server, 0, remoteUA2)
remoteVAs := []RemoteVA{
{remoteVA1, remoteUA1},
{remoteVA2, remoteUA2},
}
enforceMultiVA := map[string]bool{
"EnforceMultiVA": true,
}
enforceMultiVAFullResults := map[string]bool{
"EnforceMultiVA": true,
"MultiVAFullResults": true,
}
noEnforceMultiVA := map[string]bool{
"EnforceMultiVA": false,
}
noEnforceMultiVAFullResults := map[string]bool{
"EnforceMultiVA": false,
"MultiVAFullResults": true,
}
unauthorized := probs.Unauthorized(fmt.Sprintf(
`The key authorization file from the server did not match this challenge %q != "???"`,
expectedKeyAuthorization))
expectedInternalErrLine := fmt.Sprintf(
`ERR: \[AUDIT\] Remote VA "broken".PerformValidation failed: %s`,
errBrokenRemoteVA.Error())
testCases := []struct {
Name string
RemoteVAs []RemoteVA
AllowedUAs map[string]bool
Features map[string]bool
ExpectedProb *probs.ProblemDetails
ExpectedLog string
}{
{
// With local and both remote VAs working there should be no problem.
Name: "Local and remote VAs OK, enforce multi VA",
RemoteVAs: remoteVAs,
AllowedUAs: allowedUAs,
Features: enforceMultiVA,
},
{
// Ditto if multi VA enforcement is disabled
Name: "Local and remote VAs OK, no enforce multi VA",
RemoteVAs: remoteVAs,
AllowedUAs: allowedUAs,
Features: noEnforceMultiVA,
},
{
// If the local VA fails everything should fail
Name: "Local VA bad, remote VAs OK, no enforce multi VA",
RemoteVAs: remoteVAs,
AllowedUAs: map[string]bool{remoteUA1: true, remoteUA2: true},
Features: noEnforceMultiVA,
ExpectedProb: unauthorized,
},
{
// Ditto when enforcing remote VA
Name: "Local VA bad, remote VAs OK, enforce multi VA",
RemoteVAs: remoteVAs,
AllowedUAs: map[string]bool{remoteUA1: true, remoteUA2: true},
Features: enforceMultiVA,
ExpectedProb: unauthorized,
},
{
// If a remote VA fails with an internal err it should fail when enforcing multi VA
Name: "Local VA ok, remote VA internal err, enforce multi VA",
RemoteVAs: []RemoteVA{
{remoteVA1, remoteUA1},
{&brokenRemoteVA{}, "broken"},
},
AllowedUAs: allowedUAs,
Features: enforceMultiVA,
ExpectedProb: probs.ServerInternal("During secondary validation: Remote PerformValidation RPC failed"),
// The real failure cause should be logged
ExpectedLog: expectedInternalErrLine,
},
{
// If a remote VA fails with an internal err it should not fail when not
// enforcing multi VA
Name: "Local VA ok, remote VA internal err, no enforce multi VA",
RemoteVAs: []RemoteVA{
{remoteVA1, remoteUA1},
{&brokenRemoteVA{}, "broken"},
},
AllowedUAs: allowedUAs,
Features: noEnforceMultiVA,
// The real failure cause should be logged
ExpectedLog: expectedInternalErrLine,
},
{
// With only one working remote VA there should *not* be a validation
// failure when not enforcing multi VA.
Name: "Local VA and one remote VA OK, no enforce multi VA",
RemoteVAs: remoteVAs,
AllowedUAs: map[string]bool{localUA: true, remoteUA2: true},
Features: noEnforceMultiVA,
},
{
// With only one working remote VA there should be a validation failure
// when enforcing multi VA.
Name: "Local VA and one remote VA OK, enforce multi VA",
RemoteVAs: remoteVAs,
AllowedUAs: map[string]bool{localUA: true, remoteUA2: true},
Features: enforceMultiVA,
ExpectedProb: probs.Unauthorized(fmt.Sprintf(
`During secondary validation: The key authorization file from the server did not match this challenge %q != "???"`,
expectedKeyAuthorization)),
},
{
// When enforcing multi-VA, any cancellations are a problem.
Name: "Local VA and one remote VA OK, one cancelled VA, enforce multi VA",
RemoteVAs: []RemoteVA{
{remoteVA1, remoteUA1},
{cancelledVA{}, remoteUA2},
},
AllowedUAs: allowedUAs,
Features: enforceMultiVA,
ExpectedProb: probs.ServerInternal("During secondary validation: Remote PerformValidation RPC canceled"),
},
{
// When enforcing multi-VA, any cancellations are a problem.
Name: "Local VA OK, two cancelled remote VAs, enforce multi VA",
RemoteVAs: []RemoteVA{
{cancelledVA{}, remoteUA1},
{cancelledVA{}, remoteUA2},
},
AllowedUAs: allowedUAs,
Features: enforceMultiVA,
ExpectedProb: probs.ServerInternal("During secondary validation: Remote PerformValidation RPC canceled"),
},
{
// With the local and remote VAs seeing diff problems and the full results
// feature flag on but multi VA enforcement off we expect
// no problem.
Name: "Local and remote VA differential, full results, no enforce multi VA",
RemoteVAs: remoteVAs,
AllowedUAs: map[string]bool{localUA: true},
Features: noEnforceMultiVAFullResults,
},
{
// With the local and remote VAs seeing diff problems and the full results
// feature flag on and multi VA enforcement on we expect a problem.
Name: "Local and remote VA differential, full results, enforce multi VA",
RemoteVAs: remoteVAs,
AllowedUAs: map[string]bool{localUA: true},
Features: enforceMultiVAFullResults,
ExpectedProb: probs.Unauthorized(fmt.Sprintf(
`During secondary validation: The key authorization file from the server did not match this challenge %q != "???"`,
expectedKeyAuthorization)),
},
}
for _, tc := range testCases {
t.Run(tc.Name, func(t *testing.T) {
// Configure the test server with the testcase allowed UAs.
ms.setAllowedUAs(tc.AllowedUAs)
// Configure a primary VA with testcase remote VAs.
localVA, mockLog := setup(ms.Server, 0, localUA, tc.RemoteVAs)
if tc.Features != nil {
err := features.Set(tc.Features)
test.AssertNotError(t, err, "Failed to set feature flags")
defer features.Reset()
}
// Perform all validations
res, _ := localVA.PerformValidation(ctx, req)
if res.Problems == nil && tc.ExpectedProb != nil {
t.Errorf("expected prob %v, got nil", tc.ExpectedProb)
} else if res.Problems != nil {
// That result should match expected.
test.AssertEquals(t, res.Problems.ProblemType, string(tc.ExpectedProb.Type))
test.AssertEquals(t, res.Problems.Detail, string(tc.ExpectedProb.Detail))
}
if tc.ExpectedLog != "" {
lines := mockLog.GetAllMatching(tc.ExpectedLog)
test.AssertEquals(t, len(lines), 1)
}
})
}
}
func TestMultiVAEarlyReturn(t *testing.T) {
const (
remoteUA1 = "remote 1"
remoteUA2 = "slow remote"
localUA = "local 1"
)
allowedUAs := map[string]bool{
localUA: true,
remoteUA1: false, // forbid UA 1 to provoke early return
remoteUA2: true,
}
ms := httpMultiSrv(t, expectedToken, allowedUAs)
defer ms.Close()
remoteVA1, _ := setupRemote(ms.Server, 0, remoteUA1)
remoteVA2, _ := setupRemote(ms.Server, 0, remoteUA2)
remoteVAs := []RemoteVA{
{remoteVA1, remoteUA1},
{remoteVA2, remoteUA2},
}
// Create a local test VA with the two remote VAs
localVA, mockLog := setup(ms.Server, 0, localUA, remoteVAs)
testCases := []struct {
Name string
EarlyReturn bool
}{
{
Name: "One slow remote VA, no early return",
},
{
Name: "One slow remote VA, early return",
EarlyReturn: true,
},
}
earlyReturnFeatures := map[string]bool{
"EnforceMultiVA": true,
"MultiVAFullResults": false,
}
noEarlyReturnFeatures := map[string]bool{
"EnforceMultiVA": true,
"MultiVAFullResults": true,
}
req := createValidationRequest("localhost", core.ChallengeTypeHTTP01)
for _, tc := range testCases {
t.Run(tc.Name, func(t *testing.T) {
mockLog.Clear()
var err error
if tc.EarlyReturn {
err = features.Set(earlyReturnFeatures)
} else {
err = features.Set(noEarlyReturnFeatures)
}
test.AssertNotError(t, err, "Failed to set MultiVAFullResults feature flag")
defer features.Reset()
start := time.Now()
// Perform all validations
res, _ := localVA.PerformValidation(ctx, req)
// It should always fail
if res.Problems == nil {
t.Error("expected prob from PerformValidation, got nil")
}
elapsed := time.Since(start).Round(time.Millisecond).Milliseconds()
// The slow UA should sleep for `slowRemoteSleepMillis`. In the early return
// case the first remote VA should fail the overall validation and a prob
// should be returned quickly (i.e. in less than half of `slowRemoteSleepMillis`).
// In the non-early return case we don't expect a problem until
// `slowRemoteSleepMillis`.
if tc.EarlyReturn && elapsed > slowRemoteSleepMillis/2 {
t.Errorf(
"Expected an early return from PerformValidation in < %d ms, took %d ms",
slowRemoteSleepMillis/2, elapsed)
}
})
}
}
func TestMultiVAPolicy(t *testing.T) {
const (
remoteUA1 = "remote 1"
remoteUA2 = "remote 2"
localUA = "local 1"
)
// Forbid both remote UAs to ensure that multi-va fails
allowedUAs := map[string]bool{
localUA: true,
remoteUA1: false,
remoteUA2: false,
}
ms := httpMultiSrv(t, expectedToken, allowedUAs)
defer ms.Close()
remoteVA1, _ := setupRemote(ms.Server, 0, remoteUA1)
remoteVA2, _ := setupRemote(ms.Server, 0, remoteUA2)
remoteVAs := []RemoteVA{
{remoteVA1, remoteUA1},
{remoteVA2, remoteUA2},
}
// Create a local test VA with the two remote VAs
localVA, _ := setup(ms.Server, 0, localUA, remoteVAs)
// Ensure multi VA enforcement is enabled, don't wait for full multi VA
// results.
err := features.Set(map[string]bool{
"EnforceMultiVA": true,
"MultiVAFullResults": false,
})
test.AssertNotError(t, err, "setting feature flags")
defer features.Reset()
// Perform validation for a domain not in the disabledDomains list
req := createValidationRequest("letsencrypt.org", core.ChallengeTypeHTTP01)
res, _ := localVA.PerformValidation(ctx, req)
// It should fail
if res.Problems == nil {
t.Error("expected prob from PerformValidation, got nil")
}
}
func TestDetailedError(t *testing.T) {
cases := []struct {
err error
expected string
}{
{
&net.OpError{
Op: "dial",
Net: "tcp",
Err: &os.SyscallError{
Syscall: "getsockopt",
Err: syscall.ECONNREFUSED,
},
},
"Connection refused",
},
{
&net.OpError{
Op: "dial",
Net: "tcp",
Err: &os.SyscallError{
Syscall: "getsockopt",
Err: syscall.ECONNRESET,
},
},
"Connection reset by peer",
},
}
for _, tc := range cases {
actual := detailedError(tc.err).Detail
if actual != tc.expected {
t.Errorf("Wrong detail for %v. Got %q, expected %q", tc.err, actual, tc.expected)
}
}
}
func TestLogRemoteValidationDifferentials(t *testing.T) {
// Create some remote VAs
remoteVA1, _ := setupRemote(nil, 0, "remote 1")
remoteVA2, _ := setupRemote(nil, 0, "remote 2")
remoteVA3, _ := setupRemote(nil, 0, "remote 3")
remoteVAs := []RemoteVA{
{remoteVA1, "remote 1"},
{remoteVA2, "remote 2"},
{remoteVA3, "remote 3"},
}
// Set up a local VA that allows a max of 2 remote failures.
localVA, mockLog := setup(nil, 2, "local 1", remoteVAs)
egProbA := probs.DNS("root DNS servers closed at 4:30pm")
egProbB := probs.OrderNotReady("please take a number")
testCases := []struct {
name string
primaryResult *probs.ProblemDetails
remoteProbs []*remoteValidationResult
expectedLog string
}{
{
name: "remote and primary results equal (all nil)",
primaryResult: nil,
remoteProbs: []*remoteValidationResult{
{Problem: nil, VAHostname: "remoteA"},
{Problem: nil, VAHostname: "remoteB"},
{Problem: nil, VAHostname: "remoteC"},
},
},
{
name: "remote and primary results equal (not nil)",
primaryResult: egProbA,
remoteProbs: []*remoteValidationResult{
{Problem: egProbA, VAHostname: "remoteA"},
{Problem: egProbA, VAHostname: "remoteB"},
{Problem: egProbA, VAHostname: "remoteC"},
},
},
{
name: "remote and primary differ (primary nil)",
primaryResult: nil,
remoteProbs: []*remoteValidationResult{
{Problem: egProbA, VAHostname: "remoteA"},
{Problem: nil, VAHostname: "remoteB"},
{Problem: egProbB, VAHostname: "remoteC"},
},
expectedLog: `INFO: remoteVADifferentials JSON={"Domain":"example.com","AccountID":1999,"ChallengeType":"blorpus-01","PrimaryResult":null,"RemoteSuccesses":1,"RemoteFailures":[{"VAHostname":"remoteA","Problem":{"type":"dns","detail":"root DNS servers closed at 4:30pm","status":400}},{"VAHostname":"remoteC","Problem":{"type":"orderNotReady","detail":"please take a number","status":403}}]}`,
},
{
name: "remote and primary differ (primary not nil)",
primaryResult: egProbA,
remoteProbs: []*remoteValidationResult{
{Problem: nil, VAHostname: "remoteA"},
{Problem: egProbB, VAHostname: "remoteB"},
{Problem: nil, VAHostname: "remoteC"},
},
expectedLog: `INFO: remoteVADifferentials JSON={"Domain":"example.com","AccountID":1999,"ChallengeType":"blorpus-01","PrimaryResult":{"type":"dns","detail":"root DNS servers closed at 4:30pm","status":400},"RemoteSuccesses":2,"RemoteFailures":[{"VAHostname":"remoteB","Problem":{"type":"orderNotReady","detail":"please take a number","status":403}}]}`,
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
mockLog.Clear()
localVA.logRemoteValidationDifferentials(
"example.com", 1999, "blorpus-01", tc.primaryResult, tc.remoteProbs)
lines := mockLog.GetAllMatching("remoteVADifferentials JSON=.*")
if tc.expectedLog != "" {
test.AssertEquals(t, len(lines), 1)
test.AssertEquals(t, lines[0], tc.expectedLog)
} else {
test.AssertEquals(t, len(lines), 0)
}
})
}
}