From 6bf7542afb5c205e29da4d88a2e9e5c651c4a371 Mon Sep 17 00:00:00 2001 From: Hayden Roszell Date: Wed, 3 Jul 2024 20:06:22 +0100 Subject: [PATCH 01/38] chore(docs): Translate doc structure for compatibility with doctool and upgrade bootstrap workflow --- .../workflows/keyfactor-release-workflow.yml | 20 +++ .../workflows/keyfactor-starter-workflow.yml | 39 ----- README.md | 161 +++++------------- docsource/overview.md | 4 + integration-manifest.json | 50 +++--- 5 files changed, 93 insertions(+), 181 deletions(-) create mode 100644 .github/workflows/keyfactor-release-workflow.yml delete mode 100644 .github/workflows/keyfactor-starter-workflow.yml create mode 100644 docsource/overview.md diff --git a/.github/workflows/keyfactor-release-workflow.yml b/.github/workflows/keyfactor-release-workflow.yml new file mode 100644 index 0000000..3071ff4 --- /dev/null +++ b/.github/workflows/keyfactor-release-workflow.yml @@ -0,0 +1,20 @@ +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 + secrets: + token: ${{ secrets.V2BUILDTOKEN}} + APPROVE_README_PUSH: ${{ secrets.APPROVE_README_PUSH}} + gpg_key: ${{ secrets.KF_GPG_PRIVATE_KEY }} + gpg_pass: ${{ secrets.KF_GPG_PASSPHRASE }} + \ No newline at end of file diff --git a/.github/workflows/keyfactor-starter-workflow.yml b/.github/workflows/keyfactor-starter-workflow.yml deleted file mode 100644 index bd59e99..0000000 --- a/.github/workflows/keyfactor-starter-workflow.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: Starter Workflow -on: [workflow_dispatch, push, pull_request] - -jobs: - call-create-github-release-workflow: - uses: Keyfactor/actions/.github/workflows/github-release.yml@main - get-manifest-properties: - runs-on: windows-latest - outputs: - update_catalog: ${{ steps.read-json.outputs.prop }} - steps: - - uses: actions/checkout@v3 - - name: Read json - id: read-json - shell: pwsh - run: | - $json = Get-Content integration-manifest.json | ConvertFrom-Json - echo "::set-output name=prop::$(echo $json.update_catalog)" - - call-dotnet-build-and-release-workflow: - needs: [call-create-github-release-workflow] - uses: Keyfactor/actions/.github/workflows/dotnet-build-and-release.yml@main - with: - release_version: ${{ needs.call-create-github-release-workflow.outputs.release_version }} - release_url: ${{ needs.call-create-github-release-workflow.outputs.release_url }} - release_dir: Kemp/bin/Release/netcoreapp3.1 # TODO: set build output directory to upload as a release, relative to checkout workspace - secrets: - token: ${{ secrets.PRIVATE_PACKAGE_ACCESS }} - - call-generate-readme-workflow: - if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' - uses: Keyfactor/actions/.github/workflows/generate-readme.yml@main - - call-update-catalog-workflow: - needs: get-manifest-properties - if: needs.get-manifest-properties.outputs.update_catalog == 'True' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch') - uses: Keyfactor/actions/.github/workflows/update-catalog.yml@main - secrets: - token: ${{ secrets.SDK_SYNC_PAT }} diff --git a/README.md b/README.md index bf2a749..592d1e9 100644 --- a/README.md +++ b/README.md @@ -1,133 +1,56 @@ -# Kemp Load Balancer +

+ Kemp Load Balancer Universal Orchestrator Extension +

-Kemp Load Balancer for Add, Remove and Inventory. +

+ +Integration Status: production +Release +Issues +GitHub Downloads (all assets, all releases) +

-#### Integration status: Production - Ready for use in production environments. +

+ + + Support + + · + + Installation + + · + + License + + · + + Related Integrations + +

-## About the Keyfactor Universal Orchestrator Capability -This repository contains a Universal Orchestrator Capability which is a plugin to the Keyfactor Universal Orchestrator. Within the Keyfactor Platform, Orchestrators are used to manage “certificate stores” — collections of certificates and roots of trust that are found within and used by various applications. +## Overview -The Universal Orchestrator is part of the Keyfactor software distribution and is available via the Keyfactor customer portal. For general instructions on installing Capabilities, see the “Keyfactor Command Orchestrator Installation and Configuration Guide” section of the Keyfactor documentation. For configuration details of this specific Capability, see below in this readme. +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. -The Universal Orchestrator is the successor to the Windows Orchestrator. This Capability plugin only works with the Universal Orchestrator and does not work with the Windows Orchestrator. +## Compatibility ---- +This integration is compatible with Keyfactor Universal Orchestrator version and later. +## Support +The Kemp Load Balancer Universal Orchestrator extension is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket with your Keyfactor representative. If you have a support issue, please open a support ticket 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. +## Installation +Before installing the Kemp Load Balancer Universal Orchestrator extension, it's recommended to 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. -## Platform Specific Notes - -The Keyfactor Universal Orchestrator may be installed on either Windows or Linux based platforms. The certificate operations supported by a capability may vary based what platform the capability is installed on. The table below indicates what capabilities are supported based on which platform the encompassing Universal Orchestrator is running. -| Operation | Win | Linux | -|-----|-----|------| -|Supports Management Add|✓ | | -|Supports Management Remove|✓ | | -|Supports Create Store| | | -|Supports Discovery| | | -|Supports Renrollment| | | -|Supports Inventory|✓ | | - - - ---- - -**Kemp Load Balancer Configuration (LoadMaster)** - -**Overview** - -The Kemp Load Balancer Orchestrator (LoadMaster) remotely manages certificates on the Kemp Virtual LoadMaster Load Balancer Product - -This agent implements three job types – Inventory, Management Add, and Management Remove. Below are the steps necessary to configure this AnyAgent. It supports adding certificates with or without private keys. - - -**Kemp LoadMaster Configuration** - -1. Read up on [Kemp LoadMaster Load Balancer](https://kemptechnologies.com/virtual-load-balancer) and how it works. -2. You need to setup a user with the following permissions for API Access on the Kemp Load Balancer -![](images/ApiUserSetup.gif) -3. The following Api Access is needed: -![](images/ApiAccessNeeded.gif) - - -**1. Create the New Certificate Store Type for the Kemp Load Balancer Orchestrator** - -In Keyfactor Command create a new Certificate Store Type similar to the one below: - -#### STORE TYPE CONFIGURATION -SETTING TAB | CONFIG ELEMENT | DESCRIPTION -------|-----------|------------------ -Basic |Name |Descriptive name for the Store Type. Kemp Load Balancer can be used. -Basic |Short Name |The short name that identifies the registered functionality of the orchestrator. Must be Kemp -Basic |Custom Capability|Unchecked -Basic |Job Types |Inventory, Add, and Remove are the supported job types. -Basic |Needs Server |Must be checked -Basic |Blueprint Allowed |Must be checked -Basic |Requires Store Password |Determines if a store password is required when configuring an individual store. This must be unchecked. -Basic |Supports Entry Password |Determined if an individual entry within a store can have a password. This must be unchecked. -Advanced |Store Path Type| Determines how the user will enter the store path when setting up the cert store. Freeform -Advanced |Supports Custom Alias |Determines if an individual entry within a store can have a custom Alias. This must be Required -Advanced |Private Key Handling |Determines how the orchestrator deals with private keys. Optional -Advanced |PFX Password Style |Determines password style for the PFX Password. Default -Custom Fields|N/A| There are no Custom Fields -Entry Parameters|N/A| There are no Entry Parameters - -**Basic Settings:** - -![](images/CertStoreType-Basic.gif) - -**Advanced Settings:** - -![](images/CertStoreType-Advanced.gif) - -**Custom Fields:** - -![](images/CertStoreType-CustomFields.gif) - -**Entry Params:** - -![](images/CertStoreType-EntryParameters.gif) - -**2. Register the Kemp Load Balancer Orchestrator with Keyfactor** -See Keyfactor InstallingKeyfactorOrchestrators.pdf Documentation. Get from your Keyfactor contact/representative. - -**3. Create a Kemp Load Balancer Store within Keyfactor Command** -In Keyfactor Command create a new Certificate Store similar to the one below - -![](images/CertStoreSettings-1.gif) -![](images/CertStoreSettings-2.gif) - -#### STORE CONFIGURATION -CONFIG ELEMENT |DESCRIPTION -----------------|--------------- -Category |The type of certificate store to be configured. Select category based on the display name configured above "Kemp Load Balancer". -Container |This is a logical grouping of like stores. This configuration is optional and does not impact the functionality of the store. -Client Machine |Server and port of the kemp load balancer sample is 20.62.33:8443. -Store Path |Not used just put a "/". -Orchestrator |This is the orchestrator server registered with the appropriate capabilities to manage this certificate store type. -Inventory Schedule |The interval that the system will use to report on what certificates are currently in the store. -Use SSL |This should be checked. -User |This is not necessary. -Password |This is the Kemp Load Balancer API Key setup for the user created in Kemp described in the "LoadMaster Configuration Section". - -*** - - -#### TEST CASES -Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots -------------|---------|----------------|--------------|----------|----------------|--------------|------------ -1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) -2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) -3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) -4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) -5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) -6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) -7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) -8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) -9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) -10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) -11|Inventory SSL Certificates|SS: 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 diff --git a/docsource/overview.md b/docsource/overview.md new file mode 100644 index 0000000..a46c098 --- /dev/null +++ b/docsource/overview.md @@ -0,0 +1,4 @@ +## Overview + +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. + diff --git a/integration-manifest.json b/integration-manifest.json index 19ab937..bf25f9b 100644 --- a/integration-manifest.json +++ b/integration-manifest.json @@ -1,29 +1,33 @@ { - "$schema": "https://keyfactor.github.io/integration-manifest-schema.json", + "$schema": "/Users/hroszell/coding/dev/staff-tools/keyfactor.github.io/v2/integration-manifest-schema.json", "integration_type": "orchestrator", "name": "Kemp Load Balancer", "status": "production", "description": "Kemp Load Balancer for Add, Remove and Inventory.", "about": { - "orchestrator": { - "win": { - "supportsCreateStore": false, - "supportsDiscovery": false, - "supportsManagementAdd": true, - "supportsManagementRemove": true, - "supportsReenrollment": false, - "supportsInventory": true, - "platformSupport": "Unused" - }, - "linux": { - "supportsCreateStore": false, - "supportsDiscovery": false, - "supportsManagementAdd": false, - "supportsManagementRemove": false, - "supportsReenrollment": false, - "supportsInventory": false, - "platformSupport": "Unused" - } - } - } -} + "orchestrator": { + "win": { + "supportsCreateStore": false, + "supportsDiscovery": false, + "supportsManagementAdd": true, + "supportsManagementRemove": true, + "supportsReenrollment": false, + "supportsInventory": true, + "platformSupport": "Unused" + }, + "linux": { + "supportsCreateStore": false, + "supportsDiscovery": false, + "supportsManagementAdd": false, + "supportsManagementRemove": false, + "supportsReenrollment": false, + "supportsInventory": false, + "platformSupport": "Unused" + }, + "store_types": [] + } + }, + "support_level": "kf-supported", + "link_github": true, + "update_catalog": true +} \ No newline at end of file From 8dfdfd9ab1be77e834cf49afcc5c866292d6b128 Mon Sep 17 00:00:00 2001 From: Hayden Roszell Date: Wed, 3 Jul 2024 20:27:30 +0100 Subject: [PATCH 02/38] chore(manifest): Re-create description fields in manifest to use Noun Phrase Style --- integration-manifest.json | 22 ++-------------------- 1 file changed, 2 insertions(+), 20 deletions(-) diff --git a/integration-manifest.json b/integration-manifest.json index bf25f9b..b8e6b5c 100644 --- a/integration-manifest.json +++ b/integration-manifest.json @@ -1,29 +1,11 @@ { - "$schema": "/Users/hroszell/coding/dev/staff-tools/keyfactor.github.io/v2/integration-manifest-schema.json", + "$schema": "https://keyfactor.github.io/v2/integration-manifest-schema.json", "integration_type": "orchestrator", "name": "Kemp Load Balancer", "status": "production", - "description": "Kemp Load Balancer for Add, Remove and Inventory.", + "description": "The Kemp Load Balancer Universal Orchestrator extension allows for remote management of cryptographic certificates stored in Kemp load balancers, including tasks such as inventory, addition, and removal of certificates.", "about": { "orchestrator": { - "win": { - "supportsCreateStore": false, - "supportsDiscovery": false, - "supportsManagementAdd": true, - "supportsManagementRemove": true, - "supportsReenrollment": false, - "supportsInventory": true, - "platformSupport": "Unused" - }, - "linux": { - "supportsCreateStore": false, - "supportsDiscovery": false, - "supportsManagementAdd": false, - "supportsManagementRemove": false, - "supportsReenrollment": false, - "supportsInventory": false, - "platformSupport": "Unused" - }, "store_types": [] } }, From 7ad65e3c18277a2f8510d1e5ddf82de8a01fc8b5 Mon Sep 17 00:00:00 2001 From: Brian Hill Date: Mon, 27 Oct 2025 12:03:43 -0400 Subject: [PATCH 03/38] dual build and doc updates --- Kemp.sln | 4 +- Kemp/Kemp.csproj | 7 ++-- docsource/content.md | 89 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 95 insertions(+), 5 deletions(-) create mode 100644 docsource/content.md diff --git a/Kemp.sln b/Kemp.sln index 9a2e752..d2ba6a1 100644 --- a/Kemp.sln +++ b/Kemp.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 16 -VisualStudioVersion = 16.0.30717.126 +# Visual Studio Version 17 +VisualStudioVersion = 17.11.35222.181 MinimumVisualStudioVersion = 10.0.40219.1 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Kemp", "Kemp\Kemp.csproj", "{33FBC5A1-3466-4F10-B9A6-7186F804A65A}" EndProject diff --git a/Kemp/Kemp.csproj b/Kemp/Kemp.csproj index 843973d..6c62a00 100644 --- a/Kemp/Kemp.csproj +++ b/Kemp/Kemp.csproj @@ -1,9 +1,10 @@ - netcoreapp3.1 - Keyfactor.Extensions.Orchestrator.Kemp + true + net6.0;net8.0 true + disable @@ -22,7 +23,7 @@ - + diff --git a/docsource/content.md b/docsource/content.md new file mode 100644 index 0000000..799cfff --- /dev/null +++ b/docsource/content.md @@ -0,0 +1,89 @@ +**Kemp LoadMaster Configuration** + +1. Read up on [Kemp LoadMaster Load Balancer](https://kemptechnologies.com/virtual-load-balancer) and how it works. +2. You need to setup a user with the following permissions for API Access on the Kemp Load Balancer +![](images/ApiUserSetup.gif) +3. The following Api Access is needed: +![](images/ApiAccessNeeded.gif) + + +**1. Create the New Certificate Store Type for the Kemp Load Balancer Orchestrator** + +In Keyfactor Command create a new Certificate Store Type similar to the one below: + +#### STORE TYPE CONFIGURATION +SETTING TAB | CONFIG ELEMENT | DESCRIPTION +------|-----------|------------------ +Basic |Name |Descriptive name for the Store Type. Kemp Load Balancer can be used. +Basic |Short Name |The short name that identifies the registered functionality of the orchestrator. Must be Kemp +Basic |Custom Capability|Unchecked +Basic |Job Types |Inventory, Add, and Remove are the supported job types. +Basic |Needs Server |Must be checked +Basic |Blueprint Allowed |Must be checked +Basic |Requires Store Password |Determines if a store password is required when configuring an individual store. This must be unchecked. +Basic |Supports Entry Password |Determined if an individual entry within a store can have a password. This must be unchecked. +Advanced |Store Path Type| Determines how the user will enter the store path when setting up the cert store. Freeform +Advanced |Supports Custom Alias |Determines if an individual entry within a store can have a custom Alias. This must be Required +Advanced |Private Key Handling |Determines how the orchestrator deals with private keys. Optional +Advanced |PFX Password Style |Determines password style for the PFX Password. Default +Custom Fields|N/A| There are no Custom Fields +Entry Parameters|N/A| There are no Entry Parameters + +**Basic Settings:** + +![](images/CertStoreType-Basic.gif) + +**Advanced Settings:** + +![](images/CertStoreType-Advanced.gif) + +**Custom Fields:** + +![](images/CertStoreType-CustomFields.gif) + +**Entry Params:** + +![](images/CertStoreType-EntryParameters.gif) + +**2. Register the Kemp Load Balancer Orchestrator with Keyfactor** +See Keyfactor InstallingKeyfactorOrchestrators.pdf Documentation. Get from your Keyfactor contact/representative. + +**3. Create a Kemp Load Balancer Store within Keyfactor Command** +In Keyfactor Command create a new Certificate Store similar to the one below + +![](images/CertStoreSettings-1.gif) +![](images/CertStoreSettings-2.gif) + +#### STORE CONFIGURATION +CONFIG ELEMENT |DESCRIPTION +----------------|--------------- +Category |The type of certificate store to be configured. Select category based on the display name configured above "Kemp Load Balancer". +Container |This is a logical grouping of like stores. This configuration is optional and does not impact the functionality of the store. +Client Machine |Server and port of the kemp load balancer sample is 20.62.33:8443. +Store Path |Not used just put a "/". +Orchestrator |This is the orchestrator server registered with the appropriate capabilities to manage this certificate store type. +Inventory Schedule |The interval that the system will use to report on what certificates are currently in the store. +Use SSL |This should be checked. +User |This is not necessary. +Password |This is the Kemp Load Balancer API Key setup for the user created in Kemp described in the "LoadMaster Configuration Section". + +*** + + +#### TEST CASES +Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots +------------|---------|----------------|--------------|----------|----------------|--------------|------------ +1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) +2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) +3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) +4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) +5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) +6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) +7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) +8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) +9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) +10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) +11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) + + + From c4d6fa54c302309926d2ec9d9369f9a12abae911 Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Mon, 27 Oct 2025 16:05:28 +0000 Subject: [PATCH 04/38] Update generated docs --- README.md | 65 ++++++++++++++++++++++++++++--- docsource/content.md | 89 +------------------------------------------ docsource/overview.md | 4 -- 3 files changed, 62 insertions(+), 96 deletions(-) delete mode 100644 docsource/overview.md diff --git a/README.md b/README.md index 592d1e9..eb79c95 100644 --- a/README.md +++ b/README.md @@ -29,22 +29,77 @@

