apm/README.md

34 lines
1.1 KiB
Markdown
Raw Normal View History

2024-05-19 17:52:18 +02:00
# apm
2024-05-22 17:11:23 +02:00
apm, argon password manager; a simple implementation of [pass](https://www.passwordstore.org/)(1) in C. It uses a unique key to encrypt every password, it provides functionality to edit, add, generate, show, list, remove passwords. It uses argon2 to create hash of master password and uses XSalsa20 to encrypt the password.
2024-04-08 03:50:36 +02:00
> The name "argon" is chosen as it uses argon2 algorithm and sodium(library) is stored with argon.
2024-05-19 17:52:18 +02:00
Before using apm, you must export 2 environment variables in order to make it work
2024-04-08 03:50:36 +02:00
```sh
2024-05-19 17:52:18 +02:00
export APM_DIR=~/secret/apm
export APM_KEY=~/secret/apm_key
2024-04-08 03:50:36 +02:00
```
2024-05-19 17:52:18 +02:00
`APM_DIR` is the directory where passwords are stored and `APM_KEY` is the path to the master key file.
2024-04-08 03:50:36 +02:00
2024-05-22 12:21:42 +02:00
# Usage
```
Usage: apm [-vhL] [[-e | -R | -I | -Q] <password>] [-M <file>] [-G <password> <length>]
```
2024-04-08 03:53:02 +02:00
# Dependencies
2024-04-08 03:50:36 +02:00
- libsodium
2024-04-08 03:53:02 +02:00
# Building
2024-05-19 17:52:18 +02:00
You will need to run these with elevated privilages.
2024-05-22 11:56:58 +02:00
```
2024-04-08 03:50:36 +02:00
$ make
# make install
```
2024-04-08 03:53:02 +02:00
# Contributions
Contributions are welcomed, feel free to open a pull request.
# License
2024-05-19 17:52:18 +02:00
This project is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/apm/blob/master/LICENSE) for more information.