Skip to main content

Flask blueprint for open-passkey WebAuthn/FIDO2 authentication

Project description

open-passkey-flask

Flask blueprint for passkey (WebAuthn/FIDO2) authentication. Thin wrapper around open-passkey-server -- registers routes, parses requests, returns JSON responses.

Install

pip install open-passkey-flask

Quick Start

from flask import Flask
from open_passkey_flask import (
    create_passkey_blueprint,
    PasskeyConfig,
    MemoryChallengeStore,
    MemoryCredentialStore,
)

app = Flask(__name__)

passkey_bp = create_passkey_blueprint(PasskeyConfig(
    rp_id="localhost",
    rp_display_name="My App",
    origin="http://localhost:5000",
    challenge_store=MemoryChallengeStore(),
    credential_store=MemoryCredentialStore(),
))

app.register_blueprint(passkey_bp, url_prefix="/passkey")

With Sessions

from open_passkey_server.session import SessionConfig

passkey_bp = create_passkey_blueprint(PasskeyConfig(
    rp_id="example.com",
    rp_display_name="Example",
    origin="https://example.com",
    session=SessionConfig(secret="your-32+-character-hmac-secret"),
))

When session is configured, two additional routes are registered and login/register responses set an HttpOnly session cookie automatically.

Routes

Method Path Description
POST /register/begin Start registration ceremony
POST /register/finish Complete registration
POST /login/begin Start authentication ceremony
POST /login/finish Complete authentication
GET /session Validate session cookie (session config required)
POST /logout Clear session cookie (session config required)

API

create_passkey_blueprint(config: PasskeyConfig) -> Blueprint

Returns a Flask Blueprint with the routes above. Mount it at any URL prefix.

Dependencies

  • flask>=3.0
  • open-passkey-server

Related Packages

  • open-passkey -- core WebAuthn verification
  • open-passkey-server -- shared server logic
  • open-passkey-fastapi, open-passkey-django -- alternative framework bindings
  • @open-passkey/sdk (npm) -- browser SDK

License

MIT

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

open_passkey_flask-0.1.4.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

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

open_passkey_flask-0.1.4-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file open_passkey_flask-0.1.4.tar.gz.

File metadata

  • Download URL: open_passkey_flask-0.1.4.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for open_passkey_flask-0.1.4.tar.gz
Algorithm Hash digest
SHA256 d2ea3902a9c586768faf55f770df38db3e100f5c9bed3b9bc719745f6d8c2370
MD5 f3819ffc278c0771d9117b3ddba05f25
BLAKE2b-256 370a837ddcc04b49723b7c6157a4d64773a3da29083d6351e2689d87f86d3f1e

See more details on using hashes here.

File details

Details for the file open_passkey_flask-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for open_passkey_flask-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ca76875dd5123906d0fe58a27232ba8957204284545eb2727f391308fd1f7ae3
MD5 b73e25a0dc505cea4c3dabf49e658fad
BLAKE2b-256 c9dd090b079b03b323b4576405ad159b224e16bb6b94bd38533fe566279ddc56

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