-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_UpdateAuthorizer.go
414 lines (364 loc) · 16.5 KB
/
api_op_UpdateAuthorizer.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package apigatewayv2
import (
"context"
"errors"
"fmt"
"github.com/aws/aws-sdk-go-v2/aws"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
internalauth "github.com/aws/aws-sdk-go-v2/internal/auth"
"github.com/aws/aws-sdk-go-v2/service/apigatewayv2/types"
smithyendpoints "github.com/aws/smithy-go/endpoints"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates an Authorizer.
func (c *Client) UpdateAuthorizer(ctx context.Context, params *UpdateAuthorizerInput, optFns ...func(*Options)) (*UpdateAuthorizerOutput, error) {
if params == nil {
params = &UpdateAuthorizerInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateAuthorizer", params, optFns, c.addOperationUpdateAuthorizerMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateAuthorizerOutput)
out.ResultMetadata = metadata
return out, nil
}
// Updates an Authorizer.
type UpdateAuthorizerInput struct {
// The API identifier.
//
// This member is required.
ApiId *string
// The authorizer identifier.
//
// This member is required.
AuthorizerId *string
// Specifies the required credentials as an IAM role for API Gateway to invoke the
// authorizer. To specify an IAM role for API Gateway to assume, use the role's
// Amazon Resource Name (ARN). To use resource-based permissions on the Lambda
// function, don't specify this parameter.
AuthorizerCredentialsArn *string
// Specifies the format of the payload sent to an HTTP API Lambda authorizer.
// Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To
// learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html)
// .
AuthorizerPayloadFormatVersion *string
// The time to live (TTL) for cached authorizer results, in seconds. If it equals
// 0, authorization caching is disabled. If it is greater than 0, API Gateway
// caches authorizer responses. The maximum value is 3600, or 1 hour. Supported
// only for HTTP API Lambda authorizers.
AuthorizerResultTtlInSeconds int32
// The authorizer type. Specify REQUEST for a Lambda function using incoming
// request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP
// APIs).
AuthorizerType types.AuthorizerType
// The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers,
// this must be a well-formed Lambda function URI, for example,
// arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.
// In general, the URI has this form:
// arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the
// same as the region hosting the Lambda function, path indicates that the
// remaining substring in the URI should be treated as the path to the resource,
// including the initial /. For Lambda functions, this is usually of the form
// /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST
// authorizers.
AuthorizerUri *string
// Specifies whether a Lambda authorizer returns a response in a simple format. By
// default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda
// authorizer can return a boolean value instead of an IAM policy. Supported only
// for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP
// APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html)
EnableSimpleResponses bool
// The identity source for which authorization is requested. For a REQUEST
// authorizer, this is optional. The value is a set of one or more mapping
// expressions of the specified request parameters. The identity source can be
// headers, query string parameters, stage variables, and context parameters. For
// example, if an Auth header and a Name query string parameter are defined as
// identity sources, this value is route.request.header.Auth,
// route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection
// expressions prefixed with $, for example, $request.header.Auth,
// $request.querystring.Name. These parameters are used to perform runtime
// validation for Lambda-based authorizers by verifying all of the identity-related
// request parameters are present in the request, not null, and non-empty. Only
// when this is true does the authorizer invoke the authorizer Lambda function.
// Otherwise, it returns a 401 Unauthorized response without calling the Lambda
// function. For HTTP APIs, identity sources are also used as the cache key when
// caching is enabled. To learn more, see Working with AWS Lambda authorizers for
// HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html)
// . For JWT, a single entry that specifies where to extract the JSON Web Token
// (JWT) from inbound requests. Currently only header-based and query
// parameter-based selections are supported, for example
// $request.header.Authorization.
IdentitySource []string
// This parameter is not used.
IdentityValidationExpression *string
// Represents the configuration of a JWT authorizer. Required for the JWT
// authorizer type. Supported only for HTTP APIs.
JwtConfiguration *types.JWTConfiguration
// The name of the authorizer.
Name *string
noSmithyDocumentSerde
}
type UpdateAuthorizerOutput struct {
// Specifies the required credentials as an IAM role for API Gateway to invoke the
// authorizer. To specify an IAM role for API Gateway to assume, use the role's
// Amazon Resource Name (ARN). To use resource-based permissions on the Lambda
// function, don't specify this parameter. Supported only for REQUEST authorizers.
AuthorizerCredentialsArn *string
// The authorizer identifier.
AuthorizerId *string
// Specifies the format of the payload sent to an HTTP API Lambda authorizer.
// Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To
// learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html)
// .
AuthorizerPayloadFormatVersion *string
// The time to live (TTL) for cached authorizer results, in seconds. If it equals
// 0, authorization caching is disabled. If it is greater than 0, API Gateway
// caches authorizer responses. The maximum value is 3600, or 1 hour. Supported
// only for HTTP API Lambda authorizers.
AuthorizerResultTtlInSeconds int32
// The authorizer type. Specify REQUEST for a Lambda function using incoming
// request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP
// APIs).
AuthorizerType types.AuthorizerType
// The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers,
// this must be a well-formed Lambda function URI, for example,
// arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.
// In general, the URI has this form:
// arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the
// same as the region hosting the Lambda function, path indicates that the
// remaining substring in the URI should be treated as the path to the resource,
// including the initial /. For Lambda functions, this is usually of the form
// /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST
// authorizers.
AuthorizerUri *string
// Specifies whether a Lambda authorizer returns a response in a simple format. If
// enabled, the Lambda authorizer can return a boolean value instead of an IAM
// policy. Supported only for HTTP APIs. To learn more, see Working with AWS
// Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html)
EnableSimpleResponses bool
// The identity source for which authorization is requested. For a REQUEST
// authorizer, this is optional. The value is a set of one or more mapping
// expressions of the specified request parameters. The identity source can be
// headers, query string parameters, stage variables, and context parameters. For
// example, if an Auth header and a Name query string parameter are defined as
// identity sources, this value is route.request.header.Auth,
// route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection
// expressions prefixed with $, for example, $request.header.Auth,
// $request.querystring.Name. These parameters are used to perform runtime
// validation for Lambda-based authorizers by verifying all of the identity-related
// request parameters are present in the request, not null, and non-empty. Only
// when this is true does the authorizer invoke the authorizer Lambda function.
// Otherwise, it returns a 401 Unauthorized response without calling the Lambda
// function. For HTTP APIs, identity sources are also used as the cache key when
// caching is enabled. To learn more, see Working with AWS Lambda authorizers for
// HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html)
// . For JWT, a single entry that specifies where to extract the JSON Web Token
// (JWT) from inbound requests. Currently only header-based and query
// parameter-based selections are supported, for example
// $request.header.Authorization.
IdentitySource []string
// The validation expression does not apply to the REQUEST authorizer.
IdentityValidationExpression *string
// Represents the configuration of a JWT authorizer. Required for the JWT
// authorizer type. Supported only for HTTP APIs.
JwtConfiguration *types.JWTConfiguration
// The name of the authorizer.
Name *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateAuthorizerMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateAuthorizer{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateAuthorizer{}, middleware.After)
if err != nil {
return err
}
if err = addlegacyEndpointContextSetter(stack, options); 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, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addUpdateAuthorizerResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addOpUpdateAuthorizerValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateAuthorizer(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); 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
}
if err = addendpointDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateAuthorizer(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "apigateway",
OperationName: "UpdateAuthorizer",
}
}
type opUpdateAuthorizerResolveEndpointMiddleware struct {
EndpointResolver EndpointResolverV2
BuiltInResolver builtInParameterResolver
}
func (*opUpdateAuthorizerResolveEndpointMiddleware) ID() string {
return "ResolveEndpointV2"
}
func (m *opUpdateAuthorizerResolveEndpointMiddleware) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
out middleware.SerializeOutput, metadata middleware.Metadata, err error,
) {
if awsmiddleware.GetRequiresLegacyEndpoints(ctx) {
return next.HandleSerialize(ctx, in)
}
req, ok := in.Request.(*smithyhttp.Request)
if !ok {
return out, metadata, fmt.Errorf("unknown transport type %T", in.Request)
}
if m.EndpointResolver == nil {
return out, metadata, fmt.Errorf("expected endpoint resolver to not be nil")
}
params := EndpointParameters{}
m.BuiltInResolver.ResolveBuiltIns(¶ms)
var resolvedEndpoint smithyendpoints.Endpoint
resolvedEndpoint, err = m.EndpointResolver.ResolveEndpoint(ctx, params)
if err != nil {
return out, metadata, fmt.Errorf("failed to resolve service endpoint, %w", err)
}
req.URL = &resolvedEndpoint.URI
for k := range resolvedEndpoint.Headers {
req.Header.Set(
k,
resolvedEndpoint.Headers.Get(k),
)
}
authSchemes, err := internalauth.GetAuthenticationSchemes(&resolvedEndpoint.Properties)
if err != nil {
var nfe *internalauth.NoAuthenticationSchemesFoundError
if errors.As(err, &nfe) {
// if no auth scheme is found, default to sigv4
signingName := "apigateway"
signingRegion := m.BuiltInResolver.(*builtInResolver).Region
ctx = awsmiddleware.SetSigningName(ctx, signingName)
ctx = awsmiddleware.SetSigningRegion(ctx, signingRegion)
}
var ue *internalauth.UnSupportedAuthenticationSchemeSpecifiedError
if errors.As(err, &ue) {
return out, metadata, fmt.Errorf(
"This operation requests signer version(s) %v but the client only supports %v",
ue.UnsupportedSchemes,
internalauth.SupportedSchemes,
)
}
}
for _, authScheme := range authSchemes {
switch authScheme.(type) {
case *internalauth.AuthenticationSchemeV4:
v4Scheme, _ := authScheme.(*internalauth.AuthenticationSchemeV4)
var signingName, signingRegion string
if v4Scheme.SigningName == nil {
signingName = "apigateway"
} else {
signingName = *v4Scheme.SigningName
}
if v4Scheme.SigningRegion == nil {
signingRegion = m.BuiltInResolver.(*builtInResolver).Region
} else {
signingRegion = *v4Scheme.SigningRegion
}
if v4Scheme.DisableDoubleEncoding != nil {
// The signer sets an equivalent value at client initialization time.
// Setting this context value will cause the signer to extract it
// and override the value set at client initialization time.
ctx = internalauth.SetDisableDoubleEncoding(ctx, *v4Scheme.DisableDoubleEncoding)
}
ctx = awsmiddleware.SetSigningName(ctx, signingName)
ctx = awsmiddleware.SetSigningRegion(ctx, signingRegion)
break
case *internalauth.AuthenticationSchemeV4A:
v4aScheme, _ := authScheme.(*internalauth.AuthenticationSchemeV4A)
if v4aScheme.SigningName == nil {
v4aScheme.SigningName = aws.String("apigateway")
}
if v4aScheme.DisableDoubleEncoding != nil {
// The signer sets an equivalent value at client initialization time.
// Setting this context value will cause the signer to extract it
// and override the value set at client initialization time.
ctx = internalauth.SetDisableDoubleEncoding(ctx, *v4aScheme.DisableDoubleEncoding)
}
ctx = awsmiddleware.SetSigningName(ctx, *v4aScheme.SigningName)
ctx = awsmiddleware.SetSigningRegion(ctx, v4aScheme.SigningRegionSet[0])
break
case *internalauth.AuthenticationSchemeNone:
break
}
}
return next.HandleSerialize(ctx, in)
}
func addUpdateAuthorizerResolveEndpointMiddleware(stack *middleware.Stack, options Options) error {
return stack.Serialize.Insert(&opUpdateAuthorizerResolveEndpointMiddleware{
EndpointResolver: options.EndpointResolverV2,
BuiltInResolver: &builtInResolver{
Region: options.Region,
UseDualStack: options.EndpointOptions.UseDualStackEndpoint,
UseFIPS: options.EndpointOptions.UseFIPSEndpoint,
Endpoint: options.BaseEndpoint,
},
}, "ResolveEndpoint", middleware.After)
}