DataPower Universal Orchestrator Extension

Support · Installation · License · Related Integrations

Overview

The IBM DataPower Orchestrator allows for the management of certificates in the IBM Datapower platform. Inventory, Add and Remove functions are supported. This integration can add/replace certificates in any domain\directory combination.

• DataPower

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 tab.

Requirements & Prerequisites

Before installing the DataPower Universal Orchestrator extension, we recommend that you install kfutil. Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command.

The IBM DataPower Orchestrator allows for the management of certificates in the IBM Datapower platform. Inventory, Add and Remove functions are supported. This integration can add/replace certificates in any domain\directory combination. For example default\pubcert

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.

Supported Operations

Operation	Is Supported
Add	✅ Checked
Remove	🔲 Unchecked
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 check out the docs

Click to expand DataPower kfutil details

Using online definition from GitHub:

This will reach out to GitHub and pull the latest store-type definition

# 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 included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.

kfutil store-types create --from-file integration-manifest.json

Manual Creation

Below are instructions on how to create the DataPower store type manually in the Keyfactor Command Portal

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	🔲 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:

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).

Installation

1. Download the latest DataPower Universal Orchestrator extension from GitHub.

   Navigate to the DataPower Universal Orchestrator extension GitHub version page. Refer to the compatibility matrix below to determine the 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	ibm-datapower-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
   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 DataPower Universal Orchestrator extension inside the extensions directory.

   Create a new directory called ibm-datapower-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 ibm-datapower-orchestrator directory.

5. Restart the Universal Orchestrator service.

   Refer to Starting/Restarting the Universal Orchestrator service.

6. (optional) PAM Integration

   The DataPower 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 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.

Defining Certificate Stores

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 "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 field should always be / unless we later determine there are alternate locations needed.
   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).

Using kfutil CLI

Click to expand details

1. Generate a CSV template for the DataPower certificate store

   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 field should always be / unless we later determine there are alternate locations needed.
   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

   kfutil stores import csv --store-type-name DataPower --file DataPower.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 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) 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.

Test Cases

---

INVENTORY TEST CASES

Case Number	Case Name	Case Description	Expected Results	Passed
1	Pubcert Inventory No Black List Default Domain	Should Inventory Everything in the DataPower pubcert directory on the Default Domain	Keyfactor Inventory Matches pubcert default domain inventory	True
1a	Pubcert Inventory No Black List Default Domain using PAM Credentials	Should Inventory Everything in the DataPower pubcert directory on the Default Domain using credentials stored in a PAM Provider	Keyfactor Inventory Matches pubcert default domain inventory	True
1b	Pubcert Inventory With Black List Default Domain	Should Inventory Everything in the DataPower pubcert directory on the Default Domain Outside of Black List Items ex: Test.pem,Test2.pem	Keyfactor Inventory Matches pubcert default domain inventory outside of Black List Items	True
2	Pubcert Inventory No Black List testdomain\pubcert path	Should Inventory Everything in the DataPower pubcert directory on the testdomain\pubcert path	Keyfactor Inventory Matches pubcert default domain inventory	True
2a	Pubcert Inventory With Black List testdomain\pubcert path	Should Inventory Everything in the DataPower pubcert directory on the testdomain\pubcert path Outside of Black List Items ex: Cert1.pem,Cert2.pem	Keyfactor Inventory Matches pubcert default domain inventory outside of Black List Items	True
3	Private Key Cert Inventory No Black List Default Domain	Should Inventory Everything in the DataPower cert directory on the Default Domain	Keyfactor Inventory Matches pubcert default domain inventory	True
3a	Private Key Cert Inventory No Black List Default Domain with Credentials Stored in PAM Provider	Should Inventory Everything in the DataPower cert directory on the Default Domain with Credentials Stored in PAM Provider	Keyfactor Inventory Matches pubcert default domain inventory	True
3b	Private Key Cert Inventory With Black List Default Domain	Should Inventory Everything in the DataPower cert directory on the Default Domain Oustide of Black List Items ex: Test.pem,Test2.pem	Keyfactor Inventory Matches cert default domain inventory outside of Black List Items	True
4	Private Key Cert Inventory No Black List testdomain\cert path	Should Inventory Everything in the DataPower cert directory on the testdomain\cert path	Keyfactor Inventory Matches testdomain\cert path	inventory
4a	Private Key Cert Inventory With Black List testdomain\cert path		Should Inventory Everything in the DataPower cert directory on the testdomain\cert path	Keyfactor Inventory Matches testdomain\cert path Oustide of Black List Items ex: Test,Test2

