Rotating Certificates

Page last updated:

Warning: Pivotal Cloud Foundry (PCF) v2.3 is no longer supported because it has reached the End of General Support (EOGS) phase as defined by the Support Lifecycle Policy. To stay up to date with the latest software and security updates, upgrade to a supported version.

This topic describes how to rotate the root certificate authorities (CAs) and leaf certificates in Pivotal Cloud Foundry (PCF) that are visible to the Ops Manager API.

This topic includes the following:

For information about rotating IPsec certificates, see Rotating IPsec Certificates.

For information about using trusted third-party certificates for both apps hosted on PCF and internal PCF components, see Setting Trusted Certificates.

Overview

The Ops Manager API manages and lists internal certificates that enable PCF components to communicate with each other securely using TLS. It can also list certificates used externally, such as SAML certificates that authenticate to an external identity provider.

To keep PCF running, you must keep track of which certificates are set to expire soon, and rotate them before they expire. To do this, follow the instructions in Master Procedure: Check and Rotate Certificates.

Certificate Types

PCF uses a root CA and various leaf certificates. Root CAs are self-signed certificates that issue leaf certificates. Root CAs can be generated by Pivotal or custom.

Leaf certificates are signed by a CA and are used to identify resources in PCF. Both root CAs and leaf certificates require planned rotation in PCF.

The following types of PCF certificates require planned rotation:

  • Ops Manager Root CA: The Ops Manager root CA issues other certificates that PCF uses. The root CA can be a Pivotal-generated CA or your own custom CA. The Ops Manager root CA expires four years after creation. For more information about viewing the root CAs for Ops Manager, see Listing the Root Certificate Authorities.

  • Other internal CAs: The following CAs are used primarily for internal purposes:

    • BOSH NATS CA: The BOSH NATS CA is rotated automatically when you rotate the Ops Manager root CA. The BOSH NATS CA is rotatable in PCF v2.3.10 or later, PCF v2.4.4 or later, and PCF v2.5 or later. For more information, see 2.3.10 in Ops Manager v2.3 Release Notes and 2.4.4 in Ops Manager v2.4 Release Notes.
    • BOSH DNS CAs: The BOSH DNS CAs are applied automatically when you upgrade to PCF v2.3. You cannot rotate the BOSH DNS CAs. To apply all BOSH DNS leaf certificates after upgrading to v2.3, you must rotate all certificates in your environment. For more information, see BOSH DNS Certificate Authority Upgrades in Ops Manager v2.3 Release Notes.
  • Non-configurable Certificates: Non-configurable certificates are leaf certificates either created by a CA stored in Ops Manager, or created and stored by CredHub and managed by Ops Manager calls to the CredHub API. Non-configurable certificates are issued directly by the Ops Manager root CA, or by intermediate CAs in a chain of trust originated by the root CA. Non-configurable certificates expire after two years. For more information about about viewing non-configurable leaf certificates, see Getting Information About Certificates for Products. For more information about generating non-configurable leaf certificates, see Generating New Certificates.

  • Configurable Certificates: Configurable certificates are leaf certificates supplied by the user and pasted into configuration fields in Ops Manager. Some configuration panes include a Generate RSA Certificate button that supplies valid certificates, but users can obtain configurable certificates from elsewhere. Configurable certificates generated by Ops Manager typically expire after two years. For more information about viewing configurable leaf certificates, see Getting Information About Certificates for Products.

  • Non-rotatable Certificates: Non-rotatable certificates are leaf certificates that, like non-configurable certificates, are issued by the root CA. Unlike non-configurable certificates, non-rotatable certificates cannot be rotated by the Ops Manager API. For more information about viewing non-rotatable leaf certificates, see Getting Information About Certificates for Products.opsman-api/#getting-information-about-certificates-from-products).

In addition to the types of certificates listed above, some Pivotal products issue their own tile certificates that are not managed by or visible to the Ops Manager API. These tile certificates do not require planned rotation because they rotate automatically with product upgrades.

