Repository navigation
Expand file tree
/
Copy pathverification_policy.go
More file actions
364 lines (293 loc) · 9.28 KB
/
Copy pathverification_policy.go
File metadata and controls
364 lines (293 loc) · 9.28 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
package httpsig
import (
"bytes"
"fmt"
"slices"
"strings"
"time"
"github.com/dunglas/httpsfv"
)
type verificationPolicy struct {
tolerance *time.Duration
maxAge *time.Duration
identifiers []*componentIdentifier
asb *AcceptSignatureBuilder
reqCreatedTS *bool
reqExpiresTS *bool
requiredParameters []SignatureParameter
forbiddenParameters []SignatureParameter
expectedParameters []parameterOption
}
// clone copies the parameter slices for per-call options. Other fields are
// shared because VerifyOption does not modify them.
func (e *verificationPolicy) clone() *verificationPolicy {
clone := *e
clone.requiredParameters = slices.Clone(e.requiredParameters)
clone.forbiddenParameters = slices.Clone(e.forbiddenParameters)
clone.expectedParameters = slices.Clone(e.expectedParameters)
return &clone
}
// withOptions applies per-call options without changing the configured policy.
func (e *verificationPolicy) withOptions(tag string, opts []VerifyOption) (*verificationPolicy, error) {
if len(opts) == 0 {
return e, nil
}
effective := e.clone()
for _, opt := range opts {
if err := opt.applyVerifyOption(effective); err != nil {
return nil, err
}
}
if err := effective.validateParameters(tag); err != nil {
return nil, err
}
return effective, nil
}
// inherit applies global requirements to a tag-specific configuration.
// Tag-specific values take precedence, while parameter requirements remain additive.
func (e *verificationPolicy) inherit(globalPolicy *verificationPolicy, tag string) error {
if e.tolerance == nil {
e.tolerance = globalPolicy.tolerance
}
if e.maxAge == nil {
e.maxAge = globalPolicy.maxAge
}
if len(globalPolicy.identifiers) != 0 && len(e.identifiers) == 0 {
e.identifiers = globalPolicy.identifiers
}
if e.reqExpiresTS == nil {
e.reqExpiresTS = globalPolicy.reqExpiresTS
}
if e.reqCreatedTS == nil {
e.reqCreatedTS = globalPolicy.reqCreatedTS
}
if globalPolicy.asb != nil && e.asb == nil {
// Keep negotiation configuration independent for each required tag.
tmp := *globalPolicy.asb
e.asb = &tmp
}
if err := e.inheritParameters(globalPolicy); err != nil {
return err
}
return e.prepare(tag)
}
func (e *verificationPolicy) prepare(tag string) error {
if err := e.validateParameters(tag); err != nil {
return err
}
if e.asb != nil {
e.asb.setIdentifiers(e.identifiers)
e.asb.tag = tag
e.asb.addCreatedTS = *e.reqCreatedTS
e.asb.addExpiresTS = *e.reqExpiresTS
}
return nil
}
func (e *verificationPolicy) inheritParameters(globalPolicy *verificationPolicy) error {
for _, name := range globalPolicy.requiredParameters {
if err := e.requireParameter(name); err != nil {
return err
}
}
for _, name := range globalPolicy.forbiddenParameters {
if err := e.forbidParameter(name); err != nil {
return err
}
}
for _, param := range globalPolicy.expectedParameters {
if err := e.expectParameter(param); err != nil {
return err
}
}
return nil
}
func (e *verificationPolicy) addRequiredParameter(name SignatureParameter) error {
if err := validateParameter(name, true); err != nil {
return err
}
return e.requireParameter(name)
}
func (e *verificationPolicy) requireParameter(name SignatureParameter) error {
if slices.Contains(e.forbiddenParameters, name) {
return fmt.Errorf("%w: required parameter %q is forbidden", ErrParameter, name)
}
if !slices.Contains(e.requiredParameters, name) {
e.requiredParameters = append(e.requiredParameters, name)
}
return nil
}
func (e *verificationPolicy) addForbiddenParameter(name SignatureParameter) error {
if err := validateParameter(name, true); err != nil {
return err
}
return e.forbidParameter(name)
}
func (e *verificationPolicy) forbidParameter(name SignatureParameter) error {
if slices.Contains(e.requiredParameters, name) {
return fmt.Errorf("%w: required parameter %q is forbidden", ErrParameter, name)
}
for _, param := range e.expectedParameters {
if param.name == name {
return fmt.Errorf("%w: expected parameter %q is forbidden", ErrParameter, name)
}
}
if !slices.Contains(e.forbiddenParameters, name) {
e.forbiddenParameters = append(e.forbiddenParameters, name)
}
return nil
}
func (e *verificationPolicy) addExpectedParameter(option parameterOption) error {
if slices.Contains(e.forbiddenParameters, option.name) {
return fmt.Errorf("%w: expected parameter %q is forbidden", ErrParameter, option.name)
}
if option.name == Nonce {
if _, err := validateNonceOption(option.value); err != nil {
return err
}
} else {
var err error
option, err = normalizeParameter(option)
if err != nil {
return err
}
}
// Structured Fields sends decimal values rounded to three places. Compare
// the parsed wire value, not the caller's higher-precision float64.
if _, isDecimal := option.value.(float64); isDecimal {
encoded, err := httpsfv.Marshal(httpsfv.Item{Value: option.value, Params: httpsfv.NewParams()})
if err != nil {
return fmt.Errorf("%w: %w", ErrParameter, err)
}
parsed, err := httpsfv.UnmarshalItem([]string{encoded})
if err != nil {
return fmt.Errorf("%w: %w", ErrParameter, err)
}
option.value = parsed.Value
}
if v, ok := option.value.([]byte); ok {
option.value = bytes.Clone(v)
}
return e.expectParameter(option)
}
func (e *verificationPolicy) expectParameter(option parameterOption) error {
if slices.Contains(e.forbiddenParameters, option.name) {
return fmt.Errorf("%w: expected parameter %q is forbidden", ErrParameter, option.name)
}
for _, existing := range e.expectedParameters {
if existing.name == option.name {
if areEqual(existing.value, option.value) {
return nil
}
return fmt.Errorf("%w: conflicting expectations for parameter %q", ErrParameter, option.name)
}
}
e.expectedParameters = append(e.expectedParameters, option)
return nil
}
func (e *verificationPolicy) validateParameters(tag string) error {
for _, name := range e.forbiddenParameters {
if name == Tag && tag != "" ||
name == Created && *e.reqCreatedTS ||
name == Expires && *e.reqExpiresTS {
return fmt.Errorf("%w: required signature parameter %q is forbidden", ErrParameter, name)
}
}
return nil
}
// nolint: funlen, cyclop, gocognit
func (e *verificationPolicy) assertMetadata(si *signatureInput, msg *Message) error {
var (
missingComponents []string
cmv compositeMessageVerifier
mv messageVerifier
tolerance time.Duration
)
now := time.Now().UTC()
if e.tolerance != nil {
tolerance = *e.tolerance
}
expires, expiresPresent := si.expires()
if !expiresPresent {
if *e.reqExpiresTS {
return fmt.Errorf("%w: expected expires parameter not present", ErrMissingParameter)
}
} else if now.After(expires.Add(tolerance)) {
return fmt.Errorf("%w: signature expired", ErrValidity)
}
created, createdPresent := si.created()
if !createdPresent {
if *e.reqCreatedTS {
return fmt.Errorf("%w: expected created parameter not present", ErrMissingParameter)
}
} else {
if now.Before(created.Add(-1 * tolerance)) {
return fmt.Errorf("%w: signature not yet valid", ErrValidity)
}
if e.maxAge != nil && *e.maxAge > 0 && created.Add(*e.maxAge).Before(now) {
return fmt.Errorf("%w: signature too old", ErrValidity)
}
}
for _, expIdentifier := range e.identifiers {
if !si.hasIdentifier(expIdentifier) {
res, _ := httpsfv.Marshal(expIdentifier)
missingComponents = append(missingComponents, res)
}
}
if len(missingComponents) > 0 {
return fmt.Errorf("%w: missing component identifiers: %s",
ErrMissingParameter, strings.Join(missingComponents, ", "))
}
for _, name := range e.requiredParameters {
if _, present := si.parameter(name); !present {
return fmt.Errorf("%w: required signature parameter %q is missing", ErrParameter, name)
}
}
for _, name := range e.forbiddenParameters {
if _, present := si.parameter(name); present {
return fmt.Errorf("%w: forbidden signature parameter %q is present", ErrParameter, name)
}
}
for _, param := range e.expectedParameters {
value, present := si.parameter(param.name)
if !present {
return fmt.Errorf("%w: expected signature parameter %q is missing", ErrMissingParameter, param.name)
}
if !areEqual(value, param.value) {
return fmt.Errorf("%w: unexpected value for signature parameter %q", ErrParameter, param.name)
}
}
for _, id := range si.identifiers {
if id.Value == "content-digest" {
_, fromReq := id.Params.Get("req")
cmv = append(cmv, contentDigester{fromRequest: fromReq})
}
}
if len(cmv) == 0 {
mv = noopMessageVerifier{}
} else {
mv = cmv
}
return mv.verify(msg)
}
func (e *verificationPolicy) assertKeyAlgorithm(si *signatureInput, keyAlg SignatureAlgorithm) error {
algorithm, algPresent := si.algorithm()
if algPresent && algorithm != keyAlg {
return fmt.Errorf("%w: key algorithm %s does not match signature algorithm %s",
ErrParameter, algorithm, keyAlg)
}
return nil
}
func areEqual(expected, actual any) bool {
switch value := expected.(type) {
case string, httpsfv.Token, httpsfv.DisplayString, bool, int64, float64:
return expected == actual
case []byte:
other, ok := actual.([]byte)
return ok && bytes.Equal(value, other)
case time.Time:
other, ok := actual.(time.Time)
return ok && value.Unix() == other.Unix()
default:
return false
}
}