summaryrefslogtreecommitdiff
path: root/README
blob: 0ab4de6ac22a5081168a14e3e66845cc1cada749 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
kasi ("veil"/"conceal" in Esperanto)
====================================
A simple password manager written in POSIX shell.

Dependencies
------------
- POSIX-compliant environment
- age, gnupg, or any other utility to {en,de}crypt files
- tree (for listing all your passwords and their directories)
  - a simple version is available in https://github.com/pyr/tree
    and in OpenBSD's ports
  - can possibly be replaced with ls if you add KASI_LIST in your ~/.profile
- xsel (for copying password to clipboard, but can be changed to a different
        command with the KASI_CLIPBOARD command that accepts stdin)
- a password generator
  - script uses contrib/random from this repo by default and expects it in your
  path
  - can change by setting KASI_GEN_USER and KASI_GEN_PASS in your ~/.profile

Configuration
-------------
In your ~/.profile or wherever you set environment variables, add something
like this if you use age:
export AGE_KEY=/nas/ssh/id_ed25519
export AGE_PUB=${AGE_KEY}.pub
export KASI_DIR=/nas/kasi-age
export KASI_ENCRYPT="age -R $AGE_PUB"
export KASI_DECRYPT="age -d -i $AGE_KEY -o -"

If you use GnuPG, then add:
export GPG_ID="user@email.tld" # or your key id
export KASI_DECRYPT="gpg -qd"
export KASI_ENCRYPT="gpg -er $GPG_ID -o -"

For some other file encryptor, you'd need to be able to output the encrypted
file to stdout or change the last line of edit() that runs $KASI_ENCRYPT.

Why should I use this over password-store?
------------------------------------------
Don't. For a serious answer, it's because this doesn't depend on bash.

Migrating from password-store
-----------------------------
Set the KASI_DIR environment variable to your password store directory.

Auto-complete
-------------
If you use ksh, all you'd have to do is source contrib/autocomplete.ksh in your
kshrc.