Fastly Certificate Universal Orchestrator Extension

Support · Installation · License · Related Integrations

Overview

This Fastly orchestrator performs inventory of TLS certificates used in Fastly services. It uses the Fastly API to query for all configured TLS certificates and their details, including expiration dates, common names, and associated services. The orchestrator can be scheduled to run at regular intervals to keep the inventory up to date and can be configured to send alerts for certificates that are nearing expiration.

Compatibility

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

Support

The Fastly Certificate Universal Orchestrator extension is supported by Keyfactor. If you require support for any issues or have feature request, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com.

If you want to contribute bug fixes or additional enhancements, use the Pull requests tab.

Requirements & Prerequisites

Before installing the Fastly Certificate 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.

Fastly Certificate Store Type

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

Currently this Fastly orchestrator only performs inventory of the TLS Certificates that are managed by Fastly. The "Bring Your Own" certificates are not supported.

Fastly Requirements

End users who wish to use this orchestrator must have a Fastly account with API access and the necessary permissions to query TLS certificate information. Additionally, they will need to provide their Fastly API key and specify the desired configuration for the orchestrator, such as the frequency of inventory checks and alert thresholds for expiring certificates.

Supported Operations

Operation	Is Supported
Add	🔲 Unchecked
Remove	🔲 Unchecked
Discovery	🔲 Unchecked
Reenrollment	🔲 Unchecked
Create	🔲 Unchecked

Store Type Creation

Using kfutil:

kfutil is a custom CLI for the Keyfactor Command API and can be used to create certificate store types. For more information on kfutil check out the docs

Click to expand Fastly kfutil details

Using online definition from GitHub:

This will reach out to GitHub and pull the latest store-type definition

# Fastly
kfutil store-types create Fastly

Offline creation using integration-manifest file:

If required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.

kfutil store-types create --from-file integration-manifest.json

Manual Creation

Below are instructions on how to create the Fastly store type manually in the Keyfactor Command Portal

Click to expand manual Fastly details

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

Basic Tab

Attribute	Value	Description
Name	Fastly	Display name for the store type (may be customized)
Short Name	Fastly	Short display name for the store type
Capability	Fastly	Store type name orchestrator will register with. Check the box to allow entry of value
Supports Add	🔲 Unchecked	Indicates that the Store Type supports Management Add
Supports Remove	🔲 Unchecked	Indicates that the Store Type supports Management Remove
Supports Discovery	🔲 Unchecked	Indicates that the Store Type supports Discovery
Supports Reenrollment	🔲 Unchecked	Indicates that the Store Type supports Reenrollment
Supports Create	🔲 Unchecked	Indicates that the Store Type supports store creation
Needs Server	✅ Checked	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	Forbidden	Determines if an individual entry within a store can have a custom Alias.
Private Key Handling	Forbidden	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:

For Keyfactor Command versions 24.4 and later, a Certificate Format dropdown is available with PFX and PEM options. Ensure that PFX is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.

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
ServerUsername	Server Username	Username to log into PAM Server, otherwise the username field is not used. (This field is automatically created)	Secret		🔲 Unchecked
ServerPassword	Server Password	The Password may be used in conjunction with a supported PAM provider. If no PAM provider is used, this field is used to store the API key provided by Fastly to access their APIs. (This field is automatically created)	Secret		🔲 Unchecked
ServerUseSsl	Use SSL	Determine whether the server uses SSL or not (This field is automatically created)	Bool	true	✅ Checked

The Custom Fields tab should look like this:

Server Username

Username to log into PAM Server, otherwise the username field is not used. (This field is automatically created)

[!IMPORTANT] This field is created by the Needs Server on the Basic tab, do not create this field manually.

Server Password

The Password may be used in conjunction with a supported PAM provider. If no PAM provider is used, this field is used to store the API key provided by Fastly to access their APIs. (This field is automatically created)

[!IMPORTANT] This field is created by the Needs Server on the Basic tab, do not create this field manually.

Use SSL

Determine whether the server uses SSL or not (This field is automatically created)

Installation

1. Download the latest Fastly Certificate Universal Orchestrator extension from GitHub.

   Navigate to the Fastly Certificate Universal Orchestrator extension GitHub version page. Refer to the compatibility matrix below to determine the 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	fastly-orchestrator .NET version to download
   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 net8.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 Fastly Certificate Universal Orchestrator extension inside the extensions directory.

   Create a new directory called fastly-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 fastly-orchestrator directory.

5. Restart the Universal Orchestrator service.

   Refer to Starting/Restarting the Universal Orchestrator service.

6. (optional) PAM Integration

   The Fastly Certificate Universal Orchestrator extension is compatible with all supported Keyfactor PAM extensions to resolve PAM-eligible secrets. PAM extensions running on Universal Orchestrators enable secure retrieval of secrets from a connected PAM provider.

   To configure a PAM provider, reference the Keyfactor Integration Catalog to select an extension and follow the associated instructions to install it on the Universal Orchestrator (remote).

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

Defining Certificate Stores

Store Creation

Manually with the Command UI

Click to expand details

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 "Fastly" or the customized certificate store name from the previous step.
   Container	Optional container to associate certificate store with.
   Client Machine	The base URL address for the Fastly API. (i.e., https://api.fastly.com)
   Store Path	This orchestrator currently does not manage a particular store path. This orchestrator only inventories certificates supported and managed by Fastly.
   Orchestrator	Select an approved orchestrator capable of managing Fastly certificates. Specifically, one with the Fastly capability.
   ServerUsername	Username to log into PAM Server, otherwise the username field is not used. (This field is automatically created)
   ServerPassword	The Password may be used in conjunction with a supported PAM provider. If no PAM provider is used, this field is used to store the API key provided by Fastly to access their APIs. (This field is automatically created)
   ServerUseSsl	Determine whether the server uses SSL or not (This field is automatically created)

Using kfutil CLI

Click to expand details

1. Generate a CSV template for the Fastly certificate store

   kfutil stores import generate-template --store-type-name Fastly --outpath Fastly.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 "Fastly" or the customized certificate store name from the previous step.
   Container	Optional container to associate certificate store with.
   Client Machine	The base URL address for the Fastly API. (i.e., https://api.fastly.com)
   Store Path	This orchestrator currently does not manage a particular store path. This orchestrator only inventories certificates supported and managed by Fastly.
   Orchestrator	Select an approved orchestrator capable of managing Fastly certificates. Specifically, one with the Fastly capability.
   Properties.ServerUsername	Username to log into PAM Server, otherwise the username field is not used. (This field is automatically created)
   Properties.ServerPassword	The Password may be used in conjunction with a supported PAM provider. If no PAM provider is used, this field is used to store the API key provided by Fastly to access their APIs. (This field is automatically created)
   Properties.ServerUseSsl	Determine whether the server uses SSL or not (This field is automatically created)

3. Import the CSV file to create the certificate stores

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

PAM Provider Eligible Fields

Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator

If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.

Attribute	Description
ServerUsername	Username to log into PAM Server, otherwise the username field is not used. (This field is automatically created)
ServerPassword	The Password may be used in conjunction with a supported PAM provider. If no PAM provider is used, this field is used to store the API key provided by Fastly to access their APIs. (This field is automatically created)

Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.

Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.

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

License

Apache License 2.0, see LICENSE.

Related Integrations

See all Keyfactor Universal Orchestrator extensions.