- ## Overview 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 and later. ## Support -The Kemp Load Balancer Universal Orchestrator extension is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket with your Keyfactor representative. If you have a support issue, please open a support ticket 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 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. + +## Requirements & Prerequisites + +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. + + + +## Certificate Store Type + +To use the Kemp Load Balancer Universal Orchestrator extension, you **must** create the Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance. + + ## Installation -Before installing the Kemp Load Balancer Universal Orchestrator extension, it's recommended to 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. + +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. + + | Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server | `rollForward` condition in `Orchestrator.runtimeconfig.json` | `kemp-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. + + > **Note** If you don't see an asset with a corresponding .NET version, you should always assume that it was compiled for `net6.0`. + +2. **Locate the Universal Orchestrator extensions directory.** + + * **Default on Windows** - `C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions` + * **Default on Linux** - `/opt/keyfactor/orchestrator/extensions` + +3. **Create a new directory for the Kemp Load Balancer Universal Orchestrator extension inside the extensions directory.** + + Create a new directory called `kemp-orchestrator`. + > The directory name does not need to match any names used elsewhere; it just has to be unique within the extensions directory. + +4. **Copy the contents of the downloaded and unzipped assemblies from __step 2__ to the `kemp-orchestrator` directory.** + +5. **Restart the Universal Orchestrator service.** + + Refer to [Starting/Restarting the Universal Orchestrator service](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/StarttheService.htm). + + + +> 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 + + + ## License diff --git a/docsource/content.md b/docsource/content.md index 799cfff..a46c098 100644 --- a/docsource/content.md +++ b/docsource/content.md @@ -1,89 +1,4 @@ -**Kemp LoadMaster Configuration** - -1. Read up on [Kemp LoadMaster Load Balancer](https://kemptechnologies.com/virtual-load-balancer) and how it works. -2. You need to setup a user with the following permissions for API Access on the Kemp Load Balancer -![](images/ApiUserSetup.gif) -3. The following Api Access is needed: -![](images/ApiAccessNeeded.gif) - - -**1. Create the New Certificate Store Type for the Kemp Load Balancer Orchestrator** - -In Keyfactor Command create a new Certificate Store Type similar to the one below: - -#### STORE TYPE CONFIGURATION -SETTING TAB | CONFIG ELEMENT | DESCRIPTION -------|-----------|------------------ -Basic |Name |Descriptive name for the Store Type. Kemp Load Balancer can be used. -Basic |Short Name |The short name that identifies the registered functionality of the orchestrator. Must be Kemp -Basic |Custom Capability|Unchecked -Basic |Job Types |Inventory, Add, and Remove are the supported job types. -Basic |Needs Server |Must be checked -Basic |Blueprint Allowed |Must be checked -Basic |Requires Store Password |Determines if a store password is required when configuring an individual store. This must be unchecked. -Basic |Supports Entry Password |Determined if an individual entry within a store can have a password. This must be unchecked. -Advanced |Store Path Type| Determines how the user will enter the store path when setting up the cert store. Freeform -Advanced |Supports Custom Alias |Determines if an individual entry within a store can have a custom Alias. This must be Required -Advanced |Private Key Handling |Determines how the orchestrator deals with private keys. Optional -Advanced |PFX Password Style |Determines password style for the PFX Password. Default -Custom Fields|N/A| There are no Custom Fields -Entry Parameters|N/A| There are no Entry Parameters - -**Basic Settings:** - -![](images/CertStoreType-Basic.gif) - -**Advanced Settings:** - -![](images/CertStoreType-Advanced.gif) - -**Custom Fields:** - -![](images/CertStoreType-CustomFields.gif) - -**Entry Params:** - -![](images/CertStoreType-EntryParameters.gif) - -**2. Register the Kemp Load Balancer Orchestrator with Keyfactor** -See Keyfactor InstallingKeyfactorOrchestrators.pdf Documentation. Get from your Keyfactor contact/representative. - -**3. Create a Kemp Load Balancer Store within Keyfactor Command** -In Keyfactor Command create a new Certificate Store similar to the one below - -![](images/CertStoreSettings-1.gif) -![](images/CertStoreSettings-2.gif) - -#### STORE CONFIGURATION -CONFIG ELEMENT |DESCRIPTION -----------------|--------------- -Category |The type of certificate store to be configured. Select category based on the display name configured above "Kemp Load Balancer". -Container |This is a logical grouping of like stores. This configuration is optional and does not impact the functionality of the store. -Client Machine |Server and port of the kemp load balancer sample is 20.62.33:8443. -Store Path |Not used just put a "/". -Orchestrator |This is the orchestrator server registered with the appropriate capabilities to manage this certificate store type. -Inventory Schedule |The interval that the system will use to report on what certificates are currently in the store. -Use SSL |This should be checked. -User |This is not necessary. -Password |This is the Kemp Load Balancer API Key setup for the user created in Kemp described in the "LoadMaster Configuration Section". - -*** - - -#### TEST CASES -Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots -------------|---------|----------------|--------------|----------|----------------|--------------|------------ -1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) -2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) -3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) -4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) -5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) -6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) -7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) -8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) -9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) -10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) -11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) - +## Overview +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. diff --git a/docsource/overview.md b/docsource/overview.md deleted file mode 100644 index a46c098..0000000 --- a/docsource/overview.md +++ /dev/null @@ -1,4 +0,0 @@ -## Overview - -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. - From 23e576cab5172907f3e4d2a88a0b2d4e731e4c91 Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 12:09:38 -0400 Subject: [PATCH 05/38] Update keyfactor-release-workflow.yml --- .github/workflows/keyfactor-release-workflow.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/keyfactor-release-workflow.yml b/.github/workflows/keyfactor-release-workflow.yml index 3071ff4..64919a4 100644 --- a/.github/workflows/keyfactor-release-workflow.yml +++ b/.github/workflows/keyfactor-release-workflow.yml @@ -1,4 +1,4 @@ -name: Keyfactor Release Workflow +name: Keyfactor Bootstrap Workflow on: workflow_dispatch: @@ -17,4 +17,4 @@ jobs: APPROVE_README_PUSH: ${{ secrets.APPROVE_README_PUSH}} gpg_key: ${{ secrets.KF_GPG_PRIVATE_KEY }} gpg_pass: ${{ secrets.KF_GPG_PASSPHRASE }} - \ No newline at end of file + scan_token: ${{ secrets.SAST_TOKEN }} From 3115e053fbafe1f5057775e0b3b78a8c604b8a1a Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 12:29:00 -0400 Subject: [PATCH 06/38] Update integration-manifest.json --- integration-manifest.json | 112 +++++++++++++++++++++++++++++++++----- 1 file changed, 98 insertions(+), 14 deletions(-) diff --git a/integration-manifest.json b/integration-manifest.json index b8e6b5c..c866eef 100644 --- a/integration-manifest.json +++ b/integration-manifest.json @@ -1,15 +1,99 @@ { - "$schema": "https://keyfactor.github.io/v2/integration-manifest-schema.json", - "integration_type": "orchestrator", - "name": "Kemp Load Balancer", - "status": "production", - "description": "The Kemp Load Balancer Universal Orchestrator extension allows for remote management of cryptographic certificates stored in Kemp load balancers, including tasks such as inventory, addition, and removal of certificates.", - "about": { - "orchestrator": { - "store_types": [] - } - }, - "support_level": "kf-supported", - "link_github": true, - "update_catalog": true -} \ No newline at end of file +"$schema": "https://keyfactor.github.io/integration-manifest-schema.json", +"integration_type": "orchestrator", +"name": "Kemp Load Balancer Orchestrator", +"status": "production", +"update_catalog": true, +"link_github": true, +"support_level": "kf-supported", +"release_project": "kemp-orchestrator/Kemp/Kemp.csproj", +"release_dir": "kemp-orchestrator/Kemp/bin/Release", +"description": "Kemp Load Balancer for Add, Remove and Inventory.", +"about": { +"orchestrator": { +"UOFramework": "10.4", +"keyfactor_platform_version": "10.4", +"pam_support": true, +"keyfactor_platform_version": "10.4", +"win": { +"supportsCreateStore": false, +"supportsDiscovery": false, +"supportsManagementAdd": true, +"supportsManagementRemove": true, +"supportsReenrollment": false, +"supportsInventory": true, +"platformSupport": "Unused" +}, +"linux": { +"supportsCreateStore": false, +"supportsDiscovery": false, +"supportsManagementAdd": false, +"supportsManagementRemove": false, +"supportsReenrollment": false, +"supportsInventory": false, +"platformSupport": "Unused" +}, +"store_types": [ +{ +"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": [], +"ClientMachineDescription": "Kemp Load Balancer Client Machine and port example TestKemp:8443.", +"StorePathDescription": "Not used just put a /", +"PasswordOptions": { +"EntrySupported": false, +"StoreRequired": false, +"Style": "Default" +}, +"PrivateKeyAllowed": "Optional", +"JobProperties": [], +"ServerRequired": true, +"PowerShell": false, +"BlueprintAllowed": false, +"CustomAliasAllowed": "Required" +} +] +} +} +} From 9048773aec62aa51e1916acbefd29d4225fd7bed Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Mon, 27 Oct 2025 16:30:58 +0000 Subject: [PATCH 07/38] Update generated docs --- README.md | 209 +++++++++++++++++++++++++++++++++++++++++++++- docsource/kemp.md | 20 +++++ 2 files changed, 226 insertions(+), 3 deletions(-) create mode 100644 docsource/kemp.md diff --git a/README.md b/README.md index eb79c95..01ce734 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ The Kemp Load Balancer Universal Orchestrator extension enables remote managemen ## Compatibility -This integration is compatible with Keyfactor Universal Orchestrator version and later. +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. @@ -50,12 +50,115 @@ Before installing the Kemp Load Balancer Universal Orchestrator extension, we re -## Certificate Store Type +## Kemp Certificate Store Type -To use the Kemp Load Balancer Universal Orchestrator extension, you **must** create the Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance. +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 +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 + + + + + +#### Kemp 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 + +| Operation | Is Supported | +|--------------|------------------------------------------------------------------------------------------------------------------------| +| Add | ✅ Checked | +| Remove | ✅ Checked | +| Discovery | 🔲 Unchecked | +| Reenrollment | 🔲 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: + This will reach out to GitHub and pull the latest store-type definition + ```shell + # Kemp + kfutil store-types create Kemp + ``` + + ##### 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 +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: + + ##### Basic Tab + | Attribute | Value | Description | + | --------- | ----- | ----- | + | 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 | + | 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 | + | 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: + + ![Kemp Basic Tab](docsource/images/Kemp-basic-store-type-dialog.png) + + ##### 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. | + | 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) + + > 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: + + | Name | Display Name | Description | Type | Default Value/Options | Required | + | ---- | ------------ | ---- | --------------------- | -------- | ----------- | + | ServerUsername | Server Username | Not used. | Secret | | 🔲 Unchecked | + | ServerPassword | Server Password | Kemp Api Password. (or valid PAM key if the username is stored in a KF Command configured PAM integration). | Secret | | 🔲 Unchecked | + | ServerUseSsl | Use SSL | Should be true, http is not supported. | Bool | true | ✅ Checked | + + The Custom Fields tab should look like this: + + ![Kemp Custom Fields Tab](docsource/images/Kemp-custom-fields-store-type-dialog.png) + +
+ ## Installation 1. **Download the latest Kemp Load Balancer Universal Orchestrator extension from GitHub.** @@ -91,6 +194,12 @@ To use the Kemp Load Balancer Universal Orchestrator extension, you **must** cre 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). @@ -99,6 +208,100 @@ To use the Kemp Load Balancer Universal Orchestrator extension, you **must** cre ## Defining Certificate Stores +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 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 "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. | + | Store Path | Not used just put a / | + | Orchestrator | Select an approved orchestrator capable of managing `Kemp` certificates. Specifically, one with the `Kemp` capability. | + | ServerUsername | Not used. | + | ServerPassword | Kemp Api Password. (or valid PAM key if the username is stored in a KF Command configured PAM integration). | + | ServerUseSsl | Should be true, http is not supported. | + +
+ + + +#### Using kfutil CLI + +
Click to expand details + +1. **Generate a CSV template for the Kemp certificate store** + + ```shell + kfutil stores import generate-template --store-type-name Kemp --outpath Kemp.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 "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. | + | Store Path | Not used just put a / | + | Orchestrator | Select an approved orchestrator capable of managing `Kemp` certificates. Specifically, one with the `Kemp` capability. | + | Properties.ServerUsername | Not used. | + | Properties.ServerPassword | Kemp Api Password. (or valid PAM key if the username is stored in a KF Command configured PAM integration). | + | Properties.ServerUseSsl | Should be true, http is not supported. | + +3. **Import the CSV file to create the certificate stores** + + ```shell + kfutil stores import csv --store-type-name Kemp --file Kemp.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 | Not used. | + | ServerPassword | Kemp Api Password. (or valid PAM key if the username is stored in a KF Command configured PAM integration). | + +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 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 + +### Kemp Discovery Job +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 Discovery Job 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 + diff --git a/docsource/kemp.md b/docsource/kemp.md new file mode 100644 index 0000000..d53d056 --- /dev/null +++ b/docsource/kemp.md @@ -0,0 +1,20 @@ +## Overview + +TODO Overview is a required section + +## 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 + +## Discovery Job Configuration + +TODO Discovery Job 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 + +## Certificate Store Configuration + +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 + +## Global Store Type 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 + From 5d84b7b04e4932deaf532b79ab61bf09c5717176 Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 12:33:25 -0400 Subject: [PATCH 08/38] Update integration-manifest.json --- integration-manifest.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/integration-manifest.json b/integration-manifest.json index c866eef..b05a81a 100644 --- a/integration-manifest.json +++ b/integration-manifest.json @@ -6,8 +6,8 @@ "update_catalog": true, "link_github": true, "support_level": "kf-supported", -"release_project": "kemp-orchestrator/Kemp/Kemp.csproj", -"release_dir": "kemp-orchestrator/Kemp/bin/Release", +"release_project": "Kemp/Kemp.csproj", +"release_dir": "Kemp/bin/Release", "description": "Kemp Load Balancer for Add, Remove and Inventory.", "about": { "orchestrator": { From e8db52e9507a974bf1ba549190397aa1f6f4e558 Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 12:48:26 -0400 Subject: [PATCH 09/38] Update kemp.md --- docsource/kemp.md | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/docsource/kemp.md b/docsource/kemp.md index d53d056..986cf06 100644 --- a/docsource/kemp.md +++ b/docsource/kemp.md @@ -2,19 +2,5 @@ TODO Overview is a required section -## 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 - -## Discovery Job Configuration - -TODO Discovery Job 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 - -## Certificate Store Configuration - -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 - -## Global Store Type 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 From ec02542d3b0b531f461f32c06bc6120d7205f147 Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Mon, 27 Oct 2025 16:51:13 +0000 Subject: [PATCH 10/38] Update generated docs --- README.md | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/README.md b/README.md index 01ce734..2aae992 100644 --- a/README.md +++ b/README.md @@ -57,18 +57,10 @@ To use the Kemp Load Balancer Universal Orchestrator extension, you **must** cre 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 - -#### Kemp 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 | Operation | Is Supported | @@ -208,10 +200,6 @@ the Keyfactor Command Portal ## Defining Certificate Stores -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 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 @@ -294,14 +282,6 @@ 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). -## Discovering Certificate Stores with the Discovery Job - -### Kemp Discovery Job -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 Discovery Job 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 - From a289e8827c7847010e91870aa0436b6ed2e5794f Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 12:52:56 -0400 Subject: [PATCH 11/38] Update kemp.md --- docsource/kemp.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docsource/kemp.md b/docsource/kemp.md index 986cf06..cfb4c4e 100644 --- a/docsource/kemp.md +++ b/docsource/kemp.md @@ -2,5 +2,20 @@ TODO Overview is a required section +#### TEST CASES +Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots +------------|---------|----------------|--------------|----------|----------------|--------------|------------ +1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) +2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) +3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) +4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) +5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) +6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) +7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) +8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) +9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) +10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) +11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) + From 0db87830c37663a0ae0405b79d44ab8d4ea221f2 Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Mon, 27 Oct 2025 16:54:40 +0000 Subject: [PATCH 12/38] Update generated docs --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 2aae992..d94f5f8 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,21 @@ To use the Kemp Load Balancer Universal Orchestrator extension, you **must** cre TODO Overview is a required section +##### TEST CASES +Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots +------------|---------|----------------|--------------|----------|----------------|--------------|------------ +1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) +2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) +3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) +4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) +5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) +6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) +7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) +8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) +9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) +10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) +11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) + From 64f6f5691def9c741f18d5d2783ab89489362747 Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 13:01:47 -0400 Subject: [PATCH 13/38] Delete docsource/kemp.md --- docsource/kemp.md | 21 --------------------- 1 file changed, 21 deletions(-) delete mode 100644 docsource/kemp.md diff --git a/docsource/kemp.md b/docsource/kemp.md deleted file mode 100644 index cfb4c4e..0000000 --- a/docsource/kemp.md +++ /dev/null @@ -1,21 +0,0 @@ -## Overview - -TODO Overview is a required section - -#### TEST CASES -Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots -------------|---------|----------------|--------------|----------|----------------|--------------|------------ -1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) -2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) -3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) -4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) -5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) -6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) -7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) -8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) -9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) -10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) -11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) - - - From 3cb7c6dd67293f1f08bc2d917bfb61ed95a0d341 Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 13:01:55 -0400 Subject: [PATCH 14/38] Update content.md --- docsource/content.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docsource/content.md b/docsource/content.md index a46c098..4fe3959 100644 --- a/docsource/content.md +++ b/docsource/content.md @@ -2,3 +2,17 @@ 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. +#### TEST CASES +Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots +------------|---------|----------------|--------------|----------|----------------|--------------|------------ +1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) +2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) +3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) +4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) +5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) +6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) +7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) +8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) +9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) +10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) +11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) From 8a4e1b6de08a8278ead115a592a2cfbea4f2eb12 Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Mon, 27 Oct 2025 17:03:44 +0000 Subject: [PATCH 15/38] Update generated docs --- README.md | 48 +++++++++++++++++++++++++++++++++-------------- docsource/kemp.md | 20 ++++++++++++++++++++ 2 files changed, 54 insertions(+), 14 deletions(-) create mode 100644 docsource/kemp.md diff --git a/README.md b/README.md index d94f5f8..6ed5313 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,21 @@ 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. +#### TEST CASES +Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots +------------|---------|----------------|--------------|----------|----------------|--------------|------------ +1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) +2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) +3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) +4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) +5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) +6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) +7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) +8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) +9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) +10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) +11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) + ## Compatibility @@ -57,24 +72,17 @@ To use the Kemp Load Balancer Universal Orchestrator extension, you **must** cre 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 + -##### TEST CASES -Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots -------------|---------|----------------|--------------|----------|----------------|--------------|------------ -1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) -2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) -3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) -4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) -5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) -6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) -7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) -8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) -9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) -10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) -11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) +#### Kemp 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 @@ -215,6 +223,10 @@ the Keyfactor Command Portal ## Defining Certificate Stores +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 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 @@ -297,6 +309,14 @@ 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). +## Discovering Certificate Stores with the Discovery Job + +### Kemp Discovery Job +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 Discovery Job 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 + diff --git a/docsource/kemp.md b/docsource/kemp.md new file mode 100644 index 0000000..d53d056 --- /dev/null +++ b/docsource/kemp.md @@ -0,0 +1,20 @@ +## Overview + +TODO Overview is a required section + +## 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 + +## Discovery Job Configuration + +TODO Discovery Job 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 + +## Certificate Store Configuration + +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 + +## Global Store Type 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 + From 1d9d1505b1862a6b2a2b0df809bee6c5028479ec Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 13:14:29 -0400 Subject: [PATCH 16/38] Update content.md --- docsource/content.md | 82 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 81 insertions(+), 1 deletion(-) diff --git a/docsource/content.md b/docsource/content.md index 4fe3959..a698208 100644 --- a/docsource/content.md +++ b/docsource/content.md @@ -2,7 +2,87 @@ 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. -#### TEST CASES +## Enabling API Access on Kemp LoadMaster + +This guide describes how to enable and verify API access on a Kemp LoadMaster device for integration with Keyfactor Orchestrator. + +--- + +### 🧩 Step-by-Step: Enabling API Access + +#### 1. Log in to the Kemp Web UI +- Open a browser and go to your LoadMaster’s management interface: + ``` + https://:8443 + ``` +- Log in with an administrative account. + +--- + +#### 2. Configure User Permissions and Generate an API Key +1. Navigate to: + ``` + System Configuration → User Management + ``` +2. Under **Rules**, check the box for **Intermediate Certificates**. + - This permission allows the orchestrator to upload or replace certificates. +3. Scroll to the **API Keys** section: + - Click **Generate New APIKey**. + - Copy and securely store the API key for later use. +4. (Optional) Under **Local Certificate**: + - Click **Generate** to create a self-signed admin certificate. + - Click **Download Certificate** if the orchestrator requires importing it. + +--- + +#### 3. Enable API and Administrative Access +1. Go to: + ``` + System Configuration → Remote Access + ``` +2. Under **Administrator Access**, enable the following settings: + - ✅ **Allow Web Administrative Access** + - **Using:** `eth0` (or the management interface) + - **Port:** `8443` + - ✅ **Enable API Interface** + - **Port:** `8443` + - ✅ **Allow Multi Interface Access** (optional, if the orchestrator connects from another subnet) + - **Authentication Method:** `Password Only Access (default)` + - (Optional) **Enable Software FIPS mode** if required by compliance policies. +3. Click **Set Administrative Access** (if shown), then **Save Changes**. + +--- + +#### 4. Verify API Access +Use a command line or PowerShell session to confirm connectivity: + +#### 5. Configure in Keyfactor Orchestrator +When setting up your Kemp Orchestrator Store Type, provide the following values: + +| Field | Value | +|-------|--------| +| **ServerUsername** | LoadMaster admin username | +| **ServerPassword** | API Key generated earlier | +| **ServerUseSsl** | true | +| **ServerHostname** | e.g., `testkemp:8443` | + +--- + +#### ✅ Summary of Required Settings + +| Setting | Location | Value | +|----------|-----------|--------| +| Allow Web Administrative Access | System Configuration → Remote Access | Enabled | +| Enable API Interface | System Configuration → Remote Access | Enabled | +| API Port | System Configuration → Remote Access | 8443 | +| Intermediate Certificates Rule | System Configuration → User Management | Enabled | +| API Key | System Configuration → User Management | Generated | +| Authentication Method | System Configuration → Remote Access | Password Only (default) | + +--- + + +### TEST CASES Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots ------------|---------|----------------|--------------|----------|----------------|--------------|------------ 1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) From 3d4b3097041f5a1d97db8058c750e1f038c8c9ad Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Mon, 27 Oct 2025 17:16:12 +0000 Subject: [PATCH 17/38] Update generated docs --- README.md | 109 ++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 94 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 6ed5313..08dbad3 100644 --- a/README.md +++ b/README.md @@ -33,21 +33,6 @@ 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. -#### TEST CASES -Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots -------------|---------|----------------|--------------|----------|----------------|--------------|------------ -1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) -2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) -3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) -4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) -5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) -6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) -7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) -8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) -9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) -10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) -11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) - ## Compatibility @@ -319,6 +304,100 @@ TODO Discovery Job Configuration is an optional section. If this section doesn't +## Enabling API Access on Kemp LoadMaster + +This guide describes how to enable and verify API access on a Kemp LoadMaster device for integration with Keyfactor Orchestrator. + +--- + +### 🧩 Step-by-Step: Enabling API Access + +#### 1. Log in to the Kemp Web UI +- Open a browser and go to your LoadMaster’s management interface: + ``` + https://:8443 + ``` +- Log in with an administrative account. + +--- + +#### 2. Configure User Permissions and Generate an API Key +1. Navigate to: + ``` + System Configuration → User Management + ``` +2. Under **Rules**, check the box for **Intermediate Certificates**. + - This permission allows the orchestrator to upload or replace certificates. +3. Scroll to the **API Keys** section: + - Click **Generate New APIKey**. + - Copy and securely store the API key for later use. +4. (Optional) Under **Local Certificate**: + - Click **Generate** to create a self-signed admin certificate. + - Click **Download Certificate** if the orchestrator requires importing it. + +--- + +#### 3. Enable API and Administrative Access +1. Go to: + ``` + System Configuration → Remote Access + ``` +2. Under **Administrator Access**, enable the following settings: + - ✅ **Allow Web Administrative Access** + - **Using:** `eth0` (or the management interface) + - **Port:** `8443` + - ✅ **Enable API Interface** + - **Port:** `8443` + - ✅ **Allow Multi Interface Access** (optional, if the orchestrator connects from another subnet) + - **Authentication Method:** `Password Only Access (default)` + - (Optional) **Enable Software FIPS mode** if required by compliance policies. +3. Click **Set Administrative Access** (if shown), then **Save Changes**. + +--- + +#### 4. Verify API Access +Use a command line or PowerShell session to confirm connectivity: + +#### 5. Configure in Keyfactor Orchestrator +When setting up your Kemp Orchestrator Store Type, provide the following values: + +| Field | Value | +|-------|--------| +| **ServerUsername** | LoadMaster admin username | +| **ServerPassword** | API Key generated earlier | +| **ServerUseSsl** | true | +| **ServerHostname** | e.g., `testkemp:8443` | + +--- + +#### ✅ Summary of Required Settings + +| Setting | Location | Value | +|----------|-----------|--------| +| Allow Web Administrative Access | System Configuration → Remote Access | Enabled | +| Enable API Interface | System Configuration → Remote Access | Enabled | +| API Port | System Configuration → Remote Access | 8443 | +| Intermediate Certificates Rule | System Configuration → User Management | Enabled | +| API Key | System Configuration → User Management | Generated | +| Authentication Method | System Configuration → Remote Access | Password Only (default) | + +--- + +### TEST CASES +Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots +------------|---------|----------------|--------------|----------|----------------|--------------|------------ +1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) +2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) +3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) +4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) +5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) +6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) +7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) +8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) +9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) +10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) +11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) + ## License From 7514e2f0e0e8a2c43232fc5cd2c77fcc04c74f7d Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 14:19:24 -0400 Subject: [PATCH 18/38] Update content.md --- docsource/content.md | 95 ++++++++++++++++++++------------------------ 1 file changed, 43 insertions(+), 52 deletions(-) diff --git a/docsource/content.md b/docsource/content.md index a698208..18496a2 100644 --- a/docsource/content.md +++ b/docsource/content.md @@ -2,87 +2,78 @@ 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. -## Enabling API Access on Kemp LoadMaster +# Enabling API Access for Keyfactor on Kemp LoadMaster -This guide describes how to enable and verify API access on a Kemp LoadMaster device for integration with Keyfactor Orchestrator. +This guide explains how to enable API access for a specific user on a Kemp LoadMaster appliance to allow Keyfactor Orchestrator integrations for certificate management and inventory operations. --- -### 🧩 Step-by-Step: Enabling API Access +## 🧩 Step-by-Step: Enabling API Access for a User -#### 1. Log in to the Kemp Web UI -- Open a browser and go to your LoadMaster’s management interface: +### 1. Log in to the Kemp Web UI +- In your browser, go to: ``` https://:8443 ``` -- Log in with an administrative account. +- Log in as an administrator account that can manage users. --- -#### 2. Configure User Permissions and Generate an API Key -1. Navigate to: +### 2. Edit the User Permissions +1. In the left-hand menu, navigate to: ``` - System Configuration → User Management + System Configuration → System Administration → User Management ``` -2. Under **Rules**, check the box for **Intermediate Certificates**. - - This permission allows the orchestrator to upload or replace certificates. -3. Scroll to the **API Keys** section: - - Click **Generate New APIKey**. - - Copy and securely store the API key for later use. -4. (Optional) Under **Local Certificate**: - - Click **Generate** to create a self-signed admin certificate. - - Click **Download Certificate** if the orchestrator requires importing it. +2. Locate the user account that will be used by the Keyfactor Orchestrator (for example: `bhill`). +3. Click **Modify** next to that user to open the **Permissions for User** screen. +4. Under **Rules**, enable the following options: + - ✅ **Certificate Creation** + - ✅ **Intermediate Certificates** +5. Click **Set Permissions** to apply the changes. + +These permissions allow the orchestrator to create and manage intermediate and server certificates. --- -#### 3. Enable API and Administrative Access -1. Go to: - ``` - System Configuration → Remote Access - ``` -2. Under **Administrator Access**, enable the following settings: - - ✅ **Allow Web Administrative Access** - - **Using:** `eth0` (or the management interface) - - **Port:** `8443` - - ✅ **Enable API Interface** - - **Port:** `8443` - - ✅ **Allow Multi Interface Access** (optional, if the orchestrator connects from another subnet) - - **Authentication Method:** `Password Only Access (default)` - - (Optional) **Enable Software FIPS mode** if required by compliance policies. -3. Click **Set Administrative Access** (if shown), then **Save Changes**. +### 3. Generate and Record the API Key +1. Scroll down to the **API Keys** section. +2. Click **Generate New APIKey** to create a new key for API authentication. +3. Copy and securely store this key — it will be used in your Keyfactor orchestrator configuration as the **ServerPassword** or **API Key**. +4. You can later use **Delete** to revoke it if needed. --- -#### 4. Verify API Access -Use a command line or PowerShell session to confirm connectivity: +### 4. Verify API Access +Use a command line or PowerShell session to verify connectivity: -#### 5. Configure in Keyfactor Orchestrator -When setting up your Kemp Orchestrator Store Type, provide the following values: +#### Using curl: +```bash +curl -k -H "Authorization: " https://:8443/access/list +``` -| Field | Value | -|-------|--------| -| **ServerUsername** | LoadMaster admin username | -| **ServerPassword** | API Key generated earlier | -| **ServerUseSsl** | true | -| **ServerHostname** | e.g., `testkemp:8443` | +#### Using PowerShell: +```powershell +Invoke-RestMethod -Uri "https://:8443/access/list" -Headers @{ Authorization = "" } -SkipCertificateCheck +``` + +If you receive a JSON response, API access is successfully configured. ---- -#### ✅ Summary of Required Settings +### ✅ Summary of Required Settings | Setting | Location | Value | |----------|-----------|--------| -| Allow Web Administrative Access | System Configuration → Remote Access | Enabled | -| Enable API Interface | System Configuration → Remote Access | Enabled | -| API Port | System Configuration → Remote Access | 8443 | -| Intermediate Certificates Rule | System Configuration → User Management | Enabled | -| API Key | System Configuration → User Management | Generated | -| Authentication Method | System Configuration → Remote Access | Password Only (default) | +| Certificate Creation | User Permissions | Enabled | +| Intermediate Certificates | User Permissions | Enabled | +| API Key | User Management (Modify user) | Generated | +| Allow Web Administrative Access | Remote Access | Enabled | +| Enable API Interface | Remote Access | Enabled | +| Port | Remote Access | 8443 | +| Authentication Method | Remote Access | Password Only (default) | --- - -### TEST CASES +## TEST CASES Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots ------------|---------|----------------|--------------|----------|----------------|--------------|------------ 1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) From 89f30c002c3bb50c91218ffaa878597d14f61a66 Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Mon, 27 Oct 2025 18:21:14 +0000 Subject: [PATCH 19/38] Update generated docs --- README.md | 95 +++++++++++++++++++++++-------------------------------- 1 file changed, 40 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 08dbad3..1a32487 100644 --- a/README.md +++ b/README.md @@ -304,86 +304,71 @@ TODO Discovery Job Configuration is an optional section. If this section doesn't -## Enabling API Access on Kemp LoadMaster +## 🧩 Step-by-Step: Enabling API Access for a User -This guide describes how to enable and verify API access on a Kemp LoadMaster device for integration with Keyfactor Orchestrator. - ---- - -### 🧩 Step-by-Step: Enabling API Access - -#### 1. Log in to the Kemp Web UI -- Open a browser and go to your LoadMaster’s management interface: +### 1. Log in to the Kemp Web UI +- In your browser, go to: ``` https://:8443 ``` -- Log in with an administrative account. +- Log in as an administrator account that can manage users. --- -#### 2. Configure User Permissions and Generate an API Key -1. Navigate to: +### 2. Edit the User Permissions +1. In the left-hand menu, navigate to: ``` - System Configuration → User Management + System Configuration → System Administration → User Management ``` -2. Under **Rules**, check the box for **Intermediate Certificates**. - - This permission allows the orchestrator to upload or replace certificates. -3. Scroll to the **API Keys** section: - - Click **Generate New APIKey**. - - Copy and securely store the API key for later use. -4. (Optional) Under **Local Certificate**: - - Click **Generate** to create a self-signed admin certificate. - - Click **Download Certificate** if the orchestrator requires importing it. +2. Locate the user account that will be used by the Keyfactor Orchestrator (for example: `bhill`). +3. Click **Modify** next to that user to open the **Permissions for User** screen. +4. Under **Rules**, enable the following options: + - ✅ **Certificate Creation** + - ✅ **Intermediate Certificates** +5. Click **Set Permissions** to apply the changes. + +These permissions allow the orchestrator to create and manage intermediate and server certificates. --- -#### 3. Enable API and Administrative Access -1. Go to: - ``` - System Configuration → Remote Access - ``` -2. Under **Administrator Access**, enable the following settings: - - ✅ **Allow Web Administrative Access** - - **Using:** `eth0` (or the management interface) - - **Port:** `8443` - - ✅ **Enable API Interface** - - **Port:** `8443` - - ✅ **Allow Multi Interface Access** (optional, if the orchestrator connects from another subnet) - - **Authentication Method:** `Password Only Access (default)` - - (Optional) **Enable Software FIPS mode** if required by compliance policies. -3. Click **Set Administrative Access** (if shown), then **Save Changes**. +### 3. Generate and Record the API Key +1. Scroll down to the **API Keys** section. +2. Click **Generate New APIKey** to create a new key for API authentication. +3. Copy and securely store this key — it will be used in your Keyfactor orchestrator configuration as the **ServerPassword** or **API Key**. +4. You can later use **Delete** to revoke it if needed. --- -#### 4. Verify API Access -Use a command line or PowerShell session to confirm connectivity: +### 4. Verify API Access +Use a command line or PowerShell session to verify connectivity: -#### 5. Configure in Keyfactor Orchestrator -When setting up your Kemp Orchestrator Store Type, provide the following values: +#### Using curl: +```bash +curl -k -H "Authorization: " https://:8443/access/list +``` -| Field | Value | -|-------|--------| -| **ServerUsername** | LoadMaster admin username | -| **ServerPassword** | API Key generated earlier | -| **ServerUseSsl** | true | -| **ServerHostname** | e.g., `testkemp:8443` | +#### Using PowerShell: +```powershell +Invoke-RestMethod -Uri "https://:8443/access/list" -Headers @{ Authorization = "" } -SkipCertificateCheck +``` ---- +If you receive a JSON response, API access is successfully configured. -#### ✅ Summary of Required Settings +### ✅ Summary of Required Settings | Setting | Location | Value | |----------|-----------|--------| -| Allow Web Administrative Access | System Configuration → Remote Access | Enabled | -| Enable API Interface | System Configuration → Remote Access | Enabled | -| API Port | System Configuration → Remote Access | 8443 | -| Intermediate Certificates Rule | System Configuration → User Management | Enabled | -| API Key | System Configuration → User Management | Generated | -| Authentication Method | System Configuration → Remote Access | Password Only (default) | +| Certificate Creation | User Permissions | Enabled | +| Intermediate Certificates | User Permissions | Enabled | +| API Key | User Management (Modify user) | Generated | +| Allow Web Administrative Access | Remote Access | Enabled | +| Enable API Interface | Remote Access | Enabled | +| Port | Remote Access | 8443 | +| Authentication Method | Remote Access | Password Only (default) | --- -### TEST CASES +## TEST CASES Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots ------------|---------|----------------|--------------|----------|----------------|--------------|------------ 1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) From f07a6ce005ed0f71b63d4c3288a2a93844123263 Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 14:28:56 -0400 Subject: [PATCH 20/38] Update README.md --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 60 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a32487..1db69f4 100644 --- a/README.md +++ b/README.md @@ -366,6 +366,65 @@ If you receive a JSON response, API access is successfully configured. | Port | Remote Access | 8443 | | Authentication Method | Remote Access | Password Only (default) | +--- +## Kemp LoadMaster Orchestrator – Behavior Summary + +This document summarizes the observed behaviors of the **Kemp LoadMaster Orchestrator** integration during SSL and Intermediate Certificate management operations. +It details how the orchestrator interacts with the LoadMaster API, handles overwrite logic, manages bindings, and synchronizes data with Keyfactor Command. + +--- + +### 🧩 Overall Integration Behavior + +- The orchestrator communicates with the **Kemp LoadMaster REST API** using the configured **ServerUsername**, **API Key**, and **SSL (HTTPS)** over port 8443. +- Operations are driven by the **Overwrite flag** and **Alias Name** supplied in the job parameters. +- Certificates are managed in two categories: + - **SSL Certificates** – used by virtual services (may be bound/unbound). + - **Intermediate Certificates** – uploaded supporting CA chain files. +- The orchestrator validates overwrite rules, binding constraints, and synchronization with Keyfactor Command for each operation. + +--- + +### 🧪 Test Case Behavior Summary + +| # | Case Name | Behavior Summary | Outcome | +|---|------------|------------------|----------| +| **1** | **New Add New Alias SSL Certificates** | When a new alias (`TC1`) is provided and the certificate does not exist, the orchestrator successfully uploads a new SSL certificate to the LoadMaster and registers it in Keyfactor. | ✅ New certificate created successfully. | +| **2** | **Replace Alias SSL Certificates** | The orchestrator detects an existing alias (`TC1`) and, with **Overwrite=True**, replaces the existing SSL certificate. The old certificate file is overwritten. | ✅ Replacement successful. | +| **3** | **Replace Alias SSL Certificates (No Overwrite)** | Attempting to replace an existing alias without the overwrite flag causes the orchestrator to abort the operation and return an error indicating the flag is required. | ✅ Expected error: “Overwrite flag should be used.” | +| **4** | **Replace Alias Bound SSL Certificates** | When a certificate bound to a virtual service is replaced with **Overwrite=True**, the orchestrator updates the certificate file while maintaining the existing service binding. | ✅ Bound certificate replaced in place. | +| **5** | **Remove Bound SSL Certificate** | The orchestrator prevents removal of any certificate that is currently bound to a virtual service, returning an error message. | ✅ Error handled correctly (“cannot remove bound certificates”). | +| **6** | **Remove Unbound SSL Certificate** | The orchestrator removes an SSL certificate only if it is unbound, confirming removal through the LoadMaster API. | ✅ Certificate removed successfully. | +| **7** | **New Add New Alias Intermediate Certificates** | A new intermediate certificate (`TC8b`) is uploaded since no alias conflict exists. It appears under the Intermediate Certificates list. | ✅ Intermediate certificate created. | +| **8** | **Replace Alias Intermediate Certificates** | Kemp does not support overwriting intermediate certificates. The orchestrator logs and returns the expected API error (`Filename already exists`). | ✅ Expected failure recorded. | +| **9** | **Remove Intermediate Certificates** | The orchestrator deletes the intermediate certificate (`TC8b`) from the LoadMaster and synchronizes removal from Keyfactor Command. | ✅ Certificate removed successfully. | +| **10** | **Inventory Intermediate Certificates** | Performs an inventory scan of all intermediate certificates on the LoadMaster, importing them into Keyfactor Command. | ✅ Inventory successful. | +| **11** | **Inventory SSL Certificates** | Enumerates all SSL certificates (bound and unbound) on the LoadMaster and updates Keyfactor’s inventory accordingly. | ✅ Inventory successful. | + +--- + +### ⚙️ Functional Insights + +- **Overwrite Logic:** SSL certificates respect the `Overwrite` flag. Intermediate certificates cannot be overwritten. +- **Binding Awareness:** The orchestrator checks for bound services before delete or replace operations. +- **Error Handling:** Clear API error messages are surfaced in Keyfactor job logs. +- **Synchronization:** Add/Remove/Inventory maintain consistent state between Keyfactor and LoadMaster. +- **Security:** All operations occur over HTTPS using API Key authentication. + +--- + +### ✅ Operation Coverage Summary + +| Operation | Certificate Type | Supported | Notes | +|------------|------------------|------------|--------| +| Add | SSL | ✅ | Creates new alias or replaces with overwrite flag | +| Replace | SSL | ✅ | Requires `Overwrite=True` | +| Replace | Intermediate | ❌ | Unsupported – API rejects | +| Remove | SSL | ✅ | Allowed only if unbound | +| Remove | Intermediate | ✅ | Fully supported | +| Inventory | SSL | ✅ | Returns all SSL certificates | +| Inventory | Intermediate | ✅ | Returns all intermediate certificates | + --- ## TEST CASES @@ -390,4 +449,4 @@ 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). From cd2f45ac67f9a2ef6e2d24ffa3106538ade768f0 Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Mon, 27 Oct 2025 18:30:37 +0000 Subject: [PATCH 21/38] Update generated docs --- README.md | 61 +------------------------------------------------------ 1 file changed, 1 insertion(+), 60 deletions(-) diff --git a/README.md b/README.md index 1db69f4..1a32487 100644 --- a/README.md +++ b/README.md @@ -366,65 +366,6 @@ If you receive a JSON response, API access is successfully configured. | Port | Remote Access | 8443 | | Authentication Method | Remote Access | Password Only (default) | ---- -## Kemp LoadMaster Orchestrator – Behavior Summary - -This document summarizes the observed behaviors of the **Kemp LoadMaster Orchestrator** integration during SSL and Intermediate Certificate management operations. -It details how the orchestrator interacts with the LoadMaster API, handles overwrite logic, manages bindings, and synchronizes data with Keyfactor Command. - ---- - -### 🧩 Overall Integration Behavior - -- The orchestrator communicates with the **Kemp LoadMaster REST API** using the configured **ServerUsername**, **API Key**, and **SSL (HTTPS)** over port 8443. -- Operations are driven by the **Overwrite flag** and **Alias Name** supplied in the job parameters. -- Certificates are managed in two categories: - - **SSL Certificates** – used by virtual services (may be bound/unbound). - - **Intermediate Certificates** – uploaded supporting CA chain files. -- The orchestrator validates overwrite rules, binding constraints, and synchronization with Keyfactor Command for each operation. - ---- - -### 🧪 Test Case Behavior Summary - -| # | Case Name | Behavior Summary | Outcome | -|---|------------|------------------|----------| -| **1** | **New Add New Alias SSL Certificates** | When a new alias (`TC1`) is provided and the certificate does not exist, the orchestrator successfully uploads a new SSL certificate to the LoadMaster and registers it in Keyfactor. | ✅ New certificate created successfully. | -| **2** | **Replace Alias SSL Certificates** | The orchestrator detects an existing alias (`TC1`) and, with **Overwrite=True**, replaces the existing SSL certificate. The old certificate file is overwritten. | ✅ Replacement successful. | -| **3** | **Replace Alias SSL Certificates (No Overwrite)** | Attempting to replace an existing alias without the overwrite flag causes the orchestrator to abort the operation and return an error indicating the flag is required. | ✅ Expected error: “Overwrite flag should be used.” | -| **4** | **Replace Alias Bound SSL Certificates** | When a certificate bound to a virtual service is replaced with **Overwrite=True**, the orchestrator updates the certificate file while maintaining the existing service binding. | ✅ Bound certificate replaced in place. | -| **5** | **Remove Bound SSL Certificate** | The orchestrator prevents removal of any certificate that is currently bound to a virtual service, returning an error message. | ✅ Error handled correctly (“cannot remove bound certificates”). | -| **6** | **Remove Unbound SSL Certificate** | The orchestrator removes an SSL certificate only if it is unbound, confirming removal through the LoadMaster API. | ✅ Certificate removed successfully. | -| **7** | **New Add New Alias Intermediate Certificates** | A new intermediate certificate (`TC8b`) is uploaded since no alias conflict exists. It appears under the Intermediate Certificates list. | ✅ Intermediate certificate created. | -| **8** | **Replace Alias Intermediate Certificates** | Kemp does not support overwriting intermediate certificates. The orchestrator logs and returns the expected API error (`Filename already exists`). | ✅ Expected failure recorded. | -| **9** | **Remove Intermediate Certificates** | The orchestrator deletes the intermediate certificate (`TC8b`) from the LoadMaster and synchronizes removal from Keyfactor Command. | ✅ Certificate removed successfully. | -| **10** | **Inventory Intermediate Certificates** | Performs an inventory scan of all intermediate certificates on the LoadMaster, importing them into Keyfactor Command. | ✅ Inventory successful. | -| **11** | **Inventory SSL Certificates** | Enumerates all SSL certificates (bound and unbound) on the LoadMaster and updates Keyfactor’s inventory accordingly. | ✅ Inventory successful. | - ---- - -### ⚙️ Functional Insights - -- **Overwrite Logic:** SSL certificates respect the `Overwrite` flag. Intermediate certificates cannot be overwritten. -- **Binding Awareness:** The orchestrator checks for bound services before delete or replace operations. -- **Error Handling:** Clear API error messages are surfaced in Keyfactor job logs. -- **Synchronization:** Add/Remove/Inventory maintain consistent state between Keyfactor and LoadMaster. -- **Security:** All operations occur over HTTPS using API Key authentication. - ---- - -### ✅ Operation Coverage Summary - -| Operation | Certificate Type | Supported | Notes | -|------------|------------------|------------|--------| -| Add | SSL | ✅ | Creates new alias or replaces with overwrite flag | -| Replace | SSL | ✅ | Requires `Overwrite=True` | -| Replace | Intermediate | ❌ | Unsupported – API rejects | -| Remove | SSL | ✅ | Allowed only if unbound | -| Remove | Intermediate | ✅ | Fully supported | -| Inventory | SSL | ✅ | Returns all SSL certificates | -| Inventory | Intermediate | ✅ | Returns all intermediate certificates | - --- ## TEST CASES @@ -449,4 +390,4 @@ Apache License 2.0, see [LICENSE](LICENSE). ## Related Integrations -See all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator). +See all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator). \ No newline at end of file From c6abc88f6e6f298f6bb818d48c9a19f213395ca6 Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 14:33:11 -0400 Subject: [PATCH 22/38] Update content.md --- docsource/content.md | 62 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/docsource/content.md b/docsource/content.md index 18496a2..869777c 100644 --- a/docsource/content.md +++ b/docsource/content.md @@ -73,6 +73,68 @@ If you receive a JSON response, API access is successfully configured. --- +## Kemp LoadMaster Orchestrator – Behavior Summary + +This document summarizes the observed behaviors of the **Kemp LoadMaster Orchestrator** integration during SSL and Intermediate Certificate management operations. +It details how the orchestrator interacts with the LoadMaster API, handles overwrite logic, manages bindings, and synchronizes data with Keyfactor Command. + +--- + +### 🧩 Overall Integration Behavior + +- The orchestrator communicates with the **Kemp LoadMaster REST API** using the configured **ServerUsername**, **API Key**, and **SSL (HTTPS)** over port 8443. +- Operations are driven by the **Overwrite flag** and **Alias Name** supplied in the job parameters. +- Certificates are managed in two categories: + - **SSL Certificates** – used by virtual services (may be bound/unbound). + - **Intermediate Certificates** – uploaded supporting CA chain files. +- The orchestrator validates overwrite rules, binding constraints, and synchronization with Keyfactor Command for each operation. + +--- + +### 🧪 Test Case Behavior Summary + +| # | Case Name | Behavior Summary | Outcome | +|---|------------|------------------|----------| +| **1** | **New Add New Alias SSL Certificates** | When a new alias (`TC1`) is provided and the certificate does not exist, the orchestrator successfully uploads a new SSL certificate to the LoadMaster and registers it in Keyfactor. | ✅ New certificate created successfully. | +| **2** | **Replace Alias SSL Certificates** | The orchestrator detects an existing alias (`TC1`) and, with **Overwrite=True**, replaces the existing SSL certificate. The old certificate file is overwritten. | ✅ Replacement successful. | +| **3** | **Replace Alias SSL Certificates (No Overwrite)** | Attempting to replace an existing alias without the overwrite flag causes the orchestrator to abort the operation and return an error indicating the flag is required. | ✅ Expected error: “Overwrite flag should be used.” | +| **4** | **Replace Alias Bound SSL Certificates** | When a certificate bound to a virtual service is replaced with **Overwrite=True**, the orchestrator updates the certificate file while maintaining the existing service binding. | ✅ Bound certificate replaced in place. | +| **5** | **Remove Bound SSL Certificate** | The orchestrator prevents removal of any certificate that is currently bound to a virtual service, returning an error message. | ✅ Error handled correctly (“cannot remove bound certificates”). | +| **6** | **Remove Unbound SSL Certificate** | The orchestrator removes an SSL certificate only if it is unbound, confirming removal through the LoadMaster API. | ✅ Certificate removed successfully. | +| **7** | **New Add New Alias Intermediate Certificates** | A new intermediate certificate (`TC8b`) is uploaded since no alias conflict exists. It appears under the Intermediate Certificates list. | ✅ Intermediate certificate created. | +| **8** | **Replace Alias Intermediate Certificates** | Kemp does not support overwriting intermediate certificates. The orchestrator logs and returns the expected API error (`Filename already exists`). | ✅ Expected failure recorded. | +| **9** | **Remove Intermediate Certificates** | The orchestrator deletes the intermediate certificate (`TC8b`) from the LoadMaster and synchronizes removal from Keyfactor Command. | ✅ Certificate removed successfully. | +| **10** | **Inventory Intermediate Certificates** | Performs an inventory scan of all intermediate certificates on the LoadMaster, importing them into Keyfactor Command. | ✅ Inventory successful. | +| **11** | **Inventory SSL Certificates** | Enumerates all SSL certificates (bound and unbound) on the LoadMaster and updates Keyfactor’s inventory accordingly. | ✅ Inventory successful. | + +--- + +### ⚙️ Functional Insights + +- **Overwrite Logic:** SSL certificates respect the `Overwrite` flag. Intermediate certificates cannot be overwritten. +- **Binding Awareness:** The orchestrator checks for bound services before delete or replace operations. +- **Error Handling:** Clear API error messages are surfaced in Keyfactor job logs. +- **Synchronization:** Add/Remove/Inventory maintain consistent state between Keyfactor and LoadMaster. +- **Security:** All operations occur over HTTPS using API Key authentication. + +--- + +### ✅ Operation Coverage Summary + +| Operation | Certificate Type | Supported | Notes | +|------------|------------------|------------|--------| +| Add | SSL | ✅ | Creates new alias or replaces with overwrite flag | +| Replace | SSL | ✅ | Requires `Overwrite=True` | +| Replace | Intermediate | ❌ | Unsupported – API rejects | +| Remove | SSL | ✅ | Allowed only if unbound | +| Remove | Intermediate | ✅ | Fully supported | +| Inventory | SSL | ✅ | Returns all SSL certificates | +| Inventory | Intermediate | ✅ | Returns all intermediate certificates | + +--- + + + ## TEST CASES Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots ------------|---------|----------------|--------------|----------|----------------|--------------|------------ From 6e374826b1fd7daa4d331176719a81f66f38a4be Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Mon, 27 Oct 2025 18:36:28 +0000 Subject: [PATCH 23/38] Update generated docs --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/README.md b/README.md index 1a32487..3c98939 100644 --- a/README.md +++ b/README.md @@ -368,6 +368,66 @@ If you receive a JSON response, API access is successfully configured. --- +## Kemp LoadMaster Orchestrator – Behavior Summary + +This document summarizes the observed behaviors of the **Kemp LoadMaster Orchestrator** integration during SSL and Intermediate Certificate management operations. +It details how the orchestrator interacts with the LoadMaster API, handles overwrite logic, manages bindings, and synchronizes data with Keyfactor Command. + +--- + +### 🧩 Overall Integration Behavior + +- The orchestrator communicates with the **Kemp LoadMaster REST API** using the configured **ServerUsername**, **API Key**, and **SSL (HTTPS)** over port 8443. +- Operations are driven by the **Overwrite flag** and **Alias Name** supplied in the job parameters. +- Certificates are managed in two categories: + - **SSL Certificates** – used by virtual services (may be bound/unbound). + - **Intermediate Certificates** – uploaded supporting CA chain files. +- The orchestrator validates overwrite rules, binding constraints, and synchronization with Keyfactor Command for each operation. + +--- + +### 🧪 Test Case Behavior Summary + +| # | Case Name | Behavior Summary | Outcome | +|---|------------|------------------|----------| +| **1** | **New Add New Alias SSL Certificates** | When a new alias (`TC1`) is provided and the certificate does not exist, the orchestrator successfully uploads a new SSL certificate to the LoadMaster and registers it in Keyfactor. | ✅ New certificate created successfully. | +| **2** | **Replace Alias SSL Certificates** | The orchestrator detects an existing alias (`TC1`) and, with **Overwrite=True**, replaces the existing SSL certificate. The old certificate file is overwritten. | ✅ Replacement successful. | +| **3** | **Replace Alias SSL Certificates (No Overwrite)** | Attempting to replace an existing alias without the overwrite flag causes the orchestrator to abort the operation and return an error indicating the flag is required. | ✅ Expected error: “Overwrite flag should be used.” | +| **4** | **Replace Alias Bound SSL Certificates** | When a certificate bound to a virtual service is replaced with **Overwrite=True**, the orchestrator updates the certificate file while maintaining the existing service binding. | ✅ Bound certificate replaced in place. | +| **5** | **Remove Bound SSL Certificate** | The orchestrator prevents removal of any certificate that is currently bound to a virtual service, returning an error message. | ✅ Error handled correctly (“cannot remove bound certificates”). | +| **6** | **Remove Unbound SSL Certificate** | The orchestrator removes an SSL certificate only if it is unbound, confirming removal through the LoadMaster API. | ✅ Certificate removed successfully. | +| **7** | **New Add New Alias Intermediate Certificates** | A new intermediate certificate (`TC8b`) is uploaded since no alias conflict exists. It appears under the Intermediate Certificates list. | ✅ Intermediate certificate created. | +| **8** | **Replace Alias Intermediate Certificates** | Kemp does not support overwriting intermediate certificates. The orchestrator logs and returns the expected API error (`Filename already exists`). | ✅ Expected failure recorded. | +| **9** | **Remove Intermediate Certificates** | The orchestrator deletes the intermediate certificate (`TC8b`) from the LoadMaster and synchronizes removal from Keyfactor Command. | ✅ Certificate removed successfully. | +| **10** | **Inventory Intermediate Certificates** | Performs an inventory scan of all intermediate certificates on the LoadMaster, importing them into Keyfactor Command. | ✅ Inventory successful. | +| **11** | **Inventory SSL Certificates** | Enumerates all SSL certificates (bound and unbound) on the LoadMaster and updates Keyfactor’s inventory accordingly. | ✅ Inventory successful. | + +--- + +### ⚙️ Functional Insights + +- **Overwrite Logic:** SSL certificates respect the `Overwrite` flag. Intermediate certificates cannot be overwritten. +- **Binding Awareness:** The orchestrator checks for bound services before delete or replace operations. +- **Error Handling:** Clear API error messages are surfaced in Keyfactor job logs. +- **Synchronization:** Add/Remove/Inventory maintain consistent state between Keyfactor and LoadMaster. +- **Security:** All operations occur over HTTPS using API Key authentication. + +--- + +### ✅ Operation Coverage Summary + +| Operation | Certificate Type | Supported | Notes | +|------------|------------------|------------|--------| +| Add | SSL | ✅ | Creates new alias or replaces with overwrite flag | +| Replace | SSL | ✅ | Requires `Overwrite=True` | +| Replace | Intermediate | ❌ | Unsupported – API rejects | +| Remove | SSL | ✅ | Allowed only if unbound | +| Remove | Intermediate | ✅ | Fully supported | +| Inventory | SSL | ✅ | Returns all SSL certificates | +| Inventory | Intermediate | ✅ | Returns all intermediate certificates | + +--- + ## TEST CASES Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots ------------|---------|----------------|--------------|----------|----------------|--------------|------------ From a3c838d63af2ed3d1632cc10f5214622a1cbf5de Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 16:11:34 -0400 Subject: [PATCH 24/38] Create CHANGELOG.md --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..3516ad7 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,2 @@ +# v1.0.0 +- Initial extension release From aad1ffdfa95043b4f137ff88339fbec1db338f6f Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Mon, 27 Oct 2025 16:12:13 -0400 Subject: [PATCH 25/38] Update CHANGELOG.md --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3516ad7..fb751ff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,2 +1,5 @@ +# v2.0.0 +- .Net 6 and .Net 8 Support and Documentation Updates # v1.0.0 - Initial extension release + From 76e8734b4afd8fd3c92fc76f8419726c2e3f981e Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Thu, 30 Oct 2025 11:24:55 -0400 Subject: [PATCH 26/38] Update kemp.md --- docsource/kemp.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docsource/kemp.md b/docsource/kemp.md index d53d056..994c840 100644 --- a/docsource/kemp.md +++ b/docsource/kemp.md @@ -6,10 +6,6 @@ TODO Overview is a required section 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 -## Discovery Job Configuration - -TODO Discovery Job 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 - ## Certificate Store Configuration 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 From 830a5acdc2890ab8c5ac52d30d366ce07aaa1b9d Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Thu, 30 Oct 2025 11:25:45 -0400 Subject: [PATCH 27/38] Update kemp.md --- docsource/kemp.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docsource/kemp.md b/docsource/kemp.md index 994c840..0b6f9ed 100644 --- a/docsource/kemp.md +++ b/docsource/kemp.md @@ -10,7 +10,3 @@ TODO Requirements is an optional section. If this section doesn't seem necessary 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 -## Global Store Type 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 - From d9ef33e3d382e9a1ea18aa0ffce20f8699b0e300 Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Thu, 30 Oct 2025 15:27:19 +0000 Subject: [PATCH 28/38] Update generated docs --- README.md | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/README.md b/README.md index 3c98939..c8c13e1 100644 --- a/README.md +++ b/README.md @@ -57,8 +57,6 @@ To use the Kemp Load Balancer Universal Orchestrator extension, you **must** cre 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 - @@ -208,8 +206,6 @@ the Keyfactor Command Portal ## Defining Certificate Stores -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 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 @@ -294,14 +290,6 @@ 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). -## Discovering Certificate Stores with the Discovery Job - -### Kemp Discovery Job -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 Discovery Job 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 - ## 🧩 Step-by-Step: Enabling API Access for a User From f856edae3fe02579bebf79d206ab691d28e6b834 Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Tue, 11 Nov 2025 11:10:25 -0500 Subject: [PATCH 29/38] Delete docsource/kemp.md --- docsource/kemp.md | 12 ------------ 1 file changed, 12 deletions(-) delete mode 100644 docsource/kemp.md diff --git a/docsource/kemp.md b/docsource/kemp.md deleted file mode 100644 index 0b6f9ed..0000000 --- a/docsource/kemp.md +++ /dev/null @@ -1,12 +0,0 @@ -## Overview - -TODO Overview is a required section - -## 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 - -## Certificate Store Configuration - -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 - From 147c68f87683bc345d8d98fff43cb29c9f3bc7e1 Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Tue, 11 Nov 2025 11:11:06 -0500 Subject: [PATCH 30/38] Update integration-manifest.json --- integration-manifest.json | 1 - 1 file changed, 1 deletion(-) diff --git a/integration-manifest.json b/integration-manifest.json index b05a81a..8dfb40d 100644 --- a/integration-manifest.json +++ b/integration-manifest.json @@ -14,7 +14,6 @@ "UOFramework": "10.4", "keyfactor_platform_version": "10.4", "pam_support": true, -"keyfactor_platform_version": "10.4", "win": { "supportsCreateStore": false, "supportsDiscovery": false, From 62719fa3db3a9f73835ea7ccc1fd857bb88ef3a3 Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Tue, 11 Nov 2025 16:12:48 +0000 Subject: [PATCH 31/38] Update generated docs --- README.md | 12 ++++++++++++ docsource/kemp.md | 20 ++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 docsource/kemp.md diff --git a/README.md b/README.md index c8c13e1..3c98939 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,8 @@ To use the Kemp Load Balancer Universal Orchestrator extension, you **must** cre 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 + @@ -206,6 +208,8 @@ the Keyfactor Command Portal ## Defining Certificate Stores +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 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 @@ -290,6 +294,14 @@ 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). +## Discovering Certificate Stores with the Discovery Job + +### Kemp Discovery Job +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 Discovery Job 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 + ## 🧩 Step-by-Step: Enabling API Access for a User diff --git a/docsource/kemp.md b/docsource/kemp.md new file mode 100644 index 0000000..d53d056 --- /dev/null +++ b/docsource/kemp.md @@ -0,0 +1,20 @@ +## Overview + +TODO Overview is a required section + +## 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 + +## Discovery Job Configuration + +TODO Discovery Job 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 + +## Certificate Store Configuration + +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 + +## Global Store Type 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 + From dbce865dd99d3fa3ede124115798104107e06d22 Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Tue, 11 Nov 2025 11:12:53 -0500 Subject: [PATCH 32/38] Update content.md --- docsource/content.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docsource/content.md b/docsource/content.md index 869777c..2b6dd27 100644 --- a/docsource/content.md +++ b/docsource/content.md @@ -148,4 +148,4 @@ Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Result 8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) 9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) 10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) -11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) +11|Inventory SSL Certificates|SSL Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) From 93aa0ce98f4c4679005bf3d83580226557787bc1 Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Tue, 11 Nov 2025 11:13:58 -0500 Subject: [PATCH 33/38] Update kemp.md --- docsource/kemp.md | 149 +++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 140 insertions(+), 9 deletions(-) diff --git a/docsource/kemp.md b/docsource/kemp.md index d53d056..2b6dd27 100644 --- a/docsource/kemp.md +++ b/docsource/kemp.md @@ -1,20 +1,151 @@ ## Overview -TODO Overview is a required section +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. -## Requirements +# Enabling API Access for Keyfactor on Kemp LoadMaster -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 +This guide explains how to enable API access for a specific user on a Kemp LoadMaster appliance to allow Keyfactor Orchestrator integrations for certificate management and inventory operations. -## Discovery Job Configuration +--- -TODO Discovery Job 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 +## 🧩 Step-by-Step: Enabling API Access for a User -## Certificate Store Configuration +### 1. Log in to the Kemp Web UI +- In your browser, go to: + ``` + https://:8443 + ``` +- Log in as an administrator account that can manage users. -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 +--- -## Global Store Type Section +### 2. Edit the User Permissions +1. In the left-hand menu, navigate to: + ``` + System Configuration → System Administration → User Management + ``` +2. Locate the user account that will be used by the Keyfactor Orchestrator (for example: `bhill`). +3. Click **Modify** next to that user to open the **Permissions for User** screen. +4. Under **Rules**, enable the following options: + - ✅ **Certificate Creation** + - ✅ **Intermediate Certificates** +5. Click **Set Permissions** to apply the changes. -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 +These permissions allow the orchestrator to create and manage intermediate and server certificates. +--- + +### 3. Generate and Record the API Key +1. Scroll down to the **API Keys** section. +2. Click **Generate New APIKey** to create a new key for API authentication. +3. Copy and securely store this key — it will be used in your Keyfactor orchestrator configuration as the **ServerPassword** or **API Key**. +4. You can later use **Delete** to revoke it if needed. + +--- + +### 4. Verify API Access +Use a command line or PowerShell session to verify connectivity: + +#### Using curl: +```bash +curl -k -H "Authorization: " https://:8443/access/list +``` + +#### Using PowerShell: +```powershell +Invoke-RestMethod -Uri "https://:8443/access/list" -Headers @{ Authorization = "" } -SkipCertificateCheck +``` + +If you receive a JSON response, API access is successfully configured. + + +### ✅ Summary of Required Settings + +| Setting | Location | Value | +|----------|-----------|--------| +| Certificate Creation | User Permissions | Enabled | +| Intermediate Certificates | User Permissions | Enabled | +| API Key | User Management (Modify user) | Generated | +| Allow Web Administrative Access | Remote Access | Enabled | +| Enable API Interface | Remote Access | Enabled | +| Port | Remote Access | 8443 | +| Authentication Method | Remote Access | Password Only (default) | + +--- + +## Kemp LoadMaster Orchestrator – Behavior Summary + +This document summarizes the observed behaviors of the **Kemp LoadMaster Orchestrator** integration during SSL and Intermediate Certificate management operations. +It details how the orchestrator interacts with the LoadMaster API, handles overwrite logic, manages bindings, and synchronizes data with Keyfactor Command. + +--- + +### 🧩 Overall Integration Behavior + +- The orchestrator communicates with the **Kemp LoadMaster REST API** using the configured **ServerUsername**, **API Key**, and **SSL (HTTPS)** over port 8443. +- Operations are driven by the **Overwrite flag** and **Alias Name** supplied in the job parameters. +- Certificates are managed in two categories: + - **SSL Certificates** – used by virtual services (may be bound/unbound). + - **Intermediate Certificates** – uploaded supporting CA chain files. +- The orchestrator validates overwrite rules, binding constraints, and synchronization with Keyfactor Command for each operation. + +--- + +### 🧪 Test Case Behavior Summary + +| # | Case Name | Behavior Summary | Outcome | +|---|------------|------------------|----------| +| **1** | **New Add New Alias SSL Certificates** | When a new alias (`TC1`) is provided and the certificate does not exist, the orchestrator successfully uploads a new SSL certificate to the LoadMaster and registers it in Keyfactor. | ✅ New certificate created successfully. | +| **2** | **Replace Alias SSL Certificates** | The orchestrator detects an existing alias (`TC1`) and, with **Overwrite=True**, replaces the existing SSL certificate. The old certificate file is overwritten. | ✅ Replacement successful. | +| **3** | **Replace Alias SSL Certificates (No Overwrite)** | Attempting to replace an existing alias without the overwrite flag causes the orchestrator to abort the operation and return an error indicating the flag is required. | ✅ Expected error: “Overwrite flag should be used.” | +| **4** | **Replace Alias Bound SSL Certificates** | When a certificate bound to a virtual service is replaced with **Overwrite=True**, the orchestrator updates the certificate file while maintaining the existing service binding. | ✅ Bound certificate replaced in place. | +| **5** | **Remove Bound SSL Certificate** | The orchestrator prevents removal of any certificate that is currently bound to a virtual service, returning an error message. | ✅ Error handled correctly (“cannot remove bound certificates”). | +| **6** | **Remove Unbound SSL Certificate** | The orchestrator removes an SSL certificate only if it is unbound, confirming removal through the LoadMaster API. | ✅ Certificate removed successfully. | +| **7** | **New Add New Alias Intermediate Certificates** | A new intermediate certificate (`TC8b`) is uploaded since no alias conflict exists. It appears under the Intermediate Certificates list. | ✅ Intermediate certificate created. | +| **8** | **Replace Alias Intermediate Certificates** | Kemp does not support overwriting intermediate certificates. The orchestrator logs and returns the expected API error (`Filename already exists`). | ✅ Expected failure recorded. | +| **9** | **Remove Intermediate Certificates** | The orchestrator deletes the intermediate certificate (`TC8b`) from the LoadMaster and synchronizes removal from Keyfactor Command. | ✅ Certificate removed successfully. | +| **10** | **Inventory Intermediate Certificates** | Performs an inventory scan of all intermediate certificates on the LoadMaster, importing them into Keyfactor Command. | ✅ Inventory successful. | +| **11** | **Inventory SSL Certificates** | Enumerates all SSL certificates (bound and unbound) on the LoadMaster and updates Keyfactor’s inventory accordingly. | ✅ Inventory successful. | + +--- + +### ⚙️ Functional Insights + +- **Overwrite Logic:** SSL certificates respect the `Overwrite` flag. Intermediate certificates cannot be overwritten. +- **Binding Awareness:** The orchestrator checks for bound services before delete or replace operations. +- **Error Handling:** Clear API error messages are surfaced in Keyfactor job logs. +- **Synchronization:** Add/Remove/Inventory maintain consistent state between Keyfactor and LoadMaster. +- **Security:** All operations occur over HTTPS using API Key authentication. + +--- + +### ✅ Operation Coverage Summary + +| Operation | Certificate Type | Supported | Notes | +|------------|------------------|------------|--------| +| Add | SSL | ✅ | Creates new alias or replaces with overwrite flag | +| Replace | SSL | ✅ | Requires `Overwrite=True` | +| Replace | Intermediate | ❌ | Unsupported – API rejects | +| Remove | SSL | ✅ | Allowed only if unbound | +| Remove | Intermediate | ✅ | Fully supported | +| Inventory | SSL | ✅ | Returns all SSL certificates | +| Inventory | Intermediate | ✅ | Returns all intermediate certificates | + +--- + + + +## TEST CASES +Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots +------------|---------|----------------|--------------|----------|----------------|--------------|------------ +1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) +2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) +3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) +4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) +5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) +6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) +7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) +8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) +9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) +10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) +11|Inventory SSL Certificates|SSL Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) From 961d7a6a3accafa7bcfbe0f5ae1662693773a91a Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Tue, 11 Nov 2025 11:14:18 -0500 Subject: [PATCH 34/38] Delete docsource/content.md --- docsource/content.md | 151 ------------------------------------------- 1 file changed, 151 deletions(-) delete mode 100644 docsource/content.md diff --git a/docsource/content.md b/docsource/content.md deleted file mode 100644 index 2b6dd27..0000000 --- a/docsource/content.md +++ /dev/null @@ -1,151 +0,0 @@ -## Overview - -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. - -# Enabling API Access for Keyfactor on Kemp LoadMaster - -This guide explains how to enable API access for a specific user on a Kemp LoadMaster appliance to allow Keyfactor Orchestrator integrations for certificate management and inventory operations. - ---- - -## 🧩 Step-by-Step: Enabling API Access for a User - -### 1. Log in to the Kemp Web UI -- In your browser, go to: - ``` - https://:8443 - ``` -- Log in as an administrator account that can manage users. - ---- - -### 2. Edit the User Permissions -1. In the left-hand menu, navigate to: - ``` - System Configuration → System Administration → User Management - ``` -2. Locate the user account that will be used by the Keyfactor Orchestrator (for example: `bhill`). -3. Click **Modify** next to that user to open the **Permissions for User** screen. -4. Under **Rules**, enable the following options: - - ✅ **Certificate Creation** - - ✅ **Intermediate Certificates** -5. Click **Set Permissions** to apply the changes. - -These permissions allow the orchestrator to create and manage intermediate and server certificates. - ---- - -### 3. Generate and Record the API Key -1. Scroll down to the **API Keys** section. -2. Click **Generate New APIKey** to create a new key for API authentication. -3. Copy and securely store this key — it will be used in your Keyfactor orchestrator configuration as the **ServerPassword** or **API Key**. -4. You can later use **Delete** to revoke it if needed. - ---- - -### 4. Verify API Access -Use a command line or PowerShell session to verify connectivity: - -#### Using curl: -```bash -curl -k -H "Authorization: " https://:8443/access/list -``` - -#### Using PowerShell: -```powershell -Invoke-RestMethod -Uri "https://:8443/access/list" -Headers @{ Authorization = "" } -SkipCertificateCheck -``` - -If you receive a JSON response, API access is successfully configured. - - -### ✅ Summary of Required Settings - -| Setting | Location | Value | -|----------|-----------|--------| -| Certificate Creation | User Permissions | Enabled | -| Intermediate Certificates | User Permissions | Enabled | -| API Key | User Management (Modify user) | Generated | -| Allow Web Administrative Access | Remote Access | Enabled | -| Enable API Interface | Remote Access | Enabled | -| Port | Remote Access | 8443 | -| Authentication Method | Remote Access | Password Only (default) | - ---- - -## Kemp LoadMaster Orchestrator – Behavior Summary - -This document summarizes the observed behaviors of the **Kemp LoadMaster Orchestrator** integration during SSL and Intermediate Certificate management operations. -It details how the orchestrator interacts with the LoadMaster API, handles overwrite logic, manages bindings, and synchronizes data with Keyfactor Command. - ---- - -### 🧩 Overall Integration Behavior - -- The orchestrator communicates with the **Kemp LoadMaster REST API** using the configured **ServerUsername**, **API Key**, and **SSL (HTTPS)** over port 8443. -- Operations are driven by the **Overwrite flag** and **Alias Name** supplied in the job parameters. -- Certificates are managed in two categories: - - **SSL Certificates** – used by virtual services (may be bound/unbound). - - **Intermediate Certificates** – uploaded supporting CA chain files. -- The orchestrator validates overwrite rules, binding constraints, and synchronization with Keyfactor Command for each operation. - ---- - -### 🧪 Test Case Behavior Summary - -| # | Case Name | Behavior Summary | Outcome | -|---|------------|------------------|----------| -| **1** | **New Add New Alias SSL Certificates** | When a new alias (`TC1`) is provided and the certificate does not exist, the orchestrator successfully uploads a new SSL certificate to the LoadMaster and registers it in Keyfactor. | ✅ New certificate created successfully. | -| **2** | **Replace Alias SSL Certificates** | The orchestrator detects an existing alias (`TC1`) and, with **Overwrite=True**, replaces the existing SSL certificate. The old certificate file is overwritten. | ✅ Replacement successful. | -| **3** | **Replace Alias SSL Certificates (No Overwrite)** | Attempting to replace an existing alias without the overwrite flag causes the orchestrator to abort the operation and return an error indicating the flag is required. | ✅ Expected error: “Overwrite flag should be used.” | -| **4** | **Replace Alias Bound SSL Certificates** | When a certificate bound to a virtual service is replaced with **Overwrite=True**, the orchestrator updates the certificate file while maintaining the existing service binding. | ✅ Bound certificate replaced in place. | -| **5** | **Remove Bound SSL Certificate** | The orchestrator prevents removal of any certificate that is currently bound to a virtual service, returning an error message. | ✅ Error handled correctly (“cannot remove bound certificates”). | -| **6** | **Remove Unbound SSL Certificate** | The orchestrator removes an SSL certificate only if it is unbound, confirming removal through the LoadMaster API. | ✅ Certificate removed successfully. | -| **7** | **New Add New Alias Intermediate Certificates** | A new intermediate certificate (`TC8b`) is uploaded since no alias conflict exists. It appears under the Intermediate Certificates list. | ✅ Intermediate certificate created. | -| **8** | **Replace Alias Intermediate Certificates** | Kemp does not support overwriting intermediate certificates. The orchestrator logs and returns the expected API error (`Filename already exists`). | ✅ Expected failure recorded. | -| **9** | **Remove Intermediate Certificates** | The orchestrator deletes the intermediate certificate (`TC8b`) from the LoadMaster and synchronizes removal from Keyfactor Command. | ✅ Certificate removed successfully. | -| **10** | **Inventory Intermediate Certificates** | Performs an inventory scan of all intermediate certificates on the LoadMaster, importing them into Keyfactor Command. | ✅ Inventory successful. | -| **11** | **Inventory SSL Certificates** | Enumerates all SSL certificates (bound and unbound) on the LoadMaster and updates Keyfactor’s inventory accordingly. | ✅ Inventory successful. | - ---- - -### ⚙️ Functional Insights - -- **Overwrite Logic:** SSL certificates respect the `Overwrite` flag. Intermediate certificates cannot be overwritten. -- **Binding Awareness:** The orchestrator checks for bound services before delete or replace operations. -- **Error Handling:** Clear API error messages are surfaced in Keyfactor job logs. -- **Synchronization:** Add/Remove/Inventory maintain consistent state between Keyfactor and LoadMaster. -- **Security:** All operations occur over HTTPS using API Key authentication. - ---- - -### ✅ Operation Coverage Summary - -| Operation | Certificate Type | Supported | Notes | -|------------|------------------|------------|--------| -| Add | SSL | ✅ | Creates new alias or replaces with overwrite flag | -| Replace | SSL | ✅ | Requires `Overwrite=True` | -| Replace | Intermediate | ❌ | Unsupported – API rejects | -| Remove | SSL | ✅ | Allowed only if unbound | -| Remove | Intermediate | ✅ | Fully supported | -| Inventory | SSL | ✅ | Returns all SSL certificates | -| Inventory | Intermediate | ✅ | Returns all intermediate certificates | - ---- - - - -## TEST CASES -Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots -------------|---------|----------------|--------------|----------|----------------|--------------|------------ -1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) -2|Replace Alias SSL Certificates|Will Replace SSL Certificate|True|TC1|SSL Certificate with Alias TC1 Replaced On Kemp LoadMaster|True|![](images/TC2Results.gif) -3|Replace Alias SSL Certificates no Overwrite|Will Replace SSL Certificate|False|TC1|Error should occur stating Overwrite flag should be used|True|![](images/TC3Results.gif) -4|Replace Alias Bound SSL Certificates|Will Replace Bound SSL Certificate|True|TC1|Bound Certificate should be replaced|True|![](images/TC4Results.gif) -5|Remove Bound SSL Certificate|Should fail as you cannot remove Bound Certificates|N/A|TC1|Error Occurs stating you cannot remove bound certificates.|True|![](images/TC5Results.gif) -6|Remove UnBound SSL Certificate|Try to remove SSL Certificate that is UnBound|N/A|TC8a|Unbound Certificate Is Removed from LoadMaster.|True|![](images/TC6Results.gif) -7|New Add New Alias Intermediate Certificates|Will Create a new Intermediate Certificate|False|TC8b|New Intermediate Certificate with Alias TC8b Created On Kemp LoadMaster|True|![](images/TC7Results.gif) -8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) -9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) -10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) -11|Inventory SSL Certificates|SSL Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) From ccb7ba27baeafdda73505b349cb6074ecf0a8072 Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Tue, 11 Nov 2025 16:16:06 +0000 Subject: [PATCH 35/38] Update generated docs --- README.md | 66 +++++++++++++++++++------------------------- docsource/content.md | 16 +++++++++++ 2 files changed, 44 insertions(+), 38 deletions(-) create mode 100644 docsource/content.md diff --git a/README.md b/README.md index 3c98939..969d957 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ ## Overview -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. +TODO Overview is a required section @@ -49,6 +49,8 @@ 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. +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 + ## Kemp Certificate Store Type @@ -56,16 +58,8 @@ To use the Kemp Load Balancer Universal Orchestrator extension, you **must** cre -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 - - - - - -#### Kemp Requirements +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. -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 @@ -204,13 +198,13 @@ the Keyfactor Command Portal > 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). +## Post Installation -## Defining Certificate Stores +TODO Post Installation 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 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 +## Defining Certificate Stores -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 @@ -294,19 +288,9 @@ 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). -## Discovering Certificate Stores with the Discovery Job - -### Kemp Discovery Job -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 Discovery Job 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 - - +### 🧩 Step-by-Step: Enabling API Access for a User -## 🧩 Step-by-Step: Enabling API Access for a User - -### 1. Log in to the Kemp Web UI +#### 1. Log in to the Kemp Web UI - In your browser, go to: ``` https://:8443 @@ -315,7 +299,7 @@ TODO Discovery Job Configuration is an optional section. If this section doesn't --- -### 2. Edit the User Permissions +#### 2. Edit the User Permissions 1. In the left-hand menu, navigate to: ``` System Configuration → System Administration → User Management @@ -331,7 +315,7 @@ These permissions allow the orchestrator to create and manage intermediate and s --- -### 3. Generate and Record the API Key +#### 3. Generate and Record the API Key 1. Scroll down to the **API Keys** section. 2. Click **Generate New APIKey** to create a new key for API authentication. 3. Copy and securely store this key — it will be used in your Keyfactor orchestrator configuration as the **ServerPassword** or **API Key**. @@ -339,22 +323,22 @@ These permissions allow the orchestrator to create and manage intermediate and s --- -### 4. Verify API Access +#### 4. Verify API Access Use a command line or PowerShell session to verify connectivity: -#### Using curl: +##### Using curl: ```bash curl -k -H "Authorization: " https://:8443/access/list ``` -#### Using PowerShell: +##### Using PowerShell: ```powershell Invoke-RestMethod -Uri "https://:8443/access/list" -Headers @{ Authorization = "" } -SkipCertificateCheck ``` If you receive a JSON response, API access is successfully configured. -### ✅ Summary of Required Settings +#### ✅ Summary of Required Settings | Setting | Location | Value | |----------|-----------|--------| @@ -368,14 +352,14 @@ If you receive a JSON response, API access is successfully configured. --- -## Kemp LoadMaster Orchestrator – Behavior Summary +### Kemp LoadMaster Orchestrator – Behavior Summary This document summarizes the observed behaviors of the **Kemp LoadMaster Orchestrator** integration during SSL and Intermediate Certificate management operations. It details how the orchestrator interacts with the LoadMaster API, handles overwrite logic, manages bindings, and synchronizes data with Keyfactor Command. --- -### 🧩 Overall Integration Behavior +#### 🧩 Overall Integration Behavior - The orchestrator communicates with the **Kemp LoadMaster REST API** using the configured **ServerUsername**, **API Key**, and **SSL (HTTPS)** over port 8443. - Operations are driven by the **Overwrite flag** and **Alias Name** supplied in the job parameters. @@ -386,7 +370,7 @@ It details how the orchestrator interacts with the LoadMaster API, handles overw --- -### 🧪 Test Case Behavior Summary +#### 🧪 Test Case Behavior Summary | # | Case Name | Behavior Summary | Outcome | |---|------------|------------------|----------| @@ -404,7 +388,7 @@ It details how the orchestrator interacts with the LoadMaster API, handles overw --- -### ⚙️ Functional Insights +#### ⚙️ Functional Insights - **Overwrite Logic:** SSL certificates respect the `Overwrite` flag. Intermediate certificates cannot be overwritten. - **Binding Awareness:** The orchestrator checks for bound services before delete or replace operations. @@ -414,7 +398,7 @@ It details how the orchestrator interacts with the LoadMaster API, handles overw --- -### ✅ Operation Coverage Summary +#### ✅ Operation Coverage Summary | Operation | Certificate Type | Supported | Notes | |------------|------------------|------------|--------| @@ -428,7 +412,7 @@ It details how the orchestrator interacts with the LoadMaster API, handles overw --- -## TEST CASES +### TEST CASES Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots ------------|---------|----------------|--------------|----------|----------------|--------------|------------ 1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif) @@ -441,7 +425,13 @@ Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Result 8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif) 9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) 10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) -11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) +11|Inventory SSL Certificates|SSL Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) + +## Discovering Certificate Stores with the Discovery Job +TODO Discovery 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 + + + ## License diff --git a/docsource/content.md b/docsource/content.md new file mode 100644 index 0000000..48b64fd --- /dev/null +++ b/docsource/content.md @@ -0,0 +1,16 @@ +## Overview + +TODO Overview is a required section + +## 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 + +## Post Installation + +TODO Post Installation 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 + +## Discovery + +TODO Discovery 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 + From 8e1c128a28f050ed2ee136c9e6232622cdc5fce1 Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Tue, 11 Nov 2025 13:18:52 -0500 Subject: [PATCH 36/38] Update kemp.md --- docsource/kemp.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docsource/kemp.md b/docsource/kemp.md index 2b6dd27..1be1cef 100644 --- a/docsource/kemp.md +++ b/docsource/kemp.md @@ -1,7 +1,3 @@ -## Overview - -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. - # Enabling API Access for Keyfactor on Kemp LoadMaster This guide explains how to enable API access for a specific user on a Kemp LoadMaster appliance to allow Keyfactor Orchestrator integrations for certificate management and inventory operations. From ec70a29b16c04143cbf6a395d7cc4baea457c0ef Mon Sep 17 00:00:00 2001 From: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> Date: Tue, 11 Nov 2025 13:19:02 -0500 Subject: [PATCH 37/38] Update content.md --- docsource/content.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/docsource/content.md b/docsource/content.md index 48b64fd..a46c098 100644 --- a/docsource/content.md +++ b/docsource/content.md @@ -1,16 +1,4 @@ ## Overview -TODO Overview is a required section - -## 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 - -## Post Installation - -TODO Post Installation 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 - -## Discovery - -TODO Discovery 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 +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. From 66537cad09581612616c4137f9fc364aec8af28b Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Tue, 11 Nov 2025 18:20:24 +0000 Subject: [PATCH 38/38] Update generated docs --- README.md | 14 ++------------ docsource/kemp.md | 8 +++++--- 2 files changed, 7 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 969d957..13bf096 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ ## Overview -TODO Overview is a required section +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. @@ -49,8 +49,6 @@ 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. -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 - ## Kemp Certificate Store Type @@ -58,7 +56,7 @@ To use the Kemp Load Balancer Universal Orchestrator extension, you **must** cre -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. +TODO Overview is a required section @@ -198,10 +196,6 @@ the Keyfactor Command Portal > 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). -## Post Installation - -TODO Post Installation 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 - ## Defining Certificate Stores @@ -427,10 +421,6 @@ Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Result 10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) 11|Inventory SSL Certificates|SSL Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) -## Discovering Certificate Stores with the Discovery Job -TODO Discovery 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 - - diff --git a/docsource/kemp.md b/docsource/kemp.md index 1be1cef..f8c74c9 100644 --- a/docsource/kemp.md +++ b/docsource/kemp.md @@ -54,7 +54,6 @@ Invoke-RestMethod -Uri "https://:8443/access/list" -Headers @{ Au If you receive a JSON response, API access is successfully configured. - ### ✅ Summary of Required Settings | Setting | Location | Value | @@ -129,8 +128,6 @@ It details how the orchestrator interacts with the LoadMaster API, handles overw --- - - ## TEST CASES Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots ------------|---------|----------------|--------------|----------|----------------|--------------|------------ @@ -145,3 +142,8 @@ Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Result 9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif) 10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif) 11|Inventory SSL Certificates|SSL Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif) + +## Overview + +TODO Overview is a required section +