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/)

Download files

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

Files for Flask-FIDO-U2F, version 0.4.4
Filename, size File type Python version Upload date Hashes
Filename, size Flask-FIDO-U2F-0.4.4.tar.gz (8.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page