Affinidi Login Integration using Django, Authlib and Auth0

Auth0 Python Django authlib

A code sample using Django framework and uses AuthLib library to enable passwordless login using Auth0 IDP.

Before you begin

1. Set up Affinidi Vault account. Follow the guide below if you haven’t set it up yet.

Set up Affinidi Vault

1. Set up an Affinidi Vault account using the web app or install the mobile app .

The same installation steps for mobile app.

2. Click on Start if you are creating a new account, or click on Restore from Backup if you have an existing backup of your Affinidi Vault.

Use this guide to learn how to migrate your existing Affinidi Vault account.

3. Secure your Vault by providing a passphrase. Use this passphrase to unlock your Vault.

3. Provide your Email Address to verify with OTP.

After successfully providing the OTP, you are redirected to your Affinidi Vault dashboard.

Vault Passphrase

Remember to keep your passphrase in a secure location since it cannot be retrieved if forgotten, even with your backup. If you forget it, you must setup a new Vault.

2. Install the Affinidi CLI. Follow the guide below if it hasn’t been installed.

Set up Affinidi CLI

1. Download and install NodeJS on your machine if you haven’t set it up yet.

Node Version

Affinidi CLI requires Node version 18 and above.

2. Install Affinidi CLI using Node Package Manager (npm).

npm install -g @affinidi/cli

3. Verify that the installation is successful.

affinidi --version

3. Make sure you have Git installed on your machine. Follow this guide on how to install Git.

4. Create an Auth0 tenant or sign-in to your existing tenant account where you want to integrate Affinidi Login

5. Create a Regular Web Application in Auth0 and set up the necessary fields based on your application’s structure.

   In this guide, set the following fields in the Auth0 Regular Web Application:

   • Allowed Callback URLs: http://localhost:8000/callback
   • Allowed Logout URLs: http://localhost:3000
   • Allowed Web Origins: http://localhost:3000

Download the Application

You can download as ZIP file the code sample from the GitHub Repo or generate it using Affinidi CLI with the following command:

affinidi generate app --provider=auth0 --framework=django --library=authlib --path=affinidi-login-refcodes

Select n when prompted to Automatically configure sample app environment, we will configure it later.

The above command will generate the code sample in the affinidi-login-refcodes directory.

Install Dependencies

After successfully generating the code sample, go to the affinidi-login-refcodes directory and install the required dependencies using the following commands:

pip install -r requirements.txt

Create Login Configuration

Name: Affinidi Login Sample

Redirect URIs: https://<Auth0_App.Domain>/login/callback

Get the Auth0 Domain from the Regular Web Application created previously.

affinidi start

affinidi login create-config --name='Affinidi Login Sample' --redirect-uris='https://<Auth0_App.Domain>.us.auth0.com/login/callback'

Using Affinidi Portal

1. Go to  Affinidi Login under the Services section.

2. Click on the Create Login Configuration and provide the required details.

• Name is the string that describes your login configuration.
• Redirect URIs is the URL on your application where the user gets redirected after the successful authentication.

3. Click on create and confirm if all the details are correct.

4. After confirming the details, another popup shows the Client ID and Client Secret for your Login Configuration. Copy the generated Client Credentials and use them to integrate with Affinidi Login.

5. After copying the Client ID and Client Secret and closing the popup, you are redirected back to the Affinidi Login page.

Login Configuration uses the default Presentation Definition (presentationDefinition) and ID Token Mapping (idTokenMapping) that is used to request the user’s email address during the authentication flow.

Learn more about customising the Presentation Definition and ID Token using this guide.

Set up the Auth0 Social Connection

We create a Social Connection in Auth0, integrating Affinidi Login as the identity provider for authenticating users. Additionally, we configure Auth0 to parse the idToken provided by Affinidi Login once users verify their identity through Affinidi Vault.

In Auth0 Dashboard, go to Authentication > Social and click on Create Connection

Select Create Custom and set the following fields in the Auth0 with the values below:

• Authorization URL: <LoginConfig.auth.Issuer>/oauth2/auth
• Token URL: <LoginConfig.auth.Issuer>/oauth2/token
• Scope: openid offline_access
• Client ID: <LoginConfig.auth.ClientID>
• Client Secret: <LoginConfig.auth.ClientSecret>

The <LoginConfig.auth.*> are values from Login Configuration.

Copy the code below and paste it in the Fetch User Profile Script of the Social Connection

This script is called after the user consented to share their email address from their Affinidi Vault account. Auth0 executes this script and extracts the user_id, email, and the custom fields where additional data are populated like user address from the idToken provided by Affinidi Login after successful login:

function fetchUserProfile(accessToken, context, callback) {
  const idToken = JSON.parse(
    Buffer.from(context.id_token.split(".")[1], "base64").toString()
  );

  const profile = {
    user_id: idToken.sub,
    email: idToken.custom.find((c) => c.email).email,
    profile: idToken.custom,
  };

  callback(null, profile, context);
}

Update the fetch profile script based on the structure of the ID Token mapped in the Login Configuration.

Once you are done setting up, enable the application to use the custom Social Connection in the Applications view. This will enhance the Auth0 to use the Affinidi Vault as the identity provider to enable a decentralised identity.

Set up the Application

Once the Web Application and Social Connection configuration is completed, set up the Auth0 client credentials provided to enable Auth0 login enhanced by Affinidi Login.

Copy and set up the environment variables:

cp .env.example .env

Set the following variables with the values provided in the Auth0 Regular Web Application created previously:

PROVIDER_CLIENT_ID="<Auth0_App.ClientID>"
PROVIDER_CLIENT_SECRET="<Auth0_App.ClientSecret>"
PROVIDER_ISSUER="<Auth0_App.Domain>"

The <Auth0_App.*> are values from Auth0 Application.

Then run the migrate command:

python manage.py migrate

Run the Application

After installing the dependencies and setting up the required details in the application, run the following command to start the app locally:

python manage.py runserver

Once it is successfully started, visit the app using the link http://localhost:8000.

Integration-related Changes

To enable a seamless passwordless login experience with Affinidi Login, refer to the following key changes were implemented:

1. Imported Authlib to enable OAuth flow.
2. Implemented the following function in the ./django_reference_app/views.py:
   • Registered affinidi as OAuth provider with the client credentials.
   • login function to initiate the Affinidi Login flow using Authlib.
   • callback function to receive the response from Affinidi Login (e.g. idToken, accessToken).
3. Parsed the environment variables in the ./django_reference_app/settings.py.

Explore the sample implementation to learn more about how the integration works.