/
custom_rule.go
423 lines (361 loc) · 14.6 KB
/
custom_rule.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
package appsec
import (
"context"
"encoding/json"
"fmt"
"net/http"
"reflect"
validation "github.com/go-ozzo/ozzo-validation/v4"
)
type (
// The CustomRule interface supports creating, retrievinfg, modifying and removing custom rules
// for a configuration.
CustomRule interface {
// GetCustomRules lists custom rules defined in a security configuration.
//
// See: https://techdocs.akamai.com/application-security/reference/get-configs-custom-rules
GetCustomRules(ctx context.Context, params GetCustomRulesRequest) (*GetCustomRulesResponse, error)
// GetCustomRule returns the details of a custom rule.
//
// See: https://techdocs.akamai.com/application-security/reference/get-config-custom-rule
GetCustomRule(ctx context.Context, params GetCustomRuleRequest) (*GetCustomRuleResponse, error)
// CreateCustomRule creates a new custom rule.
//
// See: https://techdocs.akamai.com/application-security/reference/post-config-custom-rules
CreateCustomRule(ctx context.Context, params CreateCustomRuleRequest) (*CreateCustomRuleResponse, error)
// UpdateCustomRule updates an existing custom rule.
//
// See: https://techdocs.akamai.com/application-security/reference/put-config-custom-rule
UpdateCustomRule(ctx context.Context, params UpdateCustomRuleRequest) (*UpdateCustomRuleResponse, error)
// RemoveCustomRule deletes a custom rule as long as it isn't activated.
//
// See: https://techdocs.akamai.com/application-security/reference/delete-config-custom-rule
RemoveCustomRule(ctx context.Context, params RemoveCustomRuleRequest) (*RemoveCustomRuleResponse, error)
}
// CustomRuleConditionsValue is a slice of strings used to indicate condition values in custom rule conditions.
CustomRuleConditionsValue []string
// CustomRuleConditionsName is a slice of strings used to indicate condition names in custom rule conditions.
CustomRuleConditionsName []string
// GetCustomRulesRequest is used to retrieve the custom rules for a configuration.
GetCustomRulesRequest struct {
ConfigID int `json:"configid,omitempty"`
ID int `json:"-"`
}
// GetCustomRulesResponse is returned from a call to GetCustomRules.
GetCustomRulesResponse struct {
CustomRules []struct {
ID int `json:"id"`
Link string `json:"link"`
Name string `json:"name"`
Status string `json:"status"`
Version int `json:"version"`
EffectiveTimePeriod *CustomRuleEffectivePeriod `json:"effectiveTimePeriod,omitempty"`
SamplingRate *int `json:"samplingRate,omitempty"`
} `json:"customRules"`
}
// GetCustomRuleRequest is used to retrieve the details of a custom rule.
GetCustomRuleRequest struct {
ConfigID int `json:"configid,omitempty"`
ID int `json:"id,omitempty"`
}
// GetCustomRuleResponse is returned from a call to GetCustomRule.
GetCustomRuleResponse CustomRuleResponse
// CustomRuleResponse is returned from calls to GetCustomRule, UpdateCustomRule, and DeleteCustomRule.
CustomRuleResponse struct {
ID int `json:"-"`
Name string `json:"name"`
Description string `json:"description,omitempty"`
Version int `json:"-"`
RuleActivated bool `json:"-"`
Structured bool `json:"-"`
Tag []string `json:"tag"`
Conditions []struct {
Name *json.RawMessage `json:"name,omitempty"`
NameCase *bool `json:"nameCase,omitempty"`
NameWildcard *bool `json:"nameWildcard,omitempty"`
PositiveMatch bool `json:"positiveMatch"`
Type string `json:"type"`
Value *json.RawMessage `json:"value,omitempty"`
ValueCase *bool `json:"valueCase,omitempty"`
ValueExactMatch *bool `json:"valueExactMatch,omitempty"`
ValueIgnoreSegment *bool `json:"valueIgnoreSegment,omitempty"`
ValueNormalize *bool `json:"valueNormalize,omitempty"`
ValueRecursive *bool `json:"valueRecursive,omitempty"`
ValueWildcard *bool `json:"valueWildcard,omitempty"`
UseXForwardForHeaders *bool `json:"useXForwardForHeaders,omitempty"`
} `json:"conditions"`
EffectiveTimePeriod *CustomRuleEffectivePeriod `json:"effectiveTimePeriod,omitempty"`
SamplingRate int `json:"samplingRate,omitempty"`
LoggingOptions *json.RawMessage `json:"loggingOptions,omitempty"`
Operation string `json:"operation,omitempty"`
}
// CustomRuleEffectivePeriod defines the period during which a custom rule is active as well as its current status.
CustomRuleEffectivePeriod struct {
EndDate string `json:"endDate"`
StartDate string `json:"startDate"`
Status string `json:"-"`
}
// CreateCustomRuleRequest is used to create a custom rule.
CreateCustomRuleRequest struct {
ConfigID int `json:"configid,omitempty"`
Version int `json:"version,omitempty"`
JsonPayloadRaw json.RawMessage `json:"-"`
}
// CreateCustomRuleResponse is returned from a call to CreateCustomRule.
CreateCustomRuleResponse struct {
ID int `json:"id,omitempty"`
Name string `json:"name"`
Description string `json:"description,omitempty"`
Version int `json:"-"`
RuleActivated bool `json:"-"`
Structured bool `json:"-"`
Tag []string `json:"tag"`
Conditions []struct {
Name *json.RawMessage `json:"name,omitempty"`
NameCase *bool `json:"nameCase,omitempty"`
NameWildcard *bool `json:"nameWildcard,omitempty"`
PositiveMatch bool `json:"positiveMatch"`
Type string `json:"type"`
Value *json.RawMessage `json:"value,omitempty"`
ValueCase *bool `json:"valueCase,omitempty"`
ValueExactMatch *bool `json:"valueExactMatch,omitempty"`
ValueIgnoreSegment *bool `json:"valueIgnoreSegment,omitempty"`
ValueNormalize *bool `json:"valueNormalize,omitempty"`
ValueRecursive *bool `json:"valueRecursive,omitempty"`
ValueWildcard *bool `json:"valueWildcard,omitempty"`
UseXForwardForHeaders *bool `json:"useXForwardForHeaders,omitempty"`
} `json:"conditions"`
EffectiveTimePeriod *CustomRuleEffectivePeriod `json:"effectiveTimePeriod,omitempty"`
SamplingRate int `json:"samplingRate,omitempty"`
LoggingOptions *json.RawMessage `json:"loggingOptions,omitempty"`
Operation string `json:"operation,omitempty"`
}
// UpdateCustomRuleRequest is used to modify an existing custom rule.
UpdateCustomRuleRequest struct {
ConfigID int `json:"configid,omitempty"`
ID int `json:"id,omitempty"`
Version int `json:"version,omitempty"`
JsonPayloadRaw json.RawMessage `json:"-"`
}
// UpdateCustomRuleResponse is returned from a call to UpdateCustomRule.
UpdateCustomRuleResponse GetCustomRuleResponse
// RemoveCustomRuleRequest is used to remove a custom rule.
RemoveCustomRuleRequest struct {
ConfigID int `json:"configid,omitempty"`
ID int `json:"id,omitempty"`
}
// RemoveCustomRuleResponse is returned from a call to RemoveCustomRule.
RemoveCustomRuleResponse UpdateCustomRuleResponse
)
// UnmarshalJSON reads a CustomRuleConditionsValue from its data argument.
func (c *CustomRuleConditionsValue) UnmarshalJSON(data []byte) error {
var nums interface{}
err := json.Unmarshal(data, &nums)
if err != nil {
return err
}
items := reflect.ValueOf(nums)
switch items.Kind() {
case reflect.String:
*c = append(*c, items.String())
case reflect.Slice:
*c = make(CustomRuleConditionsValue, 0, items.Len())
for i := 0; i < items.Len(); i++ {
item := items.Index(i)
switch item.Kind() {
case reflect.String:
*c = append(*c, item.String())
case reflect.Interface:
*c = append(*c, item.Interface().(string))
}
}
}
return nil
}
// UnmarshalJSON reads a CustomRuleConditionsName from its data argument.
func (c *CustomRuleConditionsName) UnmarshalJSON(data []byte) error {
var nums interface{}
err := json.Unmarshal(data, &nums)
if err != nil {
return err
}
items := reflect.ValueOf(nums)
switch items.Kind() {
case reflect.String:
*c = append(*c, items.String())
case reflect.Slice:
*c = make(CustomRuleConditionsName, 0, items.Len())
for i := 0; i < items.Len(); i++ {
item := items.Index(i)
switch item.Kind() {
case reflect.String:
*c = append(*c, item.String())
case reflect.Interface:
*c = append(*c, item.Interface().(string))
}
}
}
return nil
}
// Validate validates a GetCustomRuleRequest.
func (v GetCustomRuleRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"ID": validation.Validate(v.ID, validation.Required),
}.Filter()
}
// Validate validates a GetCustomRulesRequest.
func (v GetCustomRulesRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
}.Filter()
}
// Validate validates a CreateCustomRuleRequest.
func (v CreateCustomRuleRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
}.Filter()
}
// Validate validates an UpdateCustomRuleRequest.
func (v UpdateCustomRuleRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"ID": validation.Validate(v.ID, validation.Required),
}.Filter()
}
// Validate validates a RemoveCustomRuleRequest.
func (v RemoveCustomRuleRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"ID": validation.Validate(v.ID, validation.Required),
}.Filter()
}
func (p *appsec) GetCustomRule(ctx context.Context, params GetCustomRuleRequest) (*GetCustomRuleResponse, error) {
logger := p.Log(ctx)
logger.Debug("GetCustomRule")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/configs/%d/custom-rules/%d",
params.ConfigID,
params.ID)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create GetCustomRule request: %w", err)
}
var result GetCustomRuleResponse
resp, err := p.Exec(req, &result)
if err != nil {
return nil, fmt.Errorf("get custom rule request failed: %w", err)
}
if resp.StatusCode != http.StatusOK {
return nil, p.Error(resp)
}
return &result, nil
}
func (p *appsec) GetCustomRules(ctx context.Context, params GetCustomRulesRequest) (*GetCustomRulesResponse, error) {
logger := p.Log(ctx)
logger.Debug("GetCustomRules")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/configs/%d/custom-rules",
params.ConfigID,
)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create GetCustomRules request: %w", err)
}
var result GetCustomRulesResponse
resp, err := p.Exec(req, &result)
if err != nil {
return nil, fmt.Errorf("get custom rules request failed: %w", err)
}
if resp.StatusCode != http.StatusOK {
return nil, p.Error(resp)
}
if params.ID != 0 {
var filteredResult GetCustomRulesResponse
for _, val := range result.CustomRules {
if val.ID == params.ID {
filteredResult.CustomRules = append(filteredResult.CustomRules, val)
}
}
return &filteredResult, nil
}
return &result, nil
}
func (p *appsec) UpdateCustomRule(ctx context.Context, params UpdateCustomRuleRequest) (*UpdateCustomRuleResponse, error) {
logger := p.Log(ctx)
logger.Debug("UpdateCustomRule")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/configs/%d/custom-rules/%d",
params.ConfigID,
params.ID,
)
req, err := http.NewRequestWithContext(ctx, http.MethodPut, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create UpdateCustomRule request: %w", err)
}
var result UpdateCustomRuleResponse
req.Header.Set("Content-Type", "application/json")
resp, err := p.Exec(req, &result, params.JsonPayloadRaw)
if err != nil {
return nil, fmt.Errorf("update custom rule request failed: %w", err)
}
if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusCreated {
return nil, p.Error(resp)
}
return &result, nil
}
func (p *appsec) CreateCustomRule(ctx context.Context, params CreateCustomRuleRequest) (*CreateCustomRuleResponse, error) {
logger := p.Log(ctx)
logger.Debug("CreateCustomRule")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/configs/%d/custom-rules",
params.ConfigID,
)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create CreateCustomRule request: %w", err)
}
var result CreateCustomRuleResponse
req.Header.Set("Content-Type", "application/json")
resp, err := p.Exec(req, &result, params.JsonPayloadRaw)
if err != nil {
return nil, fmt.Errorf("create custom rule request failed: %w", err)
}
if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusCreated {
return nil, p.Error(resp)
}
return &result, nil
}
func (p *appsec) RemoveCustomRule(ctx context.Context, params RemoveCustomRuleRequest) (*RemoveCustomRuleResponse, error) {
logger := p.Log(ctx)
logger.Debug("RemoveCustomRule")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
var result RemoveCustomRuleResponse
uri := fmt.Sprintf("/appsec/v1/configs/%d/custom-rules/%d", params.ConfigID, params.ID)
req, err := http.NewRequestWithContext(ctx, http.MethodDelete, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create RemoveCustomRule request: %w", err)
}
resp, err := p.Exec(req, nil)
if err != nil {
return nil, fmt.Errorf("remove custom rule request failed: %w", err)
}
if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusNoContent {
return nil, p.Error(resp)
}
return &result, nil
}