@alliander-opensource/aws-jwt-sts 0.2.6

package/LICENSE.txt

@@ -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 [2023] [Alliander NV]
+
+   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.

package/README.md

@@ -0,0 +1,130 @@
+# Use IAM roles to authenticate principals in workloads outside of AWS using JWT
+There is an inherent risk in maintaining and storing permanent credentials. In their lifetime, they are bound to be shared, compromised, and lost. When shared, it is often among a broader audience than initially intended. They can also be lost and found, sometimes by the wrong person. And when any of this occurs, it can put your systems, data or even organization at risk.
+
+Workloads running on AWS can communicate with each other or with AWS services without the need of storing permanent credentials by assuming roles or instance profiles. However, if one of the workloads lives outside of AWS, AWS principals can no longer be used for authentication.
+
+An alternative to authenticating with external workloads is to use short-lived credentials issued by a trusted party, the issuer, that the target system can accept. JWTs (JSON Web Tokens), as used by the OIDC (OpenID Connect) standard, are an example of such credentials. JWTs are short-lived credentials that can be signed and verified using a public key in what is known as public-key cryptography.
+
+## Secure Token Service (STS)
+Exchanging credentials from on form to the other is done with a Secure Token Service (STS) function. AWS also provides STS functions not the one we need. Only the other way around: to exchange a JWT to IAM Session which is called [AssumeRoleWithWebIdentity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html).
+This repo contains a CDK Construct which will deploy a new function which adds the function to exchange an AWS IAM (Session) credential with a signed JWT.
+
+## Solution overview
+
+The solution provides 2 endpoints; an OIDC discovery endpoint and a token endpoint. The OIDC discovery endpoint can be used to establish a trust between te STS function and a resource. The token endpoint can be used by client in AWS to exchange their IAM credentials to a JWT.
+
+When a client wants to retrieve a JWT key, it will invoke the token API via the API GW. The backing lambda creates a JWT based on the invoking IAM identity and invokes KMS to sign the token.
+
+On time based events, EventBridge will trigger a Step function rotation flow. This flow triggers a lambda which in subsequent steps will create a new KMS signing key. Based on that signing key a JWKS is generated and stored in S3 together with discovery files.
+
+![Solution architecture](/doc/sts-jwt-function.drawio.png "Solution architecture")
+
+## Using the construct
+
+1.	Init a new typescript CDK project
+    `cdk init app --language typescript`
+2.	Config npm to retrieve packages from github package repository
+    `echo @alliander-opensource:registry=https://npm.pkg.github.com > .npmrc`
+3.	Install the aws-jwt-sts construct
+    `npm install @alliander-opensource/aws-jwt-sts`
+4.	Edit lib/my-sts-stack.ts to add the construct to the stack
+    See the comments in the code for possible options
+
+```ts
+import * as cdk from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+import { AwsJwtSts, wafUsage } from '@alliander-opensource/aws-jwt-sts'
+
+export class MyStsStack extends cdk.Stack {
+  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
+    super(scope, id, props);
+
+    new AwsJwtSts(this, 'sts', {
+      /*
+      * Mandatory:
+      *
+      * Set the default aud claim in the jwt, when not specified in the GET param
+      */
+      defaultAudience: 'api://resourceAudience',
+
+      /*
+      * Optional: when using a custom domain
+      *
+      * The construct can run on a custom domain, for this the following properties need to be added
+      * Ensure a hosted zone is present in the account where the sts function will be deployed
+      * Both needed to be set to use the custom domain
+      */
+      hostedZoneName: 'test.example.com', // domain name of the zone
+      hostedZoneId: 'ZXXXXXXXXXXXXXXXXXXXX', // zoneId of the zone
+
+      /*
+      * Optional; when using a custom domain the subdomains of the endpoints can optionally be set
+      */
+      oidcSubdomain: 'oidc', // default 'oidc' for the discovery endpoint (cloudfront)
+      tokenSubdomain: 'token', // default 'token' for the the token api gw endpoint
+
+      /*
+      * Optional:
+      *
+      * AWS WAF can be applied to the API GW
+      * apiGwWaf acceptes the folling values:
+      * wafUsage.ConstructProvided to use the WAF defined by the contruct
+      * wafUsage.ProvideWebAclArn in combination with the apiGwWafWebAclArn param to specify an already deployed webAcl
+      *
+      * By not setting apiGwWaf, no WAF will be deployed
+      */
+      apiGwWaf: wafUsage.ProvideWebAclArn,
+
+      /*
+      * Optional; only applicable if apiGwWaf is set to: wafUsage.ProvideWebAclArn
+      *
+      * Specify the WebAcl to use for the API GW
+      */
+      apiGwWafWebAclArn: 'arn:aws:wafv2:{REGION}:{ACCOUNTID}:regional/webacl/{WebAclName}/{WebAclId}',
+
+      /*
+      * Optional:
+      *
+      * When used in a multi account structure with AWS Organizations specify the organization ID.
+      * This sets a resource policy on the API GW Stage so that the whole org may access it
+      * When not specified no policy is places on the API GW Stage and it will only allow access from within that account
+      */
+      orgId: 'o-xxxxxxxxxx'
+
+    })
+  }
+}
+```
+
+5. Deploy the stack
+   `cdk deploy`
+
+The stack outputs the urls of the endpoints. So if no custom domain is provided observe the CDK Stack output.
+
+## Using the STS function
+A token from the STS function can be obained by invoking the token endpoint.
+`GET https://$host/token`
+optionally an audience can be provided if this needs to be different than the installed default
+`GET https://$host/token?aud=api://myAudience`
+
+> Note: The IAM Role / User invoking the endpoint must have *execute-api:Invoke* permissions
+
+In CDK these permission is added as followed:
+```ts
+role.addToPolicy(new iam.PolicyStatement({
+      actions: ['execute-api:Invoke'],
+      resources: ['*']
+    }))
+```
+
+> Note: keep in mind that *resource '\*'* should only be used if no other API GW's with IAM auth are used in that account.
+
+### Test obtaining a JWT
+1.	Ensure the AWS IAM Role / User invoking the token endpoint has execute-api permissions. If you are using administrator access then that is more than sufficient.
+2.	Use a shell with AWS cli logged in, you can use your cli with which you deployed the stack or use cloudshell for this.
+3.	Install awscurl for authentication
+    `pip3 install awscurl`
+4.	Install jwt-cli for jwt formatting
+    `npm install -g jwt-cli`
+5.	Invoke the api: `awscurl {your token endpoint}/token --service execute-api --region {your_region} | jq -r .token | jwt decode – `
+6.	Observe the JWT

