diff --git a/README.md b/README.md index a4a1c5c..22e1f1b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Extract TOTP/HOTP two-factor authentication secrets +# Extract secrets from QR codes exported by two-factor authentication apps [](https://github.com/scito/extract_otp_secrets/actions/workflows/ci.yml)  @@ -12,99 +12,29 @@ --- -TODO add src/ -TODO mention renaming extract_otp_secrets +The Python script `extract_otp_secrets.py` extracts one time password (OTP) secrets from QR codes exported by two-factor authentication (2FA) apps such as "Google Authenticator". +The export QR codes from authentication apps can be provided in three ways to this script: -Extract one time passwords (OTP) / two-factor authentication (2FA, TFA) secrets from export QR codes from 2FA authentication apps such as "Google Authenticator". -The QR codes can be captured from the system camera, imported from images or from text files containing the QR code data. -The secret and otp values can be printed and exported to json or csv, as well as printed or saved to PNG images. +1. Capture from the system camera in a GUI, +2. Image files containing the QR codes, and +3. Text files containing the QR code data generated by QR readers. + +The secret and otp values can be exported to json or csv files, as well as printed or saved to PNG images. + +This script/project was renamed from extract_otp_secret_keys to extract_otp_secrets in version 2.0.0. ## Installation +``` git clone https://github.com/scito/extract_otp_secrets.git cd extract_otp_secrets +pip install -U -r requirements.txt +``` -## Usage +### Installation of shared libraries for ZBAR QR reader -### Capture QR codes from camera (since v2.0.0) - -1. Open "Google Authenticator" app on the mobile phone -2. Export the QR codes from "Google Authenticator" app -3. Point the QR codes to the camera of your computer -4. Call this script with the file as input: - - python extract_otp_secrets.py - - - -### With builtin QR decoder from image files (since v2.0.0) - -1. Open "Google Authenticator" app on the mobile phone -2. Export the QR codes from "Google Authenticator" app -4. Save the captured QR codes as image files, e.g. example_export.png -5. Transfer the images files to the computer where his script is installed. -6. Call this script with the file as input: - - python extract_otp_secrets.py example_export.png - -### With external QR decoder app from text files - -1. Open "Google Authenticator" app on the mobile phone -2. Export the QR codes from "Google Authenticator" app -3. Read QR codes with a QR code reader (e.g. from another phone) -4. Save the captured QR codes in the QR code reader to a text file, e.g. example_export.txt. Save each QR code on a new line. (The captured QR codes look like `otpauth-migration://offline?data=...`) -5. Transfer the file to the computer where his script is installed. -6. Call this script with the file as input: - - python extract_otp_secrets.py example_export.txt - -## Program help: arguments and options - -
usage: extract_otp_secrets.py [-h] [--camera NUMBER] [--qr {ZBAR,QREADER,QREADER_DEEP,CV2,CV2_WECHAT}] [--json FILE] [--csv FILE] [--keepass FILE] [--printqr] [--saveqr DIR] [--no-color] [--verbose | --quiet] [infile ...]
-
-Extracts one time password (OTP) / two-factor authentication (2FA) secrets from export QR codes, e.g. from Google Authenticator app.
-If no infiles are provided, the QR codes a GUI window starts and QR codes can interactively be captured from the system camera.
-
-positional arguments:
- infile a) file or - for stdin with 'otpauth-migration://...' URLs separated by newlines, lines starting with # are ignored;
- b) image file containing a QR code or = for stdin for an image containing a QR code
-
-options:
- -h, --help show this help message and exit
- --camera NUMBER, -C NUMBER camera number of system (default camera: 0)
- --qr {ZBAR,QREADER,QREADER_DEEP,CV2,CV2_WECHAT}, -Q {ZBAR,QREADER,QREADER_DEEP,CV2,CV2_WECHAT}
- QR reader (default: ZBAR)
- --json FILE, -j FILE export json file or - for stdout
- --csv FILE, -c FILE export csv file or - for stdout
- --keepass FILE, -k FILE export totp/hotp csv file(s) for KeePass, - for stdout
- --printqr, -p print QR code(s) as text to the terminal (requires qrcode module)
- --saveqr DIR, -s DIR save QR code(s) as images to the given folder (requires qrcode module)
- --no-color, -n do not use ANSI colors in console output
- --verbose, -v verbose output
- --quiet, -q no stdout output, except output set by -
-
-examples:
-python extract_otp_secrets.py
-python extract_otp_secrets.py example_*.txt
-python extract_otp_secrets.py - < example_export.txt
-python extract_otp_secrets.py --csv - example_*.png | tail -n+2
-python extract_otp_secrets.py = < example_export.png
-
-## Dependencies
-
- pip install -r requirements.txt
-
-Known to work with
-
-* Python 3.10.8, protobuf 4.21.9, qrcode 7.3.1, and pillow 9.2
-* Python 3.11.1, protobuf 4.21.12, qrcode 7.3.1, and pillow 9.2
-
-For protobuf versions 3.14.0 or similar or Python 3.6, use the extract_otp_secrets version 1.4.0.
-
-### Shared libs installation for reading QR code images
-
-For reading QR code images the zbar library must be installed for `ZBAR` QR reader.
-If you do not extract directly from images or using catpuring from camera, you do not need to install the zbar shared library.
+For reading QR codes with `ZBAR` QR reader, the zbar library must be installed.
+If you do not use the `ZBAR` QR reader, you do not need to install the zbar shared library. Note: The `ZBAR` QR reader is the showed for me the best results and is thus default QR Reader.
For a detailed installation documentation of [pyzbar](https://github.com/NaturalHistoryMuseum/pyzbar#installation).
@@ -126,56 +56,121 @@ For a detailed installation documentation of [pyzbar](https://github.com/Natural
#### Windows
-The zbar DLLs are included with the Windows Python wheels. However, you might need to install [Visual C++ Redistributable Packages for Visual Studio 2013](https://www.microsoft.com/en-US/download/details.aspx?id=40784). Install vcredist_x64.exe if using 64-bit Python, vcredist_x86.exe if using 32-bit Python.
+The zbar DLLs are included with the Windows Python wheels. However, you might need additionally to install [Visual C++ Redistributable Packages for Visual Studio 2013](https://www.microsoft.com/en-US/download/details.aspx?id=40784). Install `vcredist_x64.exe` if using 64-bit Python, `vcredist_x86.exe` if using 32-bit Python.
+
+## Usage
+
+### Capture QR codes from camera (since version 2.0.0)
+
+1. Open "Google Authenticator" app on the mobile phone
+2. Export the QR codes from "Google Authenticator" app
+3. Point the QR codes to the camera of your computer
+4. Call this script without infile parameters:
+
+ python src/extract_otp_secrets.py
+
+
+
+### With builtin QR decoder from image files (since version 2.0.0)
+
+1. Open "Google Authenticator" app on the mobile phone
+2. Export the QR codes from "Google Authenticator" app
+4. Save the QR code as image file, e.g. example_export.png
+5. Transfer the images files to the computer where his script is installed.
+6. Call this script with the file as input:
+
+ python src/extract_otp_secrets.py example_export.png
+
+### With external QR decoder app from text files
+
+1. Open "Google Authenticator" app on the mobile phone
+2. Export the QR codes from "Google Authenticator" app
+3. Read QR codes with a QR code reader (e.g. from another phone)
+4. Save the captured QR codes in the QR code reader to a text file, e.g. example_export.txt. Save each QR code on a new line. (The captured QR codes look like `otpauth-migration://offline?data=...`)
+5. Transfer the file to the computer where his script is installed.
+6. Call this script with the file as input:
+
+ python src/extract_otp_secrets.py example_export.txt
+
+## Program help: arguments and options
+
+Extracts one time password (OTP) secrets from QR codes exported by two-factor authentication (2FA) apps
+If no infiles are provided, a GUI window starts and QR codes are captured from the camera.
+
+positional arguments:
+ infile a) file or - for stdin with 'otpauth-migration://...' URLs separated by newlines, lines starting with # are ignored;
+ b) image file containing a QR code or = for stdin for an image containing a QR code
+
+options:
+ -h, --help show this help message and exit
+ --csv FILE, -c FILE export csv file or - for stdout
+ --keepass FILE, -k FILE export totp/hotp csv file(s) for KeePass, - for stdout
+ --json FILE, -j FILE export json file or - for stdout
+ --printqr, -p print QR code(s) as text to the terminal (requires qrcode module)
+ --saveqr DIR, -s DIR save QR code(s) as images to the given folder (requires qrcode module)
+ --camera NUMBER, -C NUMBER camera number of system (default camera: 0)
+ --qr {ZBAR,QREADER,QREADER_DEEP,CV2,CV2_WECHAT}, -Q {ZBAR,QREADER,QREADER_DEEP,CV2,CV2_WECHAT}
+ QR reader (default: ZBAR)
+ -i, --ignore ignore duplicate otps
+ --no-color, -n do not use ANSI colors in console output
+ -v, --verbose verbose output
+ -q, --quiet no stdout output, except output set by -
+
+examples:
+python extract_otp_secrets.py
+python extract_otp_secrets.py example_*.txt
+python extract_otp_secrets.py - < example_export.txt
+python extract_otp_secrets.py --csv - example_*.png | tail -n+2
+python extract_otp_secrets.py = < example_export.png
## Examples
### Printing otp secrets form text file
- python extract_otp_secrets.py example_export.txt
+ python src/extract_otp_secrets.py example_export.txt
### Printing otp secrets from image file
- python extract_otp_secrets.py example_export.png
+ python src/extract_otp_secrets.py example_export.png
### Printing otp secrets multiple files
- python extract_otp_secrets.py example_*.txt
- python extract_otp_secrets.py example_*.png
- python extract_otp_secrets.py example_export.*
- python extract_otp_secrets.py example_*.txt example_*.png
+ python src/extract_otp_secrets.py example_*.txt
+ python src/extract_otp_secrets.py example_*.png
+ python src/extract_otp_secrets.py example_export.*
+ python src/extract_otp_secrets.py example_*.txt example_*.png
### Printing otp secrets from stdin (text)
- python extract_otp_secrets.py - < example_export.txt
+ python src/extract_otp_secrets.py - < example_export.txt
### Printing otp secrets from stdin (image)
- python extract_otp_secrets.py = < example_export.png
+ python src/extract_otp_secrets.py = < example_export.png
### Printing otp secrets csv to stdout
- python extract_otp_secrets.py --csv - example_export.txt
+ python src/extract_otp_secrets.py --csv - example_export.txt
### Printing otp secrets csv to stdout without header line
- python extract_otp_secrets.py --csv - example_*.png | tail -n+2
+ python src/extract_otp_secrets.py --csv - example_*.png | tail -n+2
### Reading from stdin and printing to stdout
- cat example_*.txt | python extract_otp_secrets.py --csv - - | tail -n+2
+ cat example_*.txt | python src/extract_otp_secrets.py --csv - - | tail -n+2
## Features
* Free and open source
* Supports Google Authenticator exports (and compatible apps like Aegis Authenticator)
-* Captures the the QR codes directly from the camera using different QR code readers (based on OpenCV)
- * ZBAR: fast and reliable, good for images and video capture (default/recommended) [pyzbar](https://github.com/NaturalHistoryMuseum/pyzbar)
- * QREADER: fast [QReader](https://github.com/Eric-Canas/QReader)
- * QREADER_DEEP: slow, not good for camera [QReader](https://github.com/Eric-Canas/QReader)
- * CV2: fast [QRCodeDetector](https://docs.opencv.org/4.x/de/dc3/classcv_1_1QRCodeDetector.html)
- * CV2_WECHAT: fast [WeChatQRCode](https://docs.opencv.org/4.x/dd/d63/group__wechat__qrcode.html)
-* Supports TOTP and HOTP
+* Captures the the QR codes directly from the camera using different QR code libraries (based on OpenCV)
+ * ZBAR: [pyzbar](https://github.com/NaturalHistoryMuseum/pyzbar) - fast and reliable, good for images and video capture (default and recommended)
+ * QREADER: [QReader](https://github.com/Eric-Canas/QReader)
+ * QREADER_DEEP: [QReader](https://github.com/Eric-Canas/QReader) - very slow in GUI
+ * CV2: [QRCodeDetector](https://docs.opencv.org/4.x/de/dc3/classcv_1_1QRCodeDetector.html)
+ * CV2_WECHAT: [WeChatQRCode](https://docs.opencv.org/4.x/dd/d63/group__wechat__qrcode.html)
+* Supports TOTP and HOTP standards
* Generates QR codes
* Exports to various formats:
* CSV
@@ -191,7 +186,8 @@ The zbar DLLs are included with the Windows Python wheels. However, you might ne
* Windows bitmaps - *.bmp, *.dib
* JPEG 2000 files - *.jp2
* Portable image format - *.pbm, *.pgm, *.ppm *.pxm, *.pnm
-* Errors and warnings are written to stderr and these are printed in red color on all platforms
+* Prints errors and warnings to stderr
+* Prints colored output
* Many ways to run the script:
* Native Python
* pipenv
@@ -200,6 +196,7 @@ The zbar DLLs are included with the Windows Python wheels. However, you might ne
* Docker
* VSCode devcontainer
* devbox
+* Prebuilt Docker images provided for amd64 and arm64
* Compatible with major platforms:
* Linux
* macOS
@@ -208,7 +205,7 @@ The zbar DLLs are included with the Windows Python wheels. However, you might ne
* Supports Python >= 3.7
* Written in modern Python using type hints and following best practices
* All these features are backed by tests ran nightly
-* All functionality in one Python script: extract_otp_secrets.py (except protobuf generated code in protobuf_generated_python)
+* All functionality in one Python script: src/extract_otp_secrets.py (except protobuf generated code in protobuf_generated_python)
## KeePass
@@ -255,11 +252,11 @@ 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 or new protobuf versions):
- protoc --python_out=protobuf_generated_python google_auth.proto --mypy_out=protobuf_generated_python
+ protoc -plugin=protoc-gen-mypy=path/to/protoc-gen-mypy --python_out=protobuf_generated_python --mypy_out=protobuf_generated_python google_auth.proto
The generated protobuf Python code was generated by protoc 21.12 (https://github.com/protocolbuffers/protobuf/releases/tag/v21.12).
-https://github.com/nipunn1313/mypy-protobuf
+For Python type hint generation the [mypy-protobuf](https://github.com/nipunn1313/mypy-protobuf) package is used.
## References
@@ -284,35 +281,20 @@ pip install -U git+https://github.com/scito/extract_otp_secrets
python -m extract_otp_secrets
```
-#### For development
+or from a specific tag
```
-pip install -U git+https://github.com/scito/extract_otp_secrets.git@support_img_read
+pip install -U git+https://github.com/scito/extract_otp_secrets.git@v2.0.0
python -m extract_otp_secrets
-```
-
-```
-
-https://stackoverflow.com/questions/13685920/install-specific-git-commit-with-pip
--e for egg
-pip install -U -e git+