Skip to main content

This helps you setup MFA with 3rd Party Authenticator

Project description

MFA SETUP AND VERIFICATION PACKAGE

This is a python package for MFA setup and verification using 3rd Party Authenticating Applications (like Google Authenticator, Microsoft Authenticator,Sale Force, etc)

Setup MFA: Onboard on a 3rd Party Authenticator Application:

1. Generate the MFA URL AND SECRET KEY
2. Generate the QR Code version of the MFA URL
3. Integrate with the 3rd party Authenticator :
        a. Scan the QR code generated
        b. Enter the Secret Key

MFA Verification:

-   Insert the code and verify it

Sample Code:

from mfa import MFA


1. Generate the MFA URL AND SECRET KEY
    m = MFA(service_name, user_details)
        => service_name is the name of the service (eg: company name) : STRING
        => user_detail is the user details (eg: email address, phone number, etc):  STRING
    
    Example: 
        service_name = 'Sunny Inc'
        user_details = 'sunday@test.com'
        m = MFA(service_name, user_details) 
        mfa_url,secret_key = m.generate_mfa_code()
        print(mfa_url)
        print(secret_key)

2. Generate the QR Code version of the MFA URL
    m.generate_qr_code(mfa_url)


3. Verify the Generated Code
    generated_code = '123456' # generated by the user via the 3rd party authenticator app (Google Authenticator, Microsoft Authenticator, etc)
    
    status = m.verify_code(generated_code)
    print(status)

NOTE:

1 -> Developer will be expected to save the secret Key for each user (it should be unique for each user)
        
2 -> End User should be asked to save the secret key or I will suggest you save it in a db with a
    key value pair or a field where the key is the recovery code (unique) and value is the secret key. So you share the recovery code with the user

3 -> When they can't recover the qr or lost the mobile device, you can ask them for the recovery code then use it to get the secret 
    key then use it to setup on the 3rd party authenticator app.

Project details


Download files

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

Source Distribution

mfa_authenticator-1.0.3.tar.gz (2.5 kB view details)

Uploaded Source

Built Distribution

mfa_authenticator-1.0.3-py3-none-any.whl (2.9 kB view details)

Uploaded Python 3

File details

Details for the file mfa_authenticator-1.0.3.tar.gz.

File metadata

  • Download URL: mfa_authenticator-1.0.3.tar.gz
  • Upload date:
  • Size: 2.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for mfa_authenticator-1.0.3.tar.gz
Algorithm Hash digest
SHA256 16bcaefd7f55d7fbc19bcc50327548639990f47053b3c05697a75718ca68c1f3
MD5 d8bb28649030e42a6826c896a7606f4e
BLAKE2b-256 5114f02e61e330142b3c8b40c674002a7da68cd3dfae7ea1a71a79acac034e08

See more details on using hashes here.

File details

Details for the file mfa_authenticator-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mfa_authenticator-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fc4ae191ba0ba14e46f3e92cd788803881d5a962502ff7d3e9caa0c196cd0b13
MD5 aed53ee212883cb88906cb2ca38b7905
BLAKE2b-256 bb347ba2d73914113f6e2984a1d4946bbb5ff0227c4300636c9f37c044b9b6d4

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