6.5.18 Cisco Firepower

Pick the FDM or FMC template and understand what each deployment pushes

CertKit has four Cisco Firepower templates. Pick one by how the Firepower Threat Defense (FTD) device is managed and by where the certificate is used.

Template Use it when
Cisco Firepower (FDM): Remote Access VPN The device is managed on the box with Firepower Device Manager, and the certificate is the server certificate AnyConnect and Secure Client users see.
Cisco Firepower (FDM): SAML Server The device is managed with FDM, and the certificate is the service provider certificate on a SAML server object.
Cisco Firepower (FMC): Remote Access VPN The devices are managed by Firepower Management Center, and the certificate is the identity certificate of a Remote Access VPN policy.
Cisco Firepower (FMC): SAML Server The devices are managed by FMC, and the certificate is the service provider certificate on a Single Sign-on Server object.

If you sign in to the firewall itself to change its configuration, it is managed by FDM. If you make changes in a separate Management Center and deploy them to the firewall, it is managed by FMC.

When one certificate serves both the VPN and SAML, add both templates for that certificate. Cleanup leaves an old certificate in place while the other target still uses it.

The FMC templates are currently in beta.

FDM templates

Requirements

  • The agent host must reach the FDM management interface over HTTPS.
  • Set Firepower management IP or hostname to the address you browse to for FDM.
  • Set FDM administrator username and FDM administrator password to an FDM administrator that can manage certificate objects, the Remote Access VPN or SAML server objects, and deployments.
  • The target connection profile or SAML server object must already exist.
  • The templates use the PEM certificate, key, and chain format. The SAML template requires an RSA certificate.

Targets

Set RA VPN connection profile name to a profile under Device > Remote Access VPN. The template updates the server certificate of the Remote Access VPN configuration that owns that profile.

Set SAML server object name to the object under Objects > Identity Sources. The template updates the service provider certificate the FTD presents in the SAML exchange. It does not replace the identity provider’s signing certificate.

What each run does

  1. Signs in to the FDM API.
  2. Uploads each intermediate certificate in the chain as a trusted CA certificate, skipping any with a name the device already has.
  3. Uploads the certificate and key as an internal certificate named certkit-<certificate ID>-<first 10 characters of the thumbprint>. If that name already exists, the template reuses it.
  4. Sets the new certificate on the Remote Access VPN or the SAML server.
  5. Deletes older certkit- certificates for the same CertKit certificate. FDM refuses to delete one that is still in use, and the template logs a warning and moves on.
  6. Starts an FDM deployment and waits up to 10 minutes for it to reach the deployed state.

FMC templates

Requirements

  • FMC 7.7 or later. Earlier versions have no API for installing a certificate on a managed device. The template checks the version and stops on older releases.
  • The agent host must reach the FMC management address over HTTPS. It does not connect to the FTD devices.
  • A dedicated FMC API account. FMC ends a web interface session that uses the same credentials as the API, so don’t use an account someone signs in with. The template signs out of the API when it finishes.
  • The account needs permission to manage certificate enrollment objects, device certificates (Devices > Certificates), the Remote Access VPN policy or Single Sign-on Server objects, and deployments (Deploy Configuration to Devices), and to read task status.
  • The template works in the API account’s default domain. On a multi-domain FMC, create the account in the domain that holds the VPN policy, the SAML server, and the devices.
  • The Remote Access VPN policy must be assigned to at least one device.
  • The templates use the PFX format, which carries the certificate, key, and chain in one file. The SAML template requires an RSA certificate.

Template settings

Setting Requirement
FMC management IP or hostname The address you browse to for the FMC web interface.
FMC API username The dedicated API account described above.
FMC API password The password for that account.
RA VPN connection profile name RA VPN template. A connection profile under Devices > VPN > Remote Access. The template updates the policy that owns this profile, on every device the policy is assigned to.
SAML server object name SAML template. A Single Sign-on Server object under Objects > Object Management > AAA Server > Single Sign-on Server.

Which devices get the certificate

