Provision to an IBM DataPower Gateway
Focus
Focus
Next‑Gen Trust Security

Provision to an IBM DataPower Gateway

Table of Contents

Provision to an IBM DataPower Gateway

Provision a certificate from Next-Gen Trust Security to an application domain on an IBM DataPower Gateway. Next-Gen Trust Security uploads the certificate and private key files to the domain's filestore, creates or updates the CryptoCertificate and CryptoKey objects that point to them, and saves the domain's configuration.

Before You Begin

  • An IBM DataPower Gateway machine that you created and whose status is Verified.
  • The certificate to provision in the Next-Gen Trust Security inventory, with its private key.
  • A Superuser role or a custom role with write access to the Provisioning permission set, which is under the Machines permission set.
  • The application domain on the gateway where you want to store the certificate. The domain must already exist.

To Provision a Certificate to an IBM DataPower Gateway

  1. Sign in to Next-Gen Trust Security.
  2. Click Insights > Certificate Installations > Machines.
  3. Click the more options button at the end of the machine's row, and then select Provision.
  4. In Search a certificate by name, expiration or fingerprint, enter part of the certificate's name, expiration date, or fingerprint, and then select the certificate from the results. Confirm that it's the right certificate by checking Subject DN, Validity, and Certificate SHA1 Fingerprint.
    The rest of the Provision a certificate dialog appears after you select a certificate.
  5. Under Certificate Information, in Application Domain, enter the name of the application domain. To use the default domain, enter default.
  6. In Certificate Name, enter the name of the CryptoCertificate object. If the domain has no object with this name, Next-Gen Trust Security creates it. If it has one, Next-Gen Trust Security points it to the new certificate file. To replace a certificate that a profile already uses, enter the name of its existing CryptoCertificate object.
  7. (Optional) In Key Name, enter the name of the CryptoKey object. Next-Gen Trust Security creates or updates it the same way.
  8. In Certificate File Path, enter the filestore path for the certificate file, for example cert:///server.pem. If you enter only a file name, Next-Gen Trust Security stores the file in the cert: directory. The file holds the certificate and its issuing chain, and it replaces any file already at that path.
  9. (Optional) In Key File Path, enter the filestore path for the private key file, for example cert:///server-key.pem.
    Note: Next-Gen Trust Security uploads the private key only if you enter a Key File Path. It creates or updates the CryptoKey object only if you enter both Key Name and Key File Path.
  10. Under Installation Endpoint, for Certificate Usage Type, choose how the gateway uses the certificate:
    • HTTPS Listener
    • Outbound TLS Client
    • Signing Credential
    • Trust Anchor (CA Certificate)
    • Management Interface
    • Unbound Certificate
  11. (Optional) In SSL Profile / Credential Name, enter the name of the SSLServerProfile, SSLClientProfile, or CryptoIdentCred object that uses the certificate.
  12. (Optional) In Identity Credential, enter the name of the CryptoIdentCred object that uses the certificate.
  13. (Optional) If you chose HTTPS Listener, in HTTPS Front-Side Handler, enter the name of the front-side handler that uses the certificate.
  14. (Optional) If you chose HTTPS Listener, in Listener Port, enter the port the handler listens on.
  15. (Optional) If you chose HTTPS Listener, in Multi-Protocol Gateway, enter the name of the Multi-Protocol Gateway service that uses the handler.
    Note: The binding fields record where the certificate is used. Next-Gen Trust Security doesn't change the profiles, credentials, handlers, or services that you name.
  16. (Optional) To save the installation without pushing the certificate now, disable Push certificate on save.
  17. Click Save. To save and then provision another certificate, click Save & New.
After you save, Next-Gen Trust Security uploads the files, creates or updates the CryptoCertificate and CryptoKey objects, and then saves the application domain's configuration so the change persists after the gateway restarts. An installation appears on the machine's Installations tab. To provision on a schedule instead of right away, set up a machine provisioning schedule.