smokephil/extract_otp_secret_keys
1
0
Fork 0
mirror of https://github.com/scito/extract_otp_secret_keys.git synced 2025-12-06 06:44:57 +01:00
Code Issues Projects Releases Wiki Activity

improve docu

Browse source 
- add help page to README.txt
- remove -p
- mention optional qrcode module
This commit is contained in:
scito 2022-09-08 21:11:49 +02:00
parent cd2d3258d3
commit 4baf406211
2 changed files with 22 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -19,7 +19,25 @@ The secret and otp values can be printed and exported to json or csv. The QR cod
3. 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=...`)
4. Call this script with the file as input:
python extract_otp_secret_keys.py -p example_export.txt
python extract_otp_secret_keys.py example_export.txt
## Program help: arguments and options
<pre>
usage: extract_otp_secret_keys.py [-h] [--verbose] [--quiet] [--saveqr] [--printqr] [--json JSON] [--csv CSV] infile
positional arguments:
infile file or - for stdin (default: -) with "otpauth-migration://..." URLs separated by newlines, lines starting with # are ignored
options:
-h, --help show this help message and exit
--verbose, -v verbose output
--quiet, -q no stdout output
--saveqr, -s save QR code(s) as images to the "qr" subfolder (requires qrcode module)
--printqr, -p print QR code(s) as text to the terminal (requires qrcode module)
--json JSON, -j JSON export to json file
--csv CSV, -c CSV export to csv file
</pre>
## Dependencies

6
extract_otp_secret_keys.py
View file

@ -5,7 +5,7 @@
# 2. Read QR codes with QR code reader (e.g. with a second device)
# 3. 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=...")
# 4. Call this script with the file as input:
# python extract_otp_secret_keys.py -p example_export.txt
# python extract_otp_secret_keys.py example_export.txt
#
# Requirement:
# The protobuf package of Google for proto3 is required for running this script.
@ -72,8 +72,8 @@ def parse_args(sys_args):
arg_parser = argparse.ArgumentParser()
arg_parser.add_argument('--verbose', '-v', help='verbose output', action='count')
arg_parser.add_argument('--quiet', '-q', help='no stdout output', action='store_true')
arg_parser.add_argument('--saveqr', '-s', help='save QR code(s) as images to the "qr" subfolder', action='store_true')
arg_parser.add_argument('--printqr', '-p', help='print QR code(s) as text to the terminal', action='store_true')
arg_parser.add_argument('--saveqr', '-s', help='save QR code(s) as images to the "qr" subfolder (requires qrcode module)', action='store_true')
arg_parser.add_argument('--printqr', '-p', help='print QR code(s) as text to the terminal (requires qrcode module)', action='store_true')
arg_parser.add_argument('--json', '-j', help='export to json file')
arg_parser.add_argument('--csv', '-c', help='export to csv file')
arg_parser.add_argument('infile', help='file or - for stdin (default: -) with "otpauth-migration://..." URLs separated by newlines, lines starting with # are ignored')