Installing the Keyfactor CA Policy Module Handlers

Complete these steps only if your Keyfactor Command license includes the Keyfactor CAClosed A certificate authority (CA) is an entity that issues digital certificates. Within Keyfactor Command, a CA may be a Microsoft CA or a Keyfactor gateway to a cloud-based or remote CA. Policy Module and you plan to use one or more policy handlers. Before installing the policy handlers, review the available options to determine whether they address a requirement in your environment.

Important:  For a CA Clustered solution, if the Keyfactor CA Policy Module is installed on a node then configured, then failed over to another node, this will corrupt the check point key. The module must be installed on BOTH nodes, configured on one node, then failed over to the other node.

The available policy handlers are:

When multiple policy handlers are installed on the same CA, their processing order can affect the final certificate request:

  • Whitelist Policy Handler: Can appear anywhere in the handler list. Its behavior is not affected by other handlers.

  • SAN Attribute Policy Handler and RFC 2818 Policy Handler: Place the SAN Attribute Policy Handler above the RFC 2818 Policy Handler so it runs first.

This order is required because the SAN Attribute Policy Handler removes existing SANs from the request and replaces them with SANs submitted outside the CSR, such as SANs entered in the optional SAN section on the CSR page in the Keyfactor Command Management Portal. If the RFC 2818 Policy Handler runs first, the SAN Attribute Policy Handler can remove the DNS SAN added by that handler.

Figure 606: Keyfactor CA Policy Module Policy Module Handler Ordering

When the Keyfactor CA Policy Module is used, the policy module listed on the Default Policy tab of the Policy Module Configuration Properties dialog is run first when a request reaches the CA. This default policy might be the standard Windows default, as shown Figure 607: Default Policy Module, or it might be another non-built-in policy module, such as the Microsoft FIM CM Policy Module. After the default policy module runs, the Loaded Handlers on the Custom Handlers tab of the Policy Module Configuration Properties dialog are run in the order listed (top to bottom). After all the handlers have been run, the result (approved, denied, or marked as pending) is returned to the CA for processing.

Figure 607: Default Policy Module

Tip:  Once the installation is complete, the configuration options for the policy handlers can be found in the registry on the CA in the following paths (where CA_LOGICAL_NAME is the logical nameClosed The logical name of a certificate authority (CA) is the human-readable name assigned to the CA when it is created. This name is used to uniquely identify the CA within its management system and in Keyfactor Command configuration settings. For some CA types, such as Microsoft CAs, the logical name is combined with the CA host name to form a fully qualified identifier (for example, ca1.keyexample.com\Corp Issuing CA One) that may be used in command-line tools and configuration references. The exact format and usage of the logical name can vary by CA type. of the local CA):
HKEY_LOCAL_MACHINE\ SYSTEM\ CurrentControlSet\ services\ CertSvc\ Configuration\ CA_LOGICAL_NAME\ PolicyModules\ CMS_Custom.Policy\ PolicyHandlers\ RFC2818.PolicyHandler
HKEY_LOCAL_MACHINE\ SYSTEM\ CurrentControlSet\ services\ CertSvc\ Configuration\ CA_LOGICAL_NAME\ PolicyModules\ CMS_Custom.Policy\ PolicyHandlers\ SANAttribute.PolicyHandler
HKEY_LOCAL_MACHINE\ SYSTEM\ CurrentControlSet\ services\ CertSvc\ Configuration\ CA_LOGICAL_NAME\ PolicyModules\ CMS_Custom.Policy\ PolicyHandlers\ CMSWhitelist.PolicyHandler
Important:  These registry keys should not be modified without advice from Keyfactor support.