---

ADD/REMOVE TEST CASES

Case Number	Case Name	Case Description	Overwrite Flag	Alias Name	Expected Results	Passed
1	Pubcert Add with Alias Default Domain	Will create new Cert, Key and Pem/crt entry	False	cryptoobjs	Crypto Key Created, Crypto Cert Created, Pem/Crt created	True
1a	Pubcert Overwrite with Alias Default Domain	Will Replaced Cert, Key and Pem/crt entry	true	cryptoobjs	Crypto Key Replaced, Crypto Cert Replaced, Pem/Crt Replaced	True
1b	Pubcert Add without Alias Default Domain	Will create new Cert, Key and Pem/crt entry with GUID as name	False	cryptoobjs	Crypto Key Created, Crypto Cert Created, Pem/Crt created with GUID as name	True
2	Private Key Add with Alias Default Domain	Will create new Cert, Key and Pem/crt entry	False	cryptoobjs	Crypto Key Created, Crypto Cert Created, Pem/Crt created	True
2a	Private Key Overwrite with Alias Default Domain	Will Replaced Cert, Key and Pem/crt entry	true	cryptoobjs	Crypto Key Replaced, Crypto Cert Replaced, Pem/Crt Replaced	True
2b	Private Key Add without Alias Default Domain	Will create new Cert, Key and Pem/crt entry with GUID as name	False	cryptoobjs	Crypto Key Created, Crypto Cert Created, Pem/Crt created with GUID as name	True
2c	Private Key Cert Add with Alias testdomain\cert path	Will create new Cert, Key and Pem/crt entry in testdomain\cert path	False	cryptoobjs	Crypto Key Created, Crypto Cert Created, Pem/Crt created in testdomain\pubcert path	True
2d	Private Key Cert Add with Alias testdomain\cert path	Will create new Cert, Key and Pem/crt entry in testdomain\cert path with PAM Credentials	False	cryptoobjs	Crypto Key Created, Crypto Cert Created, Pem/Crt created in testdomain\pubcert path gettting credentials from a PAM Provider	True
3a	Private Key Cert Overwrite with Alias testdomain\cert path	Will Replaced Cert, Key and Pem/crt entry in testdomain\cert path	true	cryptoobjs	Crypto Key Replaced, Crypto Cert Replaced, Pem/Crt Replaced in testdomain\pubcert path	True
3b	Private Key Cert Add without Alias testdomain\cert path	Will create new Cert, Key and Pem/crt entry with GUID as name in testdomain\cert path	False	cryptoobjs	Crypto Key Created, Crypto Cert Created, Pem/Crt created with GUID as name in testdomain\cert path	True
4	Remove Private Key and Cert From Default Domain	Remove Private Key and Cert From Default Domain	False	cryptoobjs	Crypto Certificate, Crypto Key and Pem/Crt are removed from Data Power	True
4a	Remove Private Key and Cert From testdomain\cert path	Remove Private Key and Cert From testdomain\cert path	False	cryptoobjs	Crypto Certificate, Crypto Key and Pem/Crt are removed from Data Power testdomain\cert path	True
4b	Remove PubCert	Remove PubCert	False	cryptoobjs	Error Occurs, cannot remove Public Certs	True
4c	Remove Private Key and Cert From testdomain\cert path with PAM Credentials	Remove Private Key and Cert From testdomain\cert path using credentials stored in a PAM Provider	False	cryptoobjs	Crypto Certificate, Crypto Key and Pem/Crt are removed from Data Power testdomain\cert path	True

---

License

Apache License 2.0, see LICENSE.

Related Integrations

See all Keyfactor Universal Orchestrator extensions.