feat(apigatewayv2): websocket api: api keys #16636

alpacamybags118 · 2021-09-24T02:40:25Z

This PR adds support for requiring an API Key on Websocket API routes. Specifically, it does the following:

Exposes apiKeyRequired on route object (defaults to false)
Exposes apiKeySelectionExpression on api object

In addition, the following has been added:

Logic to ensure apiKeySelectionExpression falls within the two currently supported values
Created a few basic integration tests for the api and route objects for websockets

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

gitpod-io · 2021-09-24T02:40:27Z

alpacamybags118 · 2021-09-24T04:32:11Z

I'm running into a bit of trouble when I try to add @aws-cdk/aws-apigatewayv2-integrations as a dev dependency in aws-apigatewayv2 to write some integration tests.

When I build apigatewayv2, I get the following errors:

[2021-09-24T00:20:46.130] [ERROR] jsii/compiler - Type model errors prevented the JSII assembly from being created
error JSII8002: Method and property (unless they are static readonly) names must use camelCase. Rename "@aws-cdk/aws-apigatewayv2.HttpRouteKey.DEFAULT" to "default"
error JSII8002: Method and property (unless they are static readonly) names must use camelCase. Rename "@aws-cdk/aws-apigatewayv2.PayloadFormatVersion.VERSION_1_0" to "version10"
error JSII8002: Method and property (unless they are static readonly) names must use camelCase. Rename "@aws-cdk/aws-apigatewayv2.PayloadFormatVersion.VERSION_2_0" to "version20"
Error: /mnt/c/Git/aws-cdk/tools/cdk-build-tools/node_modules/jsii/bin/jsii --silence-warnings=reserved-word exited with error code 1

If I dont include this dependency, I don't get any errors during build and everything works just fine. I'm also importing @aws-cdk/aws-lambda and I'm able to build still with that imported.

I checked the objects the error is referring to, and they are all static readonly so I'm a bit confused.

alpacamybags118 · 2021-09-28T03:14:38Z

that issue ended up being a circular dependency between apigateway and apigateway-integrations. I made some code and test adjustments. This pr should be ready for review now

nija-at

Thanks for the PR @alpacamybags118 - please see my comments below.

nija-at · 2021-11-05T15:55:07Z

packages/@aws-cdk/aws-apigatewayv2/README.md

