HashiCorp Vault

LAST UPDATED: 04/12/2024

Overview

Manage Secrets and Protect Sensitive Data.

D3 SOAR is providing REST operations to function with HashiCorp Vault.

HashiCorp Vault is available for use in:

D3 SOAR	V14.0.283
Category	Credential Management
Deployment Options	Option I, Option III

Connection

To connect to HashiCorp Vault from D3 SOAR, please follow this part to collect the required information below:

Parameter	Description	Example
Server URL (domain level)	The domain-level Server URL of HashiCorp Vault.	1.1.1.1
API Token	The API Token obtained from HashiCorp Vault.	***
API Version	The API Version.	v1

Configuring HashiCorp Vault to Work with D3 SOAR

Please refer to Tokens | Vault | HashiCorp Developer for more information about the API token.

Configuring D3 SOAR to Work with HashiCorp Vault

Log in to D3 SOAR.
Find the HashiCorp Vault integration.

a. Navigate to Configuration on the top header menu.

b. Click on the Integration icon on the left sidebar.

c. Type HashiCorp Vault in the search box to find the integration, then click it to select it.

d. Click + Connection, on the right side of the Connections section. A new connection window will appear.

Configure the following fields to create a connection to HashiCorp Vault.
1. Connection Name: The desired name for the connection.
2. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.
3. Recipient site for events from connections Shared to Internal Sites: This field appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.
4. Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.
5. Description (Optional): Add your desired description for the connection.
6. Tenant (Optional): When configuring the connection from a master tenant site, you have the option to choose the specific tenant sites you want to share the connection with. Once you enable this setting, you can filter and select the desired tenant sites from the dropdowns to share the connection.

g. Configure User Permissions: Defines which users have access to the connection.

h. Active: Check the tick box to ensure the connection is available for use.

i. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.

1. Input the Server URL.

2. Copy the API Token from the HashiCorp Vault platform.

3. Input the API Version. The default value is v1.

j. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Please refer to the password vault connection guide if needed.

Test the connection.

a. Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green checkmark appear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.

b. Click OK to close the alert window.

c. Click + Add to create and add the configured connection.

Commands

HashiCorp Vault includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, you can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the HashiCorp Vault API, please refer to the HashiCorp Vault API reference.

Fetch Credentials

Retrieves credentials by the provided path.

READER NOTE

To determine a path, select an engine first, then add a "/" followed by your secret. For instance, if your engine name is "D3security" and your secret is for "Cybereason", your path should be "D3security/Cybereason".

Input

Input Parameter	Required/Optional	Description	Example
Path	Required	The path of the secret to read. Please use an existing item path from your HashiCorp Secrets Engines.	D3security/Cybereason

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

No Sample Data

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE

No Sample Data

Return Data

Indicates one of the possible command execution states: Successful or Failed.

The Failed state can be triggered by any of the following errors:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

SAMPLE DATA

CODE

No Sample Data

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Fetch Credentials failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the HashiCorp Vault portal. Refer to the HTTP Status Code Registry for details.	Status Code: 404.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Path not found.

Error Sample Data

Fetch Credentials failed.

Status Code: 404.

Message: Path not found.