Delinea Secret Server PAM Provider

Support · Installation · License · Related Integrations

Overview

The Delinea Secret Server PAM Provider allows for the retrieval of stored account credentials from a Delinea Secret Server secret. Supports either password or client_credential authentication methods. For more information on these authentication methods, see the Delinea Secret Server documentation.

Support

The Delinea Secret Server PAM Provider 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.

Getting Started

The Delinea Secret Server PAM Provider is used by Command to resolve PAM-eligible credentials for Universal Orchestrator extensions and for accessing Certificate Authorities. When configured, Command will use the Delinea Secret Server PAM Provider to retrieve credentials needed to communicate with the target system. There are two ways to install the Delinea Secret Server PAM Provider, and you may elect to use one or both methods:

1. Locally on the Keyfactor Command server: PAM credential resolution via the Delinea Secret Server PAM Provider will occur on the Keyfactor Command server each time an elegible credential is needed.
2. Remotely On Universal Orchestrators: When Jobs are dispatched to Universal Orchestrators, the associated Certificate Store extension assembly will use the Delinea Secret Server PAM Provider to resolve eligible PAM credentials.

Before proceeding with installation, you should consider which pattern is best for your requirements and use case.

Installation

Important

For the most up-to-date and complete documentation on how to install a PAM provider extension, please visit our product documentation

To install Delinea Secret Server PAM Provider, it is recommended you install kfutil. kfutil is a command-line tool that simplifies the process of creating PAM Types in Keyfactor Command.

Requirements

• Delinea Secret Server service account or client credential w/ permission to access the secret(s) being used. See the [Delinea Secret Server documentation](Delinea Secret Server documentation.) for more information on how to configure service accounts and client credentials.

Create PAM type in Keyfactor Command

Using kfutil

Create the required PAM Types in the connected Command platform.

# Delinea-SecretServer
kfutil pam types-create -r delinea-secretserver-pam -n Delinea-SecretServer

Using the API

For full API docs please visit our product documentation

Below is the payload to POST to the Keyfactor Command API

{
    "Name": "Delinea-SecretServer",
    "Parameters": [
        {
            "Name": "Host",
            "DisplayName": "Secret Server URL",
            "Description": "The URL to the Secret Server instance. Example: https://example.secretservercloud.com/SecretServer",
            "DataType": 1,
            "InstanceLevel": false
        },
        {
            "Name": "Username",
            "DisplayName": "Secret Server Username",
            "Description": "The username used to authenticate to the Secret Server instance. NOTE: only applicable if using the `password` grant type.",
            "DataType": 2,
            "InstanceLevel": false
        },
        {
            "Name": "Password",
            "DisplayName": "Secret Server Password",
            "Description": "The password used to authenticate to the Secret Server instance. NOTE: only applicable if using the `password` grant type.",
            "DataType": 2,
            "InstanceLevel": false
        },
        {
            "Name": "ClientId",
            "DisplayName": "Secret Server Client ID",
            "Description": "The client ID used to authenticate to the Secret Server instance. NOTE: only applicable if using the `client_credentials` grant type.",
            "DataType": 2,
            "InstanceLevel": false
        },
        {
            "Name": "ClientSecret",
            "DisplayName": "Secret Server Client Secret",
            "Description": "The client secret used to authenticate to the Secret Server instance. NOTE: only applicable if using the `client_credentials` grant type.",
            "DataType": 2,
            "InstanceLevel": false
        },
        {
            "Name": "GrantType",
            "DisplayName": "Grant Type",
            "Description": "The grant type used to authenticate to the Secret Server instance. Valid values are `password` or `client_credentials`. Default is `password`. If not provided the default value `password` will be used to maintain backwards compatability.",
            "DataType": 1,
            "InstanceLevel": false
        },
        {
            "Name": "SecretId",
            "DisplayName": "Secret ID",
            "Description": "The ID of the secret in Secret Server. This is the integer ID that is used to retrieve the secret from Secret Server.",
            "DataType": 1,
            "InstanceLevel": true
        },
        {
            "Name": "SecretFieldName",
            "DisplayName": "Secret Field Name",
            "Description": "The name of the field in the secret that contains the credential value. NOTE: The field must exist.",
            "DataType": 1,
            "InstanceLevel": true
        }
    ]
}

