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

feat(apigatewayv2): http api - jwt and cognito user pool authorizers #10972

Merged
merged 60 commits into from
Feb 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
6db0e2d
feat(apigatewayv2): Authorizer L2 Support
iRoachie Oct 20, 2020
bcadad1
Merge branch 'master' into authorizer
iRoachie Oct 20, 2020
2bf79b8
style: line endings
iRoachie Oct 20, 2020
d7f2930
Add example for authorizer
iRoachie Oct 20, 2020
3bf3762
Merge branch 'master' into authorizer
iRoachie Oct 20, 2020
57ad9ae
Merge branch 'master' into authorizer
iRoachie Oct 21, 2020
8dad3ad
docs: Add authorizer to TOC
iRoachie Oct 21, 2020
1c59827
Make suggested changes from review
iRoachie Oct 21, 2020
23b5bb4
Expose authorizerType
iRoachie Oct 21, 2020
1d1c5db
feat: Allow attaching authorizer to Route
iRoachie Oct 21, 2020
ff72b0a
test: Update test to check for authorizer on route
iRoachie Oct 21, 2020
dd579a0
feat: Attach authorizer via api.addRoutes
iRoachie Oct 21, 2020
85a9d61
Add integration test
iRoachie Oct 21, 2020
3abdeb8
Reference stack in docs
iRoachie Oct 21, 2020
25c7872
Add verification steps
iRoachie Oct 21, 2020
a3dc8b9
feat: Add authorizationScopes to Route
iRoachie Oct 22, 2020
c73a8a8
Merge branch 'master' into authorizer
iRoachie Oct 22, 2020
4261a97
Update example to correct audience
iRoachie Oct 23, 2020
5fe2645
Update integ test to include app client
iRoachie Oct 23, 2020
86c3545
Merge branch 'master' into authorizer
iRoachie Oct 24, 2020
ca2a0e8
Merge branch 'master' into authorizer
iRoachie Oct 26, 2020
729c679
Update packages/@aws-cdk/aws-apigatewayv2/README.md
iRoachie Oct 28, 2020
af3c47c
Use HttpAuthorizer for example
iRoachie Oct 28, 2020
71305f5
Update packages/@aws-cdk/aws-apigatewayv2/lib/http/authorizer.ts
iRoachie Oct 28, 2020
d1745ae
Update packages/@aws-cdk/aws-apigatewayv2/lib/http/api.ts
iRoachie Oct 28, 2020
3e8674e
Update based on feedback (not finished)
iRoachie Oct 28, 2020
422f07d
Update test
iRoachie Oct 28, 2020
d6c3a52
Update from Authorizer
iRoachie Oct 28, 2020
e9ccada
Spelling error
iRoachie Oct 28, 2020
f43fdba
Merge branch 'master' into authorizer
iRoachie Oct 28, 2020
175fab6
Don't make identitySource public
iRoachie Oct 28, 2020
f15291a
Merge branch 'master' into authorizer
iRoachie Nov 3, 2020
3315fbd
Fix formatting
iRoachie Nov 3, 2020
5e6fb78
Update packages/@aws-cdk/aws-apigatewayv2/README.md
iRoachie Nov 6, 2020
fcc1565
Update packages/@aws-cdk/aws-apigatewayv2/README.md
iRoachie Nov 6, 2020
69151c2
Update packages/@aws-cdk/aws-apigatewayv2/README.md
iRoachie Nov 6, 2020
f0c78de
Update packages/@aws-cdk/aws-apigatewayv2/test/http/integ.authorizer.ts
iRoachie Nov 6, 2020
fa24414
Move cognito to devDependencies
iRoachie Nov 8, 2020
649c7c3
Merge branch 'master' into authorizer
iRoachie Nov 20, 2020
5237227
authorizer bind pattern + separate package
Dec 8, 2020
9d8bdfb
Merge pull request #1 from nija-at/pr-10972
iRoachie Jan 24, 2021
275f915
Merge branch 'master' into authorizer
iRoachie Jan 24, 2021
a343a3b
lint fixes from fast-forward
iRoachie Jan 24, 2021
d4fb6b5
feat: add fromHttpAuthorizerAttributes
iRoachie Jan 25, 2021
b158d4d
feat: allow adding scopes via api.addRoutes
iRoachie Jan 25, 2021
3f4eda7
test: Update authorizer tests
iRoachie Jan 25, 2021
afd09d7
fix pkglint errors
iRoachie Jan 25, 2021
eb636c4
feat: add jwt authorizer
iRoachie Jan 25, 2021
ebae465
feat: change import signature for HttpAuthorizer
iRoachie Feb 5, 2021
eb6f796
Merge branch 'master' into authorizer
iRoachie Feb 5, 2021
e6dd079
docs: add info on user pool authorizer
iRoachie Feb 5, 2021
d6868a6
docs: refer to authorizers package
iRoachie Feb 5, 2021
ce218c1
Update packages/@aws-cdk/aws-apigatewayv2-authorizers/README.md
iRoachie Feb 10, 2021
27bc22b
spacing nit
iRoachie Feb 10, 2021
43625af
docs: add info on the token validation process
iRoachie Feb 10, 2021
14a2969
Merge branch 'master' into authorizer
iRoachie Feb 10, 2021
fc1d3c0
test: update integrations
iRoachie Feb 10, 2021
cf03de5
feat: add authorizer package to decdk
iRoachie Feb 10, 2021
f89041b
feat: add authorizer package to monocdk
iRoachie Feb 10, 2021
9a46843
feat: add authorizer package to aws-cdk-lib
iRoachie Feb 10, 2021
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
3 changes: 3 additions & 0 deletions packages/@aws-cdk/aws-apigatewayv2-authorizers/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
const baseConfig = require('cdk-build-tools/config/eslintrc');
baseConfig.parserOptions.project = __dirname + '/tsconfig.json';
module.exports = baseConfig;
17 changes: 17 additions & 0 deletions packages/@aws-cdk/aws-apigatewayv2-authorizers/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
*.d.ts
*.generated.ts
*.js
*.js.map
*.snk
.jsii
.LAST_BUILD
.LAST_PACKAGE
nyc.config.js
.nyc_output
coverage
dist
tsconfig.json
!.eslintrc.js
!jest.config.js