@@ -336,3 +336,12 @@ webSocketApi.addRoute('sendmessage', {
  }),
 });
 ```
+
+In addition, you can enable API key authentication to your WebSocket api:


Can you add a separate section called 'api keys' and explain them a little more? I'm not familiar with these.

nija-at · 2021-11-05T15:55:32Z

packages/@aws-cdk/aws-apigatewayv2/lib/websocket/api.ts

+  /**
+ * x-api-key type
+ */
+  X_API_KEY = '$request.header.x-api-key',
+
+  /**
+ * usageIdentifierKey type
+ */
+  USAGE_IDENTIFIER_KEY = '$context.authorizer.usageIdentifierKey'


Could you add more documentation to these on what these mean?

nija-at · 2021-11-05T15:55:52Z

packages/@aws-cdk/aws-apigatewayv2/lib/websocket/api.ts

@@ -26,6 +41,12 @@ export interface WebSocketApiProps {
   */
  readonly apiName?: string;

+  /**
+   * An API key selection expression. Currently only supports '$request.header.x-api-key' and '$context.authorizer.usageIdentifierKey'


Same here. Think of a user who is coming to the cdk and looking at these. They should be able to understand at a basic level what this is, whether they should use it, etc.

packages/@aws-cdk/aws-apigatewayv2/lib/websocket/route.ts

alpacamybags118 · 2021-11-08T17:37:26Z

thanks for the feedback @nija-at will get to updating tonight

Pull request has been modified.

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

nija-at

Please see my comments below.

nija-at · 2021-11-10T16:21:29Z

packages/@aws-cdk/aws-apigatewayv2/test/websocket/integ.api-default.ts

@@ -0,0 +1,11 @@
+#!/usr/bin/env node


We don't need an integ test for this change. Drop.

nija-at · 2021-11-10T16:23:41Z

packages/@aws-cdk/aws-apigatewayv2/lib/websocket/api.ts

+/**
+ * Represents the currently available API Key Selection Expressions
+ */
+export enum ApiKeySelectionExpression {


Use an enum-like class here instead of an enum - https://github.com/aws/aws-cdk/blob/master/docs/DESIGN_GUIDELINES.md#enums

nija-at · 2021-11-10T16:24:52Z

packages/@aws-cdk/aws-apigatewayv2/lib/websocket/api.ts

+/**
+ * Represents the currently available API Key Selection Expressions
+ */
+export enum ApiKeySelectionExpression {


This module holds both http api and websocket api, so name this WebSocketApiKeySelection

nija-at · 2021-11-10T16:25:37Z

packages/@aws-cdk/aws-apigatewayv2/lib/websocket/api.ts

+ * x-api-key type
+ * This represents an API Key that is provided via an `x-api-key` header in the user request.
+ */
+  X_API_KEY = '$request.header.x-api-key',


Call this HEADER_X_API_KEY and the other one AUTHORIZER_USAGE_IDENTIFIER_KEY

packages/@aws-cdk/aws-apigatewayv2/lib/websocket/api.ts

packages/@aws-cdk/aws-apigatewayv2/README.md

packages/@aws-cdk/aws-apigatewayv2/lib/websocket/route.ts

alpacamybags118 · 2021-11-12T20:19:07Z

Thanks for the feedback again @nija-at - ill be on vacation for a week so I'll look at this once I'm back!

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

Pull request has been modified.

mergify · 2022-01-11T15:13:58Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2022-01-11T16:01:42Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
Commit ID: 5632f9a
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2022-01-11T16:02:16Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

---- This PR adds support for requiring an API Key on Websocket API routes. Specifically, it does the following: * Exposes `apiKeyRequired` on route object (defaults to false) * Exposes `apiKeySelectionExpression` on api object In addition, the following has been added: * Logic to ensure `apiKeySelectionExpression` falls within the two currently supported values * Created a few basic integration tests for the api and route objects for websockets *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

alpacamybags118 force-pushed the api_key_websocket branch 3 times, most recently from b45ca7f to 4c168ce Compare September 28, 2021 02:41

alpacamybags118 marked this pull request as ready for review September 28, 2021 03:14

alpacamybags118 force-pushed the api_key_websocket branch from 4c168ce to a0723b6 Compare September 28, 2021 20:34

RomainMuller force-pushed the master branch from 924c117 to ebfd5f2 Compare September 29, 2021 13:07

alpacamybags118 force-pushed the api_key_websocket branch 3 times, most recently from 9b69ac1 to 729bb75 Compare October 5, 2021 22:01

peterwoodworth changed the title ~~feat(aws-apigatewayv2): add support for api-key in websocket apis~~ feat(aws-apigatewayv2): add support for api-key in websocket apis Oct 21, 2021

github-actions bot assigned nija-at Oct 21, 2021

github-actions bot added the @aws-cdk/aws-apigatewayv2 Related to Amazon API Gateway v2 label Oct 21, 2021

alpacamybags118 force-pushed the api_key_websocket branch 2 times, most recently from 9aeac9c to 0f3c41e Compare October 26, 2021 02:59

nija-at previously requested changes Nov 5, 2021

View reviewed changes

alpacamybags118 force-pushed the api_key_websocket branch from 0f3c41e to 8c5de24 Compare November 9, 2021 06:10

alpacamybags118 and others added 2 commits November 9, 2021 12:29

feat(aws-apigatewayv2): add support for api-key in websocket apis

872f428

Update packages/@aws-cdk/aws-apigatewayv2/lib/websocket/route.ts

3d1ddee

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

alpacamybags118 force-pushed the api_key_websocket branch from 732b66a to 3d1ddee Compare November 9, 2021 17:30

nija-at previously requested changes Nov 10, 2021

View reviewed changes

Update packages/@aws-cdk/aws-apigatewayv2/lib/websocket/api.ts

030bc2f

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

addressing feedback

5f1e0ed

nija-at changed the title ~~feat(aws-apigatewayv2): add support for api-key in websocket apis~~ feat(apigatewayv2): websocket api: api keys Dec 2, 2021

github-actions bot assigned otaviomacedo Dec 2, 2021

nija-at removed their assignment Dec 2, 2021

otaviomacedo and others added 4 commits January 11, 2022 10:47

Update api.ts

6b7fcdc

Merge branch 'master' into api_key_websocket

2971aa9

Fixes after conflict resolution

5415dc5

Fixed test

9a429fa

otaviomacedo approved these changes Jan 11, 2022

View reviewed changes

Merge branch 'master' into api_key_websocket

5632f9a

mergify bot merged commit 24f8f74 into aws:master Jan 11, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(apigatewayv2): websocket api: api keys #16636

feat(apigatewayv2): websocket api: api keys #16636

alpacamybags118 commented Sep 24, 2021 •

edited

Loading

gitpod-io bot commented Sep 24, 2021

alpacamybags118 commented Sep 24, 2021

alpacamybags118 commented Sep 28, 2021

nija-at left a comment

nija-at Nov 5, 2021 •

edited

Loading

nija-at Nov 5, 2021

nija-at Nov 5, 2021

alpacamybags118 commented Nov 8, 2021

nija-at left a comment

nija-at Nov 10, 2021

nija-at Nov 10, 2021

nija-at Nov 10, 2021

nija-at Nov 10, 2021

alpacamybags118 commented Nov 12, 2021

mergify bot commented Jan 11, 2022

aws-cdk-automation commented Jan 11, 2022

mergify bot commented Jan 11, 2022

feat(apigatewayv2): websocket api: api keys #16636

feat(apigatewayv2): websocket api: api keys #16636

Conversation

alpacamybags118 commented Sep 24, 2021 • edited Loading

gitpod-io bot commented Sep 24, 2021

alpacamybags118 commented Sep 24, 2021

alpacamybags118 commented Sep 28, 2021

nija-at left a comment

Choose a reason for hiding this comment

nija-at Nov 5, 2021 • edited Loading

Choose a reason for hiding this comment

nija-at Nov 5, 2021

Choose a reason for hiding this comment

nija-at Nov 5, 2021

Choose a reason for hiding this comment

alpacamybags118 commented Nov 8, 2021

nija-at left a comment

Choose a reason for hiding this comment

nija-at Nov 10, 2021

Choose a reason for hiding this comment

nija-at Nov 10, 2021

Choose a reason for hiding this comment

nija-at Nov 10, 2021

Choose a reason for hiding this comment

nija-at Nov 10, 2021

Choose a reason for hiding this comment

alpacamybags118 commented Nov 12, 2021

mergify bot commented Jan 11, 2022

aws-cdk-automation commented Jan 11, 2022

AWS CodeBuild CI Report

mergify bot commented Jan 11, 2022

alpacamybags118 commented Sep 24, 2021 •

edited

Loading

nija-at Nov 5, 2021 •

edited

Loading