Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions canonicalizer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@ func TestCanonicalization(t *testing.T) {
},
},
"@query-param for request - valid": {
identifier: `"@query-param";name=bar`,
identifier: `"@query-param";name="bar"`,
message: &Message{URL: testURL1, IsRequest: true},
assert: func(t *testing.T, err error, value []string) {
t.Helper()
Expand All @@ -430,7 +430,7 @@ func TestCanonicalization(t *testing.T) {
},
},
"@query-param for request - valid with duplicate unrelated parameter": {
identifier: `"@query-param";name=foo`,
identifier: `"@query-param";name="foo"`,
message: &Message{URL: &url.URL{RawQuery: "foo=bar&other=one&other=two"}, IsRequest: true},
assert: func(t *testing.T, err error, value []string) {
t.Helper()
Expand All @@ -440,7 +440,7 @@ func TestCanonicalization(t *testing.T) {
},
},
"@query-param for request - invalid, duplicate parameter": {
identifier: `"@query-param";name=foo`,
identifier: `"@query-param";name="foo"`,
message: &Message{URL: &url.URL{RawQuery: "foo=one&foo=two"}, IsRequest: true},
assert: func(t *testing.T, err error, _ []string) {
t.Helper()
Expand All @@ -450,7 +450,7 @@ func TestCanonicalization(t *testing.T) {
},
},
"@query-param for request - invalid, duplicate encoded parameter": {
identifier: `"@query-param";name=foo`,
identifier: `"@query-param";name="foo"`,
message: &Message{URL: &url.URL{RawQuery: "foo=one&%66oo=two"}, IsRequest: true},
assert: func(t *testing.T, err error, _ []string) {
t.Helper()
Expand All @@ -460,7 +460,7 @@ func TestCanonicalization(t *testing.T) {
},
},
"@query-param for response - invalid, duplicate request parameter": {
identifier: `"@query-param";name=foo;req`,
identifier: `"@query-param";name="foo";req`,
message: &Message{URL: &url.URL{RawQuery: "foo=one&foo=two"}, IsRequest: false},
assert: func(t *testing.T, err error, _ []string) {
t.Helper()
Expand All @@ -480,19 +480,19 @@ func TestCanonicalization(t *testing.T) {
require.ErrorContains(t, err, "named parameter")
},
},
"@query-param for request - invalid query param escaping": {
identifier: `"@query-param";name=1`,
"@query-param for request - invalid token name parameter": {
identifier: `"@query-param";name=foo`,
message: &Message{URL: testURL1, IsRequest: true},
assert: func(t *testing.T, err error, _ []string) {
t.Helper()

require.Error(t, err)
require.ErrorIs(t, err, ErrCanonicalization)
require.ErrorIs(t, err, ErrInvalidComponentIdentifier)
require.ErrorContains(t, err, "must be a string")
},
},
"@query-param for request - invalid, parameter not present in query": {
identifier: `"@query-param";name=moo`,
identifier: `"@query-param";name="moo"`,
message: &Message{URL: testURL1, IsRequest: true},
assert: func(t *testing.T, err error, _ []string) {
t.Helper()
Expand All @@ -503,7 +503,7 @@ func TestCanonicalization(t *testing.T) {
},
},
"@query-param for response - valid": {
identifier: `"@query-param";name=foo;req`,
identifier: `"@query-param";name="foo";req`,
message: &Message{URL: testURL1, IsRequest: false},
assert: func(t *testing.T, err error, value []string) {
t.Helper()
Expand All @@ -513,7 +513,7 @@ func TestCanonicalization(t *testing.T) {
},
},
"@query-param for response - invalid": {
identifier: `"@query-param";name=foo`,
identifier: `"@query-param";name="foo"`,
message: &Message{URL: testURL1, IsRequest: false},
assert: func(t *testing.T, err error, _ []string) {
t.Helper()
Expand Down Expand Up @@ -589,7 +589,7 @@ func TestCanonicalization(t *testing.T) {
},
},
"header component for request - invalid, serialization error": {
identifier: `"X-Foo-Bar";sf;key=foo`,
identifier: `"X-Foo-Bar";sf;key="foo"`,
message: &Message{Header: http.Header{"X-Foo-Bar": []string{"baz"}}, IsRequest: true},
assert: func(t *testing.T, err error, _ []string) {
t.Helper()
Expand Down Expand Up @@ -637,7 +637,7 @@ func TestCanonicalization(t *testing.T) {
c, err := canonicalizerFor(strings.ToLower(item.Value.(string)))
require.NoError(t, err)

res, err := c.canonicalize(tc.message, normaliseParams(item.Params))
res, err := c.canonicalize(tc.message, item.Params)

tc.assert(t, err, res)
})
Expand Down
26 changes: 0 additions & 26 deletions component_identifier.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package httpsig

import (
"encoding/base64"
"fmt"
"strings"

Expand Down Expand Up @@ -29,29 +28,6 @@ func quoteIdentifierName(input string) string {
return identifier + ";" + strings.Join(rest, ";")
}

func normaliseParams(params *httpsfv.Params) *httpsfv.Params {
if len(params.Names()) == 0 {
return params
}

ps := httpsfv.NewParams()

for _, name := range params.Names() {
value, _ := params.Get(name)

if v, ok := value.([]byte); ok {
encoded := base64.StdEncoding.EncodeToString(v)
ps.Add(name, encoded)
} else if v, ok := value.(httpsfv.Token); ok {
ps.Add(name, string(v))
} else {
ps.Add(name, value)
}
}

return ps
}

type componentIdentifier struct {
httpsfv.Item

Expand Down Expand Up @@ -93,8 +69,6 @@ func newComponentIdentifier(item httpsfv.Item) (*componentIdentifier, error) {
return nil, err
}

item.Params = normaliseParams(item.Params)

return &componentIdentifier{Item: item, c: canonicalizer}, nil
}

Expand Down
102 changes: 28 additions & 74 deletions component_identifier_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,78 +26,6 @@ func TestQuoteIdentifierName(t *testing.T) {
}
}

func TestNormalizeParams(t *testing.T) {
t.Parallel()

for uc, tc := range map[string]struct {
given *httpsfv.Params
expect *httpsfv.Params
}{
"empty params": {
given: httpsfv.NewParams(),
expect: httpsfv.NewParams(),
},
"byte array params": {
given: func() *httpsfv.Params {
params := httpsfv.NewParams()
params.Add("test", []byte("test"))

return params
}(),
expect: func() *httpsfv.Params {
params := httpsfv.NewParams()
params.Add("test", "dGVzdA==")

return params
}(),
},
"token params": {
given: func() *httpsfv.Params {
params := httpsfv.NewParams()
params.Add("test", httpsfv.Token("token"))

return params
}(),
expect: func() *httpsfv.Params {
params := httpsfv.NewParams()
params.Add("test", "token")

return params
}(),
},
"bare item params": {
given: func() *httpsfv.Params {
params := httpsfv.NewParams()
params.Add("test", 1)

return params
}(),
expect: func() *httpsfv.Params {
params := httpsfv.NewParams()
params.Add("test", 1)

return params
}(),
},
} {
t.Run(uc, func(t *testing.T) {
res := normaliseParams(tc.given)

assert.Equal(t, tc.given.Names(), res.Names())

for _, name := range res.Names() {
resVal, ok := res.Get(name)
assert.True(t, ok)

expVal, ok := tc.expect.Get(name)
assert.True(t, ok)

assert.Equal(t, expVal, resVal)
}
})
}
}

func TestToComponentIdentifiers(t *testing.T) {
t.Parallel()

Expand Down Expand Up @@ -132,6 +60,32 @@ func TestToComponentIdentifiers(t *testing.T) {
assert.Nil(t, ci)
},
},
"preserving structured field parameter types": {
identifiers: []string{`x-test;string="abc";token=abc;bytes=:AQID:`},
assert: func(t *testing.T, ci []*componentIdentifier, err error) {
t.Helper()

require.NoError(t, err)
require.Len(t, ci, 1)

stringValue, ok := ci[0].Params.Get("string")
require.True(t, ok)
assert.Equal(t, "abc", stringValue)

tokenValue, ok := ci[0].Params.Get("token")
require.True(t, ok)
assert.Equal(t, httpsfv.Token("abc"), tokenValue)

bytesValue, ok := ci[0].Params.Get("bytes")
require.True(t, ok)
assert.Equal(t, []byte{1, 2, 3}, bytesValue)

input := newSignatureInput(ci, nil)
marshalled, err := httpsfv.Marshal(input.value)
require.NoError(t, err)
assert.Equal(t, `("x-test";string="abc";token=abc;bytes=:AQID:)`, marshalled)
},
},
"valid": {
identifiers: []string{"@method;foo=bar", "@status", `@query-param;name="Pet"`},
assert: func(t *testing.T, ci []*componentIdentifier, err error) {
Expand All @@ -143,7 +97,7 @@ func TestToComponentIdentifiers(t *testing.T) {
assert.Equal(t, "@method", ci[0].Value.(string))
res, ok := ci[0].Params.Get("foo")
require.True(t, ok)
require.Equal(t, "bar", res.(string))
require.Equal(t, httpsfv.Token("bar"), res)
assert.NotNil(t, ci[0].c)

assert.Equal(t, "@status", ci[1].Value.(string))
Expand Down Expand Up @@ -206,7 +160,7 @@ func TestNewComponentIdentifier(t *testing.T) {

val, ok := ci.Params.Get("foo")
require.True(t, ok)
assert.Equal(t, "YmFy", val)
assert.Equal(t, []byte("bar"), val)
},
},
} {
Expand Down
13 changes: 12 additions & 1 deletion signature_input.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package httpsig

import (
"bytes"
"fmt"
"time"

Expand Down Expand Up @@ -47,7 +48,7 @@ func (si *signatureInput) hasIdentifier(id *componentIdentifier) bool {
actual, present := identifier.Params.Get(name)

expected, _ := id.Params.Get(name)
if !present || actual != expected {
if !present || !equalComponentParameterValues(actual, expected) {
matches = false

break
Expand Down Expand Up @@ -167,3 +168,13 @@ func validateSignatureInputParameters(params *httpsfv.Params) error {

return nil
}

func equalComponentParameterValues(actual, expected any) bool {
if expectedBytes, ok := expected.([]byte); ok {
actualBytes, ok := actual.([]byte)

return ok && bytes.Equal(actualBytes, expectedBytes)
}

return actual == expected
}
9 changes: 9 additions & 0 deletions signature_input_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -810,6 +810,15 @@ func TestSignatureInputHasIdentifier(t *testing.T) {
given: []string{`x-test;value=1`},
identifier: `x-test;value="1"`,
},
"matching byte sequence parameter": {
given: []string{`x-test;custom=:AQID:`},
identifier: `x-test;custom=:AQID:`,
expected: true,
},
"different byte sequence parameter": {
given: []string{`x-test;custom=:AQID:`},
identifier: `x-test;custom=:AQIE:`,
},
"different flag value": {
given: []string{`x-test;sf=?0`},
identifier: `x-test;sf`,
Expand Down
Loading