Skip to content

Latest commit

 

History

History
executable file
·
197 lines (145 loc) · 13.9 KB

README.md

File metadata and controls

executable file
·
197 lines (145 loc) · 13.9 KB
Raw

Cloudfront Auth

Google Apps (G Suite), Microsoft Azure AD, GitHub, OKTA, Auth0, Centrify authentication for CloudFront using Lambda@Edge. The original use case for cloudfront-auth was to serve private S3 content over HTTPS without running a proxy server in EC2 to authenticate requests; but cloudfront-auth can be used authenticate requests of any Cloudfront origin configuration.

Description

Upon successful authentication, a cookie (named TOKEN) with the value of a signed JWT is set and the user redirected back to the originally requested path. Upon each request, Lambda@Edge checks the JWT for validity (signature, expiration date, audience and matching hosted domain) and will redirect the user to configured provider's login when their session has timed out.

Usage

If your CloudFront distribution is pointed at a S3 bucket, configure origin access identity so S3 objects can be stored with private permissions. (Origin access identity requires the S3 ACL owner be the account owner. Use our s3-object-owner-monitor Lambda function if writing objects across multiple accounts.)

Enable SSL/HTTPS on your CloudFront distribution; AWS Certificate Manager can be used to provision a no-cost certificate.

Session duration is defined as the number of hours that the JWT is valid for. After session expiration, cloudfront-auth will redirect the user to the configured provider to re-authenticate. RSA keys are used to sign and validate the JWT.

Lambda Deployment Packages

Custom Packages

A custom package has all the configuration baked into it (including secrets). To build a custom package, execute:

./build.sh

The build script prompts you for the required configuration parameters, which are described in Identity Provider Guides. If the files id_rsa and id_rsa.pub do not exist they will be automatically generated by the build. To disable all issued JWTs upload a new ZIP using the Lambda Console after deleting the id_rsa and id_rsa.pub files (a new key will be automatically generated).

Generic Packages

A generic package retrieves its configuration at runtime from the AWS Systems Manager Parameter Store and AWS Secrets Manager. Currently, support for this type of package has been added for OKTA Native only. To disable all issued JWTs, rotate the key pair using the Secrets Manager console.

Generic packages are pre-built and available for download from the Releases page of this GitHub repository. Terraform modules are available for downloading and deploying generic packages and their configuration resources.

Identity Provider Guides

Github

  1. Clone or download this repo
  2. Navigate to your organization's profile page, then choose OAuth Apps under Developer settings.
    1. Select New OAuth App
    2. For Authorization callback URL enter your Cloudfront hostname with your preferred path value for the authorization callback. Example: https://my-cloudfront-site.example.com/_callback
  3. Execute ./build.sh in the downloaded directory. NPM will run to download dependencies and a RSA key will be generated.
    1. Choose Github as the authorization method and enter the values for Client ID, Client Secret, Redirect URI, Session Duration and Organization
      • cloudfront-auth will check that users are a member of the entered Organization.
  4. Upload the resulting zip file found in your distribution folder using the AWS Lambda console and jump to the configuration step

