https://github.com/clach04/pyfreeotpplus

Python script to dump 2fa pin from Android FreeOTPPlus (FreeOTP+) export file freeotp-backup.json
https://github.com/clach04/pyfreeotpplus

2fa otp pin python rfc-6238 totp totp-codes totp-generator totp-tfa

Last synced: 3 months ago
JSON representation

Python script to dump 2fa pin from Android FreeOTPPlus (FreeOTP+) export file freeotp-backup.json

• Host: GitHub
• URL: https://github.com/clach04/pyfreeotpplus
• Owner: clach04
• License: mit
• Created: 2019-05-18T03:33:16.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-15T04:19:04.000Z (5 months ago)
• Last Synced: 2024-08-15T05:29:20.905Z (5 months ago)
• Topics: 2fa, otp, pin, python, rfc-6238, totp, totp-codes, totp-generator, totp-tfa
• Language: Python
• Homepage:
• Size: 13.7 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pyFreeOTPPlus

Python script to dump TOTP RFC 6238 2fa/otp pin from [Android FreeOTPPlus (FreeOTP+)](https://github.com/helloworld1/FreeOTPPlus) export file freeotp-backup.json

Should work with almost any version of Python from 2.6 onwards.

Only tested with:

  * Python 3.7.3

  * Python 2.7.10

## Requirements/installation

Python 2.6 or 3.x

Relies on https://github.com/pyauth/pyotp but will use https://hg.sr.ht/~clach04/gtotp if pyotp is missing.

    pip install pyotp

Optionally install QR code generator for console output:

  * segno (preffered)

  * pyqrcodeng

I.e. `pip install pyotp segno`

Quick and dirty setup, if skipping above:

    curl https://hg.sr.ht/~clach04/gtotp/raw/gauth.py?rev=tip -o gauth.py

## Usage

    python freeotp.py freeotp-backup.json

Dumps pins for all.

Also dumps a URL for qrcode scanning - NOTE browser history will expose seed - do not use!

(its there for testing purposes of test values).

## Also see

  * https://github.com/helloworld1/FreeOTPPlus

  * https://authenticator.cc/docs/en/otp-backup

  * https://github.com/slandx/tfat

  * https://github.com/pepa65/twofat

## freeotp-backup.json schema

Sample schema with notes (i.e. not real).

    {

        "tokens": [

            {

                "digits": 6,

                "counter": 0,

                "issuerExt": "ISSUER_NAME",

                "period": 30,

                "label": "YOUR_NAME",

                "secret": [SIGNED 1-BYTE INTEGER VALUES PER BYTE],

                "secret_base32": "optional non-standard for FreeOTPPlus; base32 encoded string instead of integer secret above",

                "algo": "SHA1",

                "type": "TOTP"

            },

            ...

        ],

        "tokenOrder": [

            "ISSUER_NAME:YOUR_NAME",

            ...

        ]

    }