Google Cloud Provider Certificate Manager Universal Orchestrator Extension

Support · Installation · License · Related Integrations

Overview

The GCP Certificate Manager Orchestrator Extension remotely manages certificates on the Google Cloud Platform Certificate Manager Product.

This orchestrator extension implements three job types - Inventory, Management Add, and Management Remove. Below are the steps necessary to configure this Orchestrator Extension. It supports adding certificates with private keys only. The GCP Certificate Manager Orchestrator Extension supports the replacement of unbound certificates as well as certificates bound to existing map entries, but it does not support specifying map entry bindings when adding new certificates.

Compatibility

This integration is compatible with Keyfactor Universal Orchestrator version 10.4.1 and later.

Support

The Google Cloud Provider Certificate Manager Universal Orchestrator extension is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket with your Keyfactor representative. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com.

To report a problem or suggest a new feature, use the Issues tab. If you want to contribute actual bug fixes or proposed enhancements, use the Pull requests tab.

Requirements & Prerequisites

Before installing the Google Cloud Provider Certificate Manager Universal Orchestrator extension, we recommend that you install kfutil. Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command.

Google Cloud Configuration

1. Read up on Google Certificate Manager and how it works.

2. Either a Google Service Account is needed with the following permissions (Note: Workload Identity Management Should be used but at the time of the writing it was not available in the .net library yet), or the virtual machine running the Keyfactor Orchestrator Service must reside within Google Cloud.

3. The following Api Access is needed:

4. If authenticating via service account, download the Json Credential file as shown below:

Create the GcpCertMgr Certificate Store Type

To use the Google Cloud Provider Certificate Manager Universal Orchestrator extension, you must create the GcpCertMgr Certificate Store Type. This only needs to happen once per Keyfactor Command instance.

• Create GcpCertMgr using kfutil:

  # GCP Certificate Manager
  kfutil store-types create GcpCertMgr

• Create GcpCertMgr manually in the Command UI:

  Create GcpCertMgr manually in the Command UI

  Create a store type called GcpCertMgr with the attributes in the tables below:

  Basic Tab

  Attribute	Value	Description
  Name	GCP Certificate Manager	Display name for the store type (may be customized)
  Short Name	GcpCertMgr	Short display name for the store type
  Capability	GcpCertMgr	Store type name orchestrator will register with. Check the box to allow entry of value
  Supports Add	✅ Checked	Check the box. Indicates that the Store Type supports Management Add
  Supports Remove	✅ Checked	Check the box. Indicates that the Store Type supports Management Remove
  Supports Discovery	✅ Checked	Check the box. Indicates that the Store Type supports Discovery
  Supports Reenrollment	🔲 Unchecked	Indicates that the Store Type supports Reenrollment
  Supports Create	✅ Checked	Check the box. Indicates that the Store Type supports store creation
  Needs Server	🔲 Unchecked	Determines if a target server name is required when creating store
  Blueprint Allowed	🔲 Unchecked	Determines if store type may be included in an Orchestrator blueprint
  Uses PowerShell	🔲 Unchecked	Determines if underlying implementation is PowerShell
  Requires Store Password	🔲 Unchecked	Enables users to optionally specify a store password when defining a Certificate Store.
  Supports Entry Password	🔲 Unchecked	Determines if an individual entry within a store can have a password.

  The Basic tab should look like this:

  

  Advanced Tab

  Attribute	Value	Description
  Supports Custom Alias	Required	Determines if an individual entry within a store can have a custom Alias.
  Private Key Handling	Required	This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid.
  PFX Password Style	Default	'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.)

  The Advanced tab should look like this:

  

  Custom Fields Tab

  Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:

  Name	Display Name	Description	Type	Default Value/Options	Required
  Location	Location	The GCP region used for this Certificate Manager instance. global is the default but could be another region based on the project.	String	global	✅ Checked
  ServiceAccountKey	Service Account Key File Path	The file name of the Google Cloud Service Account Key File installed in the same folder as the orchestrator extension. Empty if the orchestrator server resides in GCP and you are not using a service account key.	String		🔲 Unchecked

  The Custom Fields tab should look like this:

  

