Skip to content

Provision certificates to F5 BIG-IP LTM

Provision a certificate from Certificate Manager - SaaS to an F5 BIG-IP Local Traffic Manager (LTM) system. You can present the certificate on an application traffic SSL profile, or on the device's administrative login page. When you provision to an SSL profile, you can use an existing profile, or Certificate Manager - SaaS creates the profile for you.

Note

An F5 BIG-IP LTM machine can also generate a certificate's private key itself. See About remote key generation.

Before you begin

  • An F5 BIG-IP LTM machine that you created and whose status is Verified.
  • The certificate to provision in the Certificate Manager - SaaS inventory, with its private key.
  • The System Administrator or PKI Administrator role, or the Resource Owner role and membership in the machine's owning team.
  • To provision to the device administration page, a BIG-IP account with administrator permissions on the machine.

To provision a certificate to F5 BIG-IP LTM

  1. Sign in to Certificate Manager - SaaS.
  2. Click 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 Certificate Name, enter the name for the certificate on the BIG-IP. The name starts with a letter or number and can contain letters, numbers, hyphens, underscores, and periods, up to 63 characters.

    When you provision, Certificate Manager - SaaS checks whether the name is already in use on the BIG-IP:

    • If the name isn't in use, Certificate Manager - SaaS uses it as you entered it.
    • If the name is in use by the same certificate, Certificate Manager - SaaS reuses that certificate.
    • If the name is in use by a different certificate, Certificate Manager - SaaS creates a unique name by appending the expiration date and the last four digits of the serial number, for example my-cert-name_22Oct05_3117.
  6. For Supporting Certificates, choose how the BIG-IP stores the certificate's supporting certificates. These are the CA certificates that clients need to verify the certificate.

    • Included with certificate: installs the certificate and its supporting certificates together in one certificate file.
    • Separate file: installs the supporting certificates in their own certificate file, which you name in Chain Bundle Name.
    • Do not install: installs only the certificate and omits the supporting certificates.

    If you leave it empty, Certificate Manager - SaaS uses Separate file when the installation has a chain bundle name and Included with certificate when it doesn't. Either way, the supporting certificates are installed.

    Important

    Choose Do not install only when you're certain that the clients connecting to the site already trust your issuing CA.

  7. If you chose Separate file, in Chain Bundle Name, enter the name for the CA certificate bundle on the BIG-IP. Chain Bundle Name also appears when the installation already has a chain bundle name from an earlier provisioning or from discovery. It's required for Separate file, and Save stays unavailable until you enter it.

    If a bundle with that name already exists on the BIG-IP, Certificate Manager - SaaS handles it as follows:

    • If the bundle doesn't exist, Certificate Manager - SaaS creates it with the supporting certificates.
    • If every supporting certificate is already in the bundle, Certificate Manager - SaaS makes no changes. Extra certificates in the bundle, or a different order, don't cause a failure.
    • If the bundle is missing any of the supporting certificates, Certificate Manager - SaaS adds them to the bundle and reinstalls it, keeping the certificates that are already there.
  8. (Optional) In Partition, enter the name of an existing BIG-IP partition. Partition names are case-sensitive. If you leave it empty, Certificate Manager - SaaS uses the Common partition. Certificate Manager - SaaS installs the certificate and its private key in this partition and looks for or creates the SSL profile in it too.

  9. Under Installation Endpoint, for Binding Type, choose where to present the certificate:

    • Application Traffic (SSL Profile): presents the certificate on a client SSL or server SSL profile that handles application traffic.
    • Device Administration: presents the certificate on the device's administrative login page, which the BIG-IP management web service (httpd) serves. See Provisioning to the device administration page.

    The fields that follow depend on your choice. Installations created before Binding Type existed continue to use Application Traffic (SSL Profile).

  10. If you chose Application Traffic (SSL Profile), for Profile Type, choose Client SSL Profile or Server SSL Profile.

  11. (Optional) If you chose Application Traffic (SSL Profile), in Parent Profile, enter the profile that a new SSL profile inherits its settings from. If you leave it empty, Certificate Manager - SaaS uses clientssl or serverssl, depending on the profile type. Certificate Manager - SaaS ignores this field when the SSL profile already exists, and it never changes the parent profile.
  12. If you chose Application Traffic (SSL Profile), in SSL Profile, enter the name of the SSL profile. If the profile exists in the partition, Certificate Manager - SaaS provisions the certificate to it. Otherwise, Certificate Manager - SaaS creates the profile with that name.

    When you open an existing installation that discovery found on one or more virtual servers, the dialog also shows Virtual Server Name(s), the virtual servers that use the SSL profile. Because one SSL profile can serve many virtual servers, check this list to confirm that you're provisioning to the right profile.

  13. (Optional) If you chose Client SSL Profile, in SNI, enter an alternative DNS name for Server Name Indication. Certificate Manager - SaaS sets it only when it creates the profile. If the client SSL profile already exists, Certificate Manager - SaaS keeps the profile's current SNI value and ignores this field.

  14. (Optional) To leave the BIG-IP configuration unsaved after provisioning, select Skip Saving Config to Disk. By default, Certificate Manager - SaaS saves the running configuration to disk after it updates the SSL profile, so the change persists when the BIG-IP restarts. If you skip saving, save the configuration on the BIG-IP yourself. This setting applies only to Application Traffic (SSL Profile).
  15. (Optional) If you chose Device Administration, to make the new certificate take effect right away, select Restart the HTTP service. Certificate Manager - SaaS restarts the management web service after it installs the certificate and then confirms that the service comes back online.

    Warning

    Restarting the service briefly disconnects the BIG-IP management session. Anyone signed in to the management interface is signed out and must sign in again.

    If you leave Restart the HTTP service cleared, which is the default, the certificate is installed but isn't presented until the next time the httpd service restarts.

  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, Certificate Manager - SaaS installs the certificate on the BIG-IP and adds an installation to the machine's Installations tab, which also shows the installation's Partition, Virtual Server Name(s), and SSL Profile. For Application Traffic (SSL Profile), Certificate Manager - SaaS provisions the certificate to the SSL profile. If it created the profile, you can assign the profile to a virtual server or an HTTPS monitor. Certificate Manager - SaaS then checks that the BIG-IP is serving the certificate, and the installation shows Validated when it is. See Verifying the installation. To provision on a schedule instead of right away, set up a machine provisioning schedule.

