This repository has been archived on 2023-09-20. You can view files and clone it, but cannot push or open issues or pull requests.
py-libreauth/README.rst

62 lines
2.4 KiB
ReStructuredText
Raw Permalink Normal View History

2017-12-16 19:21:18 +01:00
Python LibreAuth
================
Python bindings to the LibreAuth library.
LibreAuth is a collection of tools for user authentication written in Rust.
2017-12-16 22:05:51 +01:00
.. image:: https://api.travis-ci.org/breard-r/py-libreauth.png
:target: https://travis-ci.org/breard-r/py-libreauth
2017-12-17 00:40:03 +01:00
:alt: Build status
2017-12-17 00:47:46 +01:00
.. image:: https://readthedocs.org/projects/py-libreauth/badge/?version=latest
:target: http://py-libreauth.readthedocs.io/en/latest/?badge=latest
2017-12-17 00:40:03 +01:00
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/status/libreauth.svg
:target: https://pypi.python.org/pypi/libreauth
:alt: Project status
2017-12-16 22:05:51 +01:00
.. image:: https://img.shields.io/pypi/v/libreauth.svg
:target: https://pypi.python.org/pypi/libreauth
2017-12-17 00:40:03 +01:00
:alt: Version
2017-12-16 22:05:51 +01:00
2017-12-17 00:40:03 +01:00
.. image:: https://img.shields.io/pypi/pyversions/libreauth.svg
:target: https://pypi.python.org/pypi/libreauth
:alt: Python versions
2017-12-16 22:05:51 +01:00
.. image:: https://img.shields.io/pypi/l/libreauth.svg
:target: http://cecill.info/index.en.html
2017-12-17 00:40:03 +01:00
:alt: CeCILL license
2017-12-16 22:05:51 +01:00
2017-12-16 19:21:18 +01:00
Features
--------
This is a work in progress. Some features may not be available.
* Password / passphrase authentication
2017-12-16 19:27:03 +01:00
2017-12-16 19:21:18 +01:00
- ✓ no character-set limitation
2017-12-16 19:34:28 +01:00
- ✓ reasonable lenth limit (`security vs. DOS <http://arstechnica.com/security/2013/09/long-passwords-are-good-but-too-much-length-can-be-bad-for-security/>`_)
2017-12-16 19:21:18 +01:00
- ✓ strong, evolutive and retro-compatible password hashing functions
- ✓ optional NIST Special Publication 800-63B compatibility
2017-12-16 19:27:03 +01:00
2017-12-16 19:33:27 +01:00
* HOTP - HMAC-based One-time Password Algorithm (`OATH <http://www.openauthentication.org/>`_ - `RFC 4226 <https://tools.ietf.org/html/rfc4226>`_)
2017-12-16 19:27:03 +01:00
2017-12-16 19:21:18 +01:00
- ✗ the key can be passed as bytes, an ASCII string, an hexadicimal string or a base32 string
- ✗ customizable counter
- ✗ customizable hash function (sha1, sha256, sha512)
- ✗ customizable output length
- ✗ customizable output alphabet
2017-12-16 19:27:03 +01:00
2017-12-16 19:33:27 +01:00
* TOTP - Time-based One-time Password Algorithm (`OATH <http://www.openauthentication.org/>`_ - `RFC 6238 <https://tools.ietf.org/html/rfc6238>`_)
2017-12-16 19:27:03 +01:00
2017-12-16 19:21:18 +01:00
- ✗ the key can be passed as bytes, an ASCII string, an hexadicimal string or a base32 string
- ✗ customizable timestamp
- ✗ customizable period
- ✗ customizable initial time (T0)
- ✗ customizable hash function (sha1, sha256, sha512)
- ✗ customizable output length
- ✗ customizable output alphabet
- ✗ customizable positive and negative period tolerance