diff --git a/.github/workflows/keyfactor-starter-workflow.yml b/.github/workflows/keyfactor-starter-workflow.yml
index 65e8b68..3a1615b 100644
--- a/.github/workflows/keyfactor-starter-workflow.yml
+++ b/.github/workflows/keyfactor-starter-workflow.yml
@@ -1,41 +1,29 @@
-name: Starter Workflow
-on: [workflow_dispatch, push, pull_request]
+name: Keyfactor Bootstrap Workflow
-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)"
+on:
+ workflow_dispatch:
+ pull_request:
+ types: [opened, closed, synchronize, edited, reopened]
+ push:
+ create:
+ branches:
+ - 'release-*.*'
- call-dotnet-build-and-release-workflow:
- needs: [call-create-github-release-workflow]
- uses: Keyfactor/actions/.github/workflows/dotnet-build-and-release.yml@main
+jobs:
+ call-starter-workflow:
+ uses: keyfactor/actions/.github/workflows/starter.yml@screenshots
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: alteon-orchestrator\bin\Release # 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
+ command_token_url: ${{ vars.DOCTOOL_COMMAND_TOKEN_URL }}
+ command_hostname: ${{ vars.DOCTOOL_COMMAND_HOSTNAME }}
+ command_base_api_path: ${{ vars.DOCTOOL_COMMAND_BASE_API_PATH }}
secrets:
- token: ${{ secrets.APPROVE_README_PUSH }}
-
- 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 }}
+ token: ${{ secrets.V2BUILDTOKEN}}
+ APPROVE_README_PUSH: ${{ secrets.APPROVE_README_PUSH}}
+ gpg_key: ${{ secrets.KF_GPG_PRIVATE_KEY }}
+ gpg_pass: ${{ secrets.KF_GPG_PASSPHRASE }}
+ scan_token: ${{ secrets.SAST_TOKEN }}
+ entra_username: ${{ secrets.DOCTOOL_ENTRA_USERNAME }}
+ entra_password: ${{ secrets.DOCTOOL_ENTRA_PASSWD }}
+ command_client_id: ${{ secrets.DOCTOOL_COMMAND_CLIENT_ID }}
+ command_client_secret: ${{ secrets.DOCTOOL_COMMAND_CLIENT_SECRET }}
+
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..f0a8148
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,5 @@
+1.1.0
+- Add doctool and dual build for .net6/8
+
+1.0.0
+- Initial Version
\ No newline at end of file
diff --git a/README.md b/README.md
index c563492..4acb471 100644
--- a/README.md
+++ b/README.md
@@ -1,139 +1,291 @@
-# Orchestrator Extension for Alteon Load Balancer
+
+ Alteon Load Balancer Universal Orchestrator Extension
+
-The Alteon Load Balancer integration allows you to manage certificates within the Alteon Load Balancer device.
+
+
+
+
+
+
+
-#### Integration status: Production - Ready for use in production environments.
+
+
+
+ Support
+
+ ·
+
+ Installation
+
+ ·
+
+ License
+
+ ·
+
+ Related Integrations
+
+
-## About the Keyfactor Universal Orchestrator Capability
+## Overview
-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.
+The Alteon Load Balancer integration allows you to manage certificates within the Alteon Load Balancer device. It facilitates management of both the Alteon Device SSL certificate as well as entries in the trusted root store of the Alteon Load Balancer appliance.
-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 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 10.4 and later.
-## Support for Orchestrator Extension for Alteon Load Balancer
+## Support
+The Alteon Load Balancer Universal Orchestrator extension If you have a support issue, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com.
-Orchestrator Extension for Alteon Load Balancer is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket with your Keyfactor representative.
+> 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.
-###### 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.
-___
+## Requirements & Prerequisites
+Before installing the Alteon 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.
----
+## AlteonLB Certificate Store Type
+To use the Alteon Load Balancer Universal Orchestrator extension, you **must** create the AlteonLB Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance.
-## 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|✓ |✓ |
----
+#### Supported Operations
-## Setup and Configuration
+| Operation | Is Supported |
+|--------------|------------------------------------------------------------------------------------------------------------------------|
+| Add | ✅ Checked |
+| Remove | ✅ Checked |
+| Discovery | 🔲 Unchecked |
+| Reenrollment | 🔲 Unchecked |
+| Create | 🔲 Unchecked |
-The high level steps required to configure the Alteon Load Balancer Orchestrator extension are:
+#### Store Type Creation
-1) [Create the Store Type in Keyfactor](#create-the-store-type-in-keyfactor)
+##### 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 AlteonLB kfutil details
-1) [Install the Extension on the Orchestrator](#install-the-extension-on-the-orchestrator)
+ ##### Using online definition from GitHub:
+ This will reach out to GitHub and pull the latest store-type definition
+ ```shell
+ # Alteon Load Balancer
+ kfutil store-types create AlteonLB
+ ```
-1) [Create the Certificate Store](#create-the-certificate-store)
+ ##### 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
+ ```
+ Click to expand manual AlteonLB details
-Now we can navigate to the Keyfactor platform and create the store type for the extension.
+ Create a store type called `AlteonLB` with the attributes in the tables below:
-1) Navigate to your instance of Keyfactor and log in with a user that has Administrator priveledges.
+ ##### Basic Tab
+ | Attribute | Value | Description |
+ | --------- | ----- | ----- |
+ | Name | Alteon Load Balancer | Display name for the store type (may be customized) |
+ | Short Name | AlteonLB | Short display name for the store type |
+ | Capability | AlteonLB | 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. |
-1) Click on the gear icon in the top left and navigate to "Certificate Store Types".
+ The Basic tab should look like this:
- 
+ 
-1) Click "Add" to open the Add Certificate Store dialog.
+ ##### Advanced Tab
+ | Attribute | Value | Description |
+ | --------- | ----- | ----- |
+ | Supports Custom Alias | Optional | Determines if an individual entry within a store can have a custom Alias. |
+ | Private Key Handling | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
+ | PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
-1) Name the new store type "Alteon Load Balancer" and give it the short name of "AlteonLB".
+ The Advanced tab should look like this:
-1) The Alteon Load Balancer integration supports the following job types: _Inventory, Add, Remove_. Select from these the capabilities you would like to utilize.
+ 
-1) Make sure that "Needs Server" is checked.
+ > 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 | Alteon user ID with sufficient permissions to manage certs in the Alteon Load Balancer. | Secret | | ✅ Checked |
+ | ServerPassword | Server Password | Password associated with Alteon user ID entered above. | Secret | | ✅ Checked |
-1) Set the following values on the __Advanced__ tab:
- 1) **Supports Custom Alias** - Optional
- 1) **Private Key Handling** - Optional
+ The Custom Fields tab should look like this:
- 
+ 
-1) No changes are needed in the __Custom Fields__ and __Entry Parameters__ tabs.
+ 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 "Alteon Load Balancer" or the customized certificate store name from the previous step. |
+ | Container | Optional container to associate certificate store with. |
+ | Client Machine | The Alteon Load Balancer Server and port |
+ | Store Path | This value isn't used for this integration (other than to uniquely identify the cert store in certificate searches). |
+ | Orchestrator | Select an approved orchestrator capable of managing `AlteonLB` certificates. Specifically, one with the `AlteonLB` capability. |
+ | ServerUsername | Alteon user ID with sufficient permissions to manage certs in the Alteon Load Balancer. |
+ | ServerPassword | Password associated with Alteon user ID entered above. |
+
+Click to expand details
+
+1. **Generate a CSV template for the AlteonLB certificate store**
+
+ ```shell
+ kfutil stores import generate-template --store-type-name AlteonLB --outpath AlteonLB.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 "Alteon Load Balancer" or the customized certificate store name from the previous step. |
+ | Container | Optional container to associate certificate store with. |
+ | Client Machine | The Alteon Load Balancer Server and port |
+ | Store Path | This value isn't used for this integration (other than to uniquely identify the cert store in certificate searches). |
+ | Orchestrator | Select an approved orchestrator capable of managing `AlteonLB` certificates. Specifically, one with the `AlteonLB` capability. |
+ | Properties.ServerUsername | Alteon user ID with sufficient permissions to manage certs in the Alteon Load Balancer. |
+ | Properties.ServerPassword | Password associated with Alteon user ID entered above. |
+
+3. **Import the CSV file to create the certificate stores**
+
+ ```shell
+ kfutil stores import csv --store-type-name AlteonLB --file AlteonLB.csv
+ ```
+
+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 | Alteon user ID with sufficient permissions to manage certs in the Alteon Load Balancer. |
+ | ServerPassword | Password associated with Alteon user ID entered above. |
+
+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.
+
+