package/dist/index.d.ts

@@ -0,0 +1,78 @@
+import * as lambda from 'aws-cdk-lib/aws-lambda';
+import * as sns from 'aws-cdk-lib/aws-sns';
+import { Construct } from 'constructs';
+export declare enum wafUsage {
+    ConstructProvided = 0,
+    ProvideWebAclArn = 1
+}
+export interface AwsJwtStsProps {
+    /**
+     * defaultAudience which is used in de JWT's
+     */
+    readonly defaultAudience: string;
+    /**
+     * HostedZoneId of the domain used for hosting the sts function
+     */
+    readonly hostedZoneId?: string;
+    /**
+     * Name of the hostedZone.
+     */
+    readonly hostedZoneName?: string;
+    /**
+    * Optional subdomain name of oidc discovery, default: oidc.
+    */
+    readonly oidcSubdomain?: string;
+    /**
+    * Optional subdomain name of the token api (on api gw), default: token.
+    */
+    readonly tokenSubdomain?: string;
+    /**
+     * If waf needs to be added to the API GW
+     *
+     * None: no waf is used
+     * ConstructProvided: the construct will deploy a wafAcl with opinionated rules
+     * ProvideWebAclArn: provide your own arn
+     */
+    readonly apiGwWaf?: wafUsage;
+    /**
+     * Arn of the waf webAcl rule to be associated with the API GW
+     *
+     */
+    readonly apiGwWafWebAclArn?: string;
+    /**
+     * The ID of the AWS Organization 0-xxxx
+     *
+     */
+    readonly orgId?: string;
+    /**
+     * CPU Architecture
+     */
+    readonly architecture?: lambda.Architecture;
+    /**
+     * Optional boolean to specify if key rotation should be triggered on creation of the stack, default: false
+     */
+    readonly disableKeyRotateOnCreate?: boolean;
+    /**
+     * Optional custom name for the CloudWatch Alarm monitoring Step Function failures, default: sts-key_rotate_sfn-alarm
+     */
+    readonly alarmNameKeyRotationStepFunctionFailed?: string;
+    /**
+     * Optional custom name for the CloudWatch Alarm monitoring 5xx errors on the API Gateway, default: sts-5xx_api_gw-alarm
+     */
+    readonly alarmNameApiGateway5xx?: string;
+    /**
+     * Optional custom name for the CloudWatch Alarm monitoring Sign Lambda failures, default: sts-sign_errors_lambda-alarm
+     */
+    readonly alarmNameSignLambdaFailed?: string;
+    /**
+     * Optional custom name for the CloudWatch Alarm monitoring Key Rotation Lambda failures, default: sts-key_rotate_errors_lambda-alarm
+     */
+    readonly alarmNameKeyRotationLambdaFailed?: string;
+}
+export declare class AwsJwtSts extends Construct {
+    /**
+     * SNS topic used to publish errors from the Step Function rotation flow
+     */
+    readonly failedRotationTopic: sns.Topic;
+    constructor(app: Construct, id: string, props: AwsJwtStsProps);
+}