Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/szdytom/simple-totp
A simple script to calculate Time-based One-Time Password
https://github.com/szdytom/simple-totp
Last synced: 3 months ago
JSON representation
A simple script to calculate Time-based One-Time Password
- Host: GitHub
- URL: https://github.com/szdytom/simple-totp
- Owner: szdytom
- License: mit
- Created: 2023-12-04T02:36:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-13T01:59:12.000Z (about 1 year ago)
- Last Synced: 2024-10-09T19:42:46.555Z (4 months ago)
- Language: Python
- Size: 6.84 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# simple-totp
A simple script to calculate Time-based One-Time Password.
## Features
- **Standard TOPT**: Implements standard TOTP (RFC6238), tested against Google Authenticator.
- **Offline**: All data and secrets are saved and processed locally.
- **Zero-dependency**: Does not depend on other libraries except Python's standard library.
- **Lightweight**: Less than 100 LOC, nowhere to hide any backdoors.
## Installing
You only need to download the script file `totp.py` (you also need to make sure Python3 is installed on your computer).
## Usage
You need to save your TOTP key in a file in base32 format. If you are interacting with GitHub 2FA, you can click the "setup key" button to get that code. Otherwise, you may need to scan a certain QR code (provided by the website) and extract the secret key manually.
In most cases, the QR code will contain a URI similar to:
```plain
otpauth://totp/Passkou?secret=6shyg3uens2sh5slhey3dmh47skvgq5y&issuer=Test
```
You just need the part after `secret=`, in the above example, it is `6shyg3uens2sh5slhey3dmh47skvgq5y`, and save the string in a plain text file. (Note: usually, you may want to switch that file to permission 600).
After that, you can simply call the script by the following command.
```sh
python totp.py
```
You will get something like these:
```
~/keys $ python totp.py github-2fa.txt
Current OTP: 726347
Next OTP: 033150
Remaining Seconds: 14
~/keys $
```
## Contributing
I'd like to see contributions from the community. If you experience bugs, feel free to open an issue. There are a lot more features that can be added, for example,
- Configurable time step length (currently hardcoded number 30), hash algorithm (currently SHA-1 only), and code length (currently hardcoded 6) via command-line arguments.
- Recognise other secret formats such as binary, hex, or mnemonic phrases.
- A TUI or even a GUI interface.
If you have implemented any enhancement(not necessarily limited to the list above), please open a pull request.
## License
The content in this repository is licensed under the MIT License, with absolutely no warranty of any kind, see `LICENSE` for details.