https://github.com/corbado/example-passkeys-python-django
Python Django passkey repository of a sample app that offers passkey authentication.
https://github.com/corbado/example-passkeys-python-django
django faceid fido2 passkey passkeys python touchid webauthn
Last synced: 3 months ago
JSON representation
Python Django passkey repository of a sample app that offers passkey authentication.
- Host: GitHub
- URL: https://github.com/corbado/example-passkeys-python-django
- Owner: corbado
- Created: 2023-11-21T16:39:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-26T10:27:11.000Z (8 months ago)
- Last Synced: 2025-04-10T22:17:25.163Z (3 months ago)
- Topics: django, faceid, fido2, passkey, passkeys, python, touchid, webauthn
- Language: Python
- Homepage: https://www.corbado.com/passkeys/django
- Size: 51.8 KB
- Stars: 9
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Django Passkey Example App
## Project Overview
This project implements a web application with a login system using Corbado' passkey-first authentication service
integrated with a Django backend. The application consists of two main pages: a login page and a home page. Once users
log in successfully via the Corbado service on the login page, they are redirected to the home page where they can log
out and view protected content.
Please see the [full blog post](https://www.corbado.com/blog/django-passkeys) to understand all the required steps to integrate passkeys into Django apps.
## Tools and Technologies Used
- **Django**: A full-featured Python web framework, used to build the backend of the application.
- **Corbado**: An authentication service used to handle passkey-first user authentication.
- **HTML & CSS**: Used to structure and style the frontend of the application.
## Features
- **Passkey-first Authentication**: Utilizes Corbado's authentication service for secure user login.
- **Session management**: Uses Corbado's session management to display content based on the user's authentication status.
## How to Use
### 1. File structure
```
├── .env # Contains all environment variables
├── passkeys_demo
| ├── settings.py # Global settings
| ├── urls.py # Route config
| ├── views.py # Controller for our pages
| ├── templates
| | ├── index.html # Login page
| | └── profile.html # Profile page
```
### 2. Setup
#### Step 2.1: Clone the Repository
Clone this repository to your local machine by running:
```sh
git clone https://github.com/corbado/example-passkeys-django
```
#### Step 2.2: Create .env File
To configure the credentials, you will need to create a `.env` file with your `Project ID` and `API secret` from Corbado:
To get your `Project ID` and `API secret` visit your [Corbado developer panel](https://app.corbado.com/?technology=passkeys&framework=Django#signup-init).
Please refer to the [Corbado docs](https://docs.corbado.com/overview/welcome) for more details on obtaining the
necessary credentials and integrating Corbado authentication in your application.
```sh
PROJECT_ID=
API_SECRET=
```
#### Step 2.3: Configure Corbado project
In the Corbado developer Panel, visit the [URLs settings](https://app.corbado.com/app/settings/general/urls) and enter the values shown in the image below:
#### Step 2.4: Run the Project
Use the following command to run the project in a docker container:
```sh
docker compose up
```
### 3. Usage
After step 2.4. your local server should be fully working.
If you now visit [http://localhost:3000](http://localhost:3000), you should be able to sign up using the Corbado UI component.
When authenticated you will be forwarded to the `/profile` page.
