Skip to content

Generate private keys on your machines

Have the target machine generate a certificate's private key, so that the key never leaves the machine. CyberArk Certificate Manager - SaaS gets the certificate issued and installs it next to the key. To learn how it works, see About remote key generation.

Prerequisites

Make sure that:

  • Remote key generation is turned on for your organization. CyberArk turns on this feature. If you don't see the options described here, contact CyberArk support.
  • The machine type supports it. Today that is F5 BIG-IP LTM. Machines that support it show the Remote Key Generation Available chip in their side sheet on the Machines page.
  • The machine is connected and verified. Create the machine as usual and make sure its connection test succeeds. A machine that hasn't passed its connection test can't generate keys.
  • The machine is reachable when it creates the key. The machine creates the key while Certificate Manager - SaaS processes the request. It must be online and reachable from a VSatellite at that time.
  • A request policy allows the machine's key generation system. See Set up a request policy.

Supported certificate details

The machine creates the key and the certificate signing request (CSR), so a request must stay within what the machine supports. The request policy doesn't enforce these limits. A request outside them passes approval and then fails when the machine creates the key or CSR.

Detail Supported
Key algorithm RSA 2048, 3072, or 4096. EC P-256 (prime256v1) or P-384 (secp384r1).
Common name (CN) Required.
Organization (O), organizational unit (OU), locality (L), state (ST), country (C) One value each.
Street address, postal code, serial number Not supported.
Subject alternative names DNS names, IP addresses, email addresses, and URIs. User principal names (UPNs) are left out of the CSR.
CSR extensions, such as extended key usage Not supported.

To prevent failed requests, a PKI Administrator can limit the request policy's key algorithms to the supported ones.

Set up a request policy

Performed by: PKI Administrator

Requesters can only select the key generation systems that the request policy allows.

  1. Sign in to Certificate Manager - SaaS.
  2. Click Policies > Request Policies.
  3. Open the request policy, or create a new one.
  4. Under Key Generation, select System generated or System or user generated.
  5. In Key Generation System, add the key generation system of the machine type, for example F5 BIG-IP LTM. You can allow more than one key generation system in a request policy. The requester picks one.
  6. Limit the key algorithms to the supported ones.
  7. (Optional) To let certificates from this request policy renew with the same private key, select Allow private key reuse. When this option is off, every renewal creates a new key.
  8. Save the request policy.

The request policy doesn't name a machine. The requester selects the machine for each request.

Request a certificate with a key generated on a machine

  1. Open the new certificate request wizard, and select an application and a request policy that allows the machine's key generation system. For the general request steps, see Requesting and viewing a certificate.
  2. For Request method, select Service automated certificate request.
  3. For Key Generation System, choose the machine type, for example F5 BIG-IP LTM. If the request policy allows only one key generation system, Certificate Manager - SaaS selects it for you.
  4. For Target, choose the machine that creates the key. The list shows only machines that support the selected key generation system.
  5. Enter the certificate details within the supported certificate details, and continue.
  6. In Installation details, decide where on the machine the certificate goes:
    • Create a new installation: enter the machine's installation settings. For F5 BIG-IP LTM these include the partition, the SSL profile, and the Certificate Name. Certificate Manager - SaaS builds the on-device key name from the Certificate Name.
    • Choose an existing installation: select an installation that already exists on this machine. The new certificate replaces the one it currently serves.
  7. (Optional) To install the certificate on the machine as soon as it's issued, enable Push certificate on save. If you don't enable it, Certificate Manager - SaaS sets up the installation, and a provisioning schedule or a manual push installs the certificate later.
  8. Click Issue & Provision.

The machine now holds the certificate's private key, and Certificate Manager - SaaS installs the certificate next to it. If something fails, Certificate Manager - SaaS shows an error message. See Troubleshoot remote key generation.

Start from a machine

  1. Sign in to Certificate Manager - SaaS.
  2. Click Installations > Machines.
  3. Open the machine's side sheet.
  4. Click Create Installation.
  5. Select one of the following:
    • Provision a new certificate: opens the request wizard for this machine. When you select a request policy that allows this machine type's key generation system, the machine is already selected as the Target. Continue with Request a certificate with a key generated on a machine.
    • Provision existing certificate: installs a certificate you already have on this machine. The list doesn't offer certificates whose key is on a different machine.

Renew a certificate

  1. Sign in to Certificate Manager - SaaS.
  2. Click Inventory > Certificates.
  3. Find the certificate you want to renew, and then select it.
  4. In the local menu bar, click Renew.
  5. Select a renewal option. Each option treats the key differently. See How renewal affects the key.

    The options that renew without changes require the certificate to belong to an application.

  6. If a provisioning schedule doesn't push the renewed certificate, provision it from the machine.