# Authf
Authf is an authentication management package developed for Python. It offers a command-line interface that enables the addition, display, and deletion of accounts, along with the capability to generate Time-Based One-Time Passwords (TOTPs) for verifying accounts.
## Features
* Incorporate new accounts featuring encrypted secret keys.
* Account information is securely encrypted using the PBKDF2HMAC cryptography method and saved locally on your device.
* Operates without the need for an internet connection.
* The TOTP remains inaccessible to others, ensuring your security even in the even of devices loss, provided your passwords remain secure.
* Manage (view & remove) TOTP tokens used for account verification.
## Installation
You can install `Authf` using pip:
```bash
pip install authf
```
## Version
```bash
authf --version
```
## Usage
Once installed, you can use the `authf` command to access the authentication tool. Here are some examples of how to use it:
- Add a new account:
```bash
$ authf --addaccount
Enter the account name: apple
Enter password to encrypt the secret key:
Enter the secret key without any error: theSecretkey
Your TOTP for verification of the account is 685197
```
- View TOTP:
```bash
$ authf --totp
Enter the account name: apple
Enter password to view TOTP:
Your TOTP for authentication is 270142
```
The primary use of this tool is to allow you to transfer your accounts from one machine to another. Additionally, it provides an opportunity to change the password for existing scripts.
```python
>>> from authf import add_offline; help(add_offline)
```
- Restore accounts Offline:
```bash
$ authf --addoffline
```
- Remove your all accounts
*Warning: Using the following command will completely remove all your 2FA authentication accounts*
```bash
$ authf --rm
```
## Requirements
AuthF requires Python 3.x. All dependencies are listed in the `requirements.txt` file.
## Contributing
Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request on GitHub.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
If you have any questions or feedback, feel free to open an issue on GitHub.
Raw data
{
"_id": null,
"home_page": "https://github.com/1darshanpatil/authf",
"name": "authf",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "authenticator, authentication, Two Step Authentication",
"author": "Darshan P.",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b9/ec/99341dbdb49b6e4e0b6e13b3bcf048d2b6af877b3350383d60a4e92d3879/authf-0.0.4.tar.gz",
"platform": null,
"description": "\n\n\n# Authf\n\nAuthf is an authentication management package developed for Python. It offers a command-line interface that enables the addition, display, and deletion of accounts, along with the capability to generate Time-Based One-Time Passwords (TOTPs) for verifying accounts.\n\n\n\n## Features\n* Incorporate new accounts featuring encrypted secret keys.\n* Account information is securely encrypted using the PBKDF2HMAC cryptography method and saved locally on your device.\n* Operates without the need for an internet connection.\n* The TOTP remains inaccessible to others, ensuring your security even in the even of devices loss, provided your passwords remain secure.\n* Manage (view & remove) TOTP tokens used for account verification.\n\n\n\n\n## Installation\n\n\n\nYou can install `Authf` using pip:\n```bash\npip install authf\n```\n## Version\n```bash\nauthf --version\n```\n\n\n## Usage\n\n\n\nOnce installed, you can use the `authf` command to access the authentication tool. Here are some examples of how to use it:\n\n- Add a new account:\n```bash\n$ authf --addaccount\nEnter the account name: apple\nEnter password to encrypt the secret key: \nEnter the secret key without any error: theSecretkey\nYour TOTP for verification of the account is 685197\n```\n\n- View TOTP:\n```bash\n$ authf --totp\nEnter the account name: apple\nEnter password to view TOTP: \nYour TOTP for authentication is 270142\n```\n\nThe primary use of this tool is to allow you to transfer your accounts from one machine to another. Additionally, it provides an opportunity to change the password for existing scripts.\n\n```python\n>>> from authf import add_offline; help(add_offline)\n```\n- Restore accounts Offline:\n```bash\n$ authf --addoffline\n```\n\n\n- Remove your all accounts\n\n *Warning: Using the following command will completely remove all your 2FA authentication accounts*\n\n```bash\n$ authf --rm\n```\n\n\n## Requirements\n\nAuthF requires Python 3.x. All dependencies are listed in the `requirements.txt` file.\n\n## Contributing\n\nContributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request on GitHub.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n\n## Contact\n\nIf you have any questions or feedback, feel free to open an issue on GitHub.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Authenticator Application",
"version": "0.0.4",
"project_urls": {
"Documentation": "https://github.com/1darshanpatil/authf#readme",
"Homepage": "https://github.com/1darshanpatil/authf",
"Source": "https://github.com/1darshanpatil/authf",
"Tracker": "https://github.com/1darshanpatil/authf/issues"
},
"split_keywords": [
"authenticator",
" authentication",
" two step authentication"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5cfc690642490b2cd84b04c2c1546689b4a6064f55683f6e79eec805bfbca67",
"md5": "53b85d9f9c32ea9f2c9c873d8e49747a",
"sha256": "dd10f430ca3f3b2048f8f20f51b61838d728449980db662f72778530be9a6827"
},
"downloads": -1,
"filename": "authf-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "53b85d9f9c32ea9f2c9c873d8e49747a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12399,
"upload_time": "2024-10-12T08:25:14",
"upload_time_iso_8601": "2024-10-12T08:25:14.337347Z",
"url": "https://files.pythonhosted.org/packages/a5/cf/c690642490b2cd84b04c2c1546689b4a6064f55683f6e79eec805bfbca67/authf-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b9ec99341dbdb49b6e4e0b6e13b3bcf048d2b6af877b3350383d60a4e92d3879",
"md5": "6e7f807b247e329a59e25b43e439e122",
"sha256": "aacf835bfc6f6a310f9a37bd4a03609610f710ec331934bbae04a9b8f4ffef26"
},
"downloads": -1,
"filename": "authf-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "6e7f807b247e329a59e25b43e439e122",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 11108,
"upload_time": "2024-10-12T08:25:17",
"upload_time_iso_8601": "2024-10-12T08:25:17.084534Z",
"url": "https://files.pythonhosted.org/packages/b9/ec/99341dbdb49b6e4e0b6e13b3bcf048d2b6af877b3350383d60a4e92d3879/authf-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-12 08:25:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "1darshanpatil",
"github_project": "authf",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "authf"
}
JSON
