You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Michael Iseli bf96148461 Add python virtual env instructions This change adds instructions on how to setup a python virtual env for this repo. In addition, the respective requirements files have been added for easy installation with pip.		2 years ago
generated_python	fix example in readme, generate with protoc 3.14	3 years ago
.editorconfig	Initial	4 years ago
.gitignore	Add python virtual env instructions	2 years ago
README.md	Add python virtual env instructions	2 years ago
example_export.txt	fix: improve logging, handle file saving without issuer, extend example	3 years ago
extract_otp_secret_keys.py	Use print_ascii to make it work in powershell	2 years ago
google_auth.proto	Initial	4 years ago
requirements-buildenv.txt	Add python virtual env instructions	2 years ago
requirements.txt	Add python virtual env instructions	2 years ago

README.md

Extract TOTP/HOTP secret keys from Google Authenticator

Extract two-factor authentication (2FA, TFA) secret keys from export QR codes of "Google Authenticator" app

Usage

Export the QR codes from "Google Authenticator" app
Read QR codes with QR code reader
Save the captured QR codes in a text file. Save each QR code on a new line. (The captured QR codes look like otpauth-migration://offline?data=...)

Call this script with the file as input:

 python extract_otp_secret_keys.py -p example_export.txt

Requirement

The protobuf package of Google for proto3 is required for running this script. protobuf >= 3.14 is recommended.

pip install protobuf

Known to work with

Python 3.6.12 and protobuf 3.14.0
Python 3.8.5 and protobuf 3.14.0

Optional

For printing QR codes, the qrcode module is required

pip install qrcode[pil]

Alternative installation method

Alternatively, you can use a python virtual env for the dependencies:

python -m venv venv
. venv/bin/activate
pip install -r requirements-buildenv.txt
pip install -r requirements.txt

The requirements*.txt files contain all the dependencies (also the optional ones). To leave the python virtual env just call deactivate.

Technical background

The export QR code of "Google Authenticator" contains the URL otpauth-migration://offline?data=.... The data parameter is a base64 encoded proto3 message (Google Protocol Buffers).

Command for regeneration of Python code from proto3 message definition file (only necessary in case of changes of the proto3 message definition):

protoc --python_out=generated_python google_auth.proto

References

Proto3 documentation: https://developers.google.com/protocol-buffers/docs/pythontutorial
Template code: https://github.com/beemdevelopment/Aegis/pull/406