/
api_op_SimulateCustomPolicy.go
396 lines (355 loc) · 16.3 KB
/
api_op_SimulateCustomPolicy.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package iam
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/iam/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Simulate how a set of IAM policies and optionally a resource-based policy works
// with a list of API operations and AWS resources to determine the policies'
// effective permissions. The policies are provided as strings. The simulation does
// not perform the API operations; it only checks the authorization to determine if
// the simulated policies allow or deny the operations. If you want to simulate
// existing policies that are attached to an IAM user, group, or role, use
// SimulatePrincipalPolicy instead. Context keys are variables that are maintained
// by AWS and its services and which provide details about the context of an API
// query request. You can use the Condition element of an IAM policy to evaluate
// context keys. To get the list of context keys that the policies require for
// correct simulation, use GetContextKeysForCustomPolicy. If the output is long,
// you can use MaxItems and Marker parameters to paginate the results.
func (c *Client) SimulateCustomPolicy(ctx context.Context, params *SimulateCustomPolicyInput, optFns ...func(*Options)) (*SimulateCustomPolicyOutput, error) {
if params == nil {
params = &SimulateCustomPolicyInput{}
}
result, metadata, err := c.invokeOperation(ctx, "SimulateCustomPolicy", params, optFns, addOperationSimulateCustomPolicyMiddlewares)
if err != nil {
return nil, err
}
out := result.(*SimulateCustomPolicyOutput)
out.ResultMetadata = metadata
return out, nil
}
type SimulateCustomPolicyInput struct {
// A list of names of API operations to evaluate in the simulation. Each operation
// is evaluated against each resource. Each operation must include the service
// identifier, such as iam:CreateUser. This operation does not support using
// wildcards (*) in an action name.
//
// This member is required.
ActionNames []string
// A list of policy documents to include in the simulation. Each document is
// specified as a string containing the complete, valid JSON text of an IAM policy.
// Do not include any resource-based policies in this parameter. Any resource-based
// policy must be submitted with the ResourcePolicy parameter. The policies cannot
// be "scope-down" policies, such as you could include in a call to
// GetFederationToken
// (https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetFederationToken.html)
// or one of the AssumeRole
// (https://docs.aws.amazon.com/IAM/latest/APIReference/API_AssumeRole.html) API
// operations. In other words, do not use policies designed to restrict what a user
// can do while using the temporary credentials. The regex pattern
// (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of
// characters consisting of the following:
//
// * Any printable ASCII character ranging
// from the space character (\u0020) through the end of the ASCII character
// range
//
// * The printable characters in the Basic Latin and Latin-1 Supplement
// character set (through \u00FF)
//
// * The special characters tab (\u0009), line feed
// (\u000A), and carriage return (\u000D)
//
// This member is required.
PolicyInputList []string
// The ARN of the IAM user that you want to use as the simulated caller of the API
// operations. CallerArn is required if you include a ResourcePolicy so that the
// policy's Principal element has a value to use in evaluating the policy. You can
// specify only the ARN of an IAM user. You cannot specify the ARN of an assumed
// role, federated user, or a service principal.
CallerArn *string
// A list of context keys and corresponding values for the simulation to use.
// Whenever a context key is evaluated in one of the simulated IAM permissions
// policies, the corresponding value is supplied.
ContextEntries []types.ContextEntry
// Use this parameter only when paginating results and only after you receive a
// response indicating that the results are truncated. Set it to the value of the
// Marker element in the response that you received to indicate where the next call
// should start.
Marker *string
// Use this only when paginating results to indicate the maximum number of items
// you want in the response. If additional items exist beyond the maximum you
// specify, the IsTruncated response element is true. If you do not include this
// parameter, the number of items defaults to 100. Note that IAM might return fewer
// results, even when there are more results available. In that case, the
// IsTruncated response element returns true, and Marker contains a value to
// include in the subsequent call that tells the service where to continue from.
MaxItems *int32
// The IAM permissions boundary policy to simulate. The permissions boundary sets
// the maximum permissions that an IAM entity can have. You can input only one
// permissions boundary when you pass a policy to this operation. For more
// information about permissions boundaries, see Permissions Boundaries for IAM
// Entities
// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html)
// in the IAM User Guide. The policy input is specified as a string that contains
// the complete, valid JSON text of a permissions boundary policy. The regex
// pattern (http://wikipedia.org/wiki/regex) used to validate this parameter is a
// string of characters consisting of the following:
//
// * Any printable ASCII
// character ranging from the space character (\u0020) through the end of the ASCII
// character range
//
// * The printable characters in the Basic Latin and Latin-1
// Supplement character set (through \u00FF)
//
// * The special characters tab
// (\u0009), line feed (\u000A), and carriage return (\u000D)
PermissionsBoundaryPolicyInputList []string
// A list of ARNs of AWS resources to include in the simulation. If this parameter
// is not provided, then the value defaults to * (all resources). Each API in the
// ActionNames parameter is evaluated for each resource in this list. The
// simulation determines the access result (allowed or denied) of each combination
// and reports it in the response. The simulation does not automatically retrieve
// policies for the specified resources. If you want to include a resource policy
// in the simulation, then you must include the policy as a string in the
// ResourcePolicy parameter. If you include a ResourcePolicy, then it must be
// applicable to all of the resources included in the simulation or you receive an
// invalid input error. For more information about ARNs, see Amazon Resource Names
// (ARNs) and AWS Service Namespaces
// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in
// the AWS General Reference.
ResourceArns []string
// Specifies the type of simulation to run. Different API operations that support
// resource-based policies require different combinations of resources. By
// specifying the type of simulation to run, you enable the policy simulator to
// enforce the presence of the required resources to ensure reliable simulation
// results. If your simulation does not match one of the following scenarios, then
// you can omit this parameter. The following list shows each of the supported
// scenario values and the resources that you must define to run the simulation.
// Each of the EC2 scenarios requires that you specify instance, image, and
// security-group resources. If your scenario includes an EBS volume, then you must
// specify that volume as a resource. If the EC2 scenario includes VPC, then you
// must supply the network-interface resource. If it includes an IP subnet, then
// you must specify the subnet resource. For more information on the EC2 scenario
// options, see Supported Platforms
// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html)
// in the Amazon EC2 User Guide.
//
// * EC2-Classic-InstanceStore instance, image,
// security-group
//
// * EC2-Classic-EBS instance, image, security-group, volume
//
// *
// EC2-VPC-InstanceStore instance, image, security-group, network-interface
//
// *
// EC2-VPC-InstanceStore-Subnet instance, image, security-group, network-interface,
// subnet
//
// * EC2-VPC-EBS instance, image, security-group, network-interface,
// volume
//
// * EC2-VPC-EBS-Subnet instance, image, security-group, network-interface,
// subnet, volume
ResourceHandlingOption *string
// An ARN representing the AWS account ID that specifies the owner of any simulated
// resource that does not identify its owner in the resource ARN. Examples of
// resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it
// is also used as the account owner of any ResourcePolicy included in the
// simulation. If the ResourceOwner parameter is not specified, then the owner of
// the resources and the resource policy defaults to the account of the identity
// provided in CallerArn. This parameter is required only if you specify a
// resource-based policy and account that owns the resource is different from the
// account that owns the simulated calling user CallerArn. The ARN for an account
// uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to
// represent the account with the 112233445566 ID, use the following ARN:
// arn:aws:iam::112233445566-ID:root.
ResourceOwner *string
// A resource-based policy to include in the simulation provided as a string. Each
// resource in the simulation is treated as if it had this policy attached. You can
// include only one resource-based policy in a simulation. The regex pattern
// (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of
// characters consisting of the following:
//
// * Any printable ASCII character ranging
// from the space character (\u0020) through the end of the ASCII character
// range
//
// * The printable characters in the Basic Latin and Latin-1 Supplement
// character set (through \u00FF)
//
// * The special characters tab (\u0009), line feed
// (\u000A), and carriage return (\u000D)
ResourcePolicy *string
}
// Contains the response to a successful SimulatePrincipalPolicy or
// SimulateCustomPolicy request.
type SimulateCustomPolicyOutput struct {
// The results of the simulation.
EvaluationResults []types.EvaluationResult
// A flag that indicates whether there are more items to return. If your results
// were truncated, you can make a subsequent pagination request using the Marker
// request parameter to retrieve more items. Note that IAM might return fewer than
// the MaxItems number of results even when there are more results available. We
// recommend that you check IsTruncated after every call to ensure that you receive
// all your results.
IsTruncated bool
// When IsTruncated is true, this element is present and contains the value to use
// for the Marker parameter in a subsequent pagination request.
Marker *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
func addOperationSimulateCustomPolicyMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpSimulateCustomPolicy{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpSimulateCustomPolicy{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpSimulateCustomPolicyValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSimulateCustomPolicy(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// SimulateCustomPolicyAPIClient is a client that implements the
// SimulateCustomPolicy operation.
type SimulateCustomPolicyAPIClient interface {
SimulateCustomPolicy(context.Context, *SimulateCustomPolicyInput, ...func(*Options)) (*SimulateCustomPolicyOutput, error)
}
var _ SimulateCustomPolicyAPIClient = (*Client)(nil)
// SimulateCustomPolicyPaginatorOptions is the paginator options for
// SimulateCustomPolicy
type SimulateCustomPolicyPaginatorOptions struct {
// Use this only when paginating results to indicate the maximum number of items
// you want in the response. If additional items exist beyond the maximum you
// specify, the IsTruncated response element is true. If you do not include this
// parameter, the number of items defaults to 100. Note that IAM might return fewer
// results, even when there are more results available. In that case, the
// IsTruncated response element returns true, and Marker contains a value to
// include in the subsequent call that tells the service where to continue from.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// SimulateCustomPolicyPaginator is a paginator for SimulateCustomPolicy
type SimulateCustomPolicyPaginator struct {
options SimulateCustomPolicyPaginatorOptions
client SimulateCustomPolicyAPIClient
params *SimulateCustomPolicyInput
nextToken *string
firstPage bool
}
// NewSimulateCustomPolicyPaginator returns a new SimulateCustomPolicyPaginator
func NewSimulateCustomPolicyPaginator(client SimulateCustomPolicyAPIClient, params *SimulateCustomPolicyInput, optFns ...func(*SimulateCustomPolicyPaginatorOptions)) *SimulateCustomPolicyPaginator {
options := SimulateCustomPolicyPaginatorOptions{}
if params.MaxItems != nil {
options.Limit = *params.MaxItems
}
for _, fn := range optFns {
fn(&options)
}
if params == nil {
params = &SimulateCustomPolicyInput{}
}
return &SimulateCustomPolicyPaginator{
options: options,
client: client,
params: params,
firstPage: true,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *SimulateCustomPolicyPaginator) HasMorePages() bool {
return p.firstPage || p.nextToken != nil
}
// NextPage retrieves the next SimulateCustomPolicy page.
func (p *SimulateCustomPolicyPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SimulateCustomPolicyOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.Marker = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxItems = limit
result, err := p.client.SimulateCustomPolicy(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.Marker
if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opSimulateCustomPolicy(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "iam",
OperationName: "SimulateCustomPolicy",
}
}