diff --git a/.github/workflows/keyfactor-release-workflow.yml b/.github/workflows/keyfactor-release-workflow.yml index 64919a4..45eec87 100644 --- a/.github/workflows/keyfactor-release-workflow.yml +++ b/.github/workflows/keyfactor-release-workflow.yml @@ -11,10 +11,9 @@ on: jobs: call-starter-workflow: - uses: keyfactor/actions/.github/workflows/starter.yml@v3 + uses: keyfactor/actions/.github/workflows/starter.yml@v5 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 }} diff --git a/CHANGELOG.md b/CHANGELOG.md index fb751ff..0c079e9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,5 @@ +# v2.0.1 +- Added PAM resolution support # v2.0.0 - .Net 6 and .Net 8 Support and Documentation Updates # v1.0.0 diff --git a/Kemp.sln b/Kemp.sln index d2ba6a1..866dc3a 100644 --- a/Kemp.sln +++ b/Kemp.sln @@ -1,5 +1,4 @@ - -Microsoft Visual Studio Solution File, Format Version 12.00 +Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 17 VisualStudioVersion = 17.11.35222.181 MinimumVisualStudioVersion = 10.0.40219.1 diff --git a/Kemp/Jobs/Inventory.cs b/Kemp/Jobs/Inventory.cs index bda6787..645dbba 100644 --- a/Kemp/Jobs/Inventory.cs +++ b/Kemp/Jobs/Inventory.cs @@ -1,126 +1,133 @@ -using System; -using System.IO; -using System.Linq; -using System.Xml.Serialization; -using Keyfactor.Extensions.Orchestrator.Kemp.Client; -using Keyfactor.Extensions.Orchestrator.Kemp.Client.Models; -using Keyfactor.Logging; -using Keyfactor.Orchestrators.Common.Enums; -using Keyfactor.Orchestrators.Extensions; -using Microsoft.Extensions.Logging; -using Newtonsoft.Json; - -namespace Keyfactor.Extensions.Orchestrator.Kemp.Jobs -{ - public class Inventory : IInventoryJobExtension - { - private readonly ILogger _logger; - - public Inventory(ILogger logger) - { - _logger = logger; - } - - public string ExtensionName => "Kemp"; - - public JobResult ProcessJob(InventoryJobConfiguration jobConfiguration, - SubmitInventoryUpdate submitInventoryUpdate) - { - try - { - _logger.MethodEntry(); - return PerformInventory(jobConfiguration, submitInventoryUpdate); - } - catch (Exception e) - { - _logger.LogError($"Error occured in Inventory.ProcessJob: {LogHandler.FlattenException(e)}"); - throw; - } - } - - private JobResult PerformInventory(InventoryJobConfiguration config, SubmitInventoryUpdate submitInventory) - { - try - { - _logger.MethodEntry(LogLevel.Debug); - _logger.LogTrace($"Inventory Config {JsonConvert.SerializeObject(config)}"); - _logger.LogTrace( - $"Client Machine: {config.CertificateStoreDetails.ClientMachine} ApiKey: {config.ServerPassword}"); - - var client = new KempClient(config); - - var certificatesResult = client.GetCertificates().Result; - var intermediateCertificates = client.GetIntermediateCertificates().Result; - - //Debug Write Certificate List Response from Palo Alto - var listWriter = new StringWriter(); - var listSerializer = new XmlSerializer(typeof(CertListResponse)); - listSerializer.Serialize(listWriter, certificatesResult); - _logger.LogTrace($"Certificate List Result {listWriter}"); - - //Debug Write Intermediate Certificate List Response from Palo Alto - var intListWriter = new StringWriter(); - var intListSerializer = new XmlSerializer(typeof(CertListResponse)); - intListSerializer.Serialize(intListWriter, intermediateCertificates); - _logger.LogTrace($"Intermediate List Result {intListWriter}"); - - var inventoryItems = (from cert in certificatesResult?.Success?.Data?.Certs - let certPem = client.GetCertificate(cert.Name).Result - select BuildInventoryItem(cert.Name, certPem.Success.Data.Certificate, true)).ToList(); - inventoryItems.AddRange(from cert in intermediateCertificates?.Success?.Data?.Certs - let certPem = client.GetIntermediateCertificate(cert.Name).Result - select BuildInventoryItem(cert.Name, certPem.Success.Data.Certificate, false)); - - _logger.LogTrace("Submitting Inventory To Keyfactor via submitInventory.Invoke"); - submitInventory.Invoke(inventoryItems); - _logger.LogTrace("Submitted Inventory To Keyfactor via submitInventory.Invoke"); - - _logger.MethodExit(LogLevel.Debug); - - _logger.LogTrace("Return Success"); - return new JobResult - { - Result = OrchestratorJobStatusJobResult.Success, - JobHistoryId = config.JobHistoryId, - FailureMessage = "" - }; - } - catch (Exception e) +using Keyfactor.Extensions.Orchestrator.Kemp.Client; +using Keyfactor.Extensions.Orchestrator.Kemp.Client.Models; +using Keyfactor.Logging; +using Keyfactor.Orchestrators.Common.Enums; +using Keyfactor.Orchestrators.Extensions; +using Keyfactor.Orchestrators.Extensions.Interfaces; +using Microsoft.Extensions.Logging; +using Newtonsoft.Json; +using System; +using System.IO; +using System.Linq; +using System.Xml.Linq; +using System.Xml.Serialization; +using static Org.BouncyCastle.Math.EC.ECCurve; + +namespace Keyfactor.Extensions.Orchestrator.Kemp.Jobs +{ + public class Inventory : IInventoryJobExtension + { + public IPAMSecretResolver _resolver; + public string ExtensionName => "Kemp"; + private ILogger _logger; + + public Inventory(IPAMSecretResolver resolver) + { + _resolver = resolver; + } + + public JobResult ProcessJob(InventoryJobConfiguration jobConfiguration, SubmitInventoryUpdate submitInventoryUpdate) + { + _logger = LogHandler.GetClassLogger(this.GetType()); + _logger.MethodEntry(); + + try { - return new JobResult - { - Result = OrchestratorJobStatusJobResult.Failure, - JobHistoryId = config.JobHistoryId, - FailureMessage = LogHandler.FlattenException(e) - }; - } - } - - protected virtual CurrentInventoryItem BuildInventoryItem(string alias, string certPem, bool privateKey) - { - try - { - _logger.MethodEntry(); - _logger.LogTrace($"Alias: {alias} Pem: {certPem} PrivateKey: {privateKey}"); - - - var acsi = new CurrentInventoryItem - { - Alias = alias, - Certificates = new[] {certPem}, - ItemStatus = OrchestratorInventoryItemStatus.Unknown, - PrivateKeyEntry = privateKey, - UseChainLevel = false - }; - - _logger.MethodExit(); - return acsi; - } - catch (Exception e) - { - _logger.LogError($"Error Occurred in Inventory.BuildInventoryItem: {LogHandler.FlattenException(e)}"); - throw; - } - } - } + string password = PAMUtilities.ResolvePAMField(_resolver, _logger, "Kemp ApiKey", jobConfiguration.ServerPassword); + jobConfiguration.ServerPassword = password; + + return PerformInventory(jobConfiguration, submitInventoryUpdate); + } + catch (Exception e) + { + _logger.LogError($"Error occured in Inventory.ProcessJob: {LogHandler.FlattenException(e)}"); + throw; + } + } + + private JobResult PerformInventory(InventoryJobConfiguration config, SubmitInventoryUpdate submitInventory) + { + try + { + _logger.MethodEntry(LogLevel.Debug); + + _logger.LogTrace( + $"Client Machine: {config.CertificateStoreDetails.ClientMachine} ApiKey: *********"); + + var client = new KempClient(config); + + var certificatesResult = client.GetCertificates().Result; + var intermediateCertificates = client.GetIntermediateCertificates().Result; + + //Debug Write Certificate List Response from Palo Alto + var listWriter = new StringWriter(); + var listSerializer = new XmlSerializer(typeof(CertListResponse)); + listSerializer.Serialize(listWriter, certificatesResult); + _logger.LogTrace($"Certificate List Result {listWriter}"); + + //Debug Write Intermediate Certificate List Response from Palo Alto + var intListWriter = new StringWriter(); + var intListSerializer = new XmlSerializer(typeof(CertListResponse)); + intListSerializer.Serialize(intListWriter, intermediateCertificates); + _logger.LogTrace($"Intermediate List Result {intListWriter}"); + + var inventoryItems = (from cert in certificatesResult?.Success?.Data?.Certs + let certPem = client.GetCertificate(cert.Name).Result + select BuildInventoryItem(cert.Name, certPem.Success.Data.Certificate, true)).ToList(); + inventoryItems.AddRange(from cert in intermediateCertificates?.Success?.Data?.Certs + let certPem = client.GetIntermediateCertificate(cert.Name).Result + select BuildInventoryItem(cert.Name, certPem.Success.Data.Certificate, false)); + + _logger.LogTrace("Submitting Inventory To Keyfactor via submitInventory.Invoke"); + submitInventory.Invoke(inventoryItems); + _logger.LogTrace("Submitted Inventory To Keyfactor via submitInventory.Invoke"); + + _logger.MethodExit(LogLevel.Debug); + + _logger.LogTrace("Return Success"); + return new JobResult + { + Result = OrchestratorJobStatusJobResult.Success, + JobHistoryId = config.JobHistoryId, + FailureMessage = "" + }; + } + catch (Exception e) + { + return new JobResult + { + Result = OrchestratorJobStatusJobResult.Failure, + JobHistoryId = config.JobHistoryId, + FailureMessage = LogHandler.FlattenException(e) + }; + } + } + + protected virtual CurrentInventoryItem BuildInventoryItem(string alias, string certPem, bool privateKey) + { + try + { + _logger.MethodEntry(); + _logger.LogTrace($"Alias: {alias} Pem: {certPem} PrivateKey: *******"); + + + var acsi = new CurrentInventoryItem + { + Alias = alias, + Certificates = new[] {certPem}, + ItemStatus = OrchestratorInventoryItemStatus.Unknown, + PrivateKeyEntry = privateKey, + UseChainLevel = false + }; + + _logger.MethodExit(); + return acsi; + } + catch (Exception e) + { + _logger.LogError($"Error Occurred in Inventory.BuildInventoryItem: {LogHandler.FlattenException(e)}"); + throw; + } + } + } } \ No newline at end of file diff --git a/Kemp/Jobs/Management.cs b/Kemp/Jobs/Management.cs index bc82166..93d7067 100644 --- a/Kemp/Jobs/Management.cs +++ b/Kemp/Jobs/Management.cs @@ -1,17 +1,18 @@ -using System; -using System.IO; -using System.Linq; -using System.Text; -using Keyfactor.Extensions.Orchestrator.Kemp.Client; +using Keyfactor.Extensions.Orchestrator.Kemp.Client; using Keyfactor.Extensions.Orchestrator.Kemp.Client.Models; using Keyfactor.Logging; using Keyfactor.Orchestrators.Common.Enums; using Keyfactor.Orchestrators.Extensions; +using Keyfactor.Orchestrators.Extensions.Interfaces; using Microsoft.Extensions.Logging; using Newtonsoft.Json; using Org.BouncyCastle.Crypto; using Org.BouncyCastle.OpenSsl; using Org.BouncyCastle.Pkcs; +using System; +using System.IO; +using System.Linq; +using System.Text; namespace Keyfactor.Extensions.Orchestrator.Kemp.Jobs { @@ -23,23 +24,27 @@ public class Management : IManagementJobExtension private static readonly Func Pemify = ss => ss.Length <= 64 ? ss : ss.Substring(0, 64) + "\n" + Pemify(ss.Substring(64)); - private readonly ILogger _logger; + public IPAMSecretResolver _resolver; + public string ExtensionName => "Kemp"; + private ILogger _logger; - public Management(ILogger logger) + public Management(IPAMSecretResolver resolver) { - _logger = logger; + _resolver = resolver; } protected internal virtual AsymmetricKeyEntry KeyEntry { get; set; } - public string ExtensionName => "Kemp"; - - public JobResult ProcessJob(ManagementJobConfiguration jobConfiguration) { + _logger = LogHandler.GetClassLogger(this.GetType()); + _logger.MethodEntry(); + try { - _logger.MethodEntry(); + string password = PAMUtilities.ResolvePAMField(_resolver, _logger, "Kemp ApiKey", jobConfiguration.ServerPassword); + jobConfiguration.ServerPassword = password; + _logger.MethodExit(); return PerformManagement(jobConfiguration); } @@ -66,13 +71,11 @@ private JobResult PerformManagement(ManagementJobConfiguration config) if (config.OperationType.ToString() == "Add") { _logger.LogTrace("Adding..."); - _logger.LogTrace($"Add Config Json {JsonConvert.SerializeObject(config)}"); complete = PerformAddition(config); } else if (config.OperationType.ToString() == "Remove") { _logger.LogTrace("Removing..."); - _logger.LogTrace($"Remove Config Json {JsonConvert.SerializeObject(config)}"); complete = PerformRemoval(config); } @@ -94,7 +97,7 @@ private JobResult PerformRemoval(ManagementJobConfiguration config) _logger.MethodEntry(); _logger.LogTrace( - $"Credentials JSON: Url: {config.CertificateStoreDetails.ClientMachine} Password: {config.ServerPassword}"); + $"Credentials JSON: Url: {config.CertificateStoreDetails.ClientMachine} Password: **********"); var client = new KempClient(config); @@ -132,7 +135,7 @@ private JobResult PerformAddition(ManagementJobConfiguration config) { _logger.MethodEntry(); _logger.LogTrace( - $"Credentials JSON: Url: {config.CertificateStoreDetails.ClientMachine} Password: {config.ServerPassword}"); + $"Credentials JSON: Url: {config.CertificateStoreDetails.ClientMachine} Password: *********"); var client = new KempClient(config); @@ -148,7 +151,7 @@ private JobResult PerformAddition(ManagementJobConfiguration config) _logger.LogTrace("Either not a duplicate or overwrite was chosen...."); if (hasPrivateKey) // This is a PFX Entry { - _logger.LogTrace($"Found Private Key {config.JobCertificate.PrivateKeyPassword}"); + _logger.LogTrace($"Found Private Key *******"); if (string.IsNullOrWhiteSpace(config.JobCertificate.Alias)) _logger.LogTrace("No Alias Found"); @@ -178,20 +181,17 @@ private JobResult PerformAddition(ManagementJobConfiguration config) alias = p.Aliases.Cast().SingleOrDefault(a => p.IsKeyEntry(a)); _logger.LogTrace($"Alias = {alias}"); var publicKey = p.GetCertificate(alias).Certificate.GetPublicKey(); - _logger.LogTrace($"publicKey = {publicKey}"); KeyEntry = p.GetKey(alias); - _logger.LogTrace($"KeyEntry = {KeyEntry}"); if (KeyEntry == null) throw new Exception("Unable to retrieve private key"); var privateKey = KeyEntry.Key; - _logger.LogTrace($"privateKey = {privateKey}"); var keyPair = new AsymmetricCipherKeyPair(publicKey, privateKey); pemWriter.WriteObject(keyPair.Private); streamWriter.Flush(); privateKeyString = Encoding.ASCII.GetString(memoryStream.GetBuffer()).Trim() .Replace("\r", "").Replace("\0", ""); - _logger.LogTrace($"Got Private Key String {privateKeyString}"); + _logger.LogTrace($"Got Private Key String *******"); memoryStream.Close(); streamWriter.Close(); _logger.LogTrace("Finished Extracting Private Key..."); diff --git a/Kemp/Kemp.csproj b/Kemp/Kemp.csproj index 6c62a00..6ddfbe0 100644 --- a/Kemp/Kemp.csproj +++ b/Kemp/Kemp.csproj @@ -20,8 +20,8 @@ - - + + diff --git a/Kemp/PamUtilities.cs b/Kemp/PamUtilities.cs new file mode 100644 index 0000000..1cbcf93 --- /dev/null +++ b/Kemp/PamUtilities.cs @@ -0,0 +1,21 @@ +// Copyright 2026 Keyfactor +// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. +// You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions +// and limitations under the License. + +using Keyfactor.Orchestrators.Extensions.Interfaces; +using Microsoft.Extensions.Logging; + +namespace Keyfactor.Extensions.Orchestrator.Kemp +{ + internal class PAMUtilities + { + internal static string ResolvePAMField(IPAMSecretResolver resolver, ILogger logger, string name, string key) + { + logger.LogDebug($"Attempting to resolve PAM eligible field {name}"); + return string.IsNullOrEmpty(key) ? key : resolver.Resolve(key); + } + } +} diff --git a/README.md b/README.md index 13bf096..471390f 100644 --- a/README.md +++ b/README.md @@ -33,13 +33,12 @@ The Kemp Load Balancer Universal Orchestrator extension enables remote management of cryptographic certificates on Kemp Load Balancers. Kemp Load Balancers use certificates to secure HTTP and HTTPS traffic efficiently, ensuring that sensitive data is encrypted during transit. This extension integrates with Keyfactor Command to automate the process of inventorying, adding, and removing certificates within Kemp Load Balancer environments. By leveraging this orchestrator, administrators can easily manage SSL/TLS certificates, ensuring the security and reliability of their load balancing infrastructure. - - ## Compatibility This integration is compatible with Keyfactor Universal Orchestrator version 10.4 and later. ## Support + The Kemp Load Balancer 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. @@ -48,34 +47,28 @@ The Kemp Load Balancer Universal Orchestrator extension is supported by Keyfacto Before installing the Kemp Load Balancer 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. - - ## Kemp Certificate Store Type To use the Kemp Load Balancer Universal Orchestrator extension, you **must** create the Kemp Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance. - - TODO Overview is a required section - - - #### Supported Operations -| Operation | Is Supported | -|--------------|------------------------------------------------------------------------------------------------------------------------| -| Add | ✅ Checked | -| Remove | ✅ Checked | -| Discovery | 🔲 Unchecked | +| Operation | Is Supported | +|--------------|--------------| +| Add | ✅ Checked | +| Remove | ✅ Checked | +| Discovery | 🔲 Unchecked | | Reenrollment | 🔲 Unchecked | -| Create | 🔲 Unchecked | +| Create | 🔲 Unchecked | #### 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 Kemp kfutil details ##### Using online definition from GitHub: @@ -94,10 +87,10 @@ For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out ```
- #### Manual Creation Below are instructions on how to create the Kemp store type manually in the Keyfactor Command Portal +
Click to expand manual Kemp details Create a store type called `Kemp` with the attributes in the tables below: @@ -108,11 +101,11 @@ the Keyfactor Command Portal | Name | Kemp | Display name for the store type (may be customized) | | Short Name | Kemp | Short display name for the store type | | Capability | Kemp | 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 | + | Supports Add | ✅ Checked | Indicates that the Store Type supports Management Add | + | Supports Remove | ✅ Checked | 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 | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint | | Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell | @@ -121,18 +114,18 @@ the Keyfactor Command Portal The Basic tab should look like this: - ![Kemp Basic Tab](docsource/images/Kemp-basic-store-type-dialog.png) + ![Kemp Basic Tab](docsource/images/Kemp-basic-store-type-dialog.svg) ##### Advanced Tab | Attribute | Value | Description | | --------- | ----- | ----- | | Supports Custom Alias | Required | 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. | + | Private Key Handling | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store. | | 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: - ![Kemp Advanced Tab](docsource/images/Kemp-advanced-store-type-dialog.png) + ![Kemp Advanced Tab](docsource/images/Kemp-advanced-store-type-dialog.svg) > 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. @@ -147,7 +140,30 @@ the Keyfactor Command Portal The Custom Fields tab should look like this: - ![Kemp Custom Fields Tab](docsource/images/Kemp-custom-fields-store-type-dialog.png) + ![Kemp Custom Fields Tab](docsource/images/Kemp-custom-fields-store-type-dialog.svg) + + ###### Server Username + Not used. + + + > [!IMPORTANT] + > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. + + + ###### Server Password + Kemp Api Password. (or valid PAM key if the username is stored in a KF Command configured PAM integration). + + + > [!IMPORTANT] + > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. + + + ###### Use SSL + Should be true, http is not supported. + + ![Kemp Custom Field - ServerUseSsl](docsource/images/Kemp-custom-field-ServerUseSsl-dialog.svg) + ![Kemp Custom Field - ServerUseSsl](docsource/images/Kemp-custom-field-ServerUseSsl-validation-options-dialog.svg) +
@@ -155,7 +171,7 @@ the Keyfactor Command Portal 1. **Download the latest Kemp Load Balancer Universal Orchestrator extension from GitHub.** - Navigate to the [Kemp Load Balancer Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/kemp-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. + Navigate to the [Kemp Load Balancer Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/kemp-orchestrator/releases/latest). Refer to the compatibility matrix below to determine which 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` | `kemp-orchestrator` .NET version to download | | --------- | ----------- | ----------- | ----------- | @@ -163,11 +179,11 @@ the Keyfactor Command Portal | 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` | + | Between `11.6.0` and `24.x` | `net8.0` | | `net8.0` | Unzip the archive containing extension assemblies to a known location. - > **Note** If you don't see an asset with a corresponding .NET version, you should always assume that it was compiled for `net6.0`. + > **Note** If you don't see an asset with a corresponding .NET version, you should always assume that it was compiled for `net8.0`. 2. **Locate the Universal Orchestrator extensions directory.** @@ -185,22 +201,16 @@ the Keyfactor Command Portal 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 Kemp Load Balancer 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 supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions). - - ## Defining Certificate Stores - - ### Store Creation #### Manually with the Command UI @@ -215,8 +225,8 @@ the Keyfactor Command Portal Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form. - | Attribute | Description | - | --------- |---------------------------------------------------------| + | Attribute | Description | + | --------- | ----------- | | Category | Select "Kemp" or the customized certificate store name from the previous step. | | Container | Optional container to associate certificate store with. | | Client Machine | Kemp Load Balancer Client Machine and port example TestKemp:8443. | @@ -228,8 +238,6 @@ the Keyfactor Command Portal - - #### Using kfutil CLI
Click to expand details @@ -262,7 +270,6 @@ the Keyfactor Command Portal
- #### PAM Provider Eligible Fields
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator @@ -278,10 +285,8 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
- > 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). - ### 🧩 Step-by-Step: Enabling API Access for a User #### 1. Log in to the Kemp Web UI @@ -422,12 +427,10 @@ Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Result 11|Inventory SSL Certificates|SSL Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) - - ## License Apache License 2.0, see [LICENSE](LICENSE). ## Related Integrations -See all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator). \ No newline at end of file +See all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator). diff --git a/docsource/images/Kemp-advanced-store-type-dialog.svg b/docsource/images/Kemp-advanced-store-type-dialog.svg new file mode 100644 index 0000000..4bd468b --- /dev/null +++ b/docsource/images/Kemp-advanced-store-type-dialog.svg @@ -0,0 +1,67 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + Advanced + + Custom Fields + Entry Parameters + + + + + Store Path Type + + + + Freeform + + Fixed + + Multiple Choice + + + + + Other Settings + + Supports Custom Alias + + Forbidden + + Optional + + + Required + Private Key Handling + + Forbidden + + + Optional + + Required + PFX Password Style + + + Default + + Custom + \ No newline at end of file diff --git a/docsource/images/Kemp-basic-store-type-dialog.svg b/docsource/images/Kemp-basic-store-type-dialog.svg new file mode 100644 index 0000000..f1d0bfa --- /dev/null +++ b/docsource/images/Kemp-basic-store-type-dialog.svg @@ -0,0 +1,83 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + + Advanced + Custom Fields + Entry Parameters + + + + + Details + + Name + + Kemp + Short Name + + Kemp + Custom Capability + + + Custom Capability + + + + Supported Job Types + + + + Inventory + + + Add + + + Remove + + Create + + Discovery + + ODKG + + + + General Settings + + + + Needs Server + + Blueprint Allowed + + Uses PowerShell + + + + Password Settings + + + Requires Store Password + + Supports Entry Password + \ No newline at end of file diff --git a/docsource/images/Kemp-custom-field-ServerUseSsl-dialog.svg b/docsource/images/Kemp-custom-field-ServerUseSsl-dialog.svg new file mode 100644 index 0000000..08ec420 --- /dev/null +++ b/docsource/images/Kemp-custom-field-ServerUseSsl-dialog.svg @@ -0,0 +1,54 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + + Validation Options + + Name + + ServerUseSsl + Display Name + + Use SSL + Type + + Bool + ∨ + Default Value + + + True + + False + + Not Set + Depends On + + + Server Username + ∨ + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/Kemp-custom-field-ServerUseSsl-validation-options-dialog.svg b/docsource/images/Kemp-custom-field-ServerUseSsl-validation-options-dialog.svg new file mode 100644 index 0000000..7993c23 --- /dev/null +++ b/docsource/images/Kemp-custom-field-ServerUseSsl-validation-options-dialog.svg @@ -0,0 +1,39 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + Validation Options + + + Creating a certificate store + + Optional + + + Required + + Hidden + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/Kemp-custom-fields-store-type-dialog.svg b/docsource/images/Kemp-custom-fields-store-type-dialog.svg new file mode 100644 index 0000000..2108f8a --- /dev/null +++ b/docsource/images/Kemp-custom-fields-store-type-dialog.svg @@ -0,0 +1,71 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + Advanced + Custom Fields + + Entry Parameters + + + + + + ADD + + EDIT + + DELETE + Total: 3 + + + Display Name + Type + Default Value / Options + + + + + + + + + + + Server Username + Secret + + + + + + + Server Password + Secret + + + + + + + Use SSL + Bool + true + \ No newline at end of file diff --git a/scripts/store_types/bash/curl_create_store_types.sh b/scripts/store_types/bash/curl_create_store_types.sh new file mode 100644 index 0000000..17b736c --- /dev/null +++ b/scripts/store_types/bash/curl_create_store_types.sh @@ -0,0 +1,74 @@ +#!/bin/bash +# Store Type creation script using curl +# Generated by Doctool + +set -e + +# Configuration - set these variables before running +KEYFACTOR_HOSTNAME="${KEYFACTOR_HOSTNAME}" +KEYFACTOR_API_PATH="${KEYFACTOR_API_PATH:-KeyfactorAPI}" +KEYFACTOR_AUTH_TOKEN="${KEYFACTOR_AUTH_TOKEN}" + +echo "Creating store type: Kemp" +curl -s -X POST "https://${KEYFACTOR_HOSTNAME}/${KEYFACTOR_API_PATH}/CertificateStoreTypes" \ + -H "Authorization: Bearer ${KEYFACTOR_AUTH_TOKEN}" \ + -H "Content-Type: application/json" \ + -H "x-keyfactor-requested-with: APIClient" \ + -d '{ + "Name": "Kemp", + "ShortName": "Kemp", + "Capability": "Kemp", + "LocalStore": false, + "SupportedOperations": { + "Add": true, + "Create": false, + "Discovery": false, + "Enrollment": false, + "Remove": true + }, + "Properties": [ + { + "Name": "ServerUsername", + "DisplayName": "Server Username", + "Type": "Secret", + "DependsOn": "", + "DefaultValue": "", + "Required": false, + "IsPAMEligible": true, + "Description": "Not used." + }, + { + "Name": "ServerPassword", + "DisplayName": "Server Password", + "Type": "Secret", + "DependsOn": "", + "DefaultValue": "", + "Required": false, + "IsPAMEligible": true, + "Description": "Kemp Api Password. (or valid PAM key if the username is stored in a KF Command configured PAM integration)." + }, + { + "Name": "ServerUseSsl", + "DisplayName": "Use SSL", + "Type": "Bool", + "DependsOn": "", + "DefaultValue": "true", + "Required": true, + "IsPAMEligible": false, + "Description": "Should be true, http is not supported." + } + ], + "EntryParameters": [], + "PasswordOptions": { + "EntrySupported": false, + "StoreRequired": false, + "Style": "Default" + }, + "PrivateKeyAllowed": "Optional", + "JobProperties": [], + "ServerRequired": true, + "PowerShell": false, + "BlueprintAllowed": false, + "CustomAliasAllowed": "Required" +}' + diff --git a/scripts/store_types/bash/kfutil_create_store_types.sh b/scripts/store_types/bash/kfutil_create_store_types.sh new file mode 100644 index 0000000..46b9f3a --- /dev/null +++ b/scripts/store_types/bash/kfutil_create_store_types.sh @@ -0,0 +1,9 @@ +#!/bin/bash +# Store Type creation script using kfutil +# Generated by Doctool + +set -e + +echo "Creating store type: Kemp" +kfutil store-types create Kemp + diff --git a/scripts/store_types/powershell/kfutil_create_store_types.ps1 b/scripts/store_types/powershell/kfutil_create_store_types.ps1 new file mode 100644 index 0000000..e8809c6 --- /dev/null +++ b/scripts/store_types/powershell/kfutil_create_store_types.ps1 @@ -0,0 +1,6 @@ +# Store Type creation script using kfutil +# Generated by Doctool + +Write-Host "Creating store type: Kemp" +kfutil store-types create Kemp + diff --git a/scripts/store_types/powershell/restmethod_create_store_types.ps1 b/scripts/store_types/powershell/restmethod_create_store_types.ps1 new file mode 100644 index 0000000..9c7b0f4 --- /dev/null +++ b/scripts/store_types/powershell/restmethod_create_store_types.ps1 @@ -0,0 +1,77 @@ +# Store Type creation script using Invoke-RestMethod +# Generated by Doctool + +# Configuration - set these variables before running +$KeyfactorHostname = $env:KEYFACTOR_HOSTNAME +$KeyfactorApiPath = if ($env:KEYFACTOR_API_PATH) { $env:KEYFACTOR_API_PATH } else { "KeyfactorAPI" } +$KeyfactorAuthToken = $env:KEYFACTOR_AUTH_TOKEN + +$Headers = @{ + "Authorization" = "Bearer $KeyfactorAuthToken" + "Content-Type" = "application/json" + "x-keyfactor-requested-with" = "APIClient" +} + +Write-Host "Creating store type: Kemp" +$Body = @' +{ + "Name": "Kemp", + "ShortName": "Kemp", + "Capability": "Kemp", + "LocalStore": false, + "SupportedOperations": { + "Add": true, + "Create": false, + "Discovery": false, + "Enrollment": false, + "Remove": true + }, + "Properties": [ + { + "Name": "ServerUsername", + "DisplayName": "Server Username", + "Type": "Secret", + "DependsOn": "", + "DefaultValue": "", + "Required": false, + "IsPAMEligible": true, + "Description": "Not used." + }, + { + "Name": "ServerPassword", + "DisplayName": "Server Password", + "Type": "Secret", + "DependsOn": "", + "DefaultValue": "", + "Required": false, + "IsPAMEligible": true, + "Description": "Kemp Api Password. (or valid PAM key if the username is stored in a KF Command configured PAM integration)." + }, + { + "Name": "ServerUseSsl", + "DisplayName": "Use SSL", + "Type": "Bool", + "DependsOn": "", + "DefaultValue": "true", + "Required": true, + "IsPAMEligible": false, + "Description": "Should be true, http is not supported." + } + ], + "EntryParameters": [], + "PasswordOptions": { + "EntrySupported": false, + "StoreRequired": false, + "Style": "Default" + }, + "PrivateKeyAllowed": "Optional", + "JobProperties": [], + "ServerRequired": true, + "PowerShell": false, + "BlueprintAllowed": false, + "CustomAliasAllowed": "Required" +} +'@ + +Invoke-RestMethod -Uri "https://$KeyfactorHostname/$KeyfactorApiPath/CertificateStoreTypes" -Method POST -Headers $Headers -Body $Body +