Skip to main content

A Flask plugin that adds FIDO U2F support.

Project description

flask-fido-u2f
---

Flask plugin to simplify usage and management of U2F devices.

## Installation

`pip install flask-fido-u2f`

## Usage

```python
from flask_fido_u2f import U2F

app = Flask(__name__)
app.config['U2F_APPID'] = 'https://example.com'
app.config['SECRET_KEY'] = 'SomeVeryRandomKeySetYouMust'

u2f = U2F(app)

@u2f.read
def read():
# Returns users U2F devices object
pass

@u2f.save
def save(u2fdata):
# Saves users U2F devices object
pass

@u2f.enroll_on_success
def enroll_on_success():
# Executes on successful U2F enroll
pass

@u2f.enroll_on_fail
def enroll_on_fail(e):
# Executes on U2F enroll fail
# Takes argument e - exception raised
pass

@u2f.sign_on_success
def sign_on_success():
# Executes on successful U2F authentication
pass

@u2f.sign_on_fail
def sign_on_fail(e):
# Executes on U2F sign fail
# Takes argument e - exception raised
pass
```

# Development

## Install dev-dependencies

`pip install -r dev-requirements.txt`

## Run tests

`python -m unittest discover`

## Docs

* [API Docs](https://github.com/herrjemand/flask-fido-u2f/blob/master/docs/api.md)
* [Configuration Docs](https://github.com/herrjemand/flask-fido-u2f/blob/master/docs/configuration.md)
* [FIDO U2F](https://fidoalliance.org/specifications/download/)

## License

[MIT](https://github.com/herrjemand/flask-fido-u2f/blob/master/LICENSE.md) © [Yuriy Ackermann](https://jeman.de/)

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

Flask-FIDO-U2F-0.4.4.tar.gz (8.2 kB view details)

Uploaded Source

File details

Details for the file Flask-FIDO-U2F-0.4.4.tar.gz.

File metadata

File hashes

Hashes for Flask-FIDO-U2F-0.4.4.tar.gz
Algorithm Hash digest
SHA256 907d08fe41b78aa703f7f82ff01412a797f37360039c7fffd271b298b2917050
MD5 de56c93db518a19cc7d85e003a493038
BLAKE2b-256 af4705839c46c811cfb3df78dafdbe99e21aa7ab7af1c43b5038c939c2833dec

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