You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 17, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+14-11Lines changed: 14 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,18 @@
1
1
# Cryptr
2
+
2
3
Cryptr is a GUI for [Hashicorp's Vault](https://www.vaultproject.io/).
3
4
4
-
Using Cryptr, a user may easily interact with their Vault instance's API: reading, creating, and modifying secrets with ease.
5
+
Using Cryptr, a user may manage secrets in their Vault instance: reading, creating, and modifying secrets with ease.
5
6
6
7

7
8
8
9
## Download Binaries
9
10
10
-
Current release can be [downloaded here](https://github.com/adobe/cryptr/releases).
11
-
Cryptr supports Windows, Linux and Mac OS. It has been tested on Windows 10, Ubuntu 17.04 Desktop, and macOS 10.13 High Sierra.
11
+
The current release can be [downloaded here](https://github.com/adobe/cryptr/releases).
12
+
13
+
Cryptr supports Windows, Linux and macOS. It has been tested on Windows 10, Ubuntu 17.04 Desktop, and macOS 10.15 Catalina.
14
+
15
+
On macOS, you may be warned about untrusted developers when you first attempt to launch Cryptr. To resolve this, open Finder, navigate to Applications, right-click on Cryptr.app and click Open. You can then confirm you want to allow Cryptr to be opened.
12
16
13
17
For *Linux*, use the `.AppImage` files. They are self-contained binaries that run on every major linux distro. Just make it executable and run it. [AppImage information here!](https://appimage.org/)
14
18
@@ -21,6 +25,7 @@ brew cask install cryptr
21
25
```
22
26
23
27
## Building from Source
28
+
24
29
You only need to do this if you want to contribute code, or run Cryptr in developer mode. (For Linux binaries, see above).
25
30
26
31
```
@@ -33,23 +38,21 @@ npm run dev
33
38
## Unique Features
34
39
35
40
In addition to the default feature-set of Vault, Cryptr adds some things that are "nice to have". Some of these include:
36
-
- Secrets can be files
41
+
42
+
- Files can be uploaded and downloaded directly to and from the filesystem. This includes both text and binary files.
43
+
- A "share secret" features allows one user to send another user a time-limited self-destructing secret. This can be useful to send a secret to a friend without needing to change the receiving party's access in Vault.
37
44
- Underscores in key names show as whitespace. ie. `secret/My_cool_Secret` shows up in the folder structure as `My cool Secret`
38
-
-Ability to move secrets.
45
+
-Secrets can be easily moved or renamed using a friendly UI.
39
46
40
47
## License
41
48
Apache 2.0 License
42
49
43
-
## HTTPS
44
-
Cryptr will ONLY access Vault servers enabled with HTTPS. These are your secrets. Keep them secret, keep them safe.
45
-
46
-
The only exception to this is a dev server running locally at `http://127.0.0.1:<port>`. Cryptr's URL field will automatically change to contain a `http://` prefix when `127.0.0.1:` is input. (Note the colon, which is required for the prefix to change. A port number provided after the colon is also required. For reference, a default Vault dev server is started on port 8200)
47
-
48
50
### Auth backends
49
-
Currently LDAP, UserPass and Token auth backends are accepted. Most others are not useful for a GUI, but if you feel otherwise, submit a pull request.
50
51
52
+
Currently LDAP, UserPass and Token auth backends are accepted. Most others are not useful for a GUI, but if you feel otherwise, submit a pull request or open an issue.
51
53
52
54
# Important Notes about Policies
55
+
53
56
## Secret Discovery
54
57
55
58
Cryptr requires that policies associated with a token to be readable by that token. The purpose for this is to discover what secrets are available to the token. An example ACL for a policy found at `sys/policy/demo` would be as follows:
0 commit comments