Repository navigation
Expand file tree
/
Copy pathcanonicalizer.go
More file actions
401 lines (327 loc) · 11.2 KB
/
Copy pathcanonicalizer.go
File metadata and controls
401 lines (327 loc) · 11.2 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
package httpsig
import (
"fmt"
"net/http"
"net/url"
"slices"
"strconv"
"strings"
"unicode/utf8"
"github.com/dunglas/httpsfv"
)
type canonicalizer interface {
canonicalize(msg *Message, params *httpsfv.Params) ([]string, error)
}
type canonicalizerFunc func(msg *Message, params *httpsfv.Params) ([]string, error)
func (f canonicalizerFunc) canonicalize(msg *Message, params *httpsfv.Params) ([]string, error) {
return f(msg, params)
}
func assertRequestOnly(name string, params *httpsfv.Params, isRequest bool) error {
_, isReq := params.Get("req")
if isRequest && isReq {
return fmt.Errorf("%w: 'req' parameter in %s is not valid for requests",
ErrCanonicalization, name)
} else if !isRequest && !isReq {
return fmt.Errorf("%w: %s not valid for responses", ErrCanonicalization, name)
}
return nil
}
// assertParameters checks whether parameters are applicable to a
// component and have the required RFC 9421 types and values.
//
//nolint:cyclop
func assertParameters(name string, params *httpsfv.Params, allowed ...string) error {
if params == nil {
return nil
}
for _, param := range params.Names() {
if !slices.Contains(allowed, param) {
return fmt.Errorf("%w: parameter %q is not applicable to %s",
ErrInvalidComponentIdentifier, param, name)
}
value, _ := params.Get(param)
switch param {
case "sf", "bs", "tr", "req":
enabled, ok := value.(bool)
if !ok || !enabled {
return fmt.Errorf("%w: %s parameter %q must be true",
ErrInvalidComponentIdentifier, name, param)
}
case "key":
key, ok := value.(string)
if !ok || key == "" {
return fmt.Errorf("%w: %s parameter %q must be a non-empty string",
ErrInvalidComponentIdentifier, name, param)
}
case "name":
if _, ok := value.(string); !ok {
return fmt.Errorf("%w: %s parameter %q must be a string",
ErrInvalidComponentIdentifier, name, param)
}
default:
return fmt.Errorf("%w: %s has unsupported parameter %q",
ErrInvalidComponentIdentifier, name, param)
}
}
return nil
}
//nolint:cyclop
func canonicalizerFor(name string, params *httpsfv.Params) (canonicalizer, error) {
switch name {
case "@method":
return newMethodCanonicalizer(params)
case "@target-uri":
return newTargetURICanonicalizer(params)
case "@authority":
return newAuthorityCanonicalizer(params)
case "@scheme":
return newSchemeCanonicalizer(params)
case "@request-target":
return newRequestTargetCanonicalizer(params)
case "@path":
return newPathCanonicalizer(params)
case "@query":
return newQueryCanonicalizer(params)
case "@query-param":
return newQueryParamCanonicalizer(params)
case "@status":
return newStatusCodeCanonicalizer(params)
default:
if strings.HasPrefix(name, "@") {
return nil, fmt.Errorf("%w: %s", ErrUnsupportedComponentIdentifier, name)
}
return newHeaderCanonicalizer(name, params)
}
}
func newMethodCanonicalizer(params *httpsfv.Params) (canonicalizer, error) {
if err := assertParameters("@method", params, "req"); err != nil {
return nil, err
}
return canonicalizerFunc(func(msg *Message, params *httpsfv.Params) ([]string, error) {
// https://www.rfc-editor.org/rfc/rfc9421.html#content-request-method (Section 2.2.1)
if err := assertRequestOnly("@method", params, msg.IsRequest); err != nil {
return nil, err
}
return []string{msg.Method}, nil
}), nil
}
func newTargetURICanonicalizer(params *httpsfv.Params) (canonicalizer, error) {
if err := assertParameters("@target-uri", params, "req"); err != nil {
return nil, err
}
return canonicalizerFunc(func(msg *Message, params *httpsfv.Params) ([]string, error) {
// https://www.rfc-editor.org/rfc/rfc9421.html#name-target-uri (Section 2.2.2)
if err := assertRequestOnly("@target-uri", params, msg.IsRequest); err != nil {
return nil, err
}
return []string{msg.URL.String()}, nil
}), nil
}
func newAuthorityCanonicalizer(params *httpsfv.Params) (canonicalizer, error) {
if err := assertParameters("@authority", params, "req"); err != nil {
return nil, err
}
return canonicalizerFunc(func(msg *Message, params *httpsfv.Params) ([]string, error) {
// https://www.rfc-editor.org/rfc/rfc9421.html#name-authority (Section 2.2.3)
if err := assertRequestOnly("@authority", params, msg.IsRequest); err != nil {
return nil, err
}
host, port, valid := splitHostPort(msg.Authority)
if !valid {
return nil, fmt.Errorf("%w: invalid authority %q", ErrCanonicalization, msg.Authority)
}
host = normalizeHost(host)
if port == "" {
return []string{host}, nil
}
port = strings.TrimLeft(port, "0")
if port == "" {
port = "0"
}
if msg.URL != nil {
switch strings.ToLower(msg.URL.Scheme) {
case "http":
if port == "80" {
return []string{host}, nil
}
case "https":
if port == "443" {
return []string{host}, nil
}
}
}
return []string{host + ":" + port}, nil
}), nil
}
func newSchemeCanonicalizer(params *httpsfv.Params) (canonicalizer, error) {
if err := assertParameters("@scheme", params, "req"); err != nil {
return nil, err
}
return canonicalizerFunc(func(msg *Message, params *httpsfv.Params) ([]string, error) {
// https://www.rfc-editor.org/rfc/rfc9421.html#name-scheme (Section 2.2.4)
if err := assertRequestOnly("@scheme", params, msg.IsRequest); err != nil {
return nil, err
}
return []string{strings.ToLower(msg.URL.Scheme)}, nil
}), nil
}
func newRequestTargetCanonicalizer(params *httpsfv.Params) (canonicalizer, error) {
if err := assertParameters("@request-target", params, "req"); err != nil {
return nil, err
}
return canonicalizerFunc(func(msg *Message, params *httpsfv.Params) ([]string, error) {
// https://www.rfc-editor.org/rfc/rfc9421.html#name-request-target (Section 2.2.5)
if err := assertRequestOnly("@request-target", params, msg.IsRequest); err != nil {
return nil, err
}
return []string{msg.URL.RequestURI()}, nil
}), nil
}
func newPathCanonicalizer(params *httpsfv.Params) (canonicalizer, error) {
if err := assertParameters("@path", params, "req"); err != nil {
return nil, err
}
return canonicalizerFunc(func(msg *Message, params *httpsfv.Params) ([]string, error) {
// https://www.rfc-editor.org/rfc/rfc9421.html#name-path (Section 2.2.6)
if err := assertRequestOnly("@path", params, msg.IsRequest); err != nil {
return nil, err
}
path := msg.URL.EscapedPath()
if len(path) == 0 || path[0] != '/' {
path = "/" + path
}
return []string{path}, nil
}), nil
}
func newQueryCanonicalizer(params *httpsfv.Params) (canonicalizer, error) {
if err := assertParameters("@query", params, "req"); err != nil {
return nil, err
}
return canonicalizerFunc(func(msg *Message, params *httpsfv.Params) ([]string, error) {
// https://www.rfc-editor.org/rfc/rfc9421.html#name-query (Section 2.2.7)
if err := assertRequestOnly("@query", params, msg.IsRequest); err != nil {
return nil, err
}
// absent query params means use `?`
return []string{"?" + msg.URL.RawQuery}, nil
}), nil
}
func newQueryParamCanonicalizer(params *httpsfv.Params) (canonicalizer, error) {
if err := assertParameters("@query-param", params, "req", "name"); err != nil {
return nil, err
}
if params == nil {
return nil, fmt.Errorf("%w: @query-param requires a 'name' parameter", ErrInvalidComponentIdentifier)
}
val, hasName := params.Get("name")
if !hasName {
return nil, fmt.Errorf("%w: @query-param requires a 'name' parameter", ErrInvalidComponentIdentifier)
}
name := val.(string) //nolint: forcetypeassert
decodedName, err := url.PathUnescape(name)
if err != nil {
return nil, fmt.Errorf("%w: invalid @query-param name %q: %w", ErrInvalidComponentIdentifier, name, err)
}
if !utf8.ValidString(decodedName) || encodeQueryParam(decodedName) != name {
return nil, fmt.Errorf("%w: @query-param name %q is not canonically encoded", ErrInvalidComponentIdentifier, name)
}
return canonicalizerFunc(func(msg *Message, params *httpsfv.Params) ([]string, error) {
// https://www.rfc-editor.org/rfc/rfc9421.html#name-query-parameters (Section 2.2.8)
if err := assertRequestOnly("@query-param", params, msg.IsRequest); err != nil {
return nil, err
}
query := msg.queryParams()
if !query.Has(decodedName) {
return nil, fmt.Errorf("%w: expected query parameter '%s' not found", ErrCanonicalization, name)
}
unescaped := query[decodedName]
if len(unescaped) > 1 {
return nil, fmt.Errorf("%w: query parameter '%s' occurs multiple times", ErrCanonicalization, name)
}
return []string{encodeQueryParam(unescaped[0])}, nil
}), nil
}
func newStatusCodeCanonicalizer(params *httpsfv.Params) (canonicalizer, error) {
if err := assertParameters("@status", params); err != nil {
return nil, err
}
return canonicalizerFunc(func(msg *Message, _ *httpsfv.Params) ([]string, error) {
// https://www.rfc-editor.org/rfc/rfc9421.html#name-status-code (Section 2.2.9)
if msg.IsRequest {
return nil, fmt.Errorf("%w: @status not valid for requests", ErrCanonicalization)
}
return []string{strconv.Itoa(msg.StatusCode)}, nil
}), nil
}
//nolint:cyclop
func newHeaderCanonicalizer(header string, params *httpsfv.Params) (canonicalizer, error) {
if err := assertParameters(header, params, "sf", "key", "bs", "tr", "req"); err != nil {
return nil, err
}
if params != nil {
if _, present := params.Get("tr"); present {
return nil, fmt.Errorf("%w: trailer fields are not supported", ErrInvalidComponentIdentifier)
}
_, bs := params.Get("bs")
_, sf := params.Get("sf")
_, key := params.Get("key")
if bs && (sf || key) {
return nil, fmt.Errorf("%w: cannot combine 'bs' with 'sf' or 'key' on %s",
ErrInvalidComponentIdentifier, header)
}
}
return canonicalizerFunc(func(msg *Message, params *httpsfv.Params) ([]string, error) {
serializer, err := newSerializer(params, msg.IsRequest)
if err != nil {
return nil, fmt.Errorf("%w: %s: %w", ErrCanonicalization, header, err)
}
var hdr http.Header
if _, isReq := params.Get("req"); !msg.IsRequest && isReq {
hdr = msg.RequestHeader
} else {
hdr = msg.Header
}
if len(hdr) == 0 {
return nil, fmt.Errorf("%w: %s not present in message", ErrCanonicalization, header)
}
values := hdr.Values(header)
if len(values) == 0 {
// empty values are permitted, but no values are not
return nil, fmt.Errorf("%w: %s not present in message", ErrCanonicalization, header)
}
result, err := serializer.serialize(values)
if err != nil {
return nil, fmt.Errorf("%w: %s: %w", ErrCanonicalization, header, err)
}
return result, nil
}), nil
}
// encodeQueryParam uses the HTML form percent-encode set with spaces encoded
// as %20, as in RFC 9421 section 2.2.8's examples.
func encodeQueryParam(value string) string {
const hex = "0123456789ABCDEF"
for i := 0; i < len(value); i++ {
if queryParamUnescaped(value[i]) {
continue
}
var encoded strings.Builder
encoded.Grow(len(value) + 2) //nolint:mnd
encoded.WriteString(value[:i])
for ; i < len(value); i++ {
b := value[i]
if queryParamUnescaped(b) {
encoded.WriteByte(b)
continue
}
encoded.WriteByte('%')
encoded.WriteByte(hex[b>>4])
encoded.WriteByte(hex[b&0x0F])
}
return encoded.String()
}
return value
}
func queryParamUnescaped(c byte) bool {
return 'a' <= c && c <= 'z' || 'A' <= c && c <= 'Z' || '0' <= c && c <= '9' ||
c == '*' || c == '-' || c == '.' || c == '_'
}