Skip to main content

Cyberark Key Storage Plugin (Enterprise)

Cyberark Key Storage Plugin (Enterprise)

Cyberark is a leader in Privileged Access Management solutions providing cloud ready, easy to use security solutions across the complete privileged access surface. A centralized password management system provides visibility and control to protect privileges from attack. Cyberark's solution is built for the Enterprise to enforce strong password business policies and prevent data breaches.


This storage plugin requires having the JRE installed, as well as the java keytool. In order to provide the correct authentication to the plugin, store the RootCA certificate, the client certificate and the client private key in key stores and specify them in For more information on creating/using a keystore, see Java Keystoreopen in new window.

Below is an example of how to import a certificate using the command-line:

keytool -import -file "C:\Path\to\certificateFile.crt" -keystore "C:\Path\to\Keystore\Keystorename" -storepass "password"

Below is an example of how to import another key store, likely containing the private key:

keytool -importkeystore -deststorepass [password] -destkeystore [new-keystore.jks] -srckeystore [keystore-filename.p12] -srcstoretype PKCS12```

Keystore Paths

If a full path is not specified for the new keystore, it will create the keystore in the directory the command was run from. Take note of all the keystore names and passwords as they are created, they will be needed to configure Runbook Automation. Once the certificates and private key are in keystore(s), add them to Runbook Automation using or in Key Storage Config, as shown below.

Note for Cloud Users

In order to integrate Runbook Automation (Cloud) with CyberArk, the Enterprise Runner must be used. This is because we do not allow customers to upload their CA Certs and Keystores to our Cloud infrastructure. Please follow the instructions in the Integration Through Enterprise Runner section.

Operating Modes

There are two modes of operation for the Cyberark plugin. To use the different modes use the following configuration entry. If this is not specified the legacy mode will be used.[legacy|ccp]

Legacy Mode (default)

This mode is provided as the default for backwards compatibility on instances that have used the CyberArk plugin prior to the 4.17 release.

CCP Mode (ccp)

This mode will get secrets using the Central Credential Provideropen in new window (CCP) web service configuration. To setup Cyberark for this method follow this docmentationopen in new window.

This mode has a limitation that it is unable to list the keys in safes. When writing Process Automation jobs the job author will need to manually enter the path to the key using the following format:


provider_path is specified in the config. Commonly it is set as keys but could be different. safe is the Cyberark Safe where the key is stored. path/to is the folder path within the safe where the key is stored. secret.pem is the unique name of the key in that particular folder.


Use the following steps to configure the CyberArk plugin for key storage:

  1. Navigate to the System Menu (gear icon in the upper right).
  2. Click on Key Storage: Key Storage Menu
  3. Navigate to the Configure tab.
  4. Click on Add Storage Plugin +.
  5. Click on CyberArk Storage

Fill in the fields for the integration:

  • Key Storage Path: The path in the Runbook Automation storage tree to apply the plugin. If keys is specified, then all keys and directories added to Key Storage will also be added to CyberArk.
  • Remove Path Prefix: By default, the storage plugin will be invoked using the full path that is requested. If set to true, the path used when invoking the storage plugin would not include the prefix. It is recommended to set this to true. If set to false, keys will not be displayed unless an existing directory is specified in Runbook Automation.
  • username: Username for an account with access to the secrets that will be used in Runbook Automation.
  • password: The password for a user in the account where the secrets are stored.
  • mode: The mode for interacting with CyberArk. See above for descriptions of the various modes.
  • nameOfCCPWebService: If using ccp mode this can be used to specify the name of the CCP Web Service. Default (if setting is not specified) is AIMWebService.
  • base-URL: The base URL for the CyberArk account where the secrets should be saved. Use the format: https://[urltoyourserver]:[port].
  • app-id: The app ID for the application with the safes to use secrets from.
  • platform-id: Platform ID to use when creating a new secret from Runbook Automation's key storage. I.e. WinServerLocal
  • create-username: Default user name applied when creating a new password entry in CyberArk.
  • clientKeystore: The path to the key store that contains the client certificate. (Must be of type JKS)
  • clientKeystorePassword: The password for the key store that contains the client certificate.
  • rootCAKeystore: The path to the key store containing the RootCA certificate. (Must be of type JKS)
  • rootCAKeystorePassword: The password for the key store containing the RootCA certificate.
  • privateKeyStore: The path to the key store containing the user's private key. (Must be of type JKS)
  • privateKeystorePassword: The password for the key store containing the user's private key.
  • privateKeyPassword: Password to access the private key.
  • rootCAName: The name that the Root CA Certificate is saved under in the key store.
  • clientCertName: The name that the Client Certificate is saved under in the key store.
  • privateKeyName: Alias for the private key in the keystore.
  • credentialUrl: CyberArk Credential Provider URL for REST API mode.
  • credentialAppId: CyberArk Credential Provider AppId for REST API mode.
  • credentialSafe: CyberArk Credential Provider Safe for REST API mode.
  • credentialPath: CyberArk Credential Provider Safe for REST API mode.

Below is an example configuration:

CyberArk Full Config

Integration Through Enterprise Runner

The Enterprise Runneropen in new window can be used to integrate with CyberArk. This is useful when CyberArk is hosted in an environment that is not directly accessible from Runbook Automation - whether self-hosted or Cloud.

The following provides examples of how to configure the Enterprise Runner to connect to CyberArk:

Custom properties for the Runner can be set through a .yaml file:

          type: "cyberark-storage"
          pathBehavior: "predefined"
            baseURL: ""
            username: "Administrator"
            password: "myPassword"
            appId: "testappid"
            clientKeyStore: /etc/rundeck/cyberark/clientkeystore
            clientKeyStorePassword: "myClientPass"
            rootCAKeyStore: /etc/rundeck/cyberark/rootkeystore
            rootCAKeyStorePassword: "myRootPass"
            privateKeyStore: /etc/rundeck/cyberark/privatekeystore.jks
            privateKeyStorePassword: "myPrivatePass"
            privateKeyPassword: "myPrivateKeyPass"
            privateKeyName: "client_1-28"
            rootCAName: "rootcert"
            clientCertName: "clientcert"

Save this file in the directory where the Runner .jar is located and then invoke the Runner with the following command:

java -Dmicronaut.config.files=runner-props.yaml -jar runner-{{unique-runner-id}}.jar