README.md

loauth - Authentication Protocol Library

Initial documentation to help people get started. Setting up a virtualenv is highly recommended for the development of this library.

Package Structure

.
├── LICENSE
├── README.md
├── loauth
│   ├── __init__.py
│   ├── cijfer.py
│   ├── client.py
│   ├── devbutler.py
│   ├── exceptions.py
│   ├── jwt.py
│   └── protopack
│       ├── __init__.py
│       ├── chap.py
│       └── protocol.py
├── setup.py
└── test
    └── init_test.py

Extending the protopack

Currently loauth only has support for a rudimentary challenge-response protocol based on SHA256 HMACs. Other modules for other protocols should be developed similar to this module. Each protocol should have a single client and butler function.

Guidelines Modules can be tested on the provided devbutler module.

Development

Install package using pip in development mode using

(venv)$ pip install -e .

Setting Up The devbutler Development Server

The setup and use of the development server is shown below with the CHAP protocol usecase -

>>> from loauth.devbutler import deploy_butler
>>> from loauth.protopack.chap import CHAP_Butler
>>> deploy_butler(CHAP_Butler, 4000)

This well setup the server to listen on localhost:4000. The CHAP_Client test can be initialised as shown

$ python chap.py

Refer to the implementation for further details

Follow the PEP-8 Guidelines as closely as possible

---