Skip to content

Commit b8740f5

Browse files
doebrowskdoebrowsk
authored
Merge pull request #83 from Keyfactor/ab#72413
Ab#72413
2 parents 17c9034 + f62d4ab commit b8740f5

File tree

3 files changed

+33
-26
lines changed

3 files changed

+33
-26
lines changed

‎CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
v2.11.3
2+
- Change returned result of a Management-Create job for a store that already exists from 'Failure' to 'Warning'
3+
4+
v2.11.2
5+
- Documentation updates
6+
17
v2.11.1
28
- Bug Fix: added ability to set SSH port when managing Linux servers to Discovery jobs
39
- Added "@" as a valid character for Linux file paths

‎README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -158,15 +158,15 @@ Please consult with your system administrator for more information on configurin
158158

159159
## Certificate Store Types
160160

161-
To use the Remote File Universal Orchestrator extension, you **must** create the Certificate Store Types required for your usecase. This only needs to happen _once_ per Keyfactor Command instance.
161+
To use the Remote File Universal Orchestrator extension, you **must** create the Certificate Store Types required for your use-case. This only needs to happen _once_ per Keyfactor Command instance.
162162

163163
The Remote File Universal Orchestrator extension implements 6 Certificate Store Types. Depending on your use case, you may elect to use one, or all of these Certificate Store Types.
164164

165165
### RFJKS
166166

167-
168167
<details><summary>Click to expand details</summary>
169168

169+
170170
The `RFJKS` store type can be used to manage java keystores of types `JKS` or `PKCS12`. If creating a new java keystore
171171
and adding a certificate all via Keyfactor Command, the created java keystore will be of type `PKCS12`, as java keystores
172172
of type `JKS` have been deprecated as of `JDK 9`.
@@ -177,6 +177,8 @@ of type `JKS` have been deprecated as of `JDK 9`.
177177
3. A mix of trust and key entries.
178178

179179

180+
181+
180182
#### Supported Operations
181183

182184
| Operation | Is Supported |
@@ -190,7 +192,7 @@ of type `JKS` have been deprecated as of `JDK 9`.
190192
#### Store Type Creation
191193

192194
##### Using kfutil:
193-
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to created certificate store types.
195+
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
194196
For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart)
195197
<details><summary>Click to expand RFJKS kfutil details</summary>
196198

@@ -271,15 +273,14 @@ the Keyfactor Command Portal
271273

272274
![RFJKS Custom Fields Tab](docsource/images/RFJKS-custom-fields-store-type-dialog.png)
273275

274-
275276
</details>
276277
</details>
277278

278279
### RFPEM
279280

280-
281281
<details><summary>Click to expand details</summary>
282282

283+
283284
The `RFPEM` store type can be used to manage `PEM` encoded files.
284285

285286
#### Supported use cases
@@ -295,6 +296,8 @@ The `RFPEM` store type can be used to manage `PEM` encoded files.
295296
- Store password *MUST* be set to `No Password` if managing a store with a `PKCS#1` private key, as encrypted `PKCS#1` keys are not supported with this integration.
296297

297298

299+
300+
298301
#### Supported Operations
299302

300303
| Operation | Is Supported |
@@ -308,7 +311,7 @@ The `RFPEM` store type can be used to manage `PEM` encoded files.
308311
#### Store Type Creation
309312

310313
##### Using kfutil:
311-
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to created certificate store types.
314+
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
312315
For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart)
313316
<details><summary>Click to expand RFPEM kfutil details</summary>
314317

@@ -393,15 +396,14 @@ the Keyfactor Command Portal
393396

394397
![RFPEM Custom Fields Tab](docsource/images/RFPEM-custom-fields-store-type-dialog.png)
395398

396-
397399
</details>
398400
</details>
399401

400402
### RFPkcs12
401403

402-
403404
<details><summary>Click to expand details</summary>
404405

406+
405407
The `RFPkcs12` store type can be used to manage any `PKCS#12` compliant file format INCLUDING java keystores of type `PKCS12`.
406408

407409
#### Supported use cases
@@ -415,6 +417,8 @@ The `RFPkcs12` store type can be used to manage any `PKCS#12` compliant file for
415417
2. Multiple key and/or trust entries with blank friendly names/aliases
416418

417419

420+
421+
418422
#### Supported Operations
419423

420424
| Operation | Is Supported |
@@ -428,7 +432,7 @@ The `RFPkcs12` store type can be used to manage any `PKCS#12` compliant file for
428432
#### Store Type Creation
429433

430434
##### Using kfutil:
431-
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to created certificate store types.
435+
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
432436
For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart)
433437
<details><summary>Click to expand RFPkcs12 kfutil details</summary>
434438

@@ -509,22 +513,23 @@ the Keyfactor Command Portal
509513

510514
![RFPkcs12 Custom Fields Tab](docsource/images/RFPkcs12-custom-fields-store-type-dialog.png)
511515

512-
513516
</details>
514517
</details>
515518

516519
### RFDER
517520

518-
519521
<details><summary>Click to expand details</summary>
520522

