Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(apigateway): lambda authorizer does not enforce default cache TTL #27873

Merged
merged 6 commits into from
Nov 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@
"UpdateReplacePolicy": "Retain",
"DeletionPolicy": "Retain"
},
"MyRestApiDeploymentB555B582d83364d66d67f510f848797cd89349d5": {
"MyRestApiDeploymentB555B58276a4103e7ef38befb395a9ace5fdce44": {
"Type": "AWS::ApiGateway::Deployment",
"Properties": {
"Description": "Automatically created by the RestApi construct",
Expand All @@ -208,7 +208,7 @@
"Type": "AWS::ApiGateway::Stage",
"Properties": {
"DeploymentId": {
"Ref": "MyRestApiDeploymentB555B582d83364d66d67f510f848797cd89349d5"
"Ref": "MyRestApiDeploymentB555B58276a4103e7ef38befb395a9ace5fdce44"
},
"RestApiId": {
"Ref": "MyRestApi2D1F47A9"
Expand Down Expand Up @@ -306,6 +306,7 @@
"MyAuthorizer6575980E": {
"Type": "AWS::ApiGateway::Authorizer",
"Properties": {
"AuthorizerResultTtlInSeconds": 300,
"AuthorizerUri": {
"Fn::Join": [
"",
Expand Down Expand Up @@ -366,6 +367,7 @@
"MySecondAuthorizer25A69B96": {
"Type": "AWS::ApiGateway::Authorizer",
"Properties": {
"AuthorizerResultTtlInSeconds": 300,
"AuthorizerUri": {
"Fn::Join": [
"",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@
"Arn"
]
},
"AuthorizerResultTtlInSeconds": 300,
"AuthorizerUri": {
"Fn::Join": [
"",
Expand Down Expand Up @@ -233,7 +234,7 @@
"UpdateReplacePolicy": "Retain",
"DeletionPolicy": "Retain"
},
"MyRestApiDeploymentB555B582694e8eb3fdb7b5f988ba347d35601979": {
"MyRestApiDeploymentB555B58259401a546b13c99de2d05e5e255a9ede": {
"Type": "AWS::ApiGateway::Deployment",
"Properties": {
"Description": "Automatically created by the RestApi construct",
Expand All @@ -251,7 +252,7 @@
"Type": "AWS::ApiGateway::Stage",
"Properties": {
"DeploymentId": {
"Ref": "MyRestApiDeploymentB555B582694e8eb3fdb7b5f988ba347d35601979"
"Ref": "MyRestApiDeploymentB555B58259401a546b13c99de2d05e5e255a9ede"
},
"RestApiId": {
"Ref": "MyRestApi2D1F47A9"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@
"MyAuthorizer6575980E": {
"Type": "AWS::ApiGateway::Authorizer",
"Properties": {
"AuthorizerResultTtlInSeconds": 600,
"AuthorizerUri": {
"Fn::Join": [
"",
Expand Down Expand Up @@ -208,7 +209,7 @@
"UpdateReplacePolicy": "Retain",
"DeletionPolicy": "Retain"
},
"MyRestApiDeploymentB555B582e0e53f2547b469b538202de55968eaf0": {
"MyRestApiDeploymentB555B5827a9cde8f137f97e5aa74fca164d09d74": {
"Type": "AWS::ApiGateway::Deployment",
"Properties": {
"Description": "Automatically created by the RestApi construct",
Expand All @@ -226,7 +227,7 @@
"Type": "AWS::ApiGateway::Stage",
"Properties": {
"DeploymentId": {
"Ref": "MyRestApiDeploymentB555B582e0e53f2547b469b538202de55968eaf0"
"Ref": "MyRestApiDeploymentB555B5827a9cde8f137f97e5aa74fca164d09d74"
},
"RestApiId": {
"Ref": "MyRestApi2D1F47A9"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const authorizerFn = new lambda.Function(stack, 'MyAuthorizerFunction', {

const authorizer = new TokenAuthorizer(stack, 'MyAuthorizer', {
handler: authorizerFn,
resultsCacheTtl: Duration.minutes(10),
});

const restapi = new RestApi(stack, 'MyRestApi', {
Expand Down
6 changes: 3 additions & 3 deletions packages/aws-cdk-lib/aws-apigateway/lib/authorizers/lambda.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export interface LambdaAuthorizerProps {
* How long APIGateway should cache the results. Max 1 hour.
* Disable caching by setting this to 0.
*
* @default Duration.minutes(5)
* @default - Duration.minutes(5)
*/
readonly resultsCacheTtl?: Duration;

Expand Down Expand Up @@ -215,7 +215,7 @@ export class TokenAuthorizer extends LambdaAuthorizer {
type: 'TOKEN',
authorizerUri: lambdaAuthorizerArn(props.handler),
authorizerCredentials: props.assumeRole?.roleArn,
authorizerResultTtlInSeconds: props.resultsCacheTtl?.toSeconds(),
authorizerResultTtlInSeconds: props.resultsCacheTtl?.toSeconds() ?? Duration.minutes(5).toSeconds(),
identitySource: props.identitySource || 'method.request.header.Authorization',
identityValidationExpression: props.validationRegex,
};
Expand Down Expand Up @@ -284,7 +284,7 @@ export class RequestAuthorizer extends LambdaAuthorizer {
type: 'REQUEST',
authorizerUri: lambdaAuthorizerArn(props.handler),
authorizerCredentials: props.assumeRole?.roleArn,
authorizerResultTtlInSeconds: props.resultsCacheTtl?.toSeconds(),
authorizerResultTtlInSeconds: props.resultsCacheTtl?.toSeconds() ?? Duration.minutes(5).toSeconds(),
identitySource: props.identitySources.map(is => is.toString()).join(','),
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ describe('lambda authorizer', () => {
Type: 'TOKEN',
RestApiId: stack.resolve(restApi.restApiId),
IdentitySource: 'method.request.header.Authorization',
AuthorizerResultTtlInSeconds: 300,
AuthorizerUri: {
'Fn::Join': [
'',
Expand Down Expand Up @@ -102,6 +103,7 @@ describe('lambda authorizer', () => {
Template.fromStack(stack).hasResourceProperties('AWS::ApiGateway::Authorizer', {
Type: 'REQUEST',
RestApiId: stack.resolve(restApi.restApiId),
AuthorizerResultTtlInSeconds: 0,
AuthorizerUri: {
'Fn::Join': [
'',
Expand Down Expand Up @@ -153,6 +155,33 @@ describe('lambda authorizer', () => {

});

test('request authorizer with default cache TTL', () => {
const stack = new Stack();

const func = new lambda.Function(stack, 'myfunction', {
handler: 'handler',
code: lambda.Code.fromInline('foo'),
runtime: lambda.Runtime.NODEJS_LATEST,
});

const auth = new RequestAuthorizer(stack, 'myauthorizer', {
handler: func,
identitySources: [IdentitySource.header('whoami')],
});

const restApi = new RestApi(stack, 'myrestapi');
restApi.root.addMethod('ANY', undefined, {
authorizer: auth,
authorizationType: AuthorizationType.CUSTOM,
});

Template.fromStack(stack).hasResourceProperties('AWS::ApiGateway::Authorizer', {
Type: 'REQUEST',
RestApiId: stack.resolve(restApi.restApiId),
AuthorizerResultTtlInSeconds: 300,
});
});

test('invalid request authorizer config', () => {
const stack = new Stack();

Expand Down