Package: b-cfn-custom-api-key-authorizer
B.CfnCustomApiKeyAuthorizerAn AWS CDK resource that enables protection of your public APIs by
using Api Keys (ApiKey and Secret).DescriptionThis custom authorizer enables Api Key functionality
(something similar to ApiGateway V1 version:https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-setup-api-key-with-console.html)APIs created via ApiGateway V2 do not have Api Key authorization functionality out-of-the-box.
If you want to protect your V2 API by generating a secret key and giving only for the
intended clients - this library is just for you. This library allows you to protect you
ApiGatewayV2-based endpoints with a combination of ApiKey and ApiSecret. Refer to usages & examples
to understand how to use this library.The authorizer library exposes these lambda functions that can be called directly:authorizer-ApiKeysAuthorizerFunction- used by a custom (this) authorizer that is attached to your API.deleter-ApiKeysDeleterFunction- allows revoking access to your API i.e. deletes api keys.exists-ApiKeysExistsFunction- allows you to check whether a given API key exists in the database.generator-ApiKeysGeneratorFunction- generates api key and api secret pair and saves in an internal database.validator-ApiKeysValidatorFunction- validates given api key and api secret against the ones in the database.RemarksBiomapasaims to modernise life-science industry by sharing its IT knowledge with other
companies and the community. This is an open source library intended to be used by anyone. Improvements and pull
requests are welcome.Related technologyPython3AWS CDKAWS CloudFormationAWS API GatewayAWS API Gateway AuthorizerAWS LambdaAssumptionsThis project assumes you are an expert in infrastructure-as-code via AWS CloudFormation and AWS CDK. You must clearly
understand how AWS API Gateway endpoints are protected with Authorizers / Custom Authorizers and how it is managed via
CloudFormation or CDK.Excellent knowledge in IaaC (Infrastructure as a Code) principles.Excellent knowledge in API Gateway, Authorizers.Good experience in AWS CDK and AWS CloudFormation.Good Python skills and basics of OOP.Useful sourcesAWS CDK:https://docs.aws.amazon.com/cdk/api/latest/docs/aws-construct-library.htmlAWS CloudFormation:https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.htmlAPI Gateway with
CloudFormation:https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.htmlAWS Custom
Authorizers:https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.htmlInstallBefore installing this library, ensure you have these tools setup:Python / PipAWS CDKTo install this project from source run:pip install .Or you can install it from a PyPi repository:pip install b-cfn-custom-api-key-authorizerUsage & ExamplesFirstly, create an api and stage:fromaws_cdk.aws_apigatewayv2importCfnApi,CfnStageapi=CfnApi(...)api_stage=CfnStage(...)Create api key custom authorizer:fromb_cfn_custom_api_key_authorizer.custom_authorizerimportApiKeyCustomAuthorizerfromb_cfn_custom_api_key_authorizer.authorization_typeimportAuthorizationTypeauthorizer=ApiKeyCustomAuthorizer(scope=Stack(...),resource_name_prefix='MyCool',api=api,# If you specify this, your API will look for "ApiKey" and "ApiSecret" headers in your request.# authorization_type=AuthorizationType.API_KEY_AND_SECRET_HEADERS# If you specify this, your API will treat your request with basic auth in mind ("Authorization" header).# authorization_type=AuthorizationType.AUTHORIZATION_HEADER)Use that authorizer to protect your routes (endpoints):fromaws_cdk.aws_apigatewayv2importCfnRouteroute=CfnRoute(scope=Stack(...),id='DummyRoute',api_id=api.ref,route_key='GET /dummy/endpoint',authorization_type='CUSTOM',target=f'integrations/{integration.ref}',authorizer_id=authorizer.ref)Once your infrastructure is deployed, try calling your api endpoint. You will get "Unauthorized" error.importurllib3response=urllib3.PoolManager().request(method='GET',url='https://your-api-url/dummy/endpoint',headers={},)>>>response.status>>>401CreateApiKeyandApiSecretby invoking a dedicated api keys generator lambda function:# Your supplied prefix for the infrastrucutre.resource_name_prefix='MyCool'# Created generator lambda function name.function_name='ApiKeysGeneratorFunction'# Full function name is a combination of both.function_name=resource_name_prefix+function_nameresponse=boto3.client('lambda').invoke(FunctionName=function_name,InvocationType='RequestResponse',)response=json.loads(response['Payload'].read())api_key=response['ApiKey']api_secret=response['ApiSecret']Now try calling the same api with api keys:importurllib3response=urllib3.PoolManager().request(method='GET',url='https://your-api-url/dummy/endpoint',headers={'ApiKey':api_key,'ApiSecret':api_secret},)>>>response.status>>>200Exposed lambda functionsThe authorizer exposes these lambda functions that can be called directly:authorizer- ApiKeysAuthorizerFunctionresponse=boto3.client('lambda').invoke(FunctionName=prefix+'ApiKeysAuthorizerFunction',InvocationType='RequestResponse',Payload=json.dumps({'ApiKey':'123','ApiSecret':'123'}).encode())response=json.loads(response['Payload'].read())# This will contain a dictionary of IAM based# permission either to "allow" or "deny" the request.print(response)deleter- ApiKeysDeleterFunction# This does not produce a response.boto3.client('lambda').invoke(FunctionName=prefix+'ApiKeysDeleterFunction',InvocationType='RequestResponse',Payload=json.dumps({'ApiKey':'123',}).encode())exists- ApiKeysExistsFunctionresponse=boto3.client('lambda').invoke(FunctionName=prefix+'ApiKeysExistsFunction',InvocationType='RequestResponse',Payload=json.dumps({'ApiKey':'123',}).encode())response=json.loads(response['Payload'].read())# Check whether your ApiKey/Secret exists in the database.assertresponse['Exists']isTruegenerator- ApiKeysGeneratorFunctionresponse=boto3.client('lambda').invoke(FunctionName=prefix+'ApiKeysGeneratorFunction',InvocationType='RequestResponse',)response=json.loads(response['Payload'].read())api_key=response['ApiKey']api_secret=response['ApiSecret']validator- ApiKeysValidatorFunctionresponse=boto3.client('lambda').invoke(FunctionName=prefix+'ApiKeysValidatorFunction',InvocationType='RequestResponse',Payload=json.dumps({'ApiKey':'123','ApiSecret':'123',}).encode())response=json.loads(response['Payload'].read())# Check whether your ApiKey/Secret is valid.assertresponse['Valid']isTrueTestingThis package has integration tests based onpytest. To run tests simply run:pytest b_cfn_custom_api_key_authorizer_test/integration/testsContributionFound a bug? Want to add or suggest a new feature? Contributions of any kind are gladly welcome. You may contact us
directly, create a pull-request or an issue in github platform. Lets modernize the world together.Release history3.0.0Upgrade CDK support from v1 to v2.Upgrade GitHub pipelines checkout version from v2 to v3.Set GitHub pipelines node version 18.Set GitHub pipelines python version 3.10.2.3.0Update ofauthorizerfunction. Removing of sensitive information form lambda event implemented.2.2.0Remove unnecessary dependencies.2.1.1Add more integration tests.Update README documentation.2.1.0Add ability to specify what type of authentication strategy to use.
Support for bothApiKey/ApiSecretandAuthorizationheaders.2.0.1Dollar sign excluded from API secret.2.0.0Restructured project.All lambda functions are underfunctionsdirectory.Adddeleterfunction to revoke api keys.Addexistsfunction to check whether given api key exists.Addvalidatorfunction to validate api key and api secret.Increase the length of api key (15) and api secret (30).Move authentication checking logic to a lambda layer.Add more lambda-level logging.Add more integrations tests (total 11 as of now).Very important security improvement- api secrets are now hashed, to avoid
leaks if the database is pawned. This is a standard password-level storage security.Greatly improve documentation.1.1.0Create a dedicated lambda function to generate
api keys. You should not interact with the database directly.1.0.0Prod-ready version.Added documentation.Added more tests.Some code improvements.0.1.0Initial testing done. Authorizer works.Need more tests and edge case handling before promoting to 1.0.0.0.0.1Initial build.