-
Notifications
You must be signed in to change notification settings - Fork 568
/
access_policy.go
356 lines (308 loc) · 12.2 KB
/
access_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
package cloudflare
import (
"context"
"fmt"
"net/http"
"time"
"github.com/goccy/go-json"
)
type AccessApprovalGroup struct {
EmailListUuid string `json:"email_list_uuid,omitempty"`
EmailAddresses []string `json:"email_addresses,omitempty"`
ApprovalsNeeded int `json:"approvals_needed,omitempty"`
}
// AccessPolicy defines a policy for allowing or disallowing access to
// one or more Access applications.
type AccessPolicy struct {
ID string `json:"id,omitempty"`
// Precedence is the order in which the policy is executed in an Access application.
// As a general rule, lower numbers take precedence over higher numbers.
// This field can only be zero when a reusable policy is requested outside the context
// of an Access application.
Precedence int `json:"precedence"`
Decision string `json:"decision"`
CreatedAt *time.Time `json:"created_at"`
UpdatedAt *time.Time `json:"updated_at"`
Reusable *bool `json:"reusable,omitempty"`
Name string `json:"name"`
IsolationRequired *bool `json:"isolation_required,omitempty"`
SessionDuration *string `json:"session_duration,omitempty"`
PurposeJustificationRequired *bool `json:"purpose_justification_required,omitempty"`
PurposeJustificationPrompt *string `json:"purpose_justification_prompt,omitempty"`
ApprovalRequired *bool `json:"approval_required,omitempty"`
ApprovalGroups []AccessApprovalGroup `json:"approval_groups"`
// The include policy works like an OR logical operator. The user must
// satisfy one of the rules.
Include []interface{} `json:"include"`
// The exclude policy works like a NOT logical operator. The user must
// not satisfy all the rules in exclude.
Exclude []interface{} `json:"exclude"`
// The require policy works like a AND logical operator. The user must
// satisfy all the rules in require.
Require []interface{} `json:"require"`
}
// AccessPolicyListResponse represents the response from the list
// access policies endpoint.
type AccessPolicyListResponse struct {
Result []AccessPolicy `json:"result"`
Response
ResultInfo `json:"result_info"`
}
// AccessPolicyDetailResponse is the API response, containing a single
// access policy.
type AccessPolicyDetailResponse struct {
Success bool `json:"success"`
Errors []string `json:"errors"`
Messages []string `json:"messages"`
Result AccessPolicy `json:"result"`
}
type ListAccessPoliciesParams struct {
// ApplicationID is the application ID to list attached access policies for.
// If omitted, only reusable policies for the account are returned.
ApplicationID string `json:"-"`
ResultInfo
}
type GetAccessPolicyParams struct {
PolicyID string `json:"-"`
// ApplicationID is the application ID for which to scope the policy for.
// Optional, but if included, the policy returned will include its execution precedence within the application.
ApplicationID string `json:"-"`
}
type CreateAccessPolicyParams struct {
// ApplicationID is the application ID for which to create the policy for.
// Pass an empty value to create a reusable policy.
ApplicationID string `json:"-"`
// Precedence is the order in which the policy is executed in an Access application.
// As a general rule, lower numbers take precedence over higher numbers.
// This field is ignored when creating a reusable policy.
// Read more here https://developers.cloudflare.com/cloudflare-one/policies/access/#order-of-execution
Precedence int `json:"precedence"`
Decision string `json:"decision"`
Name string `json:"name"`
IsolationRequired *bool `json:"isolation_required,omitempty"`
SessionDuration *string `json:"session_duration,omitempty"`
PurposeJustificationRequired *bool `json:"purpose_justification_required,omitempty"`
PurposeJustificationPrompt *string `json:"purpose_justification_prompt,omitempty"`
ApprovalRequired *bool `json:"approval_required,omitempty"`
ApprovalGroups []AccessApprovalGroup `json:"approval_groups"`
// The include policy works like an OR logical operator. The user must
// satisfy one of the rules.
Include []interface{} `json:"include"`
// The exclude policy works like a NOT logical operator. The user must
// not satisfy all the rules in exclude.
Exclude []interface{} `json:"exclude"`
// The require policy works like a AND logical operator. The user must
// satisfy all the rules in require.
Require []interface{} `json:"require"`
}
type UpdateAccessPolicyParams struct {
// ApplicationID is the application ID that owns the existing policy.
// Pass an empty value if the existing policy is reusable.
ApplicationID string `json:"-"`
PolicyID string `json:"-"`
// Precedence is the order in which the policy is executed in an Access application.
// As a general rule, lower numbers take precedence over higher numbers.
// This field is ignored when updating a reusable policy.
Precedence int `json:"precedence"`
Decision string `json:"decision"`
Name string `json:"name"`
IsolationRequired *bool `json:"isolation_required,omitempty"`
SessionDuration *string `json:"session_duration,omitempty"`
PurposeJustificationRequired *bool `json:"purpose_justification_required,omitempty"`
PurposeJustificationPrompt *string `json:"purpose_justification_prompt,omitempty"`
ApprovalRequired *bool `json:"approval_required,omitempty"`
ApprovalGroups []AccessApprovalGroup `json:"approval_groups"`
// The include policy works like an OR logical operator. The user must
// satisfy one of the rules.
Include []interface{} `json:"include"`
// The exclude policy works like a NOT logical operator. The user must
// not satisfy all the rules in exclude.
Exclude []interface{} `json:"exclude"`
// The require policy works like a AND logical operator. The user must
// satisfy all the rules in require.
Require []interface{} `json:"require"`
}
type DeleteAccessPolicyParams struct {
// ApplicationID is the application ID the policy belongs to.
// If the existing policy is reusable, this field must be omitted. Otherwise, it is required.
ApplicationID string `json:"-"`
PolicyID string `json:"-"`
}
// ListAccessPolicies returns all access policies that match the parameters.
//
// Account API reference: https://developers.cloudflare.com/api/operations/access-policies-list-access-policies
// Zone API reference: https://developers.cloudflare.com/api/operations/zone-level-access-policies-list-access-policies
func (api *API) ListAccessPolicies(ctx context.Context, rc *ResourceContainer, params ListAccessPoliciesParams) ([]AccessPolicy, *ResultInfo, error) {
var baseURL string
if params.ApplicationID != "" {
baseURL = fmt.Sprintf(
"/%s/%s/access/apps/%s/policies",
rc.Level,
rc.Identifier,
params.ApplicationID,
)
} else {
baseURL = fmt.Sprintf(
"/%s/%s/access/policies",
rc.Level,
rc.Identifier,
)
}
autoPaginate := true
if params.PerPage >= 1 || params.Page >= 1 {
autoPaginate = false
}
if params.PerPage < 1 {
params.PerPage = 25
}
if params.Page < 1 {
params.Page = 1
}
var accessPolicies []AccessPolicy
var r AccessPolicyListResponse
for {
uri := buildURI(baseURL, params)
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return []AccessPolicy{}, &ResultInfo{}, fmt.Errorf("%s: %w", errMakeRequestError, err)
}
err = json.Unmarshal(res, &r)
if err != nil {
return []AccessPolicy{}, &ResultInfo{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
accessPolicies = append(accessPolicies, r.Result...)
params.ResultInfo = r.ResultInfo.Next()
if params.ResultInfo.Done() || !autoPaginate {
break
}
}
return accessPolicies, &r.ResultInfo, nil
}
// GetAccessPolicy returns a single policy based on the policy ID.
//
// Account API reference: https://developers.cloudflare.com/api/operations/access-policies-get-an-access-policy
// Zone API reference: https://developers.cloudflare.com/api/operations/zone-level-access-policies-get-an-access-policy
func (api *API) GetAccessPolicy(ctx context.Context, rc *ResourceContainer, params GetAccessPolicyParams) (AccessPolicy, error) {
var uri string
if params.ApplicationID != "" {
uri = fmt.Sprintf(
"/%s/%s/access/apps/%s/policies/%s",
rc.Level,
rc.Identifier,
params.ApplicationID,
params.PolicyID,
)
} else {
uri = fmt.Sprintf(
"/%s/%s/access/policies/%s",
rc.Level,
rc.Identifier,
params.PolicyID,
)
}
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return AccessPolicy{}, fmt.Errorf("%s: %w", errMakeRequestError, err)
}
var accessPolicyDetailResponse AccessPolicyDetailResponse
err = json.Unmarshal(res, &accessPolicyDetailResponse)
if err != nil {
return AccessPolicy{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return accessPolicyDetailResponse.Result, nil
}
// CreateAccessPolicy creates a new access policy.
//
// Account API reference: https://developers.cloudflare.com/api/operations/access-policies-create-an-access-policy
// Zone API reference: https://developers.cloudflare.com/api/operations/zone-level-access-policies-create-an-access-policy
func (api *API) CreateAccessPolicy(ctx context.Context, rc *ResourceContainer, params CreateAccessPolicyParams) (AccessPolicy, error) {
var uri string
if params.ApplicationID != "" {
uri = fmt.Sprintf(
"/%s/%s/access/apps/%s/policies",
rc.Level,
rc.Identifier,
params.ApplicationID,
)
} else {
uri = fmt.Sprintf(
"/%s/%s/access/policies",
rc.Level,
rc.Identifier,
)
}
res, err := api.makeRequestContext(ctx, http.MethodPost, uri, params)
if err != nil {
return AccessPolicy{}, fmt.Errorf("%s: %w", errMakeRequestError, err)
}
var accessPolicyDetailResponse AccessPolicyDetailResponse
err = json.Unmarshal(res, &accessPolicyDetailResponse)
if err != nil {
return AccessPolicy{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return accessPolicyDetailResponse.Result, nil
}
// UpdateAccessPolicy updates an existing access policy.
//
// Account API reference: https://developers.cloudflare.com/api/operations/access-policies-update-an-access-policy
// Zone API reference: https://developers.cloudflare.com/api/operations/zone-level-access-policies-update-an-access-policy
func (api *API) UpdateAccessPolicy(ctx context.Context, rc *ResourceContainer, params UpdateAccessPolicyParams) (AccessPolicy, error) {
if params.PolicyID == "" {
return AccessPolicy{}, fmt.Errorf("access policy ID cannot be empty")
}
var uri string
if params.ApplicationID != "" {
uri = fmt.Sprintf(
"/%s/%s/access/apps/%s/policies/%s",
rc.Level,
rc.Identifier,
params.ApplicationID,
params.PolicyID,
)
} else {
uri = fmt.Sprintf(
"/%s/%s/access/policies/%s",
rc.Level,
rc.Identifier,
params.PolicyID,
)
}
res, err := api.makeRequestContext(ctx, http.MethodPut, uri, params)
if err != nil {
return AccessPolicy{}, fmt.Errorf("%s: %w", errMakeRequestError, err)
}
var accessPolicyDetailResponse AccessPolicyDetailResponse
err = json.Unmarshal(res, &accessPolicyDetailResponse)
if err != nil {
return AccessPolicy{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return accessPolicyDetailResponse.Result, nil
}
// DeleteAccessPolicy deletes an access policy.
//
// Account API reference: https://developers.cloudflare.com/api/operations/access-policies-delete-an-access-policy
// Zone API reference: https://developers.cloudflare.com/api/operations/zone-level-access-policies-delete-an-access-policy
func (api *API) DeleteAccessPolicy(ctx context.Context, rc *ResourceContainer, params DeleteAccessPolicyParams) error {
var uri string
if params.ApplicationID != "" {
uri = fmt.Sprintf(
"/%s/%s/access/apps/%s/policies/%s",
rc.Level,
rc.Identifier,
params.ApplicationID,
params.PolicyID,
)
} else {
uri = fmt.Sprintf(
"/%s/%s/access/policies/%s",
rc.Level,
rc.Identifier,
params.PolicyID,
)
}
_, err := api.makeRequestContext(ctx, http.MethodDelete, uri, nil)
if err != nil {
return fmt.Errorf("%s: %w", errMakeRequestError, err)
}
return nil
}