Skip navigation links

Package software.amazon.awscdk.services.apigatewayv2.authorizers

AWS APIGatewayv2 Authorizers

See: Description

Package software.amazon.awscdk.services.apigatewayv2.authorizers Description

AWS APIGatewayv2 Authorizers

---

cdk-constructs: Experimental

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.


Table of Contents

Introduction

API Gateway supports multiple mechanisms for controlling and managing access to your HTTP API. They are mainly classified into Lambda Authorizers, JWT authorizers and standard AWS IAM roles and policies. More information is available at Controlling and managing access to an HTTP API.

HTTP APIs

Access control for Http Apis is managed by restricting which routes can be invoked via.

Authorizers, and scopes can either be applied to the api, or specifically for each route.

Default Authorization

When using default authorization, all routes of the api will inherit the configuration.

In the example below, all routes will require the manage:books scope present in order to invoke the integration.

 import software.amazon.awscdk.services.apigatewayv2.authorizers.HttpJwtAuthorizer;
 
 
 HttpJwtAuthorizer authorizer = HttpJwtAuthorizer.Builder.create()
         .jwtAudience(List.of("3131231"))
         .jwtIssuer("https://test.us.auth0.com")
         .build();
 
 HttpApi api = HttpApi.Builder.create(this, "HttpApi")
         .defaultAuthorizer(authorizer)
         .defaultAuthorizationScopes(List.of("manage:books"))
         .build();
 

Route Authorization

Authorization can also configured for each Route. When a route authorization is configured, it takes precedence over default authorization.

The example below showcases default authorization, along with route authorization. It also shows how to remove authorization entirely for a route.

 import software.amazon.awscdk.services.apigatewayv2.authorizers.HttpJwtAuthorizer;
 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpProxyIntegration;
 
 
 HttpJwtAuthorizer authorizer = HttpJwtAuthorizer.Builder.create()
         .jwtAudience(List.of("3131231"))
         .jwtIssuer("https://test.us.auth0.com")
         .build();
 
 HttpApi api = HttpApi.Builder.create(this, "HttpApi")
         .defaultAuthorizer(authorizer)
         .defaultAuthorizationScopes(List.of("read:books"))
         .build();
 
 api.addRoutes(AddRoutesOptions.builder()
         .integration(HttpProxyIntegration.Builder.create()
                 .url("https://get-books-proxy.myproxy.internal")
                 .build())
         .path("/books")
         .methods(List.of(HttpMethod.GET))
         .build());
 
 api.addRoutes(AddRoutesOptions.builder()
         .integration(HttpProxyIntegration.Builder.create()
                 .url("https://get-books-proxy.myproxy.internal")
                 .build())
         .path("/books/{id}")
         .methods(List.of(HttpMethod.GET))
         .build());
 
 api.addRoutes(AddRoutesOptions.builder()
         .integration(HttpProxyIntegration.Builder.create()
                 .url("https://get-books-proxy.myproxy.internal")
                 .build())
         .path("/books")
         .methods(List.of(HttpMethod.POST))
         .authorizationScopes(List.of("write:books"))
         .build());
 
 api.addRoutes(AddRoutesOptions.builder()
         .integration(HttpProxyIntegration.Builder.create()
                 .url("https://get-books-proxy.myproxy.internal")
                 .build())
         .path("/login")
         .methods(List.of(HttpMethod.POST))
         .authorizer(new HttpNoneAuthorizer())
         .build());
 

JWT Authorizers

JWT authorizers allow the use of JSON Web Tokens (JWTs) as part of OpenID Connect and OAuth 2.0 frameworks to allow and restrict clients from accessing HTTP APIs.

When configured, API Gateway validates the JWT submitted by the client, and allows or denies access based on its content.

The location of the token is defined by the identitySource which defaults to the http Authorization header. However it also supports a number of other options. It then decodes the JWT and validates the signature and claims, against the options defined in the authorizer and route (scopes). For more information check the JWT Authorizer documentation.

Clients that fail authorization are presented with either 2 responses:

 import software.amazon.awscdk.services.apigatewayv2.authorizers.HttpJwtAuthorizer;
 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpProxyIntegration;
 
 
 HttpJwtAuthorizer authorizer = HttpJwtAuthorizer.Builder.create()
         .jwtAudience(List.of("3131231"))
         .jwtIssuer("https://test.us.auth0.com")
         .build();
 
 HttpApi api = new HttpApi(this, "HttpApi");
 
 api.addRoutes(AddRoutesOptions.builder()
         .integration(HttpProxyIntegration.Builder.create()
                 .url("https://get-books-proxy.myproxy.internal")
                 .build())
         .path("/books")
         .authorizer(authorizer)
         .build());
 

User Pool Authorizer

User Pool Authorizer is a type of JWT Authorizer that uses a Cognito user pool and app client to control who can access your Api. After a successful authorization from the app client, the generated access token will be used as the JWT.

Clients accessing an API that uses a user pool authorizer must first sign in to a user pool and obtain an identity or access token. They must then use this token in the specified identitySource for the API call. More information is available at using Amazon Cognito user pools as authorizer.

 import software.amazon.awscdk.services.cognito.*;
 import software.amazon.awscdk.services.apigatewayv2.authorizers.HttpUserPoolAuthorizer;
 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpProxyIntegration;
 
 
 UserPool userPool = new UserPool(this, "UserPool");
 UserPoolClient userPoolClient = userPool.addClient("UserPoolClient");
 
 HttpUserPoolAuthorizer authorizer = HttpUserPoolAuthorizer.Builder.create()
         .userPool(userPool)
         .userPoolClients(List.of(userPoolClient))
         .build();
 
 HttpApi api = new HttpApi(this, "HttpApi");
 
 api.addRoutes(AddRoutesOptions.builder()
         .integration(HttpProxyIntegration.Builder.create()
                 .url("https://get-books-proxy.myproxy.internal")
                 .build())
         .path("/books")
         .authorizer(authorizer)
         .build());
 

Lambda Authorizers

Lambda authorizers use a Lambda function to control access to your HTTP API. When a client calls your API, API Gateway invokes your Lambda function and uses the response to determine whether the client can access your API.

Lambda authorizers depending on their response, fall into either two types - Simple or IAM. You can learn about differences here.

 import software.amazon.awscdk.services.apigatewayv2.authorizers.HttpLambdaAuthorizer;
 import software.amazon.awscdk.services.apigatewayv2.authorizers.HttpLambdaResponseType;
 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpProxyIntegration;
 
 // This function handles your auth logic
 Function authHandler;
 
 
 HttpLambdaAuthorizer authorizer = HttpLambdaAuthorizer.Builder.create()
         .authorizerName("lambda-authorizer")
         .responseTypes(List.of(HttpLambdaResponseType.SIMPLE)) // Define if returns simple and/or iam response
         .handler(authHandler)
         .build();
 
 HttpApi api = new HttpApi(this, "HttpApi");
 
 api.addRoutes(AddRoutesOptions.builder()
         .integration(HttpProxyIntegration.Builder.create()
                 .url("https://get-books-proxy.myproxy.internal")
                 .build())
         .path("/books")
         .authorizer(authorizer)
         .build());
 
Skip navigation links