The RA VPN template installs the certificate on every device the Remote Access VPN policy is assigned to.

The SAML template looks for every Remote Access VPN policy with a connection profile that uses the SAML server, then installs the certificate on every device those policies are assigned to. If no assigned policy uses the SAML server, the run stops.

What each run does

  1. Signs in to FMC and checks the version.
  2. Uploads the PFX as a PKCS12 certificate enrollment named certkit-<certificate ID>-<first 10 characters of the thumbprint>. If that name already exists, the template reuses it.
  3. Finds the target and its devices.
  4. Installs the certificate on each device and waits up to five minutes per device for FMC to show it as installed.
  5. Applies the certificate.
    • RA VPN: sets the SSL global identity certificate, the IPsec-IKEv2 identity certificate if one is set, and any interface-specific certificate that used the old certificate. An interface with its own different certificate is left alone, with a warning in the log.
    • SAML: sets the service provider certificate. The identity provider certificate is not changed.
  6. Waits up to two minutes for FMC to list every target device as deployable, then deploys to those devices and waits up to five minutes for the deployment to finish.
  7. After the deployment succeeds, removes older certkit- certificates for the same CertKit certificate from the devices and deletes them. A certificate still referenced by any Remote Access VPN policy or Single Sign-on Server is left in place.
  8. Signs out of the FMC API.

Pending configuration changes

Both FDM and FMC deploy every pending change on a device, not only the certificate change made by CertKit. Review pending work before a scheduled certificate deployment.

The FMC templates deploy only to the target devices, and they deploy with warnings ignored. If the target already uses the current certificate, the FMC template still deploys any target device that has pending changes.

Use a deployment window when the combined change needs controlled timing.

Common problems

Both:

  • “Could not find RA VPN connection profile named …”: confirm the exact connection profile name.
  • “Could not find SAML server named …”: the log lists the SAML servers the template found. Copy the name from that list.
  • SAML template rejects the certificate: issue or select a certificate with an RSA key.
  • Wrong SAML certificate changed: these templates set the certificate the FTD presents as the service provider. They never change the identity provider configuration.

FDM:

  • “Deploy did not complete successfully. State: …”: review all pending FDM changes, including changes unrelated to CertKit.
  • “Cert upload failed” or “Trusted CA upload failed”: the log shows the HTTP status and FDM’s response.

FMC:

  • “FMC … is not supported. FMC 7.7 or later is required …”: upgrade FMC.
  • “FMC did not return an access token”: check the API username and password.
  • “RA VPN ‘…’ is not assigned to any devices”: assign the policy to its devices in FMC, then deploy again.
  • “SAML server ‘…’ is not used by any RA VPN that is assigned to a device”: select the SAML server as the authentication server on a connection profile, in a policy that is assigned to a device.
  • “FMC refused the … check”: the message names the missing permission, such as viewing device certificates, Deploy Configuration to Devices, or reading task status.
  • “An earlier enrollment of certkit-… on … failed”: remove that certificate in FMC under Devices > Certificates, then deploy again.
  • “Enroll on … failed”: the device rejected the certificate. The message includes the device’s error.
  • “… did not complete within 5 minutes”: FMC was still working when the template stopped waiting. Check the task in FMC before you deploy again.
  • “RA VPN was updated but FMC does not list these devices as deployable”: FMC didn’t mark those devices as changed. The change is saved in FMC, so deploy those devices from FMC or run the deployment again.
  • “Deploy ended with status …”: open the deployment history in FMC for the device error. Pending changes unrelated to CertKit can cause this.
  • “Interface ‘…’ uses its own certificate ‘…’ - left unchanged”: that interface has a certificate CertKit doesn’t manage. Change it in FMC if it should use the CertKit certificate.
  • “Not deleted (may still be bound to an RA VPN or SAML server)”: expected when another target still uses the old certificate. The next run of the other template cleans it up.
  • FMC web session ends when a deployment runs: the template shares credentials with someone’s login. Give CertKit its own API account.

For a product overview, see certificate automation for Cisco Firepower.