-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cleaned up logging across the solution. Removed references to SVPIN, …
…and transitioned to u2f password. Consolidated more UI/Alert strings into internationalization
- Loading branch information
1 parent
2a813b1
commit 70593fd
Showing
24 changed files
with
1,200 additions
and
447 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,63 +1,66 @@ | ||
| == Version 2.0.0 RC == | ||
|
|
||
| - Updated look and feel of UI | ||
| - Attestation data now displayed to the user (if they are using a YubiKey) | ||
| - Added prompts to guide users when registering a Platform Authenticator | ||
| - Changed SV-PIN to U2F Password | ||
| - Code changes to include better error handling, linting, and migrated to TypeScript | ||
|
|
||
| == Version 1.0.0 == | ||
|
|
||
| GA release | ||
|
|
||
| * Added Docker deployment | ||
| * Apache License 2.0 | ||
| - Added Docker deployment | ||
| - Apache License 2.0 | ||
|
|
||
| == Version 0.0.6 == | ||
|
|
||
| Beta release | ||
|
|
||
| * Speed up recovery code generation and validation | ||
| * Internal variable naming standardization and cleanup | ||
| * Configure URL redirects for SPA | ||
|
|
||
| - Speed up recovery code generation and validation | ||
| - Internal variable naming standardization and cleanup | ||
| - Configure URL redirects for SPA | ||
|
|
||
| == Version 0.0.5 == | ||
|
|
||
| Beta release | ||
|
|
||
| * Initial iOS app commit | ||
| * Code cleanup (remove magic numbers, internal variable naming, etc.) | ||
| * Update dependencies | ||
| * Add more sanity checks to scripts | ||
|
|
||
| - Initial iOS app commit | ||
| - Code cleanup (remove magic numbers, internal variable naming, etc.) | ||
| - Update dependencies | ||
| - Add more sanity checks to scripts | ||
|
|
||
| == Version 0.0.4 == | ||
|
|
||
| Beta release | ||
|
|
||
| * Fixed cascading delete bug | ||
| * Updated packages/dependencies and removed unused packages/dependencies | ||
| * Added recovery code and SV-PIN validation, max attempts, and hashing | ||
| * Deployment script bugfixes | ||
|
|
||
| - Fixed cascading delete bug | ||
| - Updated packages/dependencies and removed unused packages/dependencies | ||
| - Added recovery code and SV-PIN validation, max attempts, and hashing | ||
| - Deployment script bugfixes | ||
|
|
||
| == Version 0.0.3 == | ||
|
|
||
| Beta release | ||
|
|
||
| * Added release notes & license | ||
|
|
||
| - Added release notes & license | ||
|
|
||
| == Version 0.0.2 == | ||
|
|
||
| Beta release | ||
|
|
||
| * Client-Side Discoverable Credential, a.k.a. Usernameless, WebAuthn credential registration and authentication | ||
| * Improved error handling | ||
| * Delete user account feature | ||
| * Scripted deployment of backend and frontend | ||
|
|
||
| - Client-Side Discoverable Credential, a.k.a. Usernameless, WebAuthn credential registration and authentication | ||
| - Improved error handling | ||
| - Delete user account feature | ||
| - Scripted deployment of backend and frontend | ||
|
|
||
| == Version 0.0.1 == | ||
|
|
||
| Alpha release | ||
|
|
||
| * AWS Cognito Custom Auth identifier-first WebAuthn registration and login flow | ||
| * WebAuthn lifecycle management (add/edit/remove WebAuthn credentials) | ||
| * Server-Verified PIN feature for authenticators without user verification capability | ||
| * Account recovery backup codes | ||
| * AWS SAM backend deployment based on CloudFormation template | ||
| * AWS Amplify hosted react web app | ||
| - AWS Cognito Custom Auth identifier-first WebAuthn registration and login flow | ||
| - WebAuthn lifecycle management (add/edit/remove WebAuthn credentials) | ||
| - Server-Verified PIN feature for authenticators without user verification capability | ||
| - Account recovery backup codes | ||
| - AWS SAM backend deployment based on CloudFormation template | ||
| - AWS Amplify hosted react web app |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,67 +1,69 @@ | ||
| # Yubico WebAuthn Starter Kit | ||
|
|
||
| The WebAuthn Starter Kit is an Authentication and Authorization turnkey solution applying the best practices for strong authentication while providing ways to automate deployment of a serverless cloud-first solution that is repeatable, modularized, and scalable. | ||
| The WebAuthn Starter Kit is an Authentication and Authorization turnkey solution applying the best practices for strong authentication while providing ways to automate deployment of a serverless cloud-first solution that is repeatable, modularized, and scalable. | ||
|
|
||
|  | ||
|
|
||
| ## How it works 🔧 ## | ||
| ## How it works 🔧 | ||
|
|
||
| The starter kit solution utilizes Amazon Cognito User Pools as an identity provider with a custom User Pool Workflow consisting of four AWS Lambda functions, a WebAuthn Lambda function, and an Amazon API Gateway endpoint, providing registration, authentication, and authorization for an identifier-first type flow. | ||
| The starter kit solution utilizes Amazon Cognito User Pools as an identity provider with a custom User Pool Workflow consisting of four AWS Lambda functions, a WebAuthn Lambda function, and an Amazon API Gateway endpoint, providing registration, authentication, and authorization for an Adaptive Multi-Factor Authentication with WebAuthn type flow. | ||
|
|
||
| ## Deliverable 📬 ## | ||
| ## Deliverable 📬 | ||
|
|
||
| The solution will be provided as an Amazon SAM template that includes the creation of a Amazon Cognito User Pool, coded AWS Lambda functions, an Amazon Aurora database, an Amazon API Gateway endpoint, and necessary permissions to create, execute, and delete these resources in your own AWS account. | ||
|
|
||
| ## Documentation ## | ||
| ## Documentation | ||
|
|
||
| Check out our [Yubico WebuAthn Starter Kit Documentation](https://developers.yubico.com/Developer_Program/WebAuthn_Starter_Kit/) for more detailed design, architecture overview, installation guide(s), and documented WebAuthn authentication flows. | ||
| Check out our [Yubico WebuAthn Starter Kit Documentation](https://developers.yubico.com/Developer_Program/WebAuthn_Starter_Kit/) for more detailed design, architecture overview, installation guide(s), and documented WebAuthn authentication flows. | ||
|
|
||
| ## Backend Resources ## | ||
| ## Backend Resources | ||
|
|
||
| These resources will be created, configured, and deployed in your own AWS environment using the provided [SAM template](https://github.com/YubicoLabs/WebAuthnKit/blob/master/backend/template.yaml). These services provide registration, authentication, WebAuthn Relying Party, and OPEN ID Connect provider solutions. | ||
|
|
||
| ✅ One Amazon Cognito User Pool. | ||
| ✅ One Amazon Cognito User Pool. | ||
|
|
||
| <details><summary>Cognito User Pools as an Identity Provider</summary><p> | ||
|
|
||
| ## About Cognito User Pools ## | ||
| ## About Cognito User Pools | ||
|
|
||
| Amazon Cognito User Pools is a full-featured user directory managed AWS service that handles user registration, authentication, and account recovery. Amazon Cognito user pools implements ID, Access, and Refresh Tokens as defined by the OpenID Connect (OIDC) open standard. | ||
|
|
||
| Note :book: : User Pools provided tokens can be used to obtain temporary AWS credentials—with permissions you define—to access other AWS services directly or resources through Amazon API Gateway using Amazon Cognito Federated Identities (Identity Pool). | ||
| Note :book: : User Pools provided tokens can be used to obtain temporary AWS credentials—with permissions you define—to access other AWS services directly or resources through Amazon API Gateway using Amazon Cognito Federated Identities (Identity Pool). | ||
|
|
||
| The WebAuthn Starter Kit relies on Cognito User Pools to store user information and handle the custom registration and authentication flow. The kit can be used to leverage Cognito Federated Identities (identity pool) for fine-grain user access to other AWS resources. | ||
|
|
||
| </p> | ||
| </details> | ||
| </p> | ||
|
|
||
| ✅ Four AWS Lambda Functions used as custom triggers with Cognito User Pool. | ||
| ✅ Four AWS Lambda Functions used as custom triggers with Cognito User Pool. | ||
|
|
||
| ✅ One AWS Lambda Function [(Yubico Java WebAuthn Server Library)](https://github.com/Yubico/java-webauthn-server) as the WebAuthn Relying Party. | ||
| ✅ One AWS Lambda Function [(Yubico Java WebAuthn Server Library)](https://github.com/Yubico/java-webauthn-server) as the WebAuthn Relying Party. | ||
|
|
||
| ✅ One Amazon RDS Database - Aurora Serverless (MySQL-compatible database used to store user credential attributes). | ||
| ✅ One Amazon RDS Database - Aurora Serverless (MySQL-compatible database used to store user credential attributes). | ||
|
|
||
| ✅ One Amazon API Gateway as our RESTful API endpoint. | ||
| ✅ One Amazon API Gateway as our RESTful API endpoint. | ||
|
|
||
| ## Backend | ||
|
|
||
| Deploy the backend as outlined in [backend](./backend/README.md). | ||
|
|
||
| ## Clients ## | ||
| ## Clients | ||
|
|
||
| Once you build and deploy the backend, you can use one of the clients below to connect into the backend. | ||
|
|
||
| [Web Client (React)](https://github.com/YubicoLabs/WebAuthnKit/tree/master/clients/web/react) | ||
|
|
||
| [iOS Client (Swift)](https://github.com/YubicoLabs/WebAuthnKit/tree/master/clients/iOS) | ||
|
|
||
| ## Cost Considerations ## | ||
| ## Cost Considerations | ||
|
|
||
| We have done our best to reduce the cost of running the Yubico WebAuthn Starter Kit on AWS, however, you are responsible the AWS service fees while running the WebAuthn Starter Kit reference deployment. | ||
|
|
||
| The WebAuthn Starter Kit utilizes an AWS SAM template for quick deployment. This template includes configuration parameters that you can customize to fit your needs and budget. Some of these settings, such as RDS Aurora database, affect the cost of deployment. For cost estimates, see the pricing pages for each AWS service used. | ||
|
|
||
| Cost Analysis: After you deploy the WebAuthn Starter Kit to your AWS environment, you can create a [AWS Cost and Usage Report](https://docs.aws.amazon.com/cur/latest/userguide/what-is-cur.html) to track costs associated with this deployment. This report will deliver billing metrics (cost estimates based on usage) to an Amazon S3 bucket in your own account. | ||
|
|
||
| ## License Summary ## | ||
| ## License Summary | ||
|
|
||
| This project is licensed under [Apache License 2.0](https://github.com/YubicoLabs/WebAuthnKit/blob/main/COPYING). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.