Skip to content

Python Django passkey repository of a sample app that offers passkey authentication.

Notifications You must be signed in to change notification settings

corbado/example-passkeys-python-django

Repository files navigation

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 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:

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.

Please refer to the Corbado docs for more details on obtaining the necessary credentials and integrating Corbado authentication in your application.

PROJECT_ID=<your-project-id>
API_SECRET=<your-api-secret>

Step 2.3: Configure Corbado project

In the Corbado developer Panel, visit the URLs settings and enter the values shown in the image below:

Corbado developer panel URL

Step 2.4: Run the Project

Use the following command to run the project in a docker container:

docker compose up

3. Usage

After step 2.4. your local server should be fully working.

If you now visit http://localhost:3000, you should be able to sign up using the Corbado UI component.

django passkeys ui component

When authenticated you will be forwarded to the /profile page.

Django Passkey List