Skip to main content

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

Project description

simple-otp

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

PyPI version

Features

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

How to use this?

Usage explained in diagram below

how-to-use

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='kshitij.nagvekar@workindia.in')

# 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.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

simple_otp-0.1.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file simple_otp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: simple_otp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.10

File hashes

Hashes for simple_otp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 af428a0e52c6fa5f3143284edfbb7db5270c505025ce899f5a321a16b93e3b07
MD5 0f6d0ddaa1813bc5ef9875a5e071e24b
BLAKE2b-256 c2c12f9de7eccd6f818850c2ccd897de6ae03e6596e283b1d79add1146c9b87b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page