junit.xml
28 changes: 28 additions & 0 deletions packages/@aws-cdk/aws-apigatewayv2-authorizers/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# The basics
*.ts
*.tgz
*.snk
!*.d.ts
!*.js
**/cdk.out

# Coverage
coverage
.nyc_output
.nycrc

# Build gear
dist
.LAST_BUILD
.LAST_PACKAGE

*.tsbuildinfo
tsconfig.json
!.jsii
.eslintrc.js
jest.config.js

# exclude cdk artifacts
**/cdk.out
junit.xml
test/
201 changes: 201 additions & 0 deletions packages/@aws-cdk/aws-apigatewayv2-authorizers/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
2 changes: 2 additions & 0 deletions packages/@aws-cdk/aws-apigatewayv2-authorizers/NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
AWS Cloud Development Kit (AWS CDK)
Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
82 changes: 82 additions & 0 deletions packages/@aws-cdk/aws-apigatewayv2-authorizers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# AWS APIGatewayv2 Authorizers
<!--BEGIN STABILITY BANNER-->

---

![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)

> 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](https://semver.org/) 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.

---

<!--END STABILITY BANNER-->

## Table of Contents

- [HTTP APIs](#http-apis)
- [JWT Authorizers](#jwt-authorizers)
- [User Pool Authorizer](#user-pool-authorizer)

## HTTP APIs

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](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html).

## JWT Authorizers

JWT authorizers allow the use of JSON Web Tokens (JWTs) as part of [OpenID Connect](https://openid.net/specs/openid-connect-core-1_0.html) and [OAuth 2.0](https://oauth.net/2/) frameworks to allow and restrict clients from accessing HTTP APIs.

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

iRoachie marked this conversation as resolved.
Show resolved Hide resolved
API gateway uses the `identitySource` to determine where to look for the token. By default it checks the http `Authorization` header. However it also [supports a number of other options](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html#http-api-lambda-authorizer.identity-sources). 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html).

```ts
const authorizer = new HttpJwtAuthorizer({
jwtAudience: ['3131231'],
jwtIssuer: 'https://test.us.auth0.com',
});

const api = new HttpApi(stack, 'HttpApi');

api.addRoutes({
integration: new HttpProxyIntegration({
url: 'https://get-books-proxy.myproxy.internal',
}),
path: '/books',
authorizer,
});
```

### 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.

iRoachie marked this conversation as resolved.
Show resolved Hide resolved
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 `Authorization` header of the API call. More information is available at [using Amazon Cognito user
pools as authorizer](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html).

```ts
const userPool = new UserPool(stack, 'UserPool');
const userPoolClient = userPool.addClient('UserPoolClient');

const authorizer = new HttpUserPoolAuthorizer({
userPool,
userPoolClient,
});

const api = new HttpApi(stack, 'HttpApi');

api.addRoutes({
integration: new HttpProxyIntegration({
url: 'https://get-books-proxy.myproxy.internal',
}),
path: '/books',
authorizer,
});
```
10 changes: 10 additions & 0 deletions packages/@aws-cdk/aws-apigatewayv2-authorizers/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
const baseConfig = require('cdk-build-tools/config/jest.config');
module.exports = {
...baseConfig,
coverageThreshold: {
global: {
...baseConfig.coverageThreshold.global,
branches: 70,
},
},
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from './user-pool';
export * from './jwt';
Loading