nogoodusername / simple-otp

Simple OTP Generation and Verification Library that does not use any Database or Cache

simple-otp

A simple OTP Generation and Verification Library which works without a Database or Cache.

Features

• Does not require database or cache
• Easy to implement
• Has OTP expiry function

How to use this?

Usage explained in diagram below

Installation

pip install -U simple-otp

Usage Example

import os
from time import sleep
from simpleotp import OTP

SECRET_KEY = os.getenv('SECRET')

otp_handler = OTP(SECRET_KEY,
                  length=6,
                  expires_after=2,
                  user_identifier='[email protected]')

# generate OTP - returns OTP and hash
otp, sig = otp_handler.generate()
print(otp, sig)

# verify OTP - correct OTP and hash passed to verify method
is_verified = otp_handler.verify(otp, sig)
print(is_verified) # returns True

# verify OTP - incorrect hardcoded OTP passed to verify method 
is_verified = otp_handler.verify('123', sig)
print(is_verified) # returns False

# Sleep added to simulate Expiry of OTP
sleep(2 * 61)
# Correct OTP and hash passed to verify method
# But after expiry time has passed
is_verified = otp_handler.verify(otp, sig)
print(is_verified) # returns False

The library also includes helper method to generate a random secret key

from simpleotp import generate_secret

SECRET_KEY = generate_secret()
print(SECRET_KEY) # 'Q0CZYBRDECESA72M'

Build Requirements

• Make
• Python
• Twine

Initialise Build Environment

One time initialisation

make init

Make a release build

1. Ensure that working directory is clean and all files are commited.
2. Bump the version. Please read Semantic Version 2.0.0 before bumping versions.

   make release PART=[major/minor/patch]
   

3. Update the CHANGELOG.md.
4. Push release tags.

   git push origin --tags
   

5. Make a release build.

   make dist
   

Publish your changes

make deploy

Changelog

Please find the changelog here: CHANGELOG.md

Authors

simple-otp was written by Kshitij Nagvekar.