Pivotal Application Service (PAS) and Pivotal Container Service (PKS) both use tile certificates in addition to their Ops Manager certificates.

Master Procedure: Check and Rotate Certificates

The following master procedure checks expiration dates of different types of internal certificates and rotates them only as necessary. You can run this procedure only when records show that your certificates will expire soon, or else periodically to comply your organization’s security compliance policies.

To check and rotate certificates, do the following:

  1. Follow the Check Ops Manager Root CA Expiration Date procedure and record your root CA expiration date.

  2. Follow the Check Leaf Certificate Expiration Dates procedure and record any leaf certificates that are expiring soon.

  3. Follow the Identify Non-Configurable, Configurable, and Unrotatable Leaf Certificates to determine which types of leaf certificates require rotation.

  4. Do the following to rotate certificates as necessary:

    1. If you have any non-rotatable certificates expiring soon, call Pivotal Support.
    2. If your root CA expires soon, follow the Rotate Root and Leaf Certificates procedure.

      Note: If you also have configurable leaf certificates expiring soon, Pivotal recommends that you follow the procedure in Step 3 (Optional): Rotate Configurable Certificates. You can also rotate your configurable certificates separately and re-deploy later.

    3. If you have non-configurable leaf certificates expiring soon, but not your root CA, follow the Rotate Non-Configurable Certificates procedure.
    4. If you have configurable leaf certificates expiring soon, but not your root CA, follow the Rotate Configurable Certificates procedure.

Check Expiration Dates and Certificate Types

Complete the following procedures to check the expiration dates and types of CAs and leaf certificates that the Ops Manager API lists and manages.

Check Ops Manager Root CA Expiration Date

This procedure describes how to check the expiration date for the Ops Manager root CA. The Ops Manager root CA expires four years after creation.

