Skip to main content

This helps you setup MFA with 3rd Party Authenticator (Google Authenticator, Microsoft Authenticator, etc)

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)   
   
    ##### NOTE: This is optional because the mfa_url should be converted to a qr code on the 
                client side ( Fromtend application : Web or Mobile App)
  


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 
    from the db and 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.4.11.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

mfa_authenticator-1.0.4.11-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mfa_authenticator-1.0.4.11.tar.gz
  • Upload date:
  • Size: 2.7 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.4.11.tar.gz
Algorithm Hash digest
SHA256 5beecdc33227905df48a3e1950d0bfaa1cf26bcda0ddb7b40467d3411cc7fcd5
MD5 e57736edee6accf3c1102ec0317fafcb
BLAKE2b-256 4b8645ae2f4d1018a733a14130a7ff7f4abc9be056bd987e914083c6321d5cf4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mfa_authenticator-1.0.4.11-py3-none-any.whl
Algorithm Hash digest
SHA256 02d9821d28c95610179bfe73aac3fb23751fe71604114248828ba3f3a09c61e0
MD5 6a9fa3655bb23121cda77189b65a6f4f
BLAKE2b-256 63c2433d6170a2cfad073ef0010ea3daef2ac10f55a9412e0b17b4e9c907faf9

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