diff --git a/README.md b/README.md index b4f59d2..f1d62ae 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,55 @@ # WebAuthn Service -A fully-functional reference implementation of **@simplewebauthn/server** and **@simplewebauthn/browser**. +This is a fully-functional reference implementation of **@simplewebauthn/server** and **@simplewebauthn/browser**, using **Express** to handle the WebAuthn flows for registration and authentication (login). + +## Features + +- **User Registration** via WebAuthn +- **User Authentication** via WebAuthn +- HTTPS Support for secure origins +- CSRF protection via **lusca** +- Rate Limiting to prevent abuse +- Handles both **resident key** and **non-resident key** options +- Uses **CORS** for cross-origin requests + +## Requirements + +- Node.js (>=12.x) +- SSL certificates for HTTPS (if enabled) +- Environment configuration via `.env` file + +## Installation + +1. Clone the repository: + + ```bash + git clone https://github.com/your-repo/webauthn-service.git + cd webauthn-service + ``` + +2. Install dependencies: + + ```bash + pnpm install + ``` + +3. Create a `.env` file with the following environment variables: + + ```env + RP_ID=["example.com"] # Relying Party ID, can be an array + EXPECTED_ORIGINS=["https://example.com"] # Expected origins for authentication + RP_NAME=My WebAuthn Service # Name of your service + TIMEOUT=60000 # Timeout for registration/authentication flows + ENABLE_CONFORMANCE=true # Enable conformance routes for FIDO Metadata Service + ENABLE_HTTPS=true # Enable HTTPS mode for the service + ``` + +## Usage + +### Start the Server + +To run the server, use the following command: + +```bash +pnpm start +```