To check the Ops Manager root CA expiration date, do the following:

  1. Perform the steps in the Using Ops Manager API topic to target and authenticate with the Ops Manager User Account and Authentication (UAA) server. Record your Ops Manager access token, and use it for YOUR-UAA-ACCESS-TOKEN in the steps below.

    Note: When you record your Ops Manager access token, remove any newline characters such as \n.

  2. To retrieve the Ops Manager root CA, use curl to make an Ops Manager API call to the https://OPS-MAN-FQDN/api/v0/certificate_authorities endpoint. For example:

    $ curl "https://OPS-MAN-FQDN/api/v0/certificate_authorities" \
          -H "Authorization: Bearer YOUR-UAA-ACCESS-TOKEN"
    

  3. To make the JSON output more readable, you can pipe it to jq or another text editor with JSON formatting.

  4. In the certificate_authorities list returned, if there is more than one, find the CA with "active": true.

  5. To determine its expiration date of the active CA, refer to its expires_on value. For example, the root CA shown below expires on September 5, 2019:

    {
    "certificate_authorities": [
    {
      "guid": "9c9a110c8f82a1e4aaca",
      "issuer": "Pivotal",
      "created_on": "2017-09-05T22:47:53Z",
      "expires_on": "2019-09-05T22:47:53Z",
      "active": true,
      "cert_pem": "-----BEGIN CERTIFICATE-----\
      [...]
      \n-----END CERTIFICATE-----\n"
    

Check Leaf Certificate Expiration Dates

This procedure describes how to check the expiration dates of non-configurable and configurable leaf certificates. Non-configurable leaf certificates expire after two years. Configurable leaf certificates generated by Ops Manager also typically expire after two years.

To check the expiration dates for non-configurable and configurable leaf certificates, do the following:

  1. If you haven’t already, perform the steps in the Using Ops Manager API topic to target and authenticate with the Ops Manager User Account and Authentication (UAA) server. Record your Ops Manager access token, and use it for YOUR-UAA-ACCESS-TOKEN in the steps below.

    Note: When you record your Ops Manager access token, remove any newline characters such as \n.

  2. To check the system for certificates that expire within a given time interval, use curl to call the https://OPS-MAN-FQDN/api/v0/deployed/certificates?expires_within=TIME API endpoint, replacing TIME with an integer-letter code. Valid letter codes are d for days, w for weeks, m for months, and y for years.

    For example, the following command searches for certificates expiring within six months:

    $ curl "https://OPS-MAN-FQDN/api/v0/deployed/certificates?expires_within=6m" \
          -H "Authorization: Bearer YOUR-UAA-ACCESS-TOKEN"
    
    Replace YOUR-UAA-ACCESS-TOKEN with the access_token value you recorded in the previous step.

  3. To make the JSON output more readable, you can pipe it to jq or another text editor with JSON formatting.

  4. To determine the expiration date of each certificate, refer to its expires_on value.

  5. To determine the type of each certificate in the output, follow the Identify Non-Configurable, Configurable, and Unrotatable Leaf Certificates procedure.

Identify Non-Configurable, Configurable, and Unrotatable Leaf Certificates

Output from the deployed/certificates endpoint, such as the output generated in the Check Leaf Certificate Expiration Dates procedure, combines information about non-configurable, configurable, and unrotatable leaf certificates into a single list.

You need to manually rotate the different leaf certificate types in different ways.

The following rules identify the type of each leaf certificate requiring rotation:

  • Non-Rotatable Certificates: Non-Rotatable leaf certificates have the following property value:

    • variable_path is /opsmgr/bosh_dns/tls_ca

    If you have non-rotatable certificates expiring soon, call Pivotal Support.

  • Non-Configurable Certificates: Non-Configurable leaf certificates have the following property values, but are not non-rotatable as identified above:

    • configurable is false
    • location is either ops_manager or credhub
  • Configurable Certificates: Configurable leaf certificates have the following property value:

    • configurable is true

Rotate CAs and Leaf Certificates

The following procedures rotate the Ops Manager root CA, BOSH NATS CA, and leaf certificates that are listed or managed by the Ops Manager API.

Note: The rotation procedures described in this topic does not work when your certificates have already expired. If your certificates have expired, contact Pivotal Support for guidance.

Rotate Root and Leaf Certificates

This procedure uses the Ops Manager API to rotate the Ops Manager root CA, the BOSH NATS CA, and the intermediate CAs and non-configurable leaf certificates underneath them.

Note: The BOSH NATS CA is automatically rotated when you rotate the Ops Manager root CA. For more information, see Certificate Types.

Rotating the Ops Manager root CA automatically rotates all configurable leaf certificates. You can also rotate configurable leaf certificates separately from rotating the root CA. For information about rotating configurable leaf certificates without also rotating the root CA, see Rotate Configurable Certificates.

PCF users never need to manually rotate intermediate CAs, because they rotate automatically when the root CA is rotated.

To prevent system downtime, this procedure includes two BOSH redeploys. When you click Apply Changes for the first time, BOSH applies new certificates to PCF components alongside the old ones. The second Apply Changes then deletes the old certificates. Each successful redeploy verifies that the certificate rotation process is proceeding correctly.

Warning: You must complete these steps in the exact order specified. Otherwise, you risk damaging your deployment.

Warning: If you use mutual TLS for route integrity, do not attempt to rotate certificate authorities (CAs). Instead, contact Pivotal Support. For more information, see Certificate Authority Rotation is Not Working in Some PAS Configurations.

Step 1: Add a New Root CA

Follow this procedure to add a new root CA for Ops Manager. The new root CA can be a Pivotal-generated CA or your own custom CA.

To add a new root CA for Ops Manager, do the following:

  1. If you haven’t already, perform the steps in the Using Ops Manager API topic to target and authenticate with the Ops Manager User Account and Authentication (UAA) server. Record your Ops Manager access token, and use it for YOUR-UAA-ACCESS-TOKEN in the following procedures.

    Note: When you record your Ops Manager access token, remove any newline characters such as \n.

  2. Use Ops Manager to generate a new CA, or else add your own custom CA.

    Note: Elliptic Curve Digital Signature Algorithm (ECDSA) certificates are not supported in PCF.

    • To use your own custom CA, call the Ops Manager API certificate_authorities endpoint as follows:
      curl "https://OPS-MAN-FQDN/api/v0/certificate_authorities" \
        -X POST \
        -H "Authorization: Bearer YOUR-UAA-ACCESS-TOKEN" \
        -H "Content-Type: application/json" \
        -d '{"cert_pem": "-----BEGIN CERTIFICATE-----\YOUR-CERTIFICATE", "private_key_pem": "-----BEGIN RSA PRIVATE KEY-----\YOUR-KEY"}'
      
      Where:
      • YOUR-CERTIFICATE is your custom CA.
      • YOUR-KEY is your RSA key.
      • YOUR-UAA-ACCESS-TOKEN is your UAA access token.

      If the command succeeds, the API returns a response that includes the new CA certificate:

      HTTP/1.1 200 OK
      {
      "certificate_authorities": [
        {
          "guid": "f7bc18f34f2a7a9403c3",
          "issuer": "YOUR-CA",
          "created_on": "2017-01-09",
          "expires_on": "2021-01-09",
          "active": true,
          "cert_pem": "-----BEGIN CERTIFICATE-----\nMIIC+zCCAeOgAwIBAgI....etc"
        }
      ]
      }
      
    • To use a Pivotal-generated CA, call the Ops Manager API generate endpoint as follows:
      $ curl "https://OPS-MAN-FQDN/api/v0/certificate_authorities/generate" \
        -X POST \
        -H "Authorization: Bearer YOUR-UAA-ACCESS-TOKEN" \
        -H "Content-Type: application/json" \
        -d '{}'
      
      If the command succeeds, the API returns a response that includes the new CA certificate:
        HTTP/1.1 200 OK
      {
        "guid": "f7bc18f34f2a7a9403c3",
        "issuer": "Pivotal",
        "created_on": "2017-01-19",
        "expires_on": "2021-01-19",
        "active": false,
        "cert_pem": "-----BEGIN EXAMPLE CERTIFICATE-----
        MIIC+zCCAeOgAwIBAgIBADANBgkqhkiG9w0BAQsFADAfMQswCQYDVQQGEwJVUzEQ
        EXAMPLEoCgwHUGl2b3RhbDAeFw0xNDarthgyMTQyMjVaFw0yMTAxMTkyMTQyMjVa
        EXAMPLEoBgNVBAYTAlVTMRAwDgYDVVaderdQaXZvdGFsMIIBIjANBgkqhkiG9w0B
        EXAMPLEoAQ8AMIIBCgKCAQEAyV4OhPIIZTEym9OcdcNVip9Ev0ijPPLo9WPLUMzT
        EXAMPLEo/TgD+DP09mwVXfqwBlJmoj9DqRED1x/6bc0Ki/BAFo/P4MmOKm3QnDCt
        EXAMPLEooqgA++2HYrNTKWJ5fsXmERs8lK9AXXT7RKXhktyWWU3oNGf7zo0e3YKp
        EXAMPLEoh1NwIbNcGT1AurIDsxyOZy1HVzBLTisMyDogJmSCLsOw3qUDQjatjXKw
        EXAMPLEojG3nv2hvD4/aTOiHuKM3+AGbnaS2MdIOvFOh/7Y79tUp89csK0gs6uOd
        EXAMPLEohe4DcKw5CzUTfHKNXgHyeoVOBPcVQTp4lJp1iQIDAQABo0IwQDAdBgNV
        EXAMPLEoyH4y7VEuImLStXM0CKR8uVqxX/gwDwYDVR0TAQH/BAUwAwEB/zAOBgNV
        EXAMPLEoBAMCAQYwDQYJKoZIhvcNAQELBQADggEBALmHOPxdyBGnuR0HgR9V4TwJ
        EXAMPLEoGLKVT7am5z6G2Oq5cwACFHWAFfrPG4W9Jm577QtewiY/Rad/PbkY0YSY
        EXAMPLEokrfNjxjxI0H2sr7qLBFjJ0wBZHhVmDsO6A9PkfAPu4eJvqRMuL/xGmSQ
        EXAMPLEoCynMNz7FgHyFbd9D9X5YW8fWGSeVBPPikcONdRvjw9aEeAtbGEh8eZCP
        EXAMPLEob33RuR+CTNqThXY9k8d7/7ba4KVdd4gP8ynFgwvnDQOjcJZ6Go5QY5HA
        EXAMPLEoPFW8pAYcvWrXKR0rE8fL5o9qgTyjmO+5yyyvWIYrKPqqIUIvMCdNr84=
          -----END EXAMPLE CERTIFICATE-----
          "
      
  3. Confirm that your new CA has been added by listing all of the root CAs for Ops Manager:

    $ curl "https://OPS-MAN-FQDN/api/v0/certificate_authorities" \
        -X GET \
        -H "Authorization: Bearer YOUR-UAA-ACCESS-TOKEN"
    
    The API call returns something like the following:
    HTTP/1.1 200 OK
    {
      "certificate_authorities": [
        {
          "guid": "f7bc18f34f2a7a9403c3",
          "issuer": "Pivotal",
          "created_on": "2017-01-09",
          "expires_on": "2021-01-09",
          "active": true,
          "cert_pem": "-----BEGIN CERTIFICATE-----\nMIIC+zCCAeOgAwIBAgI....etc"
        }
        {
          "guid": "a8ee01e33e3e3e3303e3",
          "issuer": "Pivotal",
          "created_on": "2017-04-09",
          "expires_on": "2021-04-09",
          "active": false,
          "cert_pem": "-----BEGIN CERTIFICATE-----\zBBBC+eAAAe1gAwAAAeZ....etc"
        }
      ]
    }
    
    Identify your newly added CA, which has active set to false. Record its GUID.

  4. Navigate to https://OPS-MAN-FQDN in a browser and log in to Ops Manager.

  5. Click the BOSH Director tile in the Installation Dashboard.

  6. Select the Director Config pane.

  7. Select Recreate All VMs. This propagates the new CA to all VMs to prevent downtime.

  8. Go back to the Installation Dashboard. For each service tile you have installed, do the following:

    1. Click the tile.
    2. Click the Errands tab.
    3. Enable the Recreate All Service Instances errand if provided. If you do not see this errand, contact Pivotal Support.
  9. Click Review Pending Changes, then Apply Changes. When the deploy finishes, continue to the next section.

Step 2: Activate the New CA

To activate the new CA, do the following:

  1. Use curl to make an Ops Manager API call that activates the new CA, replacing CERT-GUID with the GUID of your CA that you retrieved in the previous section:

    $ curl "https://OPS-MAN-FQDN/api/v0/certificate_authorities/CERT-GUID/activate" \
      -X POST \
      -H "Authorization: Bearer YOUR-UAA-ACCESS-TOKEN" \
      -H "Content-Type: application/json" \
      -d '{}'
    
    The API returns a successful response:
    HTTP/1.1 200 OK

  2. List your root CAs again to confirm that the new CA is active:

    $ curl "https://OPS-MAN-FQDN/api/v0/certificate_authorities" \
        -X GET \
        -H "Authorization: Bearer YOUR-UAA-ACCESS-TOKEN"
    
    Examine the response to ensure that your new CA has active set to true.

Step 3 (Optional): Rotate Configurable Certificates

If you have configurable certificates expiring soon, complete the Rotate Configurable Certificates procedure, so that your next deploy includes both new configurable certificates and new non-configurable certificates. You can also rotate your configurable certificates later and perform an additional deploy.

Step 4: Rotate Non-Configurable Certificates from the New Root

To rotate non-configurable certificates from the new root CA, do the following:

  1. Use curl to make an API call to regenerate all non-configurable certificates and apply the new CA to your existing BOSH Director:

    curl "https://OPS-MAN-FQDN/api/v0/certificate_authorities/active/regenerate" \
        -X POST \
        -H "Authorization: Bearer YOUR-UAA-ACCESS-TOKEN" \
        -H "Content-Type: application/json" \
        -d '{}'
    
    The API returns a successful response:
    HTTP/1.1 200 OK

  2. Click the BOSH Director tile in the Installation Dashboard.

  3. Select the Director Config pane.

  4. Select Recreate All VMs. This propagates the new CA to all VMs to prevent downtime.

  5. Go back to the Installation Dashboard. For each service tile you have installed, do the following:

    1. Click the tile.
    2. Click the Errands tab.
    3. Enable the Recreate All Service Instances errand if provided. If you do not see this errand, contact Pivotal Support.
  6. Navigate to Ops Manager, click Review Pending Changes, and click Apply Changes to perform a second redeploy.

Step 5: (Optional) Delete the Old CA

Warning: Be sure to include the Review Pending Changes and Apply Changes from Step 4: Rotate Non-Configurable certificates from the New Root before you proceed to deleting the old CA.

If you want to delete the old CA, do the following:

  1. List your root CAs to retrieve the GUID of your old, inactive CA:

    $ curl "https://OPS-MAN-FQDN/api/v0/certificate_authorities" \
        -X GET \
        -H "Authorization: Bearer YOUR-UAA-ACCESS-TOKEN"
    

  2. Use curl to make an API call to delete your old CA, replacing OLD-CERT-GUID with the GUID of your old, inactive CA:

    $ curl "https://OPS-MAN-FQDN/api/v0/certificate_authorities/OLD-CERT-GUID" \
        -X DELETE \
        -H "Authorization: Bearer YOUR-UAA-ACCESS-TOKEN"
    
    The API returns a successful response.
    HTTP/1.1 200 OK

  3. Navigate to Ops Manager, click Review Pending Changes, and click Apply Changes.

Rotate Non-Configurable Certificates

This procedure regenerates non-configurable leaf certificates visible to the Ops Manager API, whether they are managed and stored by Ops Manager directly, or by CredHub at Ops Manager request.

Run by itself, this procedure does not rotate or otherwise affect the Ops Manager root CA.

To rotate non-configurable certificates, do the following:

  1. Use curl to make an API call to regenerate all non-configurable certificates and apply the new CA to your existing BOSH Director:

    $ curl "https://OPS-MAN-FQDN/api/v0/certificate_authorities/active/regenerate" \
        -X POST \
        -H "Authorization: Bearer YOUR-UAA-ACCESS-TOKEN" \
        -H "Content-Type: application/json" \
        -d '{}'
    
    The API returns a successful response:
    HTTP/1.1 200 OK

  2. Navigate to Ops Manager, click Review Pending Changes, and click Apply Changes to perform a second redeploy.

Rotate Configurable Certificates

Configurable certificates are generated by the user and pasted into Ops Manager configuration panes where needed. Examples include certificates that terminate SSL traffic into PAS, or authenticate a Single Sign-On (SSO) service plan to an external SAML server.

For specific instructions on how to rotate SAML certificates for both PAS and the SSO service, see Identity Provider SAML Certificates. These certificates expire every two years, and every IdP has its own certificate that may require its own rotation cadence.

For Ops Manager, PAS, and other runtimes, Pivotal recommends only rotating configurable certificates within the more inclusive Rotate Root and Leaf Certificates procedure. But if you are sure that only your configurable certificates need rotation, and no others, you can run this procedure by itself and click Apply Changes at the end.

To rotate configurable certificates, do the following:

  1. If you haven’t already, use the Ops Manager API deployed/certificates endpoint to retrieve information about your expiring configurable certificates, as described in the procedures Check Leaf Certificate Expiration Dates and Identify Non-Configurable, Configurable, and Unrotatable Leaf Certificates.
    The information for each configurable certificate looks like this:

    {
      "configurable": true,
      "property_reference": ".properties.networking_poe_ssl_certs[0].certificate",
      "property_type": "rsa_cert_credentials",
      "product_guid": "cf-36066831c119c39736d3",
      ...
      "valid_until": "2019-01-25T22:07:58Z"
    },
    

  2. For each configurable certificate that expires soon:

    1. Find the text field the certificate is configured within the Ops Manager interface.
      • The product_guid field in the API output can help identify which tile the certificate is configured in. For example, the prefix p-bosh- refers to the BOSH Director tile, and the prefix cf- refers to the PAS tile.
      • The property_reference field in the API output can often help identify which Settings pane the certificate is configured in. For example, the uaa.service_provider_key_credentials property is configured in the PAS tile > UAA pane.
      • You might have to look through multiple configuration panes to identify where a certificate is configured.
    2. Paste a new value for the certificate into the field
    3. Click Save at the bottom of each pane in which you have provided new certificates.
  3. If you are rotating configurable certificates within the Rotate Root and Leaf Certificates procedure, continue to the next step. Otherwise, if you are rotating configurable certificates only, return to the Installation Dashboard, click Review Pending Changes, and click Apply Changes.

Identity Provider SAML Certificates

SAML service provider credentials are one example of configurable certificates in PCF. When PAS is configured to use SAML as an identity provider, it uses a configurable CA certificate to authenticate to an external SAML server, by generating ephemeral certificates that PAS includes in its outbound request message headers. This CA has a two-year expiration period.

In addition, the SSO service shares the use of PAS SAML certificates for every SAML external Identity Provider (IdP) integration, such as trust, partnership, or Federation. You must rotate these in lockstep with PAS.

The Rotate Your SAML CA for SSO procedure below provides an example of how to rotate certificates for each IdP, including temporarily disabling certificate validation on the IdP side during the rotation.

The Knowledge Base article PCF Advisory - SAML Service Provider Credential Certificates Expire after 2 Years provides more information about rotating SAML certificates.

Rotate Your SAML CA for PAS and the SSO Service

SAML service provider credentials are only required for your PAS deployment if all of these conditions are met:

  • You are using SSO in production for login to PAS or using the SSO service for login to apps.
  • You are using SAML identity providers for PAS or SSO service plans.
  • You had Ops Manager generate a certificate for you by clicking the Generate RSA Certificate button.
  • You are validating the signature of SAML authentication request with your identity provider.

To regenerate and rotate SAML service provider certificates without disrupting PAS or your apps using the SSO service, do the following:

  1. Disable certificate validation in your identity provider.

  2. For PAS, follow the procedure in the table below that corresponds to your use case. This includes downloading and importing a new certificate and updated SAML metadata in your identity provider.

    Solution Name Procedure
    CA Single Sign-On aka CA SiteMinder Configuring CA as an Identity Provider
    Ping Federate Configuring PingFederate as an Identity Provider
    Active Directory Federation Services Configuring ADFS as an Identity Provider

  3. For the SSO service, follow the procedure in the table below that corresponds to your use case. This includes downloading the SAML Service Provider metadata for each SAML identity provider integration, such as trust, partnership, or Federation, and importing the updated SAML Service Provider metadata in your identity provider.

    Solution Name Procedure
    ADFS Configuring a Single Sign-On Service Provider
    CA SSO Configuring a Single Sign-On Service Provider
    Okta Configure Okta as an Identity Provider
    PingFederate Configure PingFederate as an Identity Provider
    Additional Documentation Integration Guides

  4. Re-enable certificate validation in your identity provider.