Skip to content

Commit 547402c

Browse files
malnickmalnick
committed
Update readme
1 parent ab2fef1 commit 547402c

File tree

2 files changed

+38
-85
lines changed

2 files changed

+38
-85
lines changed

‎README.md

Lines changed: 38 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,50 @@
11
# [![CircleCI](https://circleci.com/gh/malnick/cryptorious.svg?style=svg)](https://circleci.com/gh/malnick/cryptorious)
22

3-
Like 1Password but for the CLI. Stores your encrypted data in eyaml using generic SSH keys as the basis for encryption/decryption so you never have to type a password to get your passwords ever again.
4-
5-
## Download
6-
### Linux
7-
- AMD64 | [v1.2.1](https://dl.dropboxusercontent.com/u/77193293/tools/cryptorious_1.2.1)
8-
- AMD64 | [v1.2.0](https://dl.dropboxusercontent.com/u/77193293/tools/cryptorious_1.2.0)
9-
- AMD64 | [v1.1.0](https://dl.dropboxusercontent.com/u/77193293/tools/cryptorious_1.1.0)
10-
- AMD64 | [v1.0.0](https://dl.dropboxusercontent.com/u/77193293/tools/cryptorious)
11-
12-
### Darwin (OSx)
13-
- AMD64 | [v1.2.1](https://dl.dropboxusercontent.com/u/77193293/tools/cryptorious_1.2.1_darwin)
3+
Like 1Password but for the CLI.
144

155
## Manpage
166
### Main Menu
177
```
18-
NAME:
19-
20-
_________ __ .__
8+
_________ __ .__
219
\_ ___ \ _______ ___.__.______ _/ |_ ____ _______ |__| ____ __ __ ______
2210
/ \ \/ \_ __ \< | |\____ \ \ __\ / _ \ \_ __ \| | / _ \ | | \ / ___/
23-
\ \____ | | \/ \___ || |_> > | | ( <_> ) | | \/| |( <_> )| | / \___ \
11+
\ \____ | | \/ \___ || |_> > | | ( <_> ) | | \/| |( <_> )| | / \___ \
2412
\______ / |__| / ____|| __/ |__| \____/ |__| |__| \____/ |____/ /____ >
25-
\/ \/ |__| \/
13+
\/ \/ |__| \/
2614
- CLI-based encryption for passwords and random data
2715
2816
USAGE:
2917
cryptorious [global options] command [command options] [arguments...]
30-
31-
VERSION:
32-
1.2.1
33-
18+
3419
AUTHOR(S):
35-
Jeff Malnick <malnick@gmail.com>
36-
20+
Jeff Malnick <malnick@gmail.com>
21+
3722
COMMANDS:
38-
rename Rename an entry in the vault
39-
rotate Rotate your cryptorious SSH keys and vault automatically
40-
delete Remove an entry from the cryptorious vault
41-
decrypt Decrypt a value in the vault `VALUE`
42-
encrypt Encrypt a value for the vault `VALUE`
43-
generate Generate a RSA keys or a secure password.
23+
rename Rename an entry in the vault
24+
delete Remove an entry from the cryptorious vault
25+
decrypt Decrypt a value in the vault `VALUE`
26+
encrypt Encrypt a value for the vault `VALUE`
27+
generate Generate a RSA keys or a secure password.
4428
4529
GLOBAL OPTIONS:
46-
--vault-path, --vp "/home/malnick/.cryptorious/vault.yaml" Path to vault.yaml
47-
--private-key, --priv "/home/malnick/.ssh/cryptorious_privatekey" Path to private key
48-
--public-key, --pub "/home/malnick/.ssh/cryptorious_publickey" Path to public key
49-
--debug Debug/Verbose log output
50-
--help, -h Show help
51-
--version, -v Print the version
30+
--vault-path, --vp "/Users/malnick/.cryptorious/vault.yaml" Path to vault.yaml.
31+
--debug Debug/Verbose log output.
32+
--help, -h show help
33+
--version, -v print the version
34+
```
5235

36+
### Encrypt Sub Menu
5337
```
38+
NAME:
39+
encrypt - Encrypt a value for the vault `VALUE`
40+
41+
USAGE:
42+
encrypt [command options] [arguments...]
43+
44+
OPTIONS:
45+
--key-arn KMS key ARN
46+
```
47+
5448
### Decrypt Sub Menu
5549
```
5650
NAME:
@@ -64,6 +58,7 @@ OPTIONS:
6458
--goto, -g Open your default browser to https://<key_name> and login automatically
6559
--timeout, -t "10" Timeout in seconds for the decrypt session window to expire
6660
```
61+
6762
### Rename Sub Menu
6863
```
6964
NAME:
@@ -76,6 +71,7 @@ OPTIONS:
7671
--old, -o Name of old entry name [key] in vault
7772
--new, -n Name of new entry name [key] in vault
7873
```
74+
7975
### Generate Sub Menu
8076
```
8177
NAME:
@@ -85,8 +81,7 @@ USAGE:
8581
generate command [command options] [arguments...]
8682
8783
COMMANDS:
88-
keys Generate SSH key pair for cryptorious
89-
password [--[l]ength] Generate a random password
84+
password [--[l]ength] Generate a random password
9085
9186
OPTIONS:
9287
--help, -h show help
@@ -99,36 +94,25 @@ Build it and install: `make install`
9994

10095
Add to your `.[bash | zsh | whatever]rc`: `alias cpt=cryptorious`
10196

102-
## Step 1: Generate keys
97+
## Step 1: Add KMS keys to AWS
98+
NOTE: will add cmd for this soon
10399

104-
```
105-
cryptorious generate keys
106-
```
107-
108-
Defaults to placing keys in ```$HOME/.ssh/cryptorious_privatekey``` and ```$HOME/.ssh/cryptorious_publickey```.
109-
110-
You can override this with ```--private-key``` and ```--public-key```:
111-
112-
```
113-
cryptorious generate keys --private-key foo_priv --public-key foo_pub
114-
```
115-
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.
100+
In your own AWS account, add a KMS key and grant your IAM user access.
118101

119102
## Step 2: Encrypt
103+
NOTE: will add flag for AWS profile soon
120104

105+
Use your AWS profile and encrypt some data:
121106
```
122-
cryptorious encrypt github
107+
AWS_PROFILE=personal cryptorious encrypt --key-arn=<my_kms_key_arn> github.com
123108
```
124109

125110
Will open a ncurses window and prompt you for username, password and a secure note. All input is optional.
126111

127-
128112
## Step 3: Decrypt
129113

130114
```
131-
cryptorious decrypt thing
115+
AWS_PROFILE=personal cryptorious decrypt thing
132116
```
133117

134118
Will open a ncurses window with the decrypted vault entry.
@@ -144,19 +128,6 @@ If you've saved your vault entries with the URI of the site they belong to (i.e.
144128
cpt d -g -c github.com
145129
```
146130

147-
## Step 4: Rotate Keys & Vault
148-
Compromised your keys? Not a problem.
149-
150-
```
151-
cryptorious rotate
152-
```
153-
154-
1. Backs up your old keys to `keyPath.bak`
155-
1. Backs up your old vault to `vaultPath.bak`
156-
1. Generates new keys to `keyPath`
157-
1. Decrypts vault using `cryptorious_privatekey.bak` and encrypts vault in place with new `cryptorious_publickey`
158-
1. Writes the vault back to disk at `vaultPath`
159-
160131
## Step 5: Generate Secure Password
161132
The `generate` command also lets you generate random, secure passwords of `n` length:
162133
```

‎cli/cli.go

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ package cli
22

33
import (
44
"errors"
5-
"fmt"
65
"os"
76

87
log "github.com/Sirupsen/logrus"
@@ -60,14 +59,6 @@ func Start() error {
6059
handleError(action.RenameVaultEntry(c.String("old"), c.String("new"), config.VaultPath))
6160
},
6261
},
63-
{
64-
Name: "rotate",
65-
Usage: "Rotate your cryptorious vault",
66-
Action: func(c *cli.Context) {
67-
setLogger(config.DebugMode)
68-
handleError(action.RotateVault(config))
69-
},
70-
},
7162
{
7263
Name: "delete",
7364
Usage: "Remove an entry from the cryptorious vault",
@@ -144,15 +135,6 @@ func Start() error {
144135
Aliases: []string{"g"},
145136
Usage: "Generate a RSA keys or a secure password.",
146137
Subcommands: []cli.Command{
147-
{
148-
Name: "keys",
149-
Usage: "Generate KMS key for cryptorious",
150-
Action: func(c *cli.Context) {
151-
setLogger(config.DebugMode)
152-
fmt.Println("Generating new KMS key pair for ", c.Args().First())
153-
handleError(action.GenerateKeys(config))
154-
},
155-
},
156138
{
157139
Name: "password",
158140
Usage: "Generate a random password",

0 commit comments

Comments
 (0)