Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/x1o/keypr
Credentials Management Using GPG Encryption, YAML Files and CLI
https://github.com/x1o/keypr
credentials-storage password-manager r
Last synced: 8 days ago
JSON representation
Credentials Management Using GPG Encryption, YAML Files and CLI
- Host: GitHub
- URL: https://github.com/x1o/keypr
- Owner: x1o
- License: gpl-3.0
- Created: 2020-07-03T20:32:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-21T14:19:06.000Z (over 2 years ago)
- Last Synced: 2024-08-13T07:11:06.727Z (4 months ago)
- Topics: credentials-storage, password-manager, r
- Language: R
- Homepage: https://x1o.github.io/keypr
- Size: 188 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - x1o/keypr - Credentials Management Using GPG Encryption, YAML Files and CLI (R)
README
# keypr
[](https://codecov.io/gh/x1o/keypr?branch=master)
[](https://travis-ci.org/x1o/keypr)
`keypr` is a simple yet sufficient password manager designed to be used via CLI. It operates on a YAML file (which stores credentials data) encrypted with [GnuPG](https://gnupg.org/). The idea is that you can, in principle, maintain the password file yourself manually by encrypting / decrypting with `gpg`, `grep`'ping and/or modifying it with your favourite editor. `keypr` just provides a convenient interface to all that.
## Raison d'etre
Pardon me -- a password manager in R? But why? Very simple: the author had a *sudden urge* to write it.
## Installation
Make sure [GnuPG](https://gnupg.org/) is installed (`gnupg` in dpkg-based distros).
In addition, on MacOS install `pinentry-mac` - a utility for passphrase entry.
You can install the latest version of `keypr` from github with:
```r
devtools::install_github('x1o/keypr')
```
After the installation, put the following bash script to a location in your PATH:
```sh
#!/usr/bin/env bash
umask 0002
Rscript -e 'keypr::keypr()' "$@"
```
or copy it from `/bin/keypr`.
## Configuration
GnuPG agent (`~/.gnupg/gpg-agent.conf`):
```
min-passphrase-len 0
min-passphrase-nonalpha 0
```
In addition, on MacOS, add
```
pinentry-program /usr/local/bin/pinentry-mac
```
`keypr` is configured via a YAML configuration file `keypr.yaml`, which is by
default stored in the user config directory; call
```r
rappdirs::user_config_dir(appname = 'keypr')
```
to find the exact location on your system.
In that file, specify the path to a `gpg`-encrypted password file, for example:
```yaml
passwd_pathname: "~/passwd.yaml.gpg"
```
If the config file does not exist, it will be created with `passwd_pathname`
equal to `passwd.yaml.gpg` in the user default data dir; call
```r
rappdirs::user_data_dir(appname = 'keypr')
```
to find the value on your system.
## Examples
### Adding records
Add a google login-password pair:
```sh
$ keypr add [email protected] -p google_pass Google
```
And another one, but this time do not specify a password explictly -- it will be
generated (use `-s` to create a stronger password containing special symbols):
```sh
$ keypr add [email protected] Google
```
```
→ Generated password: 7J1F4SFvIgn4
Service "Google" is already known (login “[email protected]”). Add anyway? [Y/n]
```
Add a github R personal access token (which does not require a login):
```sh
$ keypr add -p 85a964v1ajg0592kkjfl3985802d955k4 'Github R PAT'
```
### Querying
Get all google credentials:
```sh
$ keypr get goo
```
```
service login password
Google [email protected] google_pass
Google [email protected] 7J1F4SFvIgn4
```
```sh
$ keypr get gith
```
```
service login password
Github R PAT 85a964v1ajg0592kkjfl3985802d955k4
```
The resulting passwd file would be
```sh
$ keypr config
```
```yaml
passwd_pathname: ~/Library/Application Support/keypr/passwd.yaml.gpg
```
```sh
$ gpg -d ~/Library/Application\ Support/keypr/passwd.yaml.gpg
```
```
gpg: AES256.CFB encrypted data
gpg: encrypted with 1 passphrase
Google:
- [email protected]: google_pass
- [email protected]: 7J1F4SFvIgn4
Github R PAT:
- '': 85a964v1ajg0592kkjfl3985802d955k4
```