/
rate_policy.go
535 lines (475 loc) · 21.9 KB
/
rate_policy.go
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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
package appsec
import (
"context"
"encoding/json"
"fmt"
"net/http"
validation "github.com/go-ozzo/ozzo-validation/v4"
)
type (
// The RatePolicy interface supports creating, retrieving, updating and removing rate policies.
RatePolicy interface {
// GetRatePolicies returns rate policies for a specific security configuration version.
//
// See: https://techdocs.akamai.com/application-security/reference/get-rate-policies
GetRatePolicies(ctx context.Context, params GetRatePoliciesRequest) (*GetRatePoliciesResponse, error)
// GetRatePolicy returns the specified rate policy.
//
// See: https://techdocs.akamai.com/application-security/reference/get-rate-policy
GetRatePolicy(ctx context.Context, params GetRatePolicyRequest) (*GetRatePolicyResponse, error)
// CreateRatePolicy creates a new rate policy for a specific configuration version.
//
// See: https://techdocs.akamai.com/application-security/reference/post-rate-policies
CreateRatePolicy(ctx context.Context, params CreateRatePolicyRequest) (*CreateRatePolicyResponse, error)
// UpdateRatePolicy updates details for a specific rate policy.
//
// See: https://techdocs.akamai.com/application-security/reference/put-rate-policy
UpdateRatePolicy(ctx context.Context, params UpdateRatePolicyRequest) (*UpdateRatePolicyResponse, error)
// RemoveRatePolicy deletes the specified rate policy.
//
// See: https://techdocs.akamai.com/application-security/reference/delete-rate-policy
RemoveRatePolicy(ctx context.Context, params RemoveRatePolicyRequest) (*RemoveRatePolicyResponse, error)
}
// CreateRatePolicyRequest is used to create a rate policy.
CreateRatePolicyRequest struct {
ID int `json:"-"`
ConfigID int `json:"configId"`
ConfigVersion int `json:"configVersion"`
JsonPayloadRaw json.RawMessage `json:"-"`
}
// CreateRatePolicyResponse is returned from a call to CreateRatePolicy.
CreateRatePolicyResponse struct {
ID int `json:"id"`
ConfigID int `json:"configId"`
ConfigVersion int `json:"configVersion"`
MatchType string `json:"matchType"`
Type string `json:"type"`
Name string `json:"name"`
Description string `json:"description"`
AverageThreshold int `json:"averageThreshold"`
BurstThreshold int `json:"burstThreshold"`
BurstWindow int `json:"burstWindow"`
ClientIdentifier string `json:"clientIdentifier"`
UseXForwardForHeaders bool `json:"useXForwardForHeaders"`
RequestType string `json:"requestType"`
SameActionOnIpv6 bool `json:"sameActionOnIpv6"`
Path struct {
PositiveMatch bool `json:"positiveMatch"`
Values []string `json:"values"`
} `json:"path"`
PathMatchType string `json:"pathMatchType"`
PathURIPositiveMatch bool `json:"pathUriPositiveMatch"`
FileExtensions struct {
PositiveMatch bool `json:"positiveMatch"`
Values []string `json:"values"`
} `json:"fileExtensions"`
Hosts *RatePoliciesHosts `json:"hosts,omitempty"`
Hostnames []string `json:"hostnames"`
AdditionalMatchOptions []RatePolicyMatchOption `json:"additionalMatchOptions,omitempty"`
Condition *RatePolicyCondition `json:"condition,omitempty"`
QueryParameters []struct {
Name string `json:"name"`
Values []string `json:"values"`
PositiveMatch bool `json:"positiveMatch"`
ValueInRange bool `json:"valueInRange"`
} `json:"queryParameters"`
CreateDate string `json:"-"`
UpdateDate string `json:"-"`
Used json.RawMessage `json:"used"`
}
// UpdateRatePolicyRequest is used to modify an existing rate policy.
UpdateRatePolicyRequest struct {
RatePolicyID int `json:"id"`
ConfigID int `json:"configId"`
ConfigVersion int `json:"configVersion"`
JsonPayloadRaw json.RawMessage `json:"-"`
}
// UpdateRatePolicyResponse is returned from a call to UpdateRatePolicy.
UpdateRatePolicyResponse struct {
ID int `json:"id"`
ConfigID int `json:"configId"`
ConfigVersion int `json:"configVersion"`
MatchType string `json:"matchType"`
Type string `json:"type"`
Name string `json:"name"`
Description string `json:"description"`
AverageThreshold int `json:"averageThreshold"`
BurstThreshold int `json:"burstThreshold"`
BurstWindow int `json:"burstWindow"`
ClientIdentifier string `json:"clientIdentifier"`
UseXForwardForHeaders bool `json:"useXForwardForHeaders"`
RequestType string `json:"requestType"`
SameActionOnIpv6 bool `json:"sameActionOnIpv6"`
Path struct {
PositiveMatch bool `json:"positiveMatch"`
Values []string `json:"values"`
} `json:"path"`
PathMatchType string `json:"pathMatchType"`
PathURIPositiveMatch bool `json:"pathUriPositiveMatch"`
FileExtensions struct {
PositiveMatch bool `json:"positiveMatch"`
Values []string `json:"values"`
} `json:"fileExtensions"`
Hosts *RatePoliciesHosts `json:"hosts,omitempty"`
Hostnames []string `json:"hostnames"`
AdditionalMatchOptions []RatePolicyMatchOption `json:"additionalMatchOptions,omitempty"`
Condition *RatePolicyCondition `json:"condition,omitempty"`
QueryParameters []struct {
Name string `json:"name"`
Values []string `json:"values"`
PositiveMatch bool `json:"positiveMatch"`
ValueInRange bool `json:"valueInRange"`
} `json:"queryParameters"`
CreateDate string `json:"-"`
UpdateDate string `json:"-"`
Used json.RawMessage `json:"used"`
}
// RemoveRatePolicyRequest is used to remove a rate policy.
RemoveRatePolicyRequest struct {
ConfigID int `json:"configId"`
ConfigVersion int `json:"configVersion"`
RatePolicyID int `json:"ratePolicyId"`
}
// RemoveRatePolicyResponse is returned from a call to RemoveRatePolicy.
RemoveRatePolicyResponse struct {
ID int `json:"id"`
ConfigID int `json:"configId"`
ConfigVersion int `json:"configVersion"`
MatchType string `json:"matchType"`
Type string `json:"type"`
Name string `json:"name"`
Description string `json:"description"`
AverageThreshold int `json:"averageThreshold"`
BurstThreshold int `json:"burstThreshold"`
BurstWindow int `json:"burstWindow"`
ClientIdentifier string `json:"clientIdentifier"`
UseXForwardForHeaders bool `json:"useXForwardForHeaders"`
RequestType string `json:"requestType"`
SameActionOnIpv6 bool `json:"sameActionOnIpv6"`
Path struct {
PositiveMatch bool `json:"positiveMatch"`
Values []string `json:"values"`
} `json:"path"`
PathMatchType string `json:"pathMatchType"`
PathURIPositiveMatch bool `json:"pathUriPositiveMatch"`
FileExtensions struct {
PositiveMatch bool `json:"positiveMatch"`
Values []string `json:"values"`
} `json:"fileExtensions"`
Hosts *RatePoliciesHosts `json:"hosts,omitempty"`
Hostnames []string `json:"hostnames"`
AdditionalMatchOptions []RatePolicyMatchOption `json:"additionalMatchOptions,omitempty"`
Condition *RatePolicyCondition `json:"condition,omitempty"`
QueryParameters []struct {
Name string `json:"name"`
Values []string `json:"values"`
PositiveMatch bool `json:"positiveMatch"`
ValueInRange bool `json:"valueInRange"`
} `json:"queryParameters"`
CreateDate string `json:"-"`
UpdateDate string `json:"-"`
Used json.RawMessage `json:"used"`
}
// GetRatePoliciesRequest is used to retrieve the rate policies for a configuration.
GetRatePoliciesRequest struct {
ConfigID int `json:"configId"`
ConfigVersion int `json:"configVersion"`
RatePolicyID int `json:"ratePolicyId"`
}
// GetRatePoliciesResponse is returned from a call to GetRatePolicies.
GetRatePoliciesResponse struct {
RatePolicies []struct {
ID int `json:"id"`
ConfigID int `json:"-"`
ConfigVersion int `json:"-"`
MatchType string `json:"matchType,omitempty"`
Type string `json:"type,omitempty"`
Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"`
AverageThreshold int `json:"averageThreshold,omitempty"`
BurstThreshold int `json:"burstThreshold,omitempty"`
BurstWindow int `json:"burstWindow,omitempty"`
ClientIdentifier string `json:"clientIdentifier,omitempty"`
UseXForwardForHeaders bool `json:"useXForwardForHeaders"`
RequestType string `json:"requestType,omitempty"`
SameActionOnIpv6 bool `json:"sameActionOnIpv6"`
Path *RatePolicyPath `json:"path,omitempty"`
PathMatchType string `json:"pathMatchType,omitempty"`
PathURIPositiveMatch bool `json:"pathUriPositiveMatch"`
FileExtensions *RatePolicyFileExtensions `json:"fileExtensions,omitempty"`
Hosts *RatePoliciesHosts `json:"hosts,omitempty"`
Hostnames []string `json:"hostnames,omitempty"`
AdditionalMatchOptions []RatePolicyMatchOption `json:"additionalMatchOptions,omitempty"`
Condition *RatePolicyCondition `json:"condition,omitempty"`
QueryParameters *RatePolicyQueryParameters `json:"queryParameters,omitempty"`
CreateDate string `json:"-"`
UpdateDate string `json:"-"`
Used json.RawMessage `json:"used"`
SameActionOnIpv bool `json:"sameActionOnIpv"`
APISelectors *RatePolicyAPISelectors `json:"apiSelectors,omitempty"`
BodyParameters *RatePolicyBodyParameters `json:"bodyParameters,omitempty"`
} `json:"ratePolicies,omitempty"`
}
// GetRatePolicyRequest is used to retrieve information about a specific rate policy.
GetRatePolicyRequest struct {
ConfigID int `json:"configId"`
ConfigVersion int `json:"configVersion"`
RatePolicyID int `json:"ratePolicyId"`
}
// GetRatePolicyResponse is returned from a call to GetRatePolicy.
GetRatePolicyResponse struct {
ID int `json:"-"`
ConfigID int `json:"-"`
ConfigVersion int `json:"-"`
MatchType string `json:"matchType,omitempty"`
Type string `json:"type,omitempty"`
Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"`
AverageThreshold int `json:"averageThreshold,omitempty"`
BurstThreshold int `json:"burstThreshold,omitempty"`
BurstWindow int `json:"burstWindow,omitempty"`
ClientIdentifier string `json:"clientIdentifier,omitempty"`
UseXForwardForHeaders bool `json:"useXForwardForHeaders"`
RequestType string `json:"requestType,omitempty"`
SameActionOnIpv6 bool `json:"sameActionOnIpv6"`
Path *RatePolicyPath `json:"path,omitempty"`
PathMatchType string `json:"pathMatchType,omitempty"`
PathURIPositiveMatch bool `json:"pathUriPositiveMatch"`
FileExtensions *RatePolicyFileExtensions `json:"fileExtensions,omitempty"`
Hosts *RatePoliciesHosts `json:"hosts,omitempty"`
Hostnames []string `json:"hostnames,omitempty"`
AdditionalMatchOptions []RatePolicyMatchOption `json:"additionalMatchOptions,omitempty"`
Condition *RatePolicyCondition `json:"condition,omitempty"`
QueryParameters *RatePolicyQueryParameters `json:"queryParameters,omitempty"`
CreateDate string `json:"-"`
UpdateDate string `json:"-"`
Used bool `json:"-"`
}
// RatePolicyAPISelectors is used as part of a rate policy description.
RatePolicyAPISelectors []struct {
APIDefinitionID int `json:"apiDefinitionId,omitempty"`
DefinedResources *bool `json:"definedResources,omitempty"`
ResourceIds []int `json:"resourceIds"`
UndefinedResources *bool `json:"undefinedResources,omitempty"`
}
// RatePolicyBodyParameters is used as part of a rate policy description.
RatePolicyBodyParameters []struct {
Name string `json:"name,omitempty"`
Values []string `json:"values,omitempty"`
PositiveMatch bool `json:"positiveMatch"`
ValueInRange bool `json:"valueInRange"`
}
// RatePolicyPath is used as part of a rate policy description.
RatePolicyPath struct {
PositiveMatch bool `json:"positiveMatch"`
Values []string `json:"values,omitempty"`
}
// RatePolicyFileExtensions is used as part of a rate policy description.
RatePolicyFileExtensions struct {
PositiveMatch bool `json:"positiveMatch"`
Values []string `json:"values,omitempty"`
}
// RatePolicyMatchOption is used as part of a rate policy description.
RatePolicyMatchOption struct {
PositiveMatch bool `json:"positiveMatch"`
Type string `json:"type,omitempty"`
Values []string `json:"values,omitempty"`
}
// RatePolicyQueryParameters is used as part of a rate policy description.
RatePolicyQueryParameters []struct {
Name string `json:"name,omitempty"`
Values []string `json:"values,omitempty"`
PositiveMatch bool `json:"positiveMatch"`
ValueInRange bool `json:"valueInRange"`
}
// RatePoliciesHosts is used as part of a rate policy description.
RatePoliciesHosts struct {
Values *[]string `json:"values,omitempty"`
PositiveMatch *json.RawMessage `json:"positiveMatch,omitempty"`
}
// RatePolicyCondition is used as part of a rate policy description.
RatePolicyCondition struct {
AtomicConditions []struct {
Value *json.RawMessage `json:"value,omitempty"`
ClassName string `json:"className"`
PositiveMatch bool `json:"positiveMatch"`
Name []string `json:"name,omitempty"`
NameCase bool `json:"nameCase,omitempty"`
NameWildcard bool `json:"nameWildcard,omitempty"`
ValueCase bool `json:"valueCase,omitempty"`
ValueWildcard bool `json:"valueWildcard,omitempty"`
SharedIpHandling string `json:"sharedIpHandling,omitempty"`
} `json:"atomicConditions,omitempty"`
}
)
// Validate validates a GetRatePolicyRequest.
func (v GetRatePolicyRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"ConfigVersion": validation.Validate(v.ConfigVersion, validation.Required),
"RatePolicyID": validation.Validate(v.RatePolicyID, validation.Required),
}.Filter()
}
// Validate validates a GetRatePoliciesRequest.
func (v GetRatePoliciesRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"ConfigVersion": validation.Validate(v.ConfigVersion, validation.Required),
}.Filter()
}
// Validate validates a CreateRatePolicyRequest.
func (v CreateRatePolicyRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"ConfigVersion": validation.Validate(v.ConfigVersion, validation.Required),
}.Filter()
}
// Validate validates an UpdateRatePolicyRequest.
func (v UpdateRatePolicyRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"ConfigVersion": validation.Validate(v.ConfigVersion, validation.Required),
"RatePolicyID": validation.Validate(v.RatePolicyID, validation.Required),
}.Filter()
}
// Validate validates a RemoveRatePolicyRequest.
func (v RemoveRatePolicyRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"ConfigVersion": validation.Validate(v.ConfigVersion, validation.Required),
"RatePolicyID": validation.Validate(v.RatePolicyID, validation.Required),
}.Filter()
}
func (p *appsec) GetRatePolicy(ctx context.Context, params GetRatePolicyRequest) (*GetRatePolicyResponse, error) {
logger := p.Log(ctx)
logger.Debug("GetRatePolicy")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/configs/%d/versions/%d/rate-policies/%d",
params.ConfigID,
params.ConfigVersion,
params.RatePolicyID)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create GetRatePolicy request: %w", err)
}
var result GetRatePolicyResponse
resp, err := p.Exec(req, &result)
if err != nil {
return nil, fmt.Errorf("get rate policy request failed: %w", err)
}
if resp.StatusCode != http.StatusOK {
return nil, p.Error(resp)
}
return &result, nil
}
func (p *appsec) GetRatePolicies(ctx context.Context, params GetRatePoliciesRequest) (*GetRatePoliciesResponse, error) {
logger := p.Log(ctx)
logger.Debug("GetRatePolicies")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/configs/%d/versions/%d/rate-policies",
params.ConfigID,
params.ConfigVersion,
)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create GetRatePolicies request: %w", err)
}
var result GetRatePoliciesResponse
resp, err := p.Exec(req, &result)
if err != nil {
return nil, fmt.Errorf("get rate policies request failed: %w", err)
}
if resp.StatusCode != http.StatusOK {
return nil, p.Error(resp)
}
if params.RatePolicyID != 0 {
var filteredResult GetRatePoliciesResponse
for _, val := range result.RatePolicies {
if val.ID == params.RatePolicyID {
filteredResult.RatePolicies = append(filteredResult.RatePolicies, val)
}
}
return &filteredResult, nil
}
return &result, nil
}
func (p *appsec) UpdateRatePolicy(ctx context.Context, params UpdateRatePolicyRequest) (*UpdateRatePolicyResponse, error) {
logger := p.Log(ctx)
logger.Debug("UpdateRatePolicy")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/configs/%d/versions/%d/rate-policies/%d",
params.ConfigID,
params.ConfigVersion,
params.RatePolicyID,
)
req, err := http.NewRequestWithContext(ctx, http.MethodPut, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create UpdateRatePolicy request: %w", err)
}
var result UpdateRatePolicyResponse
req.Header.Set("Content-Type", "application/json")
resp, err := p.Exec(req, &result, params.JsonPayloadRaw)
if err != nil {
return nil, fmt.Errorf("update rate policy request failed: %w", err)
}
if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusCreated {
return nil, p.Error(resp)
}
return &result, nil
}
func (p *appsec) CreateRatePolicy(ctx context.Context, params CreateRatePolicyRequest) (*CreateRatePolicyResponse, error) {
logger := p.Log(ctx)
logger.Debug("CreateRatePolicy")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/configs/%d/versions/%d/rate-policies",
params.ConfigID,
params.ConfigVersion,
)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create CreateRatePolicy request: %w", err)
}
var result CreateRatePolicyResponse
req.Header.Set("Content-Type", "application/json")
resp, err := p.Exec(req, &result, params.JsonPayloadRaw)
if err != nil {
return nil, fmt.Errorf("create rate policy request failed: %w", err)
}
if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusCreated {
return nil, p.Error(resp)
}
return &result, nil
}
func (p *appsec) RemoveRatePolicy(ctx context.Context, params RemoveRatePolicyRequest) (*RemoveRatePolicyResponse, error) {
logger := p.Log(ctx)
logger.Debug("RemoveRatePolicy")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf("/appsec/v1/configs/%d/versions/%d/rate-policies/%d", params.ConfigID, params.ConfigVersion, params.RatePolicyID)
req, err := http.NewRequestWithContext(ctx, http.MethodDelete, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create RemoveRatePolicy request: %w", err)
}
var result RemoveRatePolicyResponse
resp, err := p.Exec(req, &result)
if err != nil {
return nil, fmt.Errorf("remove rate policy request failed: %w", err)
}
if resp.StatusCode != http.StatusNoContent && resp.StatusCode != http.StatusOK {
return nil, p.Error(resp)
}
return &result, nil
}