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
Copy file name to clipboardExpand all lines: README.md
+46-5Lines changed: 46 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Conceal <!-- omit in toc -->
2
2
3
-
Conceal is a command-line utility that eases the interaction between developer and OSX Keychain Access. It is the open-source companion to [Summon](https://cyberark.github.io/summon) as every secret added using this tool into Keychain is added using Summon-compliant formatting.
3
+
Conceal is a command-line utility that eases the interaction between developer and OSX Keychain Access. It is the open-source companion to [Summon](https://cyberark.github.io/summon) as every secret added using this tool into Keychain is added using Summon-compliant formatting. If you don't plan on using Summon, it's still a great Keychain management tool.
@@ -11,9 +11,12 @@ Conceal is a command-line utility that eases the interaction between developer a
11
11
-[Manual](#manual)
12
12
-[Usage](#usage)
13
13
-[Add a secret](#add-a-secret)
14
+
-[Update a secret](#update-a-secret)
14
15
-[Get a secret value](#get-a-secret-value)
15
16
-[List Summon secrets](#list-summon-secrets)
16
17
-[Remove a secret](#remove-a-secret)
18
+
-[Install Conceal as Summon Provider](#install-conceal-as-summon-provider)
19
+
-[Show a secret](#show-a-secret)
17
20
-[Display Help](#display-help)
18
21
-[Display Version](#display-version)
19
22
-[keychain Package](#keychain-package)
@@ -22,6 +25,8 @@ Conceal is a command-line utility that eases the interaction between developer a
22
25
-[func DeleteSecret](#func--deletesecret)
23
26
-[func ListSecrets](#func--listsecrets)
24
27
-[func SecretExists](#func--secretexists)
28
+
-[func UpdateSecret](#func--updatesecret)
29
+
-[func GetSecret](#func--getsecret)
25
30
-[clipboard Package](#clipboard-package)
26
31
-[Usage](#usage-2)
27
32
-[func Secret](#func--secret)
@@ -55,7 +60,7 @@ brew install conceal
55
60
56
61
### Manual
57
62
58
-
1. Download the latest release available at [GitHub Releases](https://github.com/infamousjoeg/go-conceal/releases).
63
+
1. Download the latest release available at [GitHub Releases](https://github.com/infamousjoeg/conceal/releases).
59
64
2. Move the `conceal` executable file to a directory in your `PATH`. (I use `~/bin`.)
60
65
3. In Terminal, run the following command to make sure it's in your `PATH`: \
61
66
`$ conceal`
@@ -65,8 +70,16 @@ brew install conceal
65
70
### Add a secret
66
71
67
72
`$ conceal set dockerhub/token`
73
+
`$ echo "my-secret-value" | conceal set dockerhub/token`
68
74
69
-
To add a secret to Keychain, call `conceal` and use the `set` command to pass the account name to add. You will be immediately prompted to provide a secret value in a secure manner.
75
+
To add a secret to Keychain, call `conceal` and use the `set` command to pass the account name to add. You will be immediately prompted to provide a secret value in a secure manner or you can provide it via STDIN.
To update a secret in Keychain, call `conceal` and use the `update` command to pass the account name to update. You will be immediately prompted to provide a secret value in a secure manner or you can provide it via STDIN.
70
83
71
84
### Get a secret value
72
85
@@ -88,6 +101,20 @@ To filter the list further, pipe to `grep` like this `$ conceal list | grep dock
88
101
89
102
To remove a secret that was added for Summon, call `conceal` and use the `unset` command to pass the account name to remove.
90
103
104
+
### Install Conceal as Summon Provider
105
+
106
+
`$ conceal summon install`
107
+
108
+
To install Conceal as a Summon provider, call `conceal` with the `summon install` command. This will install `conceal` as an available provider for Summon under the name `conceal_summon`. For more information about Summon's providers, check out the documentation at [cyberark.github.io/summon](https://cyberark.github.io/summon).
109
+
110
+
### Show a secret
111
+
112
+
**Note: This command is not recommended for use in scripts as it will print the secret to the terminal. It is only available for the Summon provider integration.**
113
+
114
+
`$ conceal show dockerhub/token`
115
+
116
+
To display a secret from Keychain to STDOUT, call `conceal` and use the `show` command to pass the account name to display. This is useful for debugging and testing purposes. It is used by Summon to retrieve the secret value from the `conceal_summon` provider.
117
+
91
118
### Display Help
92
119
93
120
`$ conceal help`
@@ -125,7 +152,7 @@ keychain.
125
152
```go
126
153
func DeleteSecret(secretID string)
127
154
```
128
-
DeleteSecret is a non-return function that removes the secret from keychain
155
+
DeleteSecret is a non-return function that removes the secret from keychain.
129
156
130
157
#### func ListSecrets
131
158
@@ -140,7 +167,21 @@ the label `summon`.
140
167
```go
141
168
func SecretExists(secretID string) bool
142
169
```
143
-
SecretExists is a boolean function to verify a secret is present in keychain
170
+
SecretExists is a boolean function to verify a secret is present in keychain.
171
+
172
+
#### func UpdateSecret
173
+
174
+
```go
175
+
func UpdateSecret(secretID string, secret []byte)
176
+
```
177
+
UpdateSecret is a non-return function that updates the secret value in keychain.
178
+
179
+
#### func GetSecret
180
+
181
+
```go
182
+
func GetSecret(secretID string, delivery string)
183
+
```
184
+
GetSecret is a non-return function that retrieves the secret value from keychain and delivers it in the declared method. If `delivery` is set to `clipboard`, the secret value is copied to the clipboard. If a signal interrupt is detected, the content is immediately cleared. If `delivery` is set to `stdout`, the secret value is printed to the terminal.
0 commit comments