Skip to main content

Pythonic WebAuthn

Project description

py_webauthn

PyPI GitHub license Pythonic WebAuthn

A Python3 implementation of the server-side of the WebAuthn API focused on making it easy to leverage the power of WebAuthn.

This library supports all FIDO2-compliant authenticators, including security keys, Touch ID, Face ID, Windows Hello, Android biometrics...and pretty much everything else.

Installation

This module is available on PyPI:

pip install webauthn

Requirements

  • Python 3.8 and up

Usage

The library exposes just a few core methods on the root webauthn module:

  • generate_registration_options()
  • verify_registration_response()
  • generate_authentication_options()
  • verify_authentication_response()

Two additional helper methods are also exposed:

  • options_to_json()
  • base64url_to_bytes()

Additional data structures are available on webauthn.helpers.structs. These dataclasses are useful for constructing inputs to the methods above, and for providing type hinting to help ensure consistency in the shape of data being passed around.

Generally, the library makes the following assumptions about how a Relying Party implementing this library will interface with a webpage that will handle calling the WebAuthn API:

The examples mentioned below include uses of the options_to_json() helper (see above) to show how easily bytes values in registration and authentication options can be encoded to base64url for transmission to the front end.

The examples also include demonstrations of how to pass JSON-ified responses, using base64url encoding for ArrayBuffer values, into parse_registration_credential_json and parse_authentication_credential_json to be automatically parsed by the methods in this library. An RP can pair this with corresponding custom front end logic, or one of several frontend-specific libraries (like @simplewebauthn/browser, for example) to handle encoding and decoding such values to and from JSON.

Other arguments into this library's methods that are defined as bytes are intended to be values stored entirely on the server. Such values can more easily exist as bytes without needing potentially extraneous encoding and decoding into other formats. Any encoding or decoding of such values in the name of storing them between steps in a WebAuthn ceremony is left up to the RP to achieve in an implementation-specific manner.

Registration

See examples/registration.py for practical examples of using generate_registration_options() and verify_registration_response().

You can also run these examples with the following:

# See "Development" below for venv setup instructions
venv $> python -m examples.registration

Authentication

See examples/authentication.py for practical examples of using generate_authentication_options() and verify_authentication_response().

You can also run these examples with the following:

# See "Development" below for venv setup instructions
venv $> python -m examples.authentication

Development

Installation

Set up a virtual environment, and then install the project's requirements:

$> python3 -m venv venv
$> source venv/bin/activate
venv $> pip install -r requirements.txt

Testing

Python's unittest module can be used to execute everything in the tests/ directory:

venv $> python -m unittest

Auto-watching unittests can be achieved with a tool like nodemon.

All tests:

venv $> nodemon --exec "python -m unittest" --ext py

An individual test file:

venv $> nodemon --exec "python -m unittest tests/test_aaguid_to_string.py" --ext py

Linting and Formatting

Linting is handled via mypy:

venv $> python -m mypy webauthn
Success: no issues found in 52 source files

The entire library is formatted using black:

venv $> python -m black webauthn --line-length=99
All done!  🍰 52 files left unchanged.

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

webauthn-2.2.0.tar.gz (114.0 kB view details)

Uploaded Source

Built Distribution

webauthn-2.2.0-py3-none-any.whl (67.7 kB view details)

Uploaded Python 3

File details

Details for the file webauthn-2.2.0.tar.gz.

File metadata

  • Download URL: webauthn-2.2.0.tar.gz
  • Upload date:
  • Size: 114.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for webauthn-2.2.0.tar.gz
Algorithm Hash digest
SHA256 70e4f318d293125e3a8609838be0561119f4f8846bc430d524f8da4052ee18cc
MD5 bc929fbe7828a91942304364b1683af9
BLAKE2b-256 8b51c3262e0a361b4f21b5f562f5705e74352e1c64dd9dc69d0cb3a232a50b5a

See more details on using hashes here.

File details

Details for the file webauthn-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: webauthn-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 67.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for webauthn-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e8e2daace85dde8f6fb436c1bca9aa72d5931dac8829ecc1562cc4e7cc169f6c
MD5 c61a3c78e535df487c530720ae769d03
BLAKE2b-256 53972d37cdf3f88a81a84340862b94eb9e9f76b07bd1a460fa1ce28485ba6fe5

See more details on using hashes here.

Supported by

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