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
+16-60Lines changed: 16 additions & 60 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,46 +1,10 @@
1
+
1
2
# Keyfactor Command Utility (kfutil)
2
3
3
4
`kfutil` is a go-lang CLI wrapper for Keyfactor Command API. It also includes other utility/helper functions around automating common Keyfactor Command operations.
4
5
5
6
#### Integration status: Production - Ready for use in production environments.
6
7
7
-
<!-- toc -->
8
-
9
-
-[About the Keyfactor API Client](#about-the-keyfactor-api-client)
10
-
-[Support for Keyfactor Command Utility (kfutil)](#support-for-keyfactor-command-utility-kfutil)
+[Bulk create cert store types](#bulk-create-cert-store-types)
29
-
*[Root of Trust](#root-of-trust)
30
-
+[Quickstart](#quickstart-1)
31
-
+[Generate Certificate List Template](#generate-certificate-list-template)
32
-
+[Generate Certificate Store List Template](#generate-certificate-store-list-template)
33
-
+[Run Root of Trust Audit](#run-root-of-trust-audit)
34
-
+[Run Root of Trust Reconcile](#run-root-of-trust-reconcile)
35
-
*[Certificate Store Inventory](#certificate-store-inventory)
36
-
+[Show the inventory of a certificate store](#show-the-inventory-of-a-certificate-store)
37
-
+[Add certificates to certificate stores](#add-certificates-to-certificate-stores)
38
-
+[Remove certificates from certificate stores](#remove-certificates-from-certificate-stores)
39
-
-[Development](#development)
40
-
*[Adding a new command](#adding-a-new-command)
41
-
42
-
<!-- tocstop -->
43
-
44
8
## About the Keyfactor API Client
45
9
46
10
This API client allows for programmatic management of Keyfactor resources.
@@ -49,7 +13,14 @@ This API client allows for programmatic management of Keyfactor resources.
49
13
50
14
Keyfactor Command Utility (kfutil) is open source and supported on best effort level for this tool/library/client. This means customers can report Bugs, Feature Requests, Documentation amendment or questions as well as requests for customer information required for setup that needs Keyfactor access to obtain. Such requests do not follow normal SLA commitments for response or resolution. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com/
51
15
52
-
[!NOTE] To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.
16
+
###### To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.
17
+
18
+
---
19
+
20
+
21
+
---
22
+
23
+
53
24
54
25
## Quickstart
55
26
@@ -170,45 +141,29 @@ kfutil logout
170
141
171
142
#### Bulk create cert stores
172
143
173
-
For full documentation, see [stores import](docs/kfutil_stores_import.md). For a full user-interactive guide, see the
kfutil stores import csv --file <file name to import>
150
+
kfutil stores import create --file <file name to import> --store-type-id <store type id> --store-type-name <store type name> --results-path <filepath for results> --dry-run <check fields only> [flags]
181
151
```
182
152
183
153
```bash
184
-
kfutil stores import --help
185
-
Toolsfor generating import templates and importing certificate stores
154
+
kfutil stores import --help
155
+
Toolfor generating import templates and importing certificate stores
186
156
187
157
Usage:
188
158
kfutil stores import [command]
189
159
190
160
Available Commands:
191
-
csvCreate certificate stores from CSV file.
161
+
create Create certificate stores
192
162
generate-template For generating a CSV template with headers for bulk store creation.
193
163
194
164
Flags:
195
165
-h, --help helpfor import
196
166
197
-
Global Flags:
198
-
--api-path string API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
199
-
--auth-provider-profile string The profile to use defined in the securely stored config. If not specified the config named 'default' will be used if it exists. (default "default")
200
-
--auth-provider-type string Provider type choices: (azid)
201
-
--config string Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
202
-
--debug Enable debugFlag logging.
203
-
--domain string Domain to use for authenticating to Keyfactor Command.
204
-
--exp Enable expEnabled features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
205
-
--format text How to format the CLI output. Currently only text is supported. (default "text")
206
-
--hostname string Hostname to use for authenticating to Keyfactor Command.
207
-
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
208
-
--password string Password to use forauthenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword herein plain text.
209
-
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
210
-
--username string Username to use for authenticating to Keyfactor Command.
211
-
212
167
Use "kfutil stores import [command] --help"for more information about a command.
213
168
```
214
169
@@ -251,7 +206,7 @@ For full documentation, see [stores rot](docs/kfutil_stores_rot.md).
251
206
The root of trust (rot) utility is a tool that allows you to bulk manage Keyfactor certificate stores and ensure that a
252
207
set of defined certificates are present in each store that meets a certain set of criteria or no criteria at all.
0 commit comments