Installation

1. Download the latest Google Cloud Provider Certificate Manager Universal Orchestrator extension from GitHub.

   Navigate to the Google Cloud Provider Certificate Manager Universal Orchestrator extension GitHub version page. Refer to the compatibility matrix below to determine whether the net6.0 or net8.0 asset should be downloaded. Then, click the corresponding asset to download the zip archive.

   Universal Orchestrator Version	Latest .NET version installed on the Universal Orchestrator server	rollForward condition in Orchestrator.runtimeconfig.json	gcp-certmanager-orchestrator .NET version to download
   Older than 11.0.0			net6.0
   Between 11.0.0 and 11.5.1 (inclusive)	net6.0		net6.0
   Between 11.0.0 and 11.5.1 (inclusive)	net8.0	Disable	net6.0
   Between 11.0.0 and 11.5.1 (inclusive)	net8.0	LatestMajor	net8.0
   11.6 and newer	net8.0		net8.0

   Unzip the archive containing extension assemblies to a known location.

   Note If you don't see an asset with a corresponding .NET version, you should always assume that it was compiled for net6.0.

2. Locate the Universal Orchestrator extensions directory.

   • Default on Windows - C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions
   • Default on Linux - /opt/keyfactor/orchestrator/extensions

3. Create a new directory for the Google Cloud Provider Certificate Manager Universal Orchestrator extension inside the extensions directory.

   Create a new directory called gcp-certmanager-orchestrator.

   The directory name does not need to match any names used elsewhere; it just has to be unique within the extensions directory.

4. Copy the contents of the downloaded and unzipped assemblies from step 2 to the gcp-certmanager-orchestrator directory.

5. Restart the Universal Orchestrator service.

   Refer to Starting/Restarting the Universal Orchestrator service.

The above installation steps can be supplimented by the official Command documentation.

Defining Certificate Stores

• Manually with the Command UI

  Create Certificate Stores manually in the UI

  1. Navigate to the Certificate Stores page in Keyfactor Command.

     Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.

  2. Add a Certificate Store.

     Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.

     Attribute	Description
     Category	Select "GCP Certificate Manager" or the customized certificate store name from the previous step.
     Container	Optional container to associate certificate store with.
     Client Machine	GCP Project ID for your account.
     Store Path	This is not used and should be defaulted to n/a per the certificate store type set up.
     Orchestrator	Select an approved orchestrator capable of managing GcpCertMgr certificates. Specifically, one with the GcpCertMgr capability.
     Location	The GCP region used for this Certificate Manager instance. global is the default but could be another region based on the project.
     ServiceAccountKey	The file name of the Google Cloud Service Account Key File installed in the same folder as the orchestrator extension. Empty if the orchestrator server resides in GCP and you are not using a service account key.

• Using kfutil

  Create Certificate Stores with kfutil

  1. Generate a CSV template for the GcpCertMgr certificate store

     kfutil stores import generate-template --store-type-name GcpCertMgr --outpath GcpCertMgr.csv

  2. Populate the generated CSV file

     Open the CSV file, and reference the table below to populate parameters for each Attribute.

     Attribute	Description
     Category	Select "GCP Certificate Manager" or the customized certificate store name from the previous step.
     Container	Optional container to associate certificate store with.
     Client Machine	GCP Project ID for your account.
     Store Path	This is not used and should be defaulted to n/a per the certificate store type set up.
     Orchestrator	Select an approved orchestrator capable of managing GcpCertMgr certificates. Specifically, one with the GcpCertMgr capability.
     Location	The GCP region used for this Certificate Manager instance. global is the default but could be another region based on the project.
     ServiceAccountKey	The file name of the Google Cloud Service Account Key File installed in the same folder as the orchestrator extension. Empty if the orchestrator server resides in GCP and you are not using a service account key.

  3. Import the CSV file to create the certificate stores

     kfutil stores import csv --store-type-name GcpCertMgr --file GcpCertMgr.csv

The content in this section can be supplimented by the official Command documentation.

License

Apache License 2.0, see LICENSE.

Related Integrations

See all Keyfactor Universal Orchestrator extensions.