From 873b8e0d40b1d56e5a7bf77b4669fc8c218d730f Mon Sep 17 00:00:00 2001 From: Joe VanWanzeele Date: Wed, 26 Nov 2025 14:36:53 -0500 Subject: [PATCH 1/6] Added PAM resolution for Server Username and Server Password --- CHANGELOG.md | 5 ++++- .../Jobs/VmwareVcenterJob.cs | 8 ++++++-- VmwareVcenterOrchestrator/PamUtilities.cs | 17 +++++++++++++++++ integration-manifest.json | 6 +++--- 4 files changed, 30 insertions(+), 6 deletions(-) create mode 100644 VmwareVcenterOrchestrator/PamUtilities.cs diff --git a/CHANGELOG.md b/CHANGELOG.md index 8810fd6..4d25664 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,2 +1,5 @@ -v1.0.0 +- 1.0.1 +* Added PAM support for the Server Username and Server Password fields + +- 1.0.0 * Initial release diff --git a/VmwareVcenterOrchestrator/Jobs/VmwareVcenterJob.cs b/VmwareVcenterOrchestrator/Jobs/VmwareVcenterJob.cs index e206c5b..0f02a82 100644 --- a/VmwareVcenterOrchestrator/Jobs/VmwareVcenterJob.cs +++ b/VmwareVcenterOrchestrator/Jobs/VmwareVcenterJob.cs @@ -9,8 +9,10 @@ using Keyfactor.Extensions.Orchestrator.VmwareVcenterOrchestrator.Client; using Keyfactor.Logging; using Keyfactor.Orchestrators.Extensions; +using Keyfactor.Orchestrators.Extensions.Interfaces; using Microsoft.Extensions.Logging; using Newtonsoft.Json; +using VmwareVcenterOrchestrator; namespace Keyfactor.Extensions.Orchestrator.VmwareVcenterOrchestrator.Jobs { @@ -20,6 +22,8 @@ public abstract class VmwareVcenterJob : IOrchestratorJobExtension protected VmwareVcenterClient VcenterClient { get; private set; } + internal protected IPAMSecretResolver PamSecretResolver { get; set; } + protected void Initialize(CertificateStore details) { ILogger logger = LogHandler.GetReflectedClassLogger(this); @@ -28,8 +32,8 @@ protected void Initialize(CertificateStore details) dynamic properties = JsonConvert.DeserializeObject(details.Properties); string ClientMachine = details.ClientMachine; - string Username = properties.ServerUsername; - string Password = properties.ServerPassword; + string Username = PamUtilities.ResolvePAMField(PamSecretResolver, logger, "Server Username", properties.ServerUsername); + string Password = PamUtilities.ResolvePAMField(PamSecretResolver, logger, "Server Password", properties.ServerPassword); VcenterClient = new VmwareVcenterClient(ClientMachine, Username, Password); } diff --git a/VmwareVcenterOrchestrator/PamUtilities.cs b/VmwareVcenterOrchestrator/PamUtilities.cs new file mode 100644 index 0000000..80ae47e --- /dev/null +++ b/VmwareVcenterOrchestrator/PamUtilities.cs @@ -0,0 +1,17 @@ +ο»Ώusing Keyfactor.Orchestrators.Extensions.Interfaces; +using Microsoft.Extensions.Logging; + +namespace VmwareVcenterOrchestrator +{ + internal class PamUtilities + { + internal static string ResolvePAMField(IPAMSecretResolver resolver, ILogger logger, string name, string key) + { + if (resolver == null) return key; + else + { + return resolver.Resolve(key); + } + } + } +} diff --git a/integration-manifest.json b/integration-manifest.json index 9f062df..312cdf4 100644 --- a/integration-manifest.json +++ b/integration-manifest.json @@ -4,7 +4,7 @@ "orchestrator": { "UOFramework": "10.1", "keyfactor_platform_version": "10.0", - "pam_support": false, + "pam_support": true, "store_types": [ { "Name": "VMware vCenter", @@ -42,7 +42,7 @@ "DependsOn": "", "DefaultValue": "", "Required": true, - "IsPamEligable": false, + "IsPamEligable": true, "Description": "The vCenter username used to manage the vCenter connection" }, { @@ -52,7 +52,7 @@ "DependsOn": "", "DefaultValue": "", "Required": true, - "IsPamEligable": false, + "IsPamEligable": true, "Description": "The secret vCenter password used to manage the vCenter connection" } ] From 1268ed1ed575d3615bd42deedbbfbcdddd2042f8 Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Wed, 26 Nov 2025 19:39:27 +0000 Subject: [PATCH 2/6] Update generated docs --- README.md | 268 ++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 199 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index 436c596..43bfc6f 100644 --- a/README.md +++ b/README.md @@ -37,115 +37,164 @@ VMware vCenter uses certificates to secure communications between the different -### vCenter -TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info - - -TODO Overview is a required section - ## Compatibility This integration is compatible with Keyfactor Universal Orchestrator version 10.1 and later. ## Support -The VMware vCenter Universal Orchestrator extension If you have a support issue, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com. - -> 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. +The VMware vCenter Universal Orchestrator extension is supported by Keyfactor. If you require support for any issues or have feature request, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com. + +> If you want to contribute bug fixes or additional enhancements, use the **[Pull requests](../../pulls)** tab. ## Requirements & Prerequisites Before installing the VMware vCenter Universal Orchestrator extension, we recommend that you install [kfutil](https://github.com/Keyfactor/kfutil). Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command. -### VMware vCenter Requirements + +## vCenter Certificate Store Type + +To use the VMware vCenter Universal Orchestrator extension, you **must** create the vCenter Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance. + + + +TODO Overview is a required section TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + + + +#### VMware vCenter Requirements + TODO Requirements is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info +#### Supported Operations -## Create the vCenter Certificate Store Type +| Operation | Is Supported | +|--------------|------------------------------------------------------------------------------------------------------------------------| +| Add | βœ… Checked | +| Remove | βœ… Checked | +| Discovery | πŸ”² Unchecked | +| Reenrollment | πŸ”² Unchecked | +| Create | πŸ”² Unchecked | -To use the VMware vCenter Universal Orchestrator extension, you **must** create the vCenter Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance. +#### Store Type Creation +##### Using kfutil: +`kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types. +For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart) +
Click to expand vCenter kfutil details -TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + ##### Using online definition from GitHub: + This will reach out to GitHub and pull the latest store-type definition + ```shell + # VMware vCenter + kfutil store-types create vCenter + ``` + ##### Offline creation using integration-manifest file: + If required, it is possible to create store types from the [integration-manifest.json](./integration-manifest.json) included in this repo. + You would first download the [integration-manifest.json](./integration-manifest.json) and then run the following command + in your offline environment. + ```shell + kfutil store-types create --from-file integration-manifest.json + ``` +
-* **Create vCenter using kfutil**: - ```shell - # VMware vCenter - kfutil store-types create vCenter - ``` +#### Manual Creation +Below are instructions on how to create the vCenter store type manually in +the Keyfactor Command Portal +
Click to expand manual vCenter details + + Create a store type called `vCenter` with the attributes in the tables below: + + ##### Basic Tab + | Attribute | Value | Description | + | --------- | ----- | ----- | + | Name | VMware vCenter | Display name for the store type (may be customized) | + | Short Name | vCenter | Short display name for the store type | + | Capability | vCenter | Store type name orchestrator will register with. Check the box to allow entry of value | + | Supports Add | βœ… Checked | Check the box. Indicates that the Store Type supports Management Add | + | Supports Remove | βœ… Checked | Check the box. Indicates that the Store Type supports Management Remove | + | Supports Discovery | πŸ”² Unchecked | Indicates that the Store Type supports Discovery | + | Supports Reenrollment | πŸ”² Unchecked | Indicates that the Store Type supports Reenrollment | + | Supports Create | πŸ”² Unchecked | Indicates that the Store Type supports store creation | + | Needs Server | βœ… Checked | Determines if a target server name is required when creating store | + | Blueprint Allowed | βœ… Checked | Determines if store type may be included in an Orchestrator blueprint | + | Uses PowerShell | πŸ”² Unchecked | Determines if underlying implementation is PowerShell | + | Requires Store Password | πŸ”² Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. | + | Supports Entry Password | πŸ”² Unchecked | Determines if an individual entry within a store can have a password. | + + The Basic tab should look like this: + + ![vCenter Basic Tab](docsource/images/vCenter-basic-store-type-dialog.png) + + ##### Advanced Tab + | Attribute | Value | Description | + | --------- | ----- | ----- | + | Supports Custom Alias | Optional | Determines if an individual entry within a store can have a custom Alias. | + | Private Key Handling | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. | + | PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) | + + The Advanced tab should look like this: -* **Create vCenter manually in the Command UI**: -
Create vCenter manually in the Command UI + ![vCenter Advanced Tab](docsource/images/vCenter-advanced-store-type-dialog.png) - Create a store type called `vCenter` with the attributes in the tables below: + > For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX. - #### Basic Tab - | Attribute | Value | Description | - | --------- | ----- | ----- | - | Name | VMware vCenter | Display name for the store type (may be customized) | - | Short Name | vCenter | Short display name for the store type | - | Capability | vCenter | Store type name orchestrator will register with. Check the box to allow entry of value | - | Supports Add | βœ… Checked | Check the box. Indicates that the Store Type supports Management Add | - | Supports Remove | βœ… Checked | Check the box. Indicates that the Store Type supports Management Remove | - | Supports Discovery | πŸ”² Unchecked | Indicates that the Store Type supports Discovery | - | Supports Reenrollment | πŸ”² Unchecked | Indicates that the Store Type supports Reenrollment | - | Supports Create | πŸ”² Unchecked | Indicates that the Store Type supports store creation | - | Needs Server | βœ… Checked | Determines if a target server name is required when creating store | - | Blueprint Allowed | βœ… Checked | Determines if store type may be included in an Orchestrator blueprint | - | Uses PowerShell | πŸ”² Unchecked | Determines if underlying implementation is PowerShell | - | Requires Store Password | πŸ”² Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. | - | Supports Entry Password | πŸ”² Unchecked | Determines if an individual entry within a store can have a password. | + ##### Custom Fields Tab + Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type: - The Basic tab should look like this: + | Name | Display Name | Description | Type | Default Value/Options | Required | + | ---- | ------------ | ---- | --------------------- | -------- | ----------- | + | ServerUsername | Server Username | The vCenter username used to manage the vCenter connection | Secret | | βœ… Checked | + | ServerPassword | Server Password | The secret vCenter password used to manage the vCenter connection | Secret | | βœ… Checked | - ![vCenter Basic Tab](docsource/images/vCenter-basic-store-type-dialog.png) + The Custom Fields tab should look like this: - #### Advanced Tab - | Attribute | Value | Description | - | --------- | ----- | ----- | - | Supports Custom Alias | Optional | Determines if an individual entry within a store can have a custom Alias. | - | Private Key Handling | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. | - | PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) | + ![vCenter Custom Fields Tab](docsource/images/vCenter-custom-fields-store-type-dialog.png) - The Advanced tab should look like this: - ![vCenter Advanced Tab](docsource/images/vCenter-advanced-store-type-dialog.png) + ###### Server Username + The vCenter username used to manage the vCenter connection - #### Custom Fields Tab - Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type: - | Name | Display Name | Description | Type | Default Value/Options | Required | - | ---- | ------------ | ---- | --------------------- | -------- | ----------- | - | ServerUsername | Server Username | The vCenter username used to manage the vCenter connection | Secret | | βœ… Checked | - | ServerPassword | Server Password | The secret vCenter password used to manage the vCenter connection | Secret | | βœ… Checked | + > [!IMPORTANT] + > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. - The Custom Fields tab should look like this: - ![vCenter Custom Fields Tab](docsource/images/vCenter-custom-fields-store-type-dialog.png) + ###### Server Password + The secret vCenter password used to manage the vCenter connection -
+ + > [!IMPORTANT] + > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. + + + + + + +
## Installation -1. **Download the latest VMware vCenter Universal Orchestrator extension from GitHub.** +1. **Download the latest VMware vCenter Universal Orchestrator extension from GitHub.** + + Navigate to the [VMware vCenter Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/vmware-vcenter-orchestrator/releases/latest). Refer to the compatibility matrix below to determine the asset should be downloaded. Then, click the corresponding asset to download the zip archive. - Navigate to the [VMware vCenter Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/vmware-vcenter-orchestrator/releases/latest). Refer to the compatibility matrix below to determine whether the `net6.0` or `net8.0` asset should be downloaded. Then, click the corresponding asset to download the zip archive. - | Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server | `rollForward` condition in `Orchestrator.runtimeconfig.json` | `vmware-vcenter-orchestrator` .NET version to download | - | --------- | ----------- | ----------- | ----------- | - | Older than `11.0.0` | | | `net6.0` | - | Between `11.0.0` and `11.5.1` (inclusive) | `net6.0` | | `net6.0` | - | Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` | - | Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` | - | `11.6` _and_ newer | `net8.0` | | `net8.0` | + | Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server | `rollForward` condition in `Orchestrator.runtimeconfig.json` | `vmware-vcenter-orchestrator` .NET version to download | + | --------- | ----------- | ----------- | ----------- | + | Older than `11.0.0` | | | `net6.0` | + | Between `11.0.0` and `11.5.1` (inclusive) | `net6.0` | | `net6.0` | + | Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` || Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` | + | `11.6` _and_ newer | `net8.0` | | `net8.0` | Unzip the archive containing extension assemblies to a known location. @@ -155,9 +204,9 @@ TODO Global Store Type Section is an optional section. If this section doesn't s * **Default on Windows** - `C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions` * **Default on Linux** - `/opt/keyfactor/orchestrator/extensions` - + 3. **Create a new directory for the VMware vCenter Universal Orchestrator extension inside the extensions directory.** - + Create a new directory called `vmware-vcenter-orchestrator`. > The directory name does not need to match any names used elsewhere; it just has to be unique within the extensions directory. @@ -168,8 +217,14 @@ TODO Global Store Type Section is an optional section. If this section doesn't s Refer to [Starting/Restarting the Universal Orchestrator service](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/StarttheService.htm). +6. **(optional) PAM Integration** + + The VMware vCenter Universal Orchestrator extension is compatible with all supported Keyfactor PAM extensions to resolve PAM-eligible secrets. PAM extensions running on Universal Orchestrators enable secure retrieval of secrets from a connected PAM provider. + + To configure a PAM provider, [reference the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam) to select an extension and follow the associated instructions to install it on the Universal Orchestrator (remote). + -> The above installation steps can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions). +> The above installation steps can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions). @@ -181,8 +236,83 @@ TODO Global Store Type Section is an optional section. If this section doesn't s TODO Certificate Store Configuration is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info +### Store Creation + +#### Manually with the Command UI + +
Click to expand details + +1. **Navigate to the _Certificate Stores_ page in Keyfactor Command.** + + Log into Keyfactor Command, toggle the _Locations_ dropdown, and click _Certificate Stores_. + +2. **Add a Certificate Store.** + + Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form. + + | Attribute | Description | + | --------- |---------------------------------------------------------| + | Category | Select "VMware vCenter" or the customized certificate store name from the previous step. | + | Container | Optional container to associate certificate store with. | + | Client Machine | The domain name of the vSphere client managing vCenter (url to vCenter host without the 'https://'. | + | Store Path | A unique identifier for this store. The actual value is unused by the orchestrator extension | + | Orchestrator | Select an approved orchestrator capable of managing `vCenter` certificates. Specifically, one with the `vCenter` capability. | + | ServerUsername | The vCenter username used to manage the vCenter connection | + | ServerPassword | The secret vCenter password used to manage the vCenter connection | + +
+ + + +#### Using kfutil CLI + +
Click to expand details + +1. **Generate a CSV template for the vCenter certificate store** + + ```shell + kfutil stores import generate-template --store-type-name vCenter --outpath vCenter.csv + ``` +2. **Populate the generated CSV file** + + Open the CSV file, and reference the table below to populate parameters for each **Attribute**. + + | Attribute | Description | + | --------- | ----------- | + | Category | Select "VMware vCenter" or the customized certificate store name from the previous step. | + | Container | Optional container to associate certificate store with. | + | Client Machine | The domain name of the vSphere client managing vCenter (url to vCenter host without the 'https://'. | + | Store Path | A unique identifier for this store. The actual value is unused by the orchestrator extension | + | Orchestrator | Select an approved orchestrator capable of managing `vCenter` certificates. Specifically, one with the `vCenter` capability. | + | Properties.ServerUsername | The vCenter username used to manage the vCenter connection | + | Properties.ServerPassword | The secret vCenter password used to manage the vCenter connection | + +3. **Import the CSV file to create the certificate stores** + + ```shell + kfutil stores import csv --store-type-name vCenter --file vCenter.csv + ``` + +
+ + +#### PAM Provider Eligible Fields +
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator + +If a PAM provider was installed _on the Universal Orchestrator_ in the [Installation](#Installation) section, the following parameters can be configured for retrieval _on the Universal Orchestrator_. + + | Attribute | Description | + | --------- | ----------- | + | ServerUsername | The vCenter username used to manage the vCenter connection | + | ServerPassword | The secret vCenter password used to manage the vCenter connection | + +Please refer to the **Universal Orchestrator (remote)** usage section ([PAM providers on the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam)) for your selected PAM provider for instructions on how to load attributes orchestrator-side. +> Any secret can be rendered by a PAM provider _installed on the Keyfactor Command server_. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself. + +
+ -> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store). +> 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). ## Discovering Certificate Stores with the Discovery Job From d133d626cad3c41f69805e4b5fa4edd48d2132f9 Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Wed, 26 Nov 2025 19:54:26 +0000 Subject: [PATCH 3/6] Update generated docs --- README.md | 144 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 91 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index bc11d17..7f17a21 100644 --- a/README.md +++ b/README.md @@ -37,13 +37,6 @@ VMware vCenter uses certificates to secure communications between the different -### vCenter - -The certificate store type of vCenter associated with this integration implements the Inventory, Management Add, and Management Remove job types. - -The Add and Remove operations have the ability to create and remove trusted root chains and SSL certificates associated with -VMware vCenter. The certificate type is automatically identified by the orchestrator. It does not manage ESXI host certificates. - ## Compatibility This integration is compatible with Keyfactor Universal Orchestrator version 10.1 and later. @@ -59,6 +52,22 @@ Before installing the VMware vCenter Universal Orchestrator extension, we recomm +## vCenter Certificate Store Type + +To use the VMware vCenter Universal Orchestrator extension, you **must** create the vCenter Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance. + + + +The certificate store type of vCenter associated with this integration implements the Inventory, Management Add, and Management Remove job types. + +The Add and Remove operations have the ability to create and remove trusted root chains and SSL certificates associated with +VMware vCenter. The certificate type is automatically identified by the orchestrator. It does not manage ESXI host certificates. + + + + +#### Supported Operations + | Operation | Is Supported | |--------------|------------------------------------------------------------------------------------------------------------------------| | Add | βœ… Checked | @@ -74,6 +83,21 @@ Before installing the VMware vCenter Universal Orchestrator extension, we recomm For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart)
Click to expand vCenter kfutil details + ##### Using online definition from GitHub: + This will reach out to GitHub and pull the latest store-type definition + ```shell + # VMware vCenter + kfutil store-types create vCenter + ``` + + ##### Offline creation using integration-manifest file: + If required, it is possible to create store types from the [integration-manifest.json](./integration-manifest.json) included in this repo. + You would first download the [integration-manifest.json](./integration-manifest.json) and then run the following command + in your offline environment. + ```shell + kfutil store-types create --from-file integration-manifest.json + ``` +
#### Manual Creation @@ -133,10 +157,6 @@ the Keyfactor Command Portal ###### Server Username The vCenter username used to manage the vCenter connection - > For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX. - - #### Custom Fields Tab - Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type: > [!IMPORTANT] > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. @@ -207,63 +227,81 @@ the Keyfactor Command Portal -* **Manually with the Command UI** +### Store Creation + +#### Manually with the Command UI + +
Click to expand details + +1. **Navigate to the _Certificate Stores_ page in Keyfactor Command.** + + Log into Keyfactor Command, toggle the _Locations_ dropdown, and click _Certificate Stores_. + +2. **Add a Certificate Store.** + + Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form. + + | Attribute | Description | + | --------- |---------------------------------------------------------| + | Category | Select "VMware vCenter" or the customized certificate store name from the previous step. | + | Container | Optional container to associate certificate store with. | + | Client Machine | The domain name of the vSphere client managing vCenter (url to vCenter host without the 'https://'. | + | Store Path | A unique identifier for this store. The actual value is unused by the orchestrator extension | + | Orchestrator | Select an approved orchestrator capable of managing `vCenter` certificates. Specifically, one with the `vCenter` capability. | + | ServerUsername | The vCenter username used to manage the vCenter connection | + | ServerPassword | The secret vCenter password used to manage the vCenter connection | + +
+ + + +#### Using kfutil CLI -
Create Certificate Stores manually in the UI +
Click to expand details - 1. **Navigate to the _Certificate Stores_ page in Keyfactor Command.** +1. **Generate a CSV template for the vCenter certificate store** - Log into Keyfactor Command, toggle the _Locations_ dropdown, and click _Certificate Stores_. + ```shell + kfutil stores import generate-template --store-type-name vCenter --outpath vCenter.csv + ``` +2. **Populate the generated CSV file** - 2. **Add a Certificate Store.** + Open the CSV file, and reference the table below to populate parameters for each **Attribute**. - Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form. - | Attribute | Description | - | --------- | ----------- | - | Category | Select "VMware vCenter" or the customized certificate store name from the previous step. | - | Container | Optional container to associate certificate store with. | - | Client Machine | The domain name of the vSphere client managing vCenter (url to vCenter host without the 'https://'. | - | Store Path | A unique identifier for this store. The actual value is unused by the orchestrator extension | - | Orchestrator | Select an approved orchestrator capable of managing `vCenter` certificates. Specifically, one with the `vCenter` capability. | - | ServerUsername | The vCenter username used to manage the vCenter connection | - | ServerPassword | The secret vCenter password used to manage the vCenter connection | + | Attribute | Description | + | --------- | ----------- | + | Category | Select "VMware vCenter" or the customized certificate store name from the previous step. | + | Container | Optional container to associate certificate store with. | + | Client Machine | The domain name of the vSphere client managing vCenter (url to vCenter host without the 'https://'. | + | Store Path | A unique identifier for this store. The actual value is unused by the orchestrator extension | + | Orchestrator | Select an approved orchestrator capable of managing `vCenter` certificates. Specifically, one with the `vCenter` capability. | + | Properties.ServerUsername | The vCenter username used to manage the vCenter connection | + | Properties.ServerPassword | The secret vCenter password used to manage the vCenter connection | +3. **Import the CSV file to create the certificate stores** - + ```shell + kfutil stores import csv --store-type-name vCenter --file vCenter.csv + ``` -
+
-* **Using kfutil** - -
Create Certificate Stores with kfutil - - 1. **Generate a CSV template for the vCenter certificate store** - ```shell - kfutil stores import generate-template --store-type-name vCenter --outpath vCenter.csv - ``` - 2. **Populate the generated CSV file** +#### PAM Provider Eligible Fields +
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator - Open the CSV file, and reference the table below to populate parameters for each **Attribute**. - | Attribute | Description | - | --------- | ----------- | - | Category | Select "VMware vCenter" or the customized certificate store name from the previous step. | - | Container | Optional container to associate certificate store with. | - | Client Machine | The domain name of the vSphere client managing vCenter (url to vCenter host without the 'https://'. | - | Store Path | A unique identifier for this store. The actual value is unused by the orchestrator extension | - | Orchestrator | Select an approved orchestrator capable of managing `vCenter` certificates. Specifically, one with the `vCenter` capability. | - | ServerUsername | The vCenter username used to manage the vCenter connection | - | ServerPassword | The secret vCenter password used to manage the vCenter connection | +If a PAM provider was installed _on the Universal Orchestrator_ in the [Installation](#Installation) section, the following parameters can be configured for retrieval _on the Universal Orchestrator_. + | Attribute | Description | + | --------- | ----------- | + | ServerUsername | The vCenter username used to manage the vCenter connection | + | ServerPassword | The secret vCenter password used to manage the vCenter connection | - +Please refer to the **Universal Orchestrator (remote)** usage section ([PAM providers on the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam)) for your selected PAM provider for instructions on how to load attributes orchestrator-side. +> Any secret can be rendered by a PAM provider _installed on the Keyfactor Command server_. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself. - 3. **Import the CSV file to create the certificate stores** +
- ```shell - kfutil stores import csv --store-type-name vCenter --file vCenter.csv - ``` -
> 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). From 9b2a7335bb0b84f00a54de3a4a6736b43d068c18 Mon Sep 17 00:00:00 2001 From: Joe VanWanzeele Date: Wed, 26 Nov 2025 15:01:15 -0500 Subject: [PATCH 4/6] cleaned up manifest --- integration-manifest.json | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/integration-manifest.json b/integration-manifest.json index 312cdf4..2ff4fb1 100644 --- a/integration-manifest.json +++ b/integration-manifest.json @@ -1,10 +1,19 @@ { "$schema": "https://keyfactor.github.io/v2/integration-manifest-schema.json", + "description": "The VMware vCenter Universal Orchestrator extension remotely manages certificates used by VMware vCenter, including inventory, addition, and removal of SSL certificates and trusted root chains.", + "integration_type": "orchestrator", + "link_github": true, + "name": "VMware vCenter Orchestrator", + "release_dir": "VmwareVcenterOrchestrator/bin/Release", + "release_project": "VmwareVcenterOrchestrator/VmwareVcenterOrchestrator.csproj", + "status": "production", + "support_level": "kf-supported", + "update_catalog": true, "about": { "orchestrator": { "UOFramework": "10.1", "keyfactor_platform_version": "10.0", - "pam_support": true, + "pam_support": true, "store_types": [ { "Name": "VMware vCenter", @@ -59,14 +68,5 @@ } ] } - }, - "description": "The VMware vCenter Universal Orchestrator extension remotely manages certificates used by VMware vCenter, including inventory, addition, and removal of SSL certificates and trusted root chains.", - "integration_type": "orchestrator", - "link_github": true, - "name": "VMware vCenter Orchestrator", - "release_dir": "VmwareVcenterOrchestrator/bin/Release", - "release_project": "VmwareVcenterOrchestrator/VmwareVcenterOrchestrator.csproj", - "status": "production", - "support_level": "kf-supported", - "update_catalog": true + } } From 02dcc31c3f934ed1ea96ffc2dae073eac24b26d4 Mon Sep 17 00:00:00 2001 From: Joe VanWanzeele <76071503+joevanwanzeeleKF@users.noreply.github.com> Date: Wed, 26 Nov 2025 15:04:29 -0500 Subject: [PATCH 5/6] Create keyfactor-release-workflow.yml updated release action --- .../workflows/keyfactor-release-workflow.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .github/workflows/keyfactor-release-workflow.yml diff --git a/.github/workflows/keyfactor-release-workflow.yml b/.github/workflows/keyfactor-release-workflow.yml new file mode 100644 index 0000000..b76c514 --- /dev/null +++ b/.github/workflows/keyfactor-release-workflow.yml @@ -0,0 +1,19 @@ +name: Keyfactor Release Workflow + +on: + workflow_dispatch: + pull_request: + types: [opened, closed, synchronize, edited, reopened] + push: + create: + branches: + - 'release-*.*' + +jobs: + call-starter-workflow: + uses: keyfactor/actions/.github/workflows/starter.yml@v3.1.2 + secrets: + token: ${{ secrets.V2BUILDTOKEN}} + APPROVE_README_PUSH: ${{ secrets.APPROVE_README_PUSH}} + gpg_key: ${{ secrets.KF_GPG_PRIVATE_KEY }} + gpg_pass: ${{ secrets.KF_GPG_PASSPHRASE }} From ddb5c7c4be75b49b63c5cdb3e6d986289a0c0b3a Mon Sep 17 00:00:00 2001 From: Joe VanWanzeele <76071503+joevanwanzeeleKF@users.noreply.github.com> Date: Wed, 26 Nov 2025 15:04:48 -0500 Subject: [PATCH 6/6] Delete .github/workflows/keyfactor-starter-workflow.yml --- .../workflows/keyfactor-starter-workflow.yml | 20 ------------------- 1 file changed, 20 deletions(-) delete mode 100644 .github/workflows/keyfactor-starter-workflow.yml diff --git a/.github/workflows/keyfactor-starter-workflow.yml b/.github/workflows/keyfactor-starter-workflow.yml deleted file mode 100644 index 61ea7a0..0000000 --- a/.github/workflows/keyfactor-starter-workflow.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: Keyfactor Bootstrap Workflow - -on: - workflow_dispatch: - pull_request: - types: [opened, closed, synchronize, edited, reopened] - push: - create: - branches: - - 'release-*.*' - -jobs: - call-starter-workflow: - uses: keyfactor/actions/.github/workflows/starter.yml@3.1.2 - secrets: - token: ${{ secrets.V2BUILDTOKEN}} - APPROVE_README_PUSH: ${{ secrets.APPROVE_README_PUSH}} - gpg_key: ${{ secrets.KF_GPG_PRIVATE_KEY }} - gpg_pass: ${{ secrets.KF_GPG_PASSPHRASE }} - scan_token: ${{ secrets.SAST_TOKEN }}