Skip to content

Commit 303cd59

Browse files
committed
README updates
1 parent 1becb48 commit 303cd59

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,17 +102,20 @@ Add to your `.[bash | zsh | whatever]rc`: `alias cpt=cryptorious`
102102
## Step 1: Generate keys
103103

104104
```
105-
cryptorious generate
105+
cryptorious generate keys
106106
```
107107

108108
Defaults to placing keys in ```$HOME/.ssh/cryptorious_privatekey``` and ```$HOME/.ssh/cryptorious_publickey```.
109109

110110
You can override this with ```--private-key``` and ```--public-key```:
111111

112112
```
113-
cryptorious generate --private-key foo_priv --public-key foo_pub
113+
cryptorious generate keys --private-key foo_priv --public-key foo_pub
114114
```
115115

116+
### Lock It Down
117+
If you want to win extra security stars, lock down your keys with root ownership. By default they're already read/write by the user who ran the `cryptorious` command (0600), but you can increase this security more with `chmod root:root ~/.ssh/cryptorious_privatekey`. Now you'll have to run `cryptorious` with `sudo` and enter in your root password (ugh, passwords..) every time.
118+
116119
## Step 2: Encrypt
117120

118121
```
@@ -136,6 +139,11 @@ cryptorious decrypt -[c]opy thing
136139
```
137140
No printing, just a message that your decrypted password is now available in the paste buffer for your user.
138141

142+
If you've saved your vault entries with the URI of the site they belong to (i.e., ran `cryptorious encrypt github.com`...) then you can use the `-[g]oto` flag to open your default browser to this URI. Pair it with `-[c]opy` and the shorthand for `[d]ecrypt` and you'll have a fast way of navigating directly to your desired, secure website (let's also assume you've aliased `cpt=cryptorious`):
143+
```
144+
cpt d -g -c github.com
145+
```
146+
139147
## Step 4: Rotate Keys & Vault
140148
Compromised your keys? Not a problem.
141149

@@ -148,3 +156,12 @@ cryptorious rotate
148156
1. Generates new keys to `keyPath`
149157
1. Decrypts vault using `privateKey.bak` and encrypts vault in place with new `privateKey`
150158
1. Writes the vault back to disk at `vaultPath`
159+
160+
## Step 5: Generate Secure Password
161+
The `generate` command also lets you generate random, secure passwords of `n` length:
162+
```
163+
cryptorious generate password --length 20
164+
(yZkj,GX`w7T4x&TaYyw
165+
```
166+
167+
This defaults to a length of 15 if you don't pass --[l]ength.

0 commit comments

Comments
 (0)