Install PAM provider on Keyfactor Command Host (Local)

1. On the server that hosts Keyfactor Command, download and unzip the latest release of the Delinea Secret Server PAM Provider from the Releases page.

2. Copy the assemblies to the appropriate directories on the Keyfactor Command server:

   Keyfactor Command 11+

   1. Copy the unzipped assemblies to each of the following directories:

      • C:\Program Files\Keyfactor\Keyfactor Platform\WebAgentServices\Extensions\PamProviders\delinea-secretserver-pam
      • C:\Program Files\Keyfactor\Keyfactor Platform\WebConsole\Extensions\PamProviders\delinea-secretserver-pam
      • C:\Program Files\Keyfactor\Keyfactor Platform\KeyfactorAPI\Extensions\PamProviders
   Keyfactor Command 10

   1. Copy the assemblies to each of the following directories:

      • C:\Program Files\Keyfactor\Keyfactor Platform\WebAgentServices\bin\delinea-secretserver-pam
      • C:\Program Files\Keyfactor\Keyfactor Platform\KeyfactorAPI\bin\delinea-secretserver-pam
      • C:\Program Files\Keyfactor\Keyfactor Platform\WebConsole\bin\delinea-secretserver-pam
      • C:\Program Files\Keyfactor\Keyfactor Platform\Service\delinea-secretserver-pam

   2. Open a text editor on the Keyfactor Command server as an administrator and open the web.config file located in the WebAgentServices directory.

   3. In the web.config file, locate the <container> </container> section and add the following registration:

      <container>
          ...
          <!--The following are PAM Provider registrations. Uncomment them to use them in the Keyfactor Product:-->
          
          <!--Add the following line exactly to register the PAM Provider-->
          <register type="IPAMProvider" mapTo="Keyfactor.Extensions.Pam.Delinea.SecretServerPam, Keyfactor.Command.PAMProviders" name="Delinea-SecretServer" />
      </container>

   4. Repeat steps 2 and 3 for each of the directories listed in step 1. The configuration files are located in the following paths by default:

      • C:\Program Files\Keyfactor\Keyfactor Platform\WebAgentServices\web.config
      • C:\Program Files\Keyfactor\Keyfactor Platform\KeyfactorAPI\web.config
      • C:\Program Files\Keyfactor\Keyfactor Platform\WebConsole\web.config
      • C:\Program Files\Keyfactor\Keyfactor Platform\Service\CMSTimerService.exe.config

3. Restart the Keyfactor Command services (iisreset).

Install PAM provider on a Universal Orchestrator Host (Remote)

1. Install the Delinea Secret Server PAM Provider assemblies.

   • Using kfutil: On the server that that hosts the Universal Orchestrator, run the following command:

     # Windows Server
     kfutil orchestrator extension -e delinea-secretserver-pam@latest --out "C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions"
     
     # Linux
     kfutil orchestrator extension -e delinea-secretserver-pam@latest --out "/opt/keyfactor/orchestrator/extensions"

   • Manually: Download the latest release of the Delinea Secret Server PAM Provider from the Releases page. Extract the contents of the archive to:

     • Windows Server: C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions\delinea-secretserver-pam
     • Linux: /opt/keyfactor/orchestrator/extensions/delinea-secretserver-pam

2. Included in the release is a manifest.json file that contains the following object:

   {
       "Keyfactor:PAMProviders:Delinea-SecretServer:InitializationInfo": {
           "Host": "https://example.secretservercloud.com/SecretServer",
           "Username": "<USERNAME>",
           "Password": "<PASSWORD>",
           "ClientId": "<OAUTH_CLIENT_ID>",
           "ClientSecret": "<OAUTH_CLIENT_SECRET>",
           "GrantType": "password|client_credentials"
       }
   }
   

   Populate the fields in this object with credentials and configuration data collected in the requirements section.

3. Restart the Universal Orchestrator service.

Usage

From Keyfactor Command Host (Local)

