Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/corbado/keycloak-passkeys
Keycloak Passkey repository of a sample Node.js app with existing users.
https://github.com/corbado/keycloak-passkeys
authentication faceid fido2 keycloak passkey passkeys passwordless touchid webauthn
Last synced: 28 days ago
JSON representation
Keycloak Passkey repository of a sample Node.js app with existing users.
- Host: GitHub
- URL: https://github.com/corbado/keycloak-passkeys
- Owner: corbado
- License: mit
- Created: 2023-07-06T14:23:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-08T13:53:25.000Z (8 months ago)
- Last Synced: 2024-05-08T14:48:13.138Z (8 months ago)
- Topics: authentication, faceid, fido2, keycloak, passkey, passkeys, passwordless, touchid, webauthn
- Language: JavaScript
- Homepage: https://www.corbado.com/passkeys/keycloak
- Size: 84 KB
- Stars: 6
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Keycloak Passkey Node.js Integration Example
This is a sample implementation of a Keycloak based app with existing users where the Corbado's passkey-first web component is integrated. Keycloak can be kept as existing auth solution, while Corbado handles the passkey authentication part. Existing password-based users from Keycloak are integrated using Corbado webhooks while new users are stored passwordless.
Read the **full tutorial** in our [blog post here](https://www.corbado.com/blog/keycloak-passkeys).
**Note:** In this tutorial, an existing app is created with some pre-existing, password-based users. Have a look at our [docs](https://docs.corbado.com/integrations/web-component/no-existing-user-base) to see the integration if you don't have any users yet.
## 1. File structure
```
├── app.js
├── .env
├── src
| ├── controllers
| | ├── authController.js # renders views and uses Corbado SDK for session management
| | └── corbadoWebhookController.js # Takes all requests belonging to the Corbado webhook logic
| |
| ├── routes
| | ├── authRoutes.js # All routes belonging to certain views
| | └── corbadoWebhookRoutes.js # All routes belonging to the Corbado webhook
| |
| ├── services
| | └── userService.js # Communicates with Keycloak
| |
| └── views/pages
| ├── login.ejs # Login page with the web component
| └── profile.ejs # Profile page showing user info
```
## 2. Setup
### 2.1. Configure environment variables
Please follow steps 1-3 on our [Getting started](https://docs.corbado.com/overview/getting-started) page to create and configure a project in the [Corbado developer panel](https://app.corbado.com).
Next, follow steps 4-6 on our [Web component guide](https://docs.corbado.com/integrations/web-component#4.-define-application-url) and set the Application URL to `http://localhost:3000/login`, the Redirect URL to `http://localhost:3000/profile` and the Relying Party ID to `localhost`.
In the [integration mode settings](https://app.corbado.com/app/settings/integration-mode), make sure you have selected `Web component` as integration mode and selected `Yes` as existing user base.
Lastly, configure the [webhooks](https://app.corbado.com/app/settings/webhooks) as seen in the image:
Use the values you obtained above to configure the following variables inside `.env`:
The CLI secret is located [here](https://app.corbado.com/app/settings/credentials/cli-secret).
1. **PROJECT_ID**=""
2. **API_SECRET**=""
3. **CLI_SECRET**=""
### 2.2. Start Docker containers
**Note:** Before continuing, please ensure you have [Docker](https://www.docker.com/products/docker-desktop/) installed and accessible from your shell.
Use the following command to start the system:
```
docker compose up
```
**Note:** Please wait until all containers are ready. This can take some time.
## 3. Usage
After step 2.2. your local server should be fully working.
If you now visit [http://localhost:3000](http://localhost:3000), you should be forwarded to the `/login` page.
When authenticated you will be forwarded to the `/profile` page.
You can find the Keycloak Dashboard at [http://localhost:8080/admin/master/console/](http://localhost:8080/admin/master/console/) with username and password both being `admin`. Feel free to navigate to the Users-page and adding some password-based users. If you go back to [http://localhost:3000](http://localhost:3000), you'll be able to login with those users as well as explore the possibilities of passkeys with optimized UI experience.