pass_manager/README.md

47 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2023-08-08 12:27:55 +00:00
# Pass Manager
2024-04-23 15:42:55 +00:00
Telegram bot, written in Rust, that manages your passwords
2023-08-08 12:27:55 +00:00
## Usage
2024-04-23 15:42:55 +00:00
This bot has to be self hosted. No official instance exists. To host this bot you have to:
2023-08-08 12:27:55 +00:00
2024-04-23 15:42:55 +00:00
* Clone this repository
2023-08-08 12:27:55 +00:00
2024-04-23 15:42:55 +00:00
* Create .env file in the root of the repository and add your token
```dotenv
2023-08-08 12:27:55 +00:00
TOKEN=<YOUR-TOKEN>
```
2024-04-23 15:42:55 +00:00
* Start the bot using docker compose
2023-08-08 12:27:55 +00:00
```bash
2024-04-23 15:42:55 +00:00
docker compose up -d
2023-08-08 12:27:55 +00:00
```
## Cryptography
* Scrypt is used to store and verify the master password
* PBKDF2 is used to get a 256 bit key for encryption
* ChaCha20-Poly1305 is used to encrypt logins and passwords
## Commands
These commands are supported:
* /start — displays the welcome message
* /help — displays this text
* /set_master_pass — sets the master password
* /menu — gives you a menu to manage your accounts
* /add_account — adds the account
* /get_account — gets the account
* /get_accounts — gets a list of accounts
* /delete — deletes the account
* /delete_all — deletes all the accounts and the master password
* /export — exports all the accounts in a json file
* /import — loads the accounts from a json file
* /gen_password — generates 10 secure passwords
* /cancel — cancels the current action
2024-04-23 15:42:55 +00:00
* /change_language - allows you to change the language