Define a PAM provider in Command

1. In the Keyfactor Command Portal, hover over the ⚙️ (settings) icon in the top right corner of the screen and select Priviledged Access Management.

2. Select the Add button to create a new PAM provider. Click the dropdown for Provider Type and select Delinea-SecretServer.

Important

If you're running Keyfactor Command 11+, make sure Remote Provider is unchecked.

3. Populate the fields with the necessary information collected in the requirements section:

Initialization parameter	Display Name	Description
Host	Secret Server URL	The URL to the Secret Server instance. Example: https://example.secretservercloud.com/SecretServer
Username	Secret Server Username	The username used to authenticate to the Secret Server instance. NOTE: only applicable if using the password grant type.
Password	Secret Server Password	The password used to authenticate to the Secret Server instance. NOTE: only applicable if using the password grant type.
ClientId	Secret Server Client ID	The client ID used to authenticate to the Secret Server instance. NOTE: only applicable if using the client_credentials grant type.
ClientSecret	Secret Server Client Secret	The client secret used to authenticate to the Secret Server instance. NOTE: only applicable if using the client_credentials grant type.
GrantType	Grant Type	The grant type used to authenticate to the Secret Server instance. Valid values are password or client_credentials. Default is password. If not provided the default value password will be used to maintain backwards compatability.

4. Click Save. The PAM provider is now available for use in Keyfactor Command.

Using the PAM provider

Now, when defining Certificate Stores (Locations->Certificate Stores), Delinea-SecretServer will be available as a PAM provider option. When defining new Certificate Stores, the secret parameter form will display tabs for Load From Keyfactor Secrets or Load From PAM Provider.

Select the Load From PAM Provider tab, choose the Delinea-SecretServer provider from the list of Providers, and populate the fields with the necessary information from the table below:

Instance parameter	Display Name	Description
SecretId	Secret ID	The ID of the secret in Secret Server. This is the integer ID that is used to retrieve the secret from Secret Server.
SecretFieldName	Secret Field Name	The name of the field in the secret that contains the credential value. NOTE: The field must exist.

From a Universal Orchestrator Host (Remote)

Keyfactor Command 11+

Define a remote PAM provider in Command

In Command 11 and greater, before using the Delinea-SecretServer PAM type, you must define a Remote PAM Provider in the Command portal.

1. In the Keyfactor Command Portal, hover over the ⚙️ (settings) icon in the top right corner of the screen and select Priviledged Access Management.

2. Select the Add button to create a new PAM provider.

3. Make sure that Remote Provider is checked.

4. Click the dropdown for Provider Type and select Delinea-SecretServer.

5. Give the provider a unique name.

6. Click "Save".

Using the PAM provider

When defining Certificate Stores (Locations->Certificate Stores), Delinea-SecretServer can be used as a PAM provider. When defining a new Certificate Store, the secret parameter form will display tabs for Load From Keyfactor Secrets or Load From PAM Provider.

Select the Load From PAM Provider tab, choose the Delinea-SecretServer provider from the list of Providers, and populate the fields with the necessary information from the table below:

Instance parameter	Display Name	Description
SecretId	Secret ID	The ID of the secret in Secret Server. This is the integer ID that is used to retrieve the secret from Secret Server.
SecretFieldName	Secret Field Name	The name of the field in the secret that contains the credential value. NOTE: The field must exist.

Keyfactor Command 10

When defining Certificate Stores (Locations->Certificate Stores), Delinea-SecretServer can be used as a PAM provider.

When entering Secret fields, select the Load From Keyfactor Secrets tab, and populate the Secret Value field with the following JSON object:

{"SecretId": "The ID of the secret in Secret Server. This is the integer ID that is used to retrieve the secret from Secret Server.","SecretFieldName": "The name of the field in the secret that contains the credential value. NOTE: The field must exist."}

We recommend creating this JSON object in a text editor, and copying it into the Secret Value field.

Note

Additional information on Delinea-SecretServer can be found in the supplemental documentation.

License

Apache License 2.0, see LICENSE

Related Integrations

See all Keyfactor PAM Provider extensions.