523+
521524
The `RFDER` store type can be used to manage DER encoded files.
522525

523526
#### Supported use cases
524527
1. Single certificate stores with private key in an external file.
525528
2. Single certificate stores with no private key.
526529

527530

531+
532+
528533
#### Supported Operations
529534

530535
| Operation | Is Supported |
@@ -538,7 +543,7 @@ The `RFDER` store type can be used to manage DER encoded files.
538543
#### Store Type Creation
539544

540545
##### Using kfutil:
541-
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to created certificate store types.
546+
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
542547
For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart)
543548
<details><summary>Click to expand RFDER kfutil details</summary>
544549

@@ -620,15 +625,14 @@ the Keyfactor Command Portal
620625

621626
![RFDER Custom Fields Tab](docsource/images/RFDER-custom-fields-store-type-dialog.png)
622627

623-
624628
</details>
625629
</details>
626630

627631
### RFKDB
628632

629-
630633
<details><summary>Click to expand details</summary>
631634

635+
632636
The `RFKDB` store type can be used to manage IBM Key Database Files (`KDB`) files. The IBM utility, `GSKCAPICMD`, is used
633637
to read and write certificates from and to the target store and is therefore required to be installed on the server where
634638
each `KDB` certificate store being managed resides, and its location MUST be in the system `$Path`.
@@ -639,6 +643,8 @@ each `KDB` certificate store being managed resides, and its location MUST be in
639643
3. A mix of trust and key entries.
640644

641645

646+
647+
642648
#### Supported Operations
643649

644650
| Operation | Is Supported |
@@ -652,7 +658,7 @@ each `KDB` certificate store being managed resides, and its location MUST be in
652658
#### Store Type Creation
653659

654660
##### Using kfutil:
655-
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to created certificate store types.
661+
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
656662
For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart)
657663
<details><summary>Click to expand RFKDB kfutil details</summary>
658664

@@ -733,15 +739,14 @@ the Keyfactor Command Portal
733739

734740
![RFKDB Custom Fields Tab](docsource/images/RFKDB-custom-fields-store-type-dialog.png)
735741

736-
737742
</details>
738743
</details>
739744

740745
### RFORA
741746

742-
743747
<details><summary>Click to expand details</summary>
744748

749+
745750
The `RFORA` store type can be used to manage `PKCS12` Oracle Wallets.
746751

747752
> NOTE: This should work for `PKCS12` Oracle Wallets installed on both Windows and Linux servers, this has only been tested on wallets installed on Windows.
@@ -753,6 +758,8 @@ The `RFORA` store type can be used to manage `PKCS12` Oracle Wallets.
753758
3. A mix of trust and key entries.
754759

755760

761+
762+
756763
#### Supported Operations
757764

758765
| Operation | Is Supported |
@@ -766,7 +773,7 @@ The `RFORA` store type can be used to manage `PKCS12` Oracle Wallets.
766773
#### Store Type Creation
767774

768775
##### Using kfutil:
769-
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to created certificate store types.
776+
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
770777
For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart)
771778
<details><summary>Click to expand RFORA kfutil details</summary>
772779

@@ -848,7 +855,6 @@ the Keyfactor Command Portal
848855

849856
![RFORA Custom Fields Tab](docsource/images/RFORA-custom-fields-store-type-dialog.png)
850857

851-
852858
</details>
853859
</details>
854860

@@ -1027,7 +1033,6 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
10271033
</details>
10281034

10291035

1030-
10311036
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
10321037

10331038

@@ -1135,7 +1140,6 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
11351140
</details>
11361141

11371142

1138-
11391143
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
11401144

11411145

@@ -1235,7 +1239,6 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
12351239
</details>
12361240

12371241

1238-
12391242
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
12401243

12411244

@@ -1337,7 +1340,6 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
13371340
</details>
13381341

13391342

1340-
13411343
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
13421344

13431345

@@ -1437,7 +1439,6 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
14371439
</details>
14381440

14391441

1440-
14411442
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
14421443

14431444

@@ -1539,7 +1540,6 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
15391540
</details>
15401541

15411542

1542-
15431543
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
15441544

15451545

‎RemoteFile/ManagementBase.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ public JobResult ProcessJob(ManagementJobConfiguration config)
7979
logger.LogDebug($"BEGIN create Operation for {config.CertificateStoreDetails.StorePath} on {config.CertificateStoreDetails.ClientMachine}.");
8080
if (certificateStore.DoesStoreExist())
8181
{
82-
throw new RemoteFileException($"Certificate store {config.CertificateStoreDetails.StorePath} already exists.");
82+
logger.LogWarning($"Certificate store {config.CertificateStoreDetails.StorePath} already exists.");
83+
return new JobResult() { Result = OrchestratorJobStatusJobResult.Warning, JobHistoryId = config.JobHistoryId, FailureMessage = $"Certificate store {config.CertificateStoreDetails.StorePath} already exists. Site {config.CertificateStoreDetails.StorePath} on server {config.CertificateStoreDetails.ClientMachine}" };
8384
}
8485
else
8586
{

0 commit comments

Comments
 (0)