Skip to main content

Demonstration OpenID Connect Client

Project description

Auth Playground

Tests Docker Docker Image

A demonstration OAuth2 / OpenID Connect (OIDC) client application built with Authlib. This project illustrates how to integrate with an identity provider for user authentication, registration, and consent management. It can be used to play with the different interactions between clients and server, or debug a server implementation.

Installation

Using pip

pip install auth-playground

Using uv

uv add auth-playground

Using Docker

Run the pre-built image from GitHub Container Registry:

docker run -p 4000:4000 -e SECRET_KEY="your-secret-key" ghcr.io/authlib/auth-playground:latest

Or build locally:

docker build -t auth-playground .
docker run -p 4000:4000 -e SECRET_KEY="your-secret-key" auth-playground

Configuration

The application is configured using environment variables. Copy the example configuration file:

cp example.env .env

Edit .env and set the required values:

# Required
export SECRET_KEY="your-secret-key"

# Optional
export OAUTH_CLIENT_ID="your-client-id"
export OAUTH_CLIENT_SECRET="your-client-secret"
export OAUTH_AUTH_SERVER="https://your-identity-provider.example.com"

Registering with your Identity Provider

When registering this application with your identity provider, configure the following redirect URIs:

http://localhost:4000/login_callback
http://localhost:4000/logout_callback

Usage

auth-playground

The application will be available at http://localhost:4000

Development

Running Tests

uv run pytest

Code Style

uv run prek run --all-files

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

auth_playground-0.0.1.tar.gz (143.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

auth_playground-0.0.1-py3-none-any.whl (61.3 kB view details)

Uploaded Python 3

File details

Details for the file auth_playground-0.0.1.tar.gz.

File metadata

  • Download URL: auth_playground-0.0.1.tar.gz
  • Upload date:
  • Size: 143.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for auth_playground-0.0.1.tar.gz
Algorithm Hash digest
SHA256 cf59414debbf5159fa6f820579818f0f687076d0cbf4b094634e621c524f508e
MD5 607fa680e11da519a2c395cec9abd795
BLAKE2b-256 6186547e5d6ce0e4940d38a3984aea910ce6c2f662c3a21838176cb4af118c88

See more details on using hashes here.

File details

Details for the file auth_playground-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for auth_playground-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c61d5ead92a026a783b2176f439524bcac76b6087c8a09a5587d3eb7da6ae07e
MD5 dd1b3fcedf88dbab178c9ab4c8ca65ba
BLAKE2b-256 db346a8dcb8be58854d7d946bda63f5ad0fd2e9d50e95d152ea8d22299da984c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page