DataPower Universal Orchestrator Extension
Support
ยท
Installation
ยท
License
ยท
Related Integrations
## Overview
The IBM DataPower Universal Orchestrator manages certificates on IBM DataPower appliances. It targets the appliance's REST Management Interface (typically port `5554`) and uses the same store-path model across every job type: `\`.
```mermaid
flowchart LR
A[Keyfactor Command] -->|Discovery / Inventory / Add / Remove| B[Orchestrator]
B -->|HTTPS REST| C[DataPower REST Mgmt]
C -->|domains, filestore, CryptoCertificate, CryptoKey| D[(DataPower Appliance)]
```
## Compatibility
This integration is compatible with Keyfactor Universal Orchestrator version 10.4 and later.
## Support
The DataPower 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 DataPower 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.
## DataPower Certificate Store Type
To use the DataPower Universal Orchestrator extension, you **must** create the DataPower Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance.
TODO Overview is a required section
#### Supported Operations
| Operation | Is Supported |
|--------------|------------------------------------------------------------------------------------------------------------------------|
| Add | โ
Checked |
| Remove | ๐ฒ Unchecked |
| Discovery | โ
Checked |
| 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 DataPower kfutil details
##### Using online definition from GitHub:
This will reach out to GitHub and pull the latest store-type definition
```shell
# IBM Data Power
kfutil store-types create DataPower
```
##### 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 DataPower details
Create a store type called `DataPower` with the attributes in the tables below:
##### Basic Tab
| Attribute | Value | Description |
| --------- | ----- | ----- |
| Name | IBM Data Power | Display name for the store type (may be customized) |
| Short Name | DataPower | Short display name for the store type |
| Capability | DataPower | 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 | ๐ฒ Unchecked | Indicates that the Store Type supports Management Remove |
| Supports Discovery | โ
Checked | Check the box. 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:
##### 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:
> 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 | Api UserName for DataPower. (or valid PAM key if the username is stored in a KF Command configured PAM integration). | Secret | | ๐ฒ Unchecked |
| ServerPassword | Server Password | A password for DataPower API access. Used for inventory.(or valid PAM key if the password is stored in a KF Command configured PAM integration). | Secret | | ๐ฒ Unchecked |
| ServerUseSsl | Use SSL | Should be true, http is not supported. | Bool | true | โ
Checked |
| InventoryBlackList | Inventory Black List | Comma seperated list of alias values you do not want to inventory from DataPower. | String | | ๐ฒ Unchecked |
| Protocol | Protocol Name | Comma seperated list of alias values you do not want to inventory from DataPower. | String | https | โ
Checked |
| PublicCertStoreName | Public Cert Store Name | This probably will remain pubcert unless someone changed the default name in DataPower. | String | pubcert | โ
Checked |
| InventoryPageSize | Inventory Page Size | This determines the page size during the inventory calls. (100 should be fine). | String | 100 | โ
Checked |
The Custom Fields tab should look like this:
###### Server Username
Api UserName for DataPower. (or valid PAM key if the username is stored in a KF Command configured PAM integration).
> [!IMPORTANT]
> This field is created by the `Needs Server` on the Basic tab, do not create this field manually.
###### Server Password
A password for DataPower API access. Used for inventory.(or valid PAM key if the password is stored in a KF Command configured PAM integration).
> [!IMPORTANT]
> This field is created by the `Needs Server` on the Basic tab, do not create this field manually.
###### Use SSL
Should be true, http is not supported.
###### Inventory Black List
Comma seperated list of alias values you do not want to inventory from DataPower.
###### Protocol Name
Comma seperated list of alias values you do not want to inventory from DataPower.
###### Public Cert Store Name
This probably will remain pubcert unless someone changed the default name in DataPower.
###### Inventory Page Size
This determines the page size during the inventory calls. (100 should be fine).
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 "IBM Data Power" or the customized certificate store name from the previous step. |
| Container | Optional container to associate certificate store with. |
| Client Machine | The Client Machine field should contain the IP or Domain name and Port Needed for REST API Access. For SSH Access, Port 22 will be used. |
| Store Path | The store path uses the format domain\directory (e.g., default\pubcert, production-api\cert). The Discovery job can automatically find all valid store paths on an appliance. |
| Orchestrator | Select an approved orchestrator capable of managing `DataPower` certificates. Specifically, one with the `DataPower` capability. |
| ServerUsername | Api UserName for DataPower. (or valid PAM key if the username is stored in a KF Command configured PAM integration). |
| ServerPassword | A password for DataPower API access. Used for inventory.(or valid PAM key if the password is stored in a KF Command configured PAM integration). |
| ServerUseSsl | Should be true, http is not supported. |
| InventoryBlackList | Comma seperated list of alias values you do not want to inventory from DataPower. |
| Protocol | Comma seperated list of alias values you do not want to inventory from DataPower. |
| PublicCertStoreName | This probably will remain pubcert unless someone changed the default name in DataPower. |
| InventoryPageSize | This determines the page size during the inventory calls. (100 should be fine). |
Click to expand details
1. **Generate a CSV template for the DataPower certificate store**
```shell
kfutil stores import generate-template --store-type-name DataPower --outpath DataPower.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 "IBM Data Power" or the customized certificate store name from the previous step. |
| Container | Optional container to associate certificate store with. |
| Client Machine | The Client Machine field should contain the IP or Domain name and Port Needed for REST API Access. For SSH Access, Port 22 will be used. |
| Store Path | The store path uses the format domain\directory (e.g., default\pubcert, production-api\cert). The Discovery job can automatically find all valid store paths on an appliance. |
| Orchestrator | Select an approved orchestrator capable of managing `DataPower` certificates. Specifically, one with the `DataPower` capability. |
| Properties.ServerUsername | Api UserName for DataPower. (or valid PAM key if the username is stored in a KF Command configured PAM integration). |
| Properties.ServerPassword | A password for DataPower API access. Used for inventory.(or valid PAM key if the password is stored in a KF Command configured PAM integration). |
| Properties.ServerUseSsl | Should be true, http is not supported. |
| Properties.InventoryBlackList | Comma seperated list of alias values you do not want to inventory from DataPower. |
| Properties.Protocol | Comma seperated list of alias values you do not want to inventory from DataPower. |
| Properties.PublicCertStoreName | This probably will remain pubcert unless someone changed the default name in DataPower. |
| Properties.InventoryPageSize | This determines the page size during the inventory calls. (100 should be fine). |
3. **Import the CSV file to create the certificate stores**
```shell
kfutil stores import csv --store-type-name DataPower --file DataPower.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 | Api UserName for DataPower. (or valid PAM key if the username is stored in a KF Command configured PAM integration). |
| ServerPassword | A password for DataPower API access. Used for inventory.(or valid PAM key if the password 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.