Skip to main content

HashiCorp Configuration

Set Up External Vault Connection

Connect Data Connection Manager (DCM) to your HashiCorp instance, so that later you can fetch authentication data from HashiCorp to your workflow.

  1. Go to File > Manage Connections to open DCM.

  2. Select External Vaults in the bottom-left corner.

  3. Select the + New button to add a new Vault to DCM.

  4. Choose your HashiCorp Vault technology. Only the KV secrets engine is supported, in versions 1 and 2.

  5. Enter a custom name for this Vault connection.

  6. Next, enter the URL and Namespace, where your HashiCorp Vault is located, and select Save.

    For example URL: https://vault.your-company.hashicorp.cloud:8200 

    Namespace: Namespace1 

  7. Select + Connect Credential and choose Create New Credential in the Credential dropdown.

  8. Fill in the fields based on your selected authentication method to access HashiCorp (username and password for basic authentication or when using LDAP, ClientId, Secret for OIDC, or mTLS Certificate).

  9. Select Create and Link.

    Now, you can select this newly created Vault when you create new Credentials.

hashicorp_1.png

mTLS Certificate Configuration

To configure the mTLS certificate credential for HashiCorp Vault, you need to fill in the following information:

  • Credential Name: Choose a custom name for referencing the created credential.

  • SSL Certificate: Specify the file path to the certificate file with the supported types mentioned below.

  • Certificate Type: Choose from auto, DER, P12, or PEM. Leave it on auto to automatically determine the certificate type based on the file extension.

  • Key: If the SSL Certificate does not contain the key file, provide the file path to the key itself. The only supported file type is .key.

  • Password: Enter the password for the key (or certificate if a single file) if the file is protected.

  • HashiCorp Vault Certificate Role: Optionally, specify the desired role for authentication using the certificate, following the certificate roles configuration in your HashiCorp Vault.

For self-signed certificates, you must add the certificate authority as a trusted root certificate authority to access the Vault using a TLS certificate. To create credentials for fetching secrets from the Vault, follow the same process as with any other available form of authentication.

HashiCorp_mTLS.png

Create a New Credential with an External Vault

Create a new DCM Credential, which will use the External Vault connection to get authentication data from HashiCorp.

  1. Go to File > Manage Connections to open DCM.

  2. Select Credentials in the top-left corner.

  3. Select the + Add Credential button to add a new Credential.

  4. Enter a name for your new Credential.

  5. In the Vault dropdown, choose the HashiCorp instance you previously created.

  6. Fill in the Vault Path field with the path to the authentication data in your HashiCorp Vault.

    For example, you have a username and password for your Microsoft SQL database saved in HashiCorp, the path could be this: "vault_name/databases/mssql". 

    To read the secret values from the Vault, the HCV HTTP API is used, hence the requests are constructed differently, but the Vault Path entered into DCM remains the same for both versions 1 and 2 of the KV secrets engine.

    • For KV version 1, the request URL is constructed as [vaultUrl]/v1/secret/[vaultPath], e.g. to https://my-vault.hashicorp.cloud/v1/secret/vault_name/database/mssql.

    • For KV version 2, the request URL is constructed as [vaultUrl]/v1/secret/data/[vaultPath], e.g. to https://my-vault.hashicorp.cloud/v1/secret/data/vault_name/database/mssql.

  7. Next, choose your preferred Method of authentication. This method should match the authentication data you want to fetch from HashiCorp.

    For example, if I want to get the Username and Password from HashiCorp, I will select the "Username and password" option. 

  8. Make sure the Use Values from Vault check box is enabled, if you want the authentication data to be fetched from HashiCorp. Then, each corresponding field should contain the key, under which is the value saved in your HashiCorp.

    For example, if my Username is saved in HashiCorp under a key named "SQLUsername1", then I will check "Use Values from Vault" and enter "SQLUsername1" in the Username field. 

  9. Select Save.

    Now, you can use this newly created Credential for a corresponding Data Source when you configure a workflow tool.

hashicorp configuration_2

Use Credential in a Workflow

You can use your new Credential in a workflow. This flow is identical to using a Credential stored in DCM.

  1. To start create a new Workflow, and add some Input or Output Data tools.

    For example, I can add the Input Data tool.

  2. Make sure the tool is configured to use DCM (enable the Use Data Connection Manager (DCM) check box in my Input Data tool).

  3. Set up your connection, and choose your desired technology.

    For example, I will select "MSSQL Server Quick Connect" in my Input Data tool.

  4. Once the Connection Manager window opens, choose an existing Data Source or create a new one.

  5. Select + Connect Credential and choose the previously created credential (the one that gets authentication data from HashiCorp).

    For example, I will select the Credential that I named "John's MSSQL creds". 

  6. Select Create and Link.

  7. Select Connect.

  8. Now, the connection is set up. You can proceed to configure any specific details related to your data source technology (for example, select database table, record limit, etc.).

    Once your workflow is ready, run it to see if you correctly authenticate to your Data Source using Credentials obtained from your HashiCorp Vault.

Dans cette section​: