Skip to content

Commit fde4fb2

Browse files
committed
Convenience function: AddHeaderOptional
1 parent c7bb950 commit fde4fb2

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

fields.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,12 @@ func (fs *Fields) AddHeaderExt(hdr string, optional bool, binarySequence bool, a
123123
return fs
124124
}
125125

126+
// AddHeaderOptional appends a bare header name, e.g. "cache-control". However, the header is not required to exist
127+
// in the message. This is a convenience function and AddHeaderExt is more general.
128+
func (fs *Fields) AddHeaderOptional(hdr string) *Fields {
129+
return fs.AddHeaderExt(hdr, true, false, false, false)
130+
}
131+
126132
func fromQueryParam(qp string) *field {
127133
i := httpsfv.NewItem("@query-param")
128134
i.Params.Add("name", QueryEscapeForSignature(qp))

signatures_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1633,7 +1633,7 @@ func TestVerifyResponse(t *testing.T) {
16331633

16341634
func TestOptionalSign(t *testing.T) {
16351635
req := readRequest(httpreq2)
1636-
f1 := NewFields().AddHeader("date").AddHeaderExt("x-optional", true, false, false, false)
1636+
f1 := NewFields().AddHeader("date").AddHeaderOptional("x-optional")
16371637
key1 := bytes.Repeat([]byte{0x55}, 64)
16381638
signer1, err := NewHMACSHA256Signer(key1, NewSignConfig().setFakeCreated(9999).SetKeyID("key1"), *f1)
16391639
assert.NoError(t, err, "Could not create signer")
@@ -1777,7 +1777,7 @@ func TestRequestBinding(t *testing.T) {
17771777
func TestOptionalVerify(t *testing.T) {
17781778
req := readRequest(httpreq2)
17791779
req.Header.Add("X-Opt1", "val1")
1780-
f1 := NewFields().AddHeader("date").AddHeaderExt("x-opt1", true, false, false, false)
1780+
f1 := NewFields().AddHeader("date").AddHeaderOptional("x-opt1")
17811781
key1 := bytes.Repeat([]byte{0x66}, 64)
17821782
signer, err := NewHMACSHA256Signer(key1, NewSignConfig().setFakeCreated(8888).SetKeyID("key1"), *f1)
17831783
assert.NoError(t, err, "Could not create signer")

0 commit comments

Comments
 (0)