Skip to content

Commit 112fae0

Browse files
committed
chore: Update conceal package to version 4.0.0
1 parent fbdb840 commit 112fae0

File tree

2 files changed

+47
-5
lines changed

2 files changed

+47
-5
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
bin/

README.md

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Conceal <!-- omit in toc -->
22

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.
44

55
[![](https://github.com/infamousjoeg/conceal/workflows/Go/badge.svg?branch=master)](https://github.com/infamousjoeg/conceal/actions?query=workflow%3AGo) [![](https://img.shields.io/github/downloads/infamousjoeg/conceal/latest/total?color=blue&label=Download%20Latest%20Release&logo=github)](https://github.com/infamousjoeg/conceal/releases/latest)
66

@@ -11,9 +11,12 @@ Conceal is a command-line utility that eases the interaction between developer a
1111
- [Manual](#manual)
1212
- [Usage](#usage)
1313
- [Add a secret](#add-a-secret)
14+
- [Update a secret](#update-a-secret)
1415
- [Get a secret value](#get-a-secret-value)
1516
- [List Summon secrets](#list-summon-secrets)
1617
- [Remove a secret](#remove-a-secret)
18+
- [Install Conceal as Summon Provider](#install-conceal-as-summon-provider)
19+
- [Show a secret](#show-a-secret)
1720
- [Display Help](#display-help)
1821
- [Display Version](#display-version)
1922
- [keychain Package](#keychain-package)
@@ -22,6 +25,8 @@ Conceal is a command-line utility that eases the interaction between developer a
2225
- [func DeleteSecret](#func--deletesecret)
2326
- [func ListSecrets](#func--listsecrets)
2427
- [func SecretExists](#func--secretexists)
28+
- [func UpdateSecret](#func--updatesecret)
29+
- [func GetSecret](#func--getsecret)
2530
- [clipboard Package](#clipboard-package)
2631
- [Usage](#usage-2)
2732
- [func Secret](#func--secret)
@@ -55,7 +60,7 @@ brew install conceal
5560

5661
### Manual
5762

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).
5964
2. Move the `conceal` executable file to a directory in your `PATH`. (I use `~/bin`.)
6065
3. In Terminal, run the following command to make sure it's in your `PATH`: \
6166
`$ conceal`
@@ -65,8 +70,16 @@ brew install conceal
6570
### Add a secret
6671

6772
`$ conceal set dockerhub/token`
73+
`$ echo "my-secret-value" | conceal set dockerhub/token`
6874

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.
76+
77+
### Update a secret
78+
79+
`$ conceal update dockerhub/token`
80+
`$ echo "my-new-secret-value" | conceal update dockerhub/token`
81+
82+
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.
7083

7184
### Get a secret value
7285

@@ -88,6 +101,20 @@ To filter the list further, pipe to `grep` like this `$ conceal list | grep dock
88101

89102
To remove a secret that was added for Summon, call `conceal` and use the `unset` command to pass the account name to remove.
90103

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+
91118
### Display Help
92119

93120
`$ conceal help`
@@ -125,7 +152,7 @@ keychain.
125152
```go
126153
func DeleteSecret(secretID string)
127154
```
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.
129156

130157
#### func ListSecrets
131158

@@ -140,7 +167,21 @@ the label `summon`.
140167
```go
141168
func SecretExists(secretID string) bool
142169
```
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.
144185

145186
## clipboard Package
146187

0 commit comments

Comments
 (0)