https://github.com/jan-janssen/pyauthenticator
Similar to the Google authenticator just written in Python to automate annoying two factor authentication.
https://github.com/jan-janssen/pyauthenticator
2fa 2fa-client 2fa-client-python 2factor hotp hotp-generator otpauth totp totp-generator two-factor-authentication
Last synced: about 1 month ago
JSON representation
Similar to the Google authenticator just written in Python to automate annoying two factor authentication.
- Host: GitHub
- URL: https://github.com/jan-janssen/pyauthenticator
- Owner: jan-janssen
- License: bsd-3-clause
- Created: 2021-05-08T12:33:37.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-02T04:11:28.000Z (about 2 months ago)
- Last Synced: 2025-04-02T05:20:21.414Z (about 2 months ago)
- Topics: 2fa, 2fa-client, 2fa-client-python, 2factor, hotp, hotp-generator, otpauth, totp, totp-generator, two-factor-authentication
- Language: Python
- Homepage:
- Size: 406 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pyauthenticator
[](https://github.com/jan-janssen/pyauthenticator/actions/workflows/unittest.yml)
[](https://coveralls.io/github/jan-janssen/pyauthenticator?branch=main)
[](https://github.com/psf/black)
Similar to the Google authenticator just written in Python. With more and more services requiring two factor
authentication without supporting application specific passwords or other forms of token based authenication
suitable for automation this python packages allows to generate two factor authentication codes on the commandline
or in python.
# For Users
## Installation
Install `pyauthenticator` via conda:
```
>>> conda install -c conda-forge pyauthenticator
```
Alternatively, `pyauthenticator` can also be installed via pip:
```
>>> pip install pyauthenticator
```
## Command Line
Get help how to use `pyauthenticator` using the `--help/-h` option:
```
>>> pyauthenticator --help
usage: pyauthenticator [-h] [-qr] [-a ADD] service
positional arguments:
service Service to generate optauth code for. Currently no
service is defined in the ~/.pyauthenticator config file.
options:
-h, --help show this help message and exit
-qr, --qrcode Generate qrcode as file.
-a ADD, --add ADD Add service by providing the file as
additional argument.
```
Add `google` as new service after saving the qrcode to `Screenshot 2023-07-02 at 12.45.09.png` to your desktop:
```
>>> pyauthenticator google --add ~/Desktop/Screenshot\ 2023-07-02\ at\ 12.45.09.png
The service 'google' was added, from file
```
Afterwards, new authentication codes can be generated for the service `google` using:
```
>>> pyauthenticator google
087078
```
Beyond google, `pyauthenticator` works for any service which implements the two factor authentication.
If you mistype the name of the service, then `pyauthenticator` suggests alternative options:
```
>>> pyauthenticator googel
The service "googel" does not exist.
The config file ~/.pyauthenticator contains the following services:
* google
Choose one of these or add a new service using:
pyauthenticator --add
```
## Support
For any support requests feel free to open an [issue on Github](https://github.com/jan-janssen/pyauthenticator/issues).
# For Developers
## Python Interface
The same functionality which is available on the command line is also available via the python interface:
```
from pyauthenticator import get_two_factor_code
get_two_factor_code(service)
```
So `pyauthenticator` can be integrated in existing python packages which need access to resources protected by two
factor authentication.
## Configuration
The configuration is stored in `~/.pyauthenticator` it is written in the JSON format. For a given service like `github`
the config file contains:
```
{"google": "otpauth://totp/Google:?secret=&issuer=Google"}
```
With the Google username `` and the corresponding secret `` being contained in the QR code.
## License
The `pyauthenticator` package is licensed under the [BSD-3-Clause license](https://github.com/jan-janssen/pyauthenticator/blob/main/LICENSE).