tiManager Universal Orchestrator Extension

Support · Installation · License · Related Integrations

Overview

The FortiManager Orchestrator Extension enables certificate inventory, addition, and removal on FortiGate devices managed by a FortiManager instance. Managed devices can be found in the FortiManager UI under Device Manager → Device & Groups → Managed FortiGate. Each Keyfactor Command Certificate Store maps to a unique combination of FortiManager instance, ADOM, device, and a specific VDOM on the managed FortiGate device. Certificate changes (add/remove) can be pushed to the FortiGate device automatically or synced manually at a later time.

Supported use cases:

1. Inventory all certificates for a specified FortiGate device and VDOM, as managed through FortiManager.
2. Add new certificates to a specified FortiGate device and VDOM.
3. Replace existing certificates on a specified FortiGate device and VDOM.
4. Remove existing unbound certificates from a specified FortiGate device and VDOM.
5. Any of the above (2–4) can optionally be followed by syncing changes down to the managed FortiGate device.

Unsupported use cases:

1. Certificates enrolled through the FortiGate or FortiManager internal CA.
2. Factory-installed certificates.
3. Globally scoped certificates on the managed FortiGate device.
4. Removal of any certificate that is bound to a FortiGate object (e.g., an SSL VPN or HTTPS server certificate).

Compatibility

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

Support

The tiManager 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 tiManager 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.

FortiManager Certificate Store Type

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

Supported Operations

Operation	Is Supported
Add	✅ Checked
Remove	✅ Checked
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 FortiManager kfutil details

Using online definition from GitHub:

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

# FortiManager
kfutil store-types create FortiManager

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 FortiManager store type manually in the Keyfactor Command Portal

Click to expand manual FortiManager details

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

Basic Tab

Attribute	Value	Description
Name	FortiManager	Display name for the store type (may be customized)
Short Name	FortiManager	Short display name for the store type
Capability	FortiManager	Store type name orchestrator will register with. Check the box to allow entry of value
Supports Add	✅ Checked	Indicates that the Store Type supports Management Add
Supports Remove	✅ Checked	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	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.
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
SyncFortigateDevice	Sync Fortigate Device After Update	Set to true if you want to push any modifications automatically to the managed Fortigate device. Set to false if you only want to make modifications on the FortiManager device and sync later.	Bool	false	✅ Checked
ServerUsername	Server Username	User ID for the FortiManager instance you are managing.	Secret		🔲 Unchecked
ServerPassword	Server Password	Password for the FortiManager instance you are managing	Secret		🔲 Unchecked
ServerUseSsl	Use SSL	Not Used. Required field in the Keyfactor Command UI, but not used by this integration.	Bool	true	✅ Checked

The Custom Fields tab should look like this:

Sync Fortigate Device After Update

Set to true if you want to push any modifications automatically to the managed Fortigate device. Set to false if you only want to make modifications on the FortiManager device and sync later.

Server Username

User ID for the FortiManager instance you are managing.

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

Server Password

Password for the FortiManager instance you are managing

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

Use SSL

Not Used. Required field in the Keyfactor Command UI, but not used by this integration.

Installation

1. Download the latest tiManager Universal Orchestrator extension from GitHub.

   Navigate to the tiManager Universal Orchestrator extension GitHub version page. Refer to the compatibility matrix below to determine which 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	fortimanager-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 tiManager Universal Orchestrator extension inside the extensions directory.

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

5. Restart the Universal Orchestrator service.

   Refer to Starting/Restarting the Universal Orchestrator service.

6. (optional) PAM Integration

   The tiManager 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 "FortiManager" or the customized certificate store name from the previous step.
   Container	Optional container to associate certificate store with.
   Client Machine	The IP address or DNS of the FortiManager server
   Store Path	Value must contain the the FortiManager ADOM, FortiManager device name, and Fortigate VDOM this certificate store will be managing using the pipe character as a delimiter. For example - root|Device1|root
   Orchestrator	Select an approved orchestrator capable of managing FortiManager certificates. Specifically, one with the FortiManager capability.
   SyncFortigateDevice	Set to true if you want to push any modifications automatically to the managed Fortigate device. Set to false if you only want to make modifications on the FortiManager device and sync later.
   ServerUsername	User ID for the FortiManager instance you are managing.
   ServerPassword	Password for the FortiManager instance you are managing
   ServerUseSsl	Not Used. Required field in the Keyfactor Command UI, but not used by this integration.

Using kfutil CLI

Click to expand details

1. Generate a CSV template for the FortiManager certificate store

   kfutil stores import generate-template --store-type-name FortiManager --outpath FortiManager.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 "FortiManager" or the customized certificate store name from the previous step.
   Container	Optional container to associate certificate store with.
   Client Machine	The IP address or DNS of the FortiManager server
   Store Path	Value must contain the the FortiManager ADOM, FortiManager device name, and Fortigate VDOM this certificate store will be managing using the pipe character as a delimiter. For example - root|Device1|root
   Orchestrator	Select an approved orchestrator capable of managing FortiManager certificates. Specifically, one with the FortiManager capability.
   Properties.SyncFortigateDevice	Set to true if you want to push any modifications automatically to the managed Fortigate device. Set to false if you only want to make modifications on the FortiManager device and sync later.
   Properties.ServerUsername	User ID for the FortiManager instance you are managing.
   Properties.ServerPassword	Password for the FortiManager instance you are managing
   Properties.ServerUseSsl	Not Used. Required field in the Keyfactor Command UI, but not used by this integration.

3. Import the CSV file to create the certificate stores

   kfutil stores import csv --store-type-name FortiManager --file FortiManager.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	User ID for the FortiManager instance you are managing.
ServerPassword	Password for the FortiManager instance you are managing

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.