Skip to content

Commit 4dedf74

Browse files
authored
chore: Global test clock replaced with testing/synctest (#183)
1 parent 33d307e commit 4dedf74

6 files changed

Lines changed: 83 additions & 65 deletions

File tree

‎patch.go‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎rfc_vectors_test.go‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
package httpsig
22

3+
import (
4+
"testing"
5+
"testing/synctest"
6+
"time"
7+
)
8+
9+
// withRFC9421Time runs an assertion at the timestamp used by RFC 9421 test vectors.
10+
func withRFC9421Time(t *testing.T, run func(*testing.T)) {
11+
t.Helper()
12+
13+
synctest.Test(t, func(t *testing.T) {
14+
time.Sleep(time.Until(time.Unix(1618884473, 0)))
15+
run(t)
16+
})
17+
}
18+
319
// from https://www.rfc-editor.org/rfc/rfc9421.html#name-example-rsa-pss-key
420
// nolint: gochecknoglobals
521
var (

‎signer.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ func (s *signer) Sign(msg *Message, opts ...SignOption) (http.Header, error) {
153153
}
154154

155155
func (s *signer) signatureInput(opts signOptions) *signatureInput {
156-
created := currentTime().UTC()
156+
created := time.Now().UTC()
157157

158158
params := httpsfv.NewParams()
159159
params.Add(string(Created), created.Unix())

‎signer_test.go‎

Lines changed: 55 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -211,13 +211,6 @@ func TestNewSigner(t *testing.T) {
211211
}
212212

213213
func TestSignerSign(t *testing.T) {
214-
// used by RFC9421 in test vectors
215-
currentTime = func() time.Time { return time.Unix(1618884473, 0) }
216-
217-
t.Cleanup(func() {
218-
currentTime = time.Now
219-
})
220-
221214
pkp384, err := ecdsa.GenerateKey(elliptic.P384(), rand.Reader)
222215
require.NoError(t, err)
223216

@@ -789,58 +782,74 @@ func TestSignerSign(t *testing.T) {
789782
},
790783
} {
791784
t.Run(tc.uc, func(t *testing.T) {
792-
s, err := NewSigner(tc.key, tc.opts...)
793-
require.NoError(t, err)
785+
withRFC9421Time(t, func(t *testing.T) {
786+
t.Helper()
787+
788+
s, err := NewSigner(tc.key, tc.opts...)
789+
require.NoError(t, err)
794790

795-
res, err := s.Sign(tc.msg, tc.signOpts...)
791+
res, err := s.Sign(tc.msg, tc.signOpts...)
796792

797-
tc.assert(t, err, res)
793+
tc.assert(t, err, res)
794+
})
798795
})
799796
}
800797

801798
t.Run("per-call label does not persist", func(t *testing.T) {
802-
s, err := NewSigner(Key{Algorithm: HmacSha256, Material: []byte("secret")},
803-
WithTTL(0),
804-
WithLabel("static"),
805-
)
806-
require.NoError(t, err)
807-
808-
first, err := s.Sign(&Message{Header: http.Header{}, IsRequest: true}, WithLabel("dynamic"))
809-
require.NoError(t, err)
810-
assert.Equal(t, `dynamic=();created=1618884473`, first.Get("Signature-Input"))
811-
812-
second, err := s.Sign(&Message{Header: http.Header{}, IsRequest: true})
813-
require.NoError(t, err)
814-
assert.Equal(t, `static=();created=1618884473`, second.Get("Signature-Input"))
799+
withRFC9421Time(t, func(t *testing.T) {
800+
t.Helper()
801+
802+
s, err := NewSigner(Key{Algorithm: HmacSha256, Material: []byte("secret")},
803+
WithTTL(0),
804+
WithLabel("static"),
805+
)
806+
require.NoError(t, err)
807+
808+
first, err := s.Sign(&Message{Header: http.Header{}, IsRequest: true}, WithLabel("dynamic"))
809+
require.NoError(t, err)
810+
assert.Equal(t, `dynamic=();created=1618884473`, first.Get("Signature-Input"))
811+
812+
second, err := s.Sign(&Message{Header: http.Header{}, IsRequest: true})
813+
require.NoError(t, err)
814+
assert.Equal(t, `static=();created=1618884473`, second.Get("Signature-Input"))
815+
})
815816
})
816817

817818
t.Run("per-call nonce does not persist", func(t *testing.T) {
818-
s, err := NewSigner(Key{Algorithm: HmacSha256, Material: []byte("secret")}, WithTTL(0))
819-
require.NoError(t, err)
819+
withRFC9421Time(t, func(t *testing.T) {
820+
t.Helper()
821+
822+
s, err := NewSigner(Key{Algorithm: HmacSha256, Material: []byte("secret")}, WithTTL(0))
823+
require.NoError(t, err)
820824

821-
first, err := s.Sign(&Message{Header: http.Header{}, IsRequest: true},
822-
WithParameter("nonce", "requested-nonce"))
823-
require.NoError(t, err)
824-
assert.Equal(t, `sig=();created=1618884473;nonce="requested-nonce"`, first.Get("Signature-Input"))
825+
first, err := s.Sign(&Message{Header: http.Header{}, IsRequest: true},
826+
WithParameter("nonce", "requested-nonce"))
827+
require.NoError(t, err)
828+
assert.Equal(t, `sig=();created=1618884473;nonce="requested-nonce"`, first.Get("Signature-Input"))
825829

826-
second, err := s.Sign(&Message{Header: http.Header{}, IsRequest: true})
827-
require.NoError(t, err)
828-
assert.Equal(t, `sig=();created=1618884473`, second.Get("Signature-Input"))
830+
second, err := s.Sign(&Message{Header: http.Header{}, IsRequest: true})
831+
require.NoError(t, err)
832+
assert.Equal(t, `sig=();created=1618884473`, second.Get("Signature-Input"))
833+
})
829834
})
830835

831836
t.Run("per-call parameters do not persist", func(t *testing.T) {
832-
s, err := NewSigner(Key{Algorithm: HmacSha256, Material: []byte("secret")},
833-
WithTTL(0),
834-
)
835-
require.NoError(t, err)
836-
837-
first, err := s.Sign(&Message{Header: http.Header{}, IsRequest: true},
838-
WithParameter("wimse-req-nonce", "request-nonce"))
839-
require.NoError(t, err)
840-
assert.Contains(t, first.Get("Signature-Input"), `;wimse-req-nonce="request-nonce"`)
841-
842-
second, err := s.Sign(&Message{Header: http.Header{}, IsRequest: true})
843-
require.NoError(t, err)
844-
assert.Equal(t, `sig=();created=1618884473`, second.Get("Signature-Input"))
837+
withRFC9421Time(t, func(t *testing.T) {
838+
t.Helper()
839+
840+
s, err := NewSigner(Key{Algorithm: HmacSha256, Material: []byte("secret")},
841+
WithTTL(0),
842+
)
843+
require.NoError(t, err)
844+
845+
first, err := s.Sign(&Message{Header: http.Header{}, IsRequest: true},
846+
WithParameter("wimse-req-nonce", "request-nonce"))
847+
require.NoError(t, err)
848+
assert.Contains(t, first.Get("Signature-Input"), `;wimse-req-nonce="request-nonce"`)
849+
850+
second, err := s.Sign(&Message{Header: http.Header{}, IsRequest: true})
851+
require.NoError(t, err)
852+
assert.Equal(t, `sig=();created=1618884473`, second.Get("Signature-Input"))
853+
})
845854
})
846855
}

‎verification_policy.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ func (e *verificationPolicy) assertMetadata(si *signatureInput, msg *Message) er
254254
mv messageVerifier
255255
)
256256

257-
now := currentTime().UTC()
257+
now := time.Now().UTC()
258258

259259
expires, expiresPresent := si.expires()
260260
if !expiresPresent {

‎verifier_test.go‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -465,9 +465,6 @@ func TestNewVerifier(t *testing.T) {
465465
}
466466

467467
func TestVerifierVerify(t *testing.T) {
468-
// used by RFC9421 in test vectors
469-
currentTime = func() time.Time { return time.Unix(1618884473, 0) }
470-
471468
testURL, err := url.Parse("http://example.com/foo?param=Value&Pet=dog")
472469
require.NoError(t, err)
473470

@@ -1889,14 +1886,18 @@ func TestVerifierVerify(t *testing.T) {
18891886
},
18901887
} {
18911888
t.Run(uc, func(t *testing.T) {
1892-
kr := NewKeyResolverMock(t)
1893-
tc.configureResolver(t, kr)
1889+
withRFC9421Time(t, func(t *testing.T) {
1890+
t.Helper()
18941891

1895-
v, err := NewVerifier(kr, tc.opts...)
1896-
require.NoError(t, err)
1892+
kr := NewKeyResolverMock(t)
1893+
tc.configureResolver(t, kr)
18971894

1898-
results, err := v.Verify(tc.msg, tc.verifyOpts...)
1899-
tc.assert(t, err, results)
1895+
v, err := NewVerifier(kr, tc.opts...)
1896+
require.NoError(t, err)
1897+
1898+
results, err := v.Verify(tc.msg, tc.verifyOpts...)
1899+
tc.assert(t, err, results)
1900+
})
19001901
})
19011902
}
19021903

0 commit comments

Comments
 (0)