Google

  1. Clone or download this repo
  2. Go to the Credentials tab of your Google developers console
    1. Create a new Project
    2. Create an OAuth Client ID from the Create credentials menu
    3. Select Web application for the Application type
    4. Under Authorized redirect URIs, enter your Cloudfront hostname with your preferred path value for the authorization callback. Example: https://my-cloudfront-site.example.com/_callback
  3. Execute ./build.sh in the downloaded directory. NPM will run to download dependencies and a RSA key will be generated.
  4. Choose Google as the authorization method and enter the values for Client ID, Client Secret, Redirect URI, Hosted Domain and Session Duration
  5. Select the preferred authentication method
    1. Hosted Domain (verify email's domain matches that of the given hosted domain)
    2. JSON Email Lookup
      1. Enter your JSON Email Lookup URL (example below) that consists of a single JSON array of emails to search through
    3. Google Groups Lookup
      1. Use Google Groups to authorize users
  6. Upload the resulting zip file found in your distribution folder using the AWS Lambda console and jump to the configuration step

Microsoft Azure

  1. Clone or download this repo
  2. In your Azure portal, go to Azure Active Directory and select App registrations
    1. Create a new application registration with an application type of Web app / api
    2. Once created, go to your application Settings -> Keys and make a new key with your desired duration. Click save and copy the value. This will be your client_secret
    3. Above where you selected Keys, go to Reply URLs and enter your Cloudfront hostname with your preferred path value for the authorization callback. Example: https://my-cloudfront-site.example.com/_callback
  3. Execute ./build.sh in the downloaded directory. NPM will run to download dependencies and a RSA key will be generated.
  4. Choose Microsoft as the authorization method and enter the values for Tenant, Client ID (Application ID), Client Secret (previously created key), Redirect URI and Session Duration
  5. Select the preferred authentication method
    1. Azure AD Membership (default)
    2. JSON Username Lookup
      1. Enter your JSON Username Lookup URL (example below) that consists of a single JSON array of usernames to search through
  6. Upload the resulting zip file found in your distribution folder using the AWS Lambda console and jump to the configuration step

OKTA

  1. Clone or download this repo
  2. Sign in to OKTA with your administrator account and navigate to the Applications tab.
  3. Add Application
    1. Select the Web application type
    2. Base URI: CloudFront distribution domain name (https://{cf-endpoint}.cloudfront.net)
    3. Login Redirect URI: CloudFront distribution domain name with callback path (https://{cf-endpoint}.cloudfront.net/_callback)
    4. Group Assignments: Optional
    5. Grant Type Allowed: Authorization Code
    6. Done
  4. Gather the following information for Lambda configuration
    1. Client Id and Client Secret from the application created in our previous step (can be found at the bottom of the general tab)
    2. Base Url
      1. This is named the 'Org URL' and can be found in the top right of the Dashboard tab.
  5. Execute ./build.sh in the downloaded directory. NPM will run to download dependencies and a RSA key will be generated.
  6. Choose OKTA as the authorization method and enter the values for Base URL (Org URL), Client ID, Client Secret, Redirect URI, and Session Duration
  7. Upload the resulting zip file found in your distribution folder using the AWS Lambda console and jump to the configuration step

Auth0

  1. Clone or download this repo
  2. Go to the Dashboard of your Auth0 admin page
    1. Click New Application
    2. Select Regular Web App and click Create.
    3. Now select an application type and follow the steps for 'Quick Start' or use your own app.
    4. Go to application Settings and enter required details. In Allowed Callback URLs enter your Cloudfront hostname with your preferred path value for the authorization callback. Example: https://my-cloudfront-site.example.com/_callback
  3. Execute ./build.sh in the downloaded directory. NPM will run to download dependencies and a RSA key will be generated.
  4. Choose AUTH0 as the authorization method and enter the values for Base URL (Auth0 Domain), Client ID, Client Secret, Redirect URI, and Session Duration
  5. Upload the resulting zip file found in your distribution folder using the AWS Lambda console and jump to the configuration step

Centrify

  1. Clone or download this repo
  2. Go to the Dashboard of your Centrify admin page
    1. Click Web Apps from the LHS.
    2. Click Add Web App and select the Custom Tab.
    3. Add an OpenID Connect webapp and click Yes to confirm.
  3. Fill in naming and logo information and then switch to the Trust tab.
  4. Enter service provider information. In Authorized Redirect URIs enter your Cloudfront hostname with your preferred path value for the authorization callback. Example: https://my-cloudfront-site.example.com/_callback
  5. Execute ./build.sh in the downloaded directory. NPM will run to download dependencies and a RSA key will be generated.
  6. Choose CENTRIFY as the authorization method and enter the values for Base URL (Centrify Resource application URL), Client ID, Client Secret, Redirect URI, and Session Duration (which is available from the Tokens tab).
  7. Upload the resulting zip file found in your distribution folder using the AWS Lambda console and jump to the configuration step

OKTA Native

  1. Clone or download this repo
  2. Sign in to OKTA with your administrator account and navigate to the Applications tab.
  3. Add Application
    1. Select the Native application type
    2. Base URI: CloudFront distribution domain name (https://{cf-endpoint}.cloudfront.net)
    3. Login Redirect URI: CloudFront distribution domain name with callback path (https://{cf-endpoint}.cloudfront.net/_callback)
    4. Group Assignments: Optional
    5. Grant Type Allowed: Authorization Code
    6. Done
  4. Gather the following information for Lambda configuration
    1. Client Id from the application created in our previous step (can be found at the bottom of the general tab)
    2. Base Url
      1. This is named the 'Org URL' and can be found in the top right of the Dashboard tab.
  5. To use the generic package, jump straight to Terraform Modules for CloudFront Authentication.
  6. Execute ./build.sh in the downloaded directory. NPM will run to download dependencies and a RSA key will be generated.
  7. Choose OKTA Native as the authorization method and enter the values for Base URL (Org URL), Client ID, PKCE Code Verifier Length, Redirect URI, and Session Duration
  8. Upload the resulting zip file found in your distribution folder using the AWS Lambda console and jump to the configuration step

Configure Lambda and CloudFront

See Manual Deployment or AWS SAM Deployment

Authorization Method Examples

Testing

Detailed instructions on testing your function can be found in the Wiki.

Build Requirements

Building Generic Packages

If you need to build a generic package yourself, execute:

./build.sh package

The supported values of package are:

  • okta_native - builds a generic Lambda package for OKTA Native authentication
  • rotate_key_pair - builds a Lambda package for rotating the RSA keys in AWS Secrets Manager

GitHub Actions automatically creates a new GitHub release when the repository owner pushes a tag that begins with v.

e.g.

git tag -a -m "Target AWS Lambda Node.js 14.x runtime" v3.0.0
git push origin v3.0.0

Contributing

All contributions are welcome. Please create an issue in order open up communication with the community.

When implementing a new flow or using an already implemented flow, be sure to follow the same style used in build.js. The config.json file should have an object for each request made. For example, openid.index.js converts config.AUTH_REQUEST and config.TOKEN_REQUEST to querystrings for simplified requests (after adding dynamic variables such as state or nonce). For implementations that are not generic (most), endpoints are hardcoded in to the config (or discovery documents).

Be considerate of our limitations. The zipped function can be no more than 1MB in size and execution cannot take longer than 5 seconds, so we must pay close attention to the size of our dependencies and complexity of operations.