/
activations.go
333 lines (272 loc) · 11.4 KB
/
activations.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
package appsec
import (
"context"
"fmt"
"net/http"
"time"
validation "github.com/go-ozzo/ozzo-validation/v4"
)
type (
// The Activations interface supports the activation and deactivation of security configurations.
Activations interface {
// GetActivations returns the status of an activation.
//
// See: https://techdocs.akamai.com/application-security/reference/get-activation
GetActivations(ctx context.Context, params GetActivationsRequest) (*GetActivationsResponse, error)
// GetActivationHistory lists the activation history for a configuration.
//
// See: https://techdocs.akamai.com/application-security/reference/get-activation-history
GetActivationHistory(ctx context.Context, params GetActivationHistoryRequest) (*GetActivationHistoryResponse, error)
// CreateActivations activates a configuration. If acknowledgeWarnings is true and warnings are
// returned on the first attempt, a second attempt is made acknowledging the warnings.
//
CreateActivations(ctx context.Context, params CreateActivationsRequest, acknowledgeWarnings bool) (*CreateActivationsResponse, error)
// RemoveActivations deactivates a configuration.
//
RemoveActivations(ctx context.Context, params RemoveActivationsRequest) (*RemoveActivationsResponse, error)
}
// GetActivationsRequest is used to request the status of an activation request.
GetActivationsRequest struct {
ActivationID int `json:"activationId"`
}
// GetActivationsResponse is returned from a call to GetActivations.
GetActivationsResponse struct {
DispatchCount int `json:"dispatchCount"`
ActivationID int `json:"activationId"`
Action string `json:"action"`
Status StatusValue `json:"status"`
Network NetworkValue `json:"network"`
Estimate string `json:"estimate"`
CreatedBy string `json:"createdBy"`
CreateDate time.Time `json:"createDate"`
ActivationConfigs []struct {
ConfigID int `json:"configId"`
ConfigName string `json:"configName"`
ConfigVersion int `json:"configVersion"`
PreviousConfigVersion int `json:"previousConfigVersion"`
} `json:"activationConfigs"`
}
// GetActivationHistoryRequest is used to request the activation history for a configuration.
GetActivationHistoryRequest struct {
ConfigID int `json:"configId"`
}
// GetActivationHistoryResponse lists the activation history for a configuration.
GetActivationHistoryResponse struct {
ConfigID int `json:"configId"`
ActivationHistory []Activation `json:"activationHistory,omitempty"`
}
// Activation represents the status of a configuration activation.
Activation struct {
ActivationID int `json:"activationId"`
Version int `json:"version"`
Status string `json:"status"`
Network string `json:"Network"`
ActivatedBy string `json:"activatedBy"`
ActivationDate time.Time `json:"activationDate"`
Notes string `json:"notes"`
NotificationEmails []string `json:"notificationEmails"`
}
// CreateActivationsRequest is used to request activation or deactivation of a configuration.
CreateActivationsRequest struct {
Action string `json:"action"`
Network string `json:"network"`
Note string `json:"note"`
NotificationEmails []string `json:"notificationEmails"`
ActivationConfigs []struct {
ConfigID int `json:"configId"`
ConfigVersion int `json:"configVersion"`
} `json:"activationConfigs"`
}
// CreateActivationsResponse is returned from a call to CreateActivations.
CreateActivationsResponse struct {
DispatchCount int `json:"dispatchCount"`
ActivationID int `json:"activationId"`
Action string `json:"action"`
Status StatusValue `json:"status"`
Network NetworkValue `json:"network"`
Estimate string `json:"estimate"`
CreatedBy string `json:"createdBy"`
CreateDate time.Time `json:"createDate"`
ActivationConfigs []struct {
ConfigID int `json:"configId"`
ConfigName string `json:"configName"`
ConfigVersion int `json:"configVersion"`
PreviousConfigVersion int `json:"previousConfigVersion"`
} `json:"activationConfigs"`
}
// ActivationConfigs describes a specific configuration version to be activated or deactivated.
ActivationConfigs struct {
ConfigID int `json:"configId"`
ConfigVersion int `json:"configVersion"`
}
// RemoveActivationsRequest is used to request deactivation of one or more configurations.
RemoveActivationsRequest struct {
ActivationID int `json:"-"`
Action string `json:"action"`
Network string `json:"network"`
Note string `json:"note"`
NotificationEmails []string `json:"notificationEmails"`
ActivationConfigs []struct {
ConfigID int `json:"configId"`
ConfigVersion int `json:"configVersion"`
} `json:"activationConfigs"`
}
// RemoveActivationsResponse is returned from a call to RemoveActivations.
RemoveActivationsResponse struct {
DispatchCount int `json:"dispatchCount"`
ActivationID int `json:"activationId"`
Action string `json:"action"`
Status StatusValue `json:"status"`
Network NetworkValue `json:"network"`
Estimate string `json:"estimate"`
CreatedBy string `json:"createdBy"`
CreateDate time.Time `json:"createDate"`
ActivationConfigs []struct {
ConfigID int `json:"configId"`
ConfigName string `json:"configName"`
ConfigVersion int `json:"configVersion"`
PreviousConfigVersion int `json:"previousConfigVersion"`
} `json:"activationConfigs"`
}
)
// Validate validates a GetActivationsRequest.
func (v GetActivationsRequest) Validate() error {
return validation.Errors{
"activationid": validation.Validate(v.ActivationID, validation.Required),
}.Filter()
}
// Validate validates a GetActivationHistoryRequest.
func (v GetActivationHistoryRequest) Validate() error {
return validation.Errors{
"configId": validation.Validate(v.ConfigID, validation.Required),
}.Filter()
}
func (p *appsec) GetActivations(ctx context.Context, params GetActivationsRequest) (*GetActivationsResponse, error) {
logger := p.Log(ctx)
logger.Debug("GetActivations")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/activations/%d",
params.ActivationID)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create GetActivations request: %w", err)
}
var result GetActivationsResponse
resp, errp := p.Exec(req, &result)
if errp != nil {
return nil, fmt.Errorf("get activations request failed: %w", errp)
}
if resp.StatusCode != http.StatusOK {
return nil, p.Error(resp)
}
return &result, nil
}
func (p *appsec) GetActivationHistory(ctx context.Context, params GetActivationHistoryRequest) (*GetActivationHistoryResponse, error) {
logger := p.Log(ctx)
logger.Debug("GetActivationHistory")
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
}
uri := fmt.Sprintf(
"/appsec/v1/configs/%d/activations",
params.ConfigID)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create GetActivationHistory request: %w", err)
}
var result GetActivationHistoryResponse
resp, err := p.Exec(req, &result)
if err != nil {
return nil, fmt.Errorf("get activation history request failed: %w", err)
}
if resp.StatusCode != http.StatusOK {
return nil, p.Error(resp)
}
return &result, nil
}
func (p *appsec) CreateActivations(ctx context.Context, params CreateActivationsRequest, _ bool) (*CreateActivationsResponse, error) {
logger := p.Log(ctx)
logger.Debug("CreateActivations")
uri := "/appsec/v1/activations"
req, err := http.NewRequestWithContext(ctx, http.MethodPost, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create CreateActivations request: %w", err)
}
var result CreateActivationsResponse
resp, err := p.Exec(req, &result, params)
if err != nil {
return nil, fmt.Errorf("create activations request failed: %w", err)
}
if resp.StatusCode != http.StatusOK {
return nil, p.Error(resp)
}
uriget := fmt.Sprintf(
"/appsec/v1/activations/%d",
result.ActivationID,
)
req, err = http.NewRequestWithContext(ctx, http.MethodGet, uriget, nil)
if err != nil {
return nil, fmt.Errorf("failed to create GetActivation request: %w", err)
}
resp, err = p.Exec(req, &result)
if err != nil {
return nil, fmt.Errorf("get activation request failed: %w", err)
}
if resp.StatusCode != http.StatusOK {
return nil, p.Error(resp)
}
return &result, nil
}
func (p *appsec) RemoveActivations(ctx context.Context, params RemoveActivationsRequest) (*RemoveActivationsResponse, error) {
logger := p.Log(ctx)
logger.Debug("RemoveActivations")
uri := "/appsec/v1/activations"
req, err := http.NewRequestWithContext(ctx, http.MethodPost, uri, nil)
if err != nil {
return nil, fmt.Errorf("failed to create RemoveActivations request: %w", err)
}
var result RemoveActivationsResponse
resp, errp := p.Exec(req, &result, params)
if errp != nil {
return nil, fmt.Errorf("remove activations request failed: %w", errp)
}
if resp.StatusCode != http.StatusOK {
return nil, p.Error(resp)
}
return &result, nil
}
// ActivationValue is used to create an "enum" of possible Activation.ActivationType values
type ActivationValue string
// NetworkValue is used to create an "enum" of possible Activation.Network values
type NetworkValue string
// StatusValue is used to create an "enum" of possible Activation.Status values
type StatusValue string
const (
// ActivationTypeActivate is used to activate a configuration.
ActivationTypeActivate ActivationValue = "ACTIVATE"
// ActivationTypeDeactivate is used to deactivate a configuration.
ActivationTypeDeactivate ActivationValue = "DEACTIVATE"
// NetworkProduction is used to activate/deactivate a configuration in the production network.
NetworkProduction NetworkValue = "PRODUCTION"
// NetworkStaging is used to activate/deactivate a configuration in the staging network.
NetworkStaging NetworkValue = "STAGING"
// StatusActive indicates that a configuration has been activated.
StatusActive StatusValue = "ACTIVATED"
// StatusInactive indicates that a configuration is inactive.
StatusInactive StatusValue = "INACTIVE"
// StatusPending indicates that an activation/deactivation request has been received.
StatusPending StatusValue = "RECEIVED"
// StatusAborted indicates that an activation/deactivation request has been aborted.
StatusAborted StatusValue = "ABORTED"
// StatusFailed indicates that an activation/deactivation request has failed.
StatusFailed StatusValue = "FAILED"
// StatusDeactivated indicates that an configuration has been deactivated.
StatusDeactivated StatusValue = "DEACTIVATED"
// StatusPendingDeactivation indicates that a deactivation request is in progress.
StatusPendingDeactivation StatusValue = "PENDING_DEACTIVATION"
// StatusNew indicates that a deactivation request is new.
StatusNew StatusValue = "NEW"
)