Setting up HashiCorp Vault Connectors
WebUI Changes implemented in Artifactory 7.38.x and above
Security is now called Authentication Providers. All the relevant text and images on this page have been updated to reflect this change.
HashiCorp Vault connectors enable you to use a centralized secret management tool for the keys used to sign packages.
To set up HashiCorp Vault connectors:
- In the JFrog Platform, navigate to Administration | Authentication Providers | HashiCorp Vault.
This opens the HashiCorp Vault Connectors window that displays the list of available connectors.
- Click +Add Connector.
This opens the HashiCorp Vault window, where you will configure a connector to your enterprise HashiCorp Vault to be used as a centralized secret management tool.
- The connector to the vault requires the following information:
- URL: The base URL of the vault server.
- Authentication: The authentication method used. For more information, see Hashicorp Vault Docs.
- AppRole: Using a role ID and a secret ID.
- TLS Certificate: Using a certificate and a private key.
Agent Auto-Auth: Using the vault agent running as a daemon.
The Agent Auto-Auth method is only supported on Self-Hosted environments.
- Secret Engine (Mount): A mountable engine that stores or generates secrets in vault. Provide the following details:
- Path: Secret engines are enabled at a "path" in vault.
- Type: Vault supports several secret engines, each one has different capabilities. The supported secret engine types are KV-v1 and KV-v2.
- Before saving the connector, click Test Configuration to test and verify the configuration.
- If the test is successful, click Save. The new connector will be displayed in the list of configured connectors together with its URL.
Connecting HashiCorp Vault to the JFrog Platform Using REST API
Connect the HashiCorp Vault you set up to the JFrog Platform by running the Vault Configuration REST API. The connector to the vault requires the information detailed above (in the UI setup).
Retrieving Signing Keys from HashiCorp Vault
To be able to retrieve the signing keys from HashiCorp Vault, use the following REST API commands to define the HashiCorp Vault key aliases. Using the REST API, the signing keys can be either set inline, set as reference to Vault, or they can be deleted.
Artifactory GPG and RSA Signing Keys
Use the Create Key Pair REST API to point the JFrog Platform to the GPG and RSA signing keys stored in the vault.
Use the Upload and Propagate GPG Signing Keys for Distribution REST API to to point the JFrog Platform to the GPG and RSA signing keys stored in the vault.
REST API Support
Vault integration can be done with the following REST API endpoints :