Renewals and discovered installations

Each time you renew and provision a certificate to an SSL profile, Certificate Manager - SaaS manages the certificate generations on the BIG-IP:

  • The newly provisioned certificate becomes the active version.
  • Certificate Manager - SaaS keeps the previously active certificate as a rollback version.
  • Certificate Manager - SaaS removes older generations that it deployed, unless another SSL profile uses them. This cleanup needs no configuration.

When Certificate Manager - SaaS discovers your BIG-IP, it records how each SSL profile stores its supporting certificates, so that later provisioning reproduces the same arrangement. A profile that references a separate chain bundle is recorded as Separate file with that bundle's name. A profile with no separate chain bundle is recorded as Included with certificate. Discovery never records Do not install, because omitting the supporting certificates is always your explicit choice. Because Chain Bundle Name is optional, you can renew a profile discovered without a chain bundle without providing one.

Installations created or discovered before Supporting Certificates existed have no recorded setting. For those, Certificate Manager - SaaS applies the empty-field rule the next time it provisions, so their supporting certificates are installed again without new discovery or edits.

Note

If an installation's certificate is stored on the BIG-IP without its supporting certificates, and Certificate Manager - SaaS now installs it as Included with certificate, the new certificate file differs from the one on the BIG-IP even when the certificate itself hasn't changed. Certificate Manager - SaaS therefore adds the certificate under a generated name, such as my-cert-name_22Oct05_3117, and presents it on the SSL profile.

Verifying the installation

A BIG-IP can accept a certificate without serving it. For example, a script on the BIG-IP might rename the certificate after it's installed, or the SSL profile might still reference the previous certificate. To catch this, after Certificate Manager - SaaS installs the certificate and binds it to the SSL profile, it reads back from the BIG-IP and checks the following, in order. It uses the installation's partition, or Common if you left Partition empty.

  1. The certificate exists in the partition.
  2. A private key with the same name as the certificate exists in the partition. Certificate Manager - SaaS checks only that the key exists. It doesn't read the key or confirm that it pairs with the certificate.
  3. The SSL profile exists in the partition and references the certificate. For a client SSL profile, the certificate can be in any of the profile's certificate key chains.
  4. The certificate on the BIG-IP is the certificate that Certificate Manager - SaaS provisioned. Certificate Manager - SaaS compares the fingerprint of the certificate file on the BIG-IP with the provisioned certificate's. If the file also holds supporting certificates, only the website certificate is compared.

The installation's status on the Installations tab shows the result:

  • Validated: every check passed.
  • Failed: a check failed. Certificate Manager - SaaS stops at the first check that fails.

Verification doesn't change anything on the BIG-IP. When an installation shows Failed, Certificate Manager - SaaS doesn't roll back or retry the provisioning.

To find out which check failed, open the event log and find the Onboard Validation Failed event for the installation. The event's message names the cause:

  • The certificate or private key wasn't found in the partition.
  • The SSL profile wasn't found in the partition.
  • The SSL profile references a different certificate. The message names the certificate that the profile references and the one that was expected.
  • The certificate on the BIG-IP isn't the one that was provisioned. The message gives the thumbprint and serial number of the certificate on the BIG-IP, and the thumbprint of the provisioned certificate.

Certificate Manager - SaaS skips some checks in these cases:

  • Device Administration has no SSL profile, so Certificate Manager - SaaS skips all of the checks and the installation shows Validated.
  • If Certificate Manager - SaaS has no fingerprint on record for the certificate, it skips the fourth check. This can happen for installations provisioned before Certificate Manager - SaaS began recording fingerprints.

Provisioning to the device administration page

When you choose Device Administration, Certificate Manager - SaaS installs the certificate and private key on the files that the BIG-IP management web service (httpd) serves. The BIG-IP configuration already points to these files, so you don't need to configure anything else on the device.

  • Provisioning to Device Administration requires a BIG-IP account with administrator permissions. Without them, provisioning fails with a message that administrator permission is required.
  • Set Supporting Certificates to Included with certificate or Do not install. The device administration page is served from a single certificate file with no separate chain file. With Separate file, Certificate Manager - SaaS installs only the website certificate on the management web service, and the chain bundle it creates on the BIG-IP goes unused.
  • Before it overwrites the files, Certificate Manager - SaaS archives the current certificate and key in /var/tmp on the device. Only the archive's owner can read it, because it contains the management private key. Certificate Manager - SaaS keeps the three most recent archives and removes older ones.
  • If Certificate Manager - SaaS writes the certificate but can't write the private key, it restores the archive that it created at the start, so the management web service can still start. Provisioning is reported as failed, and you can retry it. If the restore also fails, the error message names the archive to restore manually.
  • Archiving is best effort. If Certificate Manager - SaaS couldn't create an archive at the start, it can't roll back automatically, and the error message tells you to restore the previous certificate and key manually before the next httpd restart.
  • Discovery doesn't find the certificate that secures the device administration page. It finds the certificates in SSL profiles.
  • Certificate Manager - SaaS doesn't verify the installation for Device Administration. The installation shows Validated after the certificate is installed.