/
challenge_action.go
341 lines (278 loc) · 10.8 KB
/
challenge_action.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
package botman
import (
"context"
"encoding/json"
"fmt"
"net/http"
validation "github.com/go-ozzo/ozzo-validation/v4"
)
type (
// The ChallengeAction interface supports creating, retrieving, modifying and removing challenge action as well as
// updating google recaptcha secret key for challenge action for a configuration.
ChallengeAction interface {
// GetChallengeActionList https://techdocs.akamai.com/bot-manager/reference/get-challenge-actions
GetChallengeActionList(ctx context.Context, params GetChallengeActionListRequest) (*GetChallengeActionListResponse, error)
// GetChallengeAction https://techdocs.akamai.com/bot-manager/reference/get-challenge-action
GetChallengeAction(ctx context.Context, params GetChallengeActionRequest) (map[string]interface{}, error)
// CreateChallengeAction https://techdocs.akamai.com/bot-manager/reference/post-challenge-action
CreateChallengeAction(ctx context.Context, params CreateChallengeActionRequest) (map[string]interface{}, error)
// UpdateChallengeAction https://techdocs.akamai.com/bot-manager/reference/put-challenge-action
UpdateChallengeAction(ctx context.Context, params UpdateChallengeActionRequest) (map[string]interface{}, error)
// RemoveChallengeAction https://techdocs.akamai.com/bot-manager/reference/delete-challenge-action
RemoveChallengeAction(ctx context.Context, params RemoveChallengeActionRequest) error
// UpdateGoogleReCaptchaSecretKey https://techdocs.akamai.com/bot-manager/reference/put-google-recaptch-secret-key
UpdateGoogleReCaptchaSecretKey(ctx context.Context, params UpdateGoogleReCaptchaSecretKeyRequest) error
}
// GetChallengeActionListRequest is used to retrieve challenge actions for a configuration.
GetChallengeActionListRequest struct {
ConfigID int64
Version int64
ActionID string
}
// GetChallengeActionListResponse is used to retrieve challenge actions for a configuration.
GetChallengeActionListResponse struct {
ChallengeActions []map[string]interface{} `json:"challengeActions"`
}
// GetChallengeActionRequest is used to retrieve a specific challenge action
GetChallengeActionRequest struct {
ConfigID int64
Version int64
ActionID string
}
// CreateChallengeActionRequest is used to create a new challenge action for a specific configuration.
CreateChallengeActionRequest struct {
ConfigID int64
Version int64
JsonPayload json.RawMessage
}
// UpdateChallengeActionRequest is used to update an existing challenge action
UpdateChallengeActionRequest struct {
ConfigID int64
Version int64
ActionID string
JsonPayload json.RawMessage
}
// RemoveChallengeActionRequest is used to remove an existing challenge action
RemoveChallengeActionRequest struct {
ConfigID int64
Version int64
ActionID string
}
// UpdateGoogleReCaptchaSecretKeyRequest is used to update google reCaptcha secret key
UpdateGoogleReCaptchaSecretKeyRequest struct {
ConfigID int64 `json:"-"`
Version int64 `json:"-"`
ActionID string `json:"-"`
SecretKey string `json:"googleReCaptchaSecretKey"`
}
)
// Validate validates a GetChallengeActionRequest.
func (v GetChallengeActionRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"Version": validation.Validate(v.Version, validation.Required),
"ActionID": validation.Validate(v.ActionID, validation.Required),
}.Filter()
}
// Validate validates a GetChallengeActionListRequest.
func (v GetChallengeActionListRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"Version": validation.Validate(v.Version, validation.Required),
}.Filter()
}
// Validate validates a CreateChallengeActionRequest.
func (v CreateChallengeActionRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"Version": validation.Validate(v.Version, validation.Required),
"JsonPayload": validation.Validate(v.JsonPayload, validation.Required),
}.Filter()
}
// Validate validates an UpdateChallengeActionRequest.
func (v UpdateChallengeActionRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"Version": validation.Validate(v.Version, validation.Required),
"ActionID": validation.Validate(v.ActionID, validation.Required),
"JsonPayload": validation.Validate(v.JsonPayload, validation.Required),
}.Filter()
}
// Validate validates a RemoveChallengeActionRequest.
func (v RemoveChallengeActionRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"Version": validation.Validate(v.Version, validation.Required),
"ActionID": validation.Validate(v.ActionID, validation.Required),
}.Filter()
}
// Validate validates a UpdateGoogleReCaptchaSecretKeyRequest.
func (v UpdateGoogleReCaptchaSecretKeyRequest) Validate() error {
return validation.Errors{
"ConfigID": validation.Validate(v.ConfigID, validation.Required),
"Version": validation.Validate(v.Version, validation.Required),
"ActionID": validation.Validate(v.ActionID, validation.Required),
"SecretKey": validation.Validate(v.SecretKey, validation.Required),
}.Filter()
}
func (b *botman) GetChallengeAction(ctx context.Context, params GetChallengeActionRequest) (map[string]interface{}, error) {
logger := b.Log(ctx)
logger.Debug("GetChallengeAction")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/configs/%d/versions/%d/response-actions/challenge-actions/%s",
params.ConfigID,
params.Version,
params.ActionID)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create GetChallengeAction request: %w", err)
}
var result map[string]interface{}
resp, err := b.Exec(req, &result)
if err != nil {
return nil, fmt.Errorf("GetChallengeAction request failed: %w", err)
}
if resp.StatusCode != http.StatusOK {
return nil, b.Error(resp)
}
return result, nil
}
func (b *botman) GetChallengeActionList(ctx context.Context, params GetChallengeActionListRequest) (*GetChallengeActionListResponse, error) {
logger := b.Log(ctx)
logger.Debug("GetChallengeActionList")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/configs/%d/versions/%d/response-actions/challenge-actions",
params.ConfigID,
params.Version,
)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create GetlustomDenyList request: %w", err)
}
var result GetChallengeActionListResponse
resp, err := b.Exec(req, &result)
if err != nil {
return nil, fmt.Errorf("GetChallengeActionList request failed: %w", err)
}
if resp.StatusCode != http.StatusOK {
return nil, b.Error(resp)
}
var filteredResult GetChallengeActionListResponse
if params.ActionID != "" {
for _, val := range result.ChallengeActions {
if val["actionId"].(string) == params.ActionID {
filteredResult.ChallengeActions = append(filteredResult.ChallengeActions, val)
}
}
} else {
filteredResult = result
}
return &filteredResult, nil
}
func (b *botman) UpdateChallengeAction(ctx context.Context, params UpdateChallengeActionRequest) (map[string]interface{}, error) {
logger := b.Log(ctx)
logger.Debug("UpdateChallengeAction")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
putURL := fmt.Sprintf(
"/appsec/v1/configs/%d/versions/%d/response-actions/challenge-actions/%s",
params.ConfigID,
params.Version,
params.ActionID,
)
req, err := http.NewRequestWithContext(ctx, http.MethodPut, putURL, nil)
if err != nil {
return nil, fmt.Errorf("failed to create UpdateChallengeAction request: %w", err)
}
var result map[string]interface{}
resp, err := b.Exec(req, &result, params.JsonPayload)
if err != nil {
return nil, fmt.Errorf("UpdateChallengeAction request failed: %w", err)
}
if resp.StatusCode != http.StatusOK {
return nil, b.Error(resp)
}
return result, nil
}
func (b *botman) CreateChallengeAction(ctx context.Context, params CreateChallengeActionRequest) (map[string]interface{}, error) {
logger := b.Log(ctx)
logger.Debug("CreateChallengeAction")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/configs/%d/versions/%d/response-actions/challenge-actions",
params.ConfigID,
params.Version,
)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create CreateChallengeAction request: %w", err)
}
var result map[string]interface{}
resp, err := b.Exec(req, &result, params.JsonPayload)
if err != nil {
return nil, fmt.Errorf("CreateChallengeAction request failed: %w", err)
}
if resp.StatusCode != http.StatusCreated {
return nil, b.Error(resp)
}
return result, nil
}
func (b *botman) RemoveChallengeAction(ctx context.Context, params RemoveChallengeActionRequest) error {
logger := b.Log(ctx)
logger.Debug("RemoveChallengeAction")
if err := params.Validate(); err != nil {
return fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf("/appsec/v1/configs/%d/versions/%d/response-actions/challenge-actions/%s",
params.ConfigID,
params.Version,
params.ActionID)
req, err := http.NewRequestWithContext(ctx, http.MethodDelete, uri, nil)
if err != nil {
return fmt.Errorf("failed to create RemoveChallengeAction request: %w", err)
}
var result map[string]interface{}
resp, err := b.Exec(req, &result)
if err != nil {
return fmt.Errorf("RemoveChallengeAction request failed: %w", err)
}
if resp.StatusCode != http.StatusNoContent {
return b.Error(resp)
}
return nil
}
func (b *botman) UpdateGoogleReCaptchaSecretKey(ctx context.Context, params UpdateGoogleReCaptchaSecretKeyRequest) error {
logger := b.Log(ctx)
logger.Debug("UpdateGoogleReCaptchaSecretKey")
if err := params.Validate(); err != nil {
return fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
putURL := fmt.Sprintf(
"/appsec/v1/configs/%d/versions/%d/response-actions/challenge-actions/%s/google-recaptcha-secret-key",
params.ConfigID,
params.Version,
params.ActionID,
)
req, err := http.NewRequestWithContext(ctx, http.MethodPut, putURL, nil)
if err != nil {
return fmt.Errorf("failed to create UpdateGoogleReCaptchaSecretKey request: %w", err)
}
var result map[string]interface{}
resp, err := b.Exec(req, &result, params)
if err != nil {
return fmt.Errorf("UpdateGoogleReCaptchaSecretKey request failed: %w", err)
}
if resp.StatusCode != http.StatusNoContent {
return b.Error(resp)
}
return nil
}