itk-dev/vault-bundle

Symfony bundle for vault

0.1.0 2024-10-21 07:19 UTC

Requires

• php: ^8.0
• itk-dev/vault: ^0.0.5
• nyholm/psr7: ^1.8
• symfony/config: ^6.4|^7.0|^7.1|^7.2
• symfony/dependency-injection: ^6.4|^7.0|^7.1|^7.2
• symfony/http-client: ^6.4|^7.0|^7.1|^7.2
• symfony/http-kernel: ^6.4|^7.0|^7.1|^7.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.64

MIT

• Jesper Kristensen

README

This bundle enables Symfony sites to interact with HashiCorp Vault using the "approle" authentication method. It allows fetching secrets and provides the capability for local caching of both access tokens and the secrets themselves.

The bundle offers a services wrapper for the PHP library itk-dev/vault-library. Additionally, it includes an environment variable processor, enabling the retrieval of secrets directly in .env files at runtime.

Install

composer require itk-dev/vault-bundle

Setup

Create a configuration file at config/packages/itkdev_vault.yaml and add the three referenced variables to .env with placeholder values. Then add the actual values to .env.local.

itkdev_vault:
  role_id: '%env(VAULT_ROLE_ID)%'
  secret_id: '%env(VAULT_SECRET_ID)%'
  url: '%env(VAULT_URL)%'

Usage

Use the service by simply injecting the service named Vault from the namespace ItkDev\VaultBundle\Service. Use the login function to fetch a token and then use the acquired token in the getSecret or getSecrets functions.

To use the environment variable processor, use the following format to specify what to retrieve from the vault:

MY_SECRET=<PATH>:<SECRET>:<KEY>:<VERSION>:<EXPIRE>

• Path: The secret engine path (e.g. prod, stg, test)
• Secret: Name of the secret in the engine (eg. itksites, dokk1)
• Key: The secret key that should be fetched (eg. OIDC, pretix-api-key)
• Version: Optional, fetch a specific version of the secret.
• Expire: Optional, the number of seconds to cache the secret.

When the variable have been defined, the next step is to activate the processor on the variable in config/services.yaml using the vault keyword.

parameters:
  $myOtherSecret: '%env(vault:MY_OTHER_SECRET)%'

App\Command\TestCommand:
  arguments:
    $secret: '%env(vault:MY_SECRET)%'

CLI support

This bundle also comes with two CLI commands to help debug configuration and to check that you fetch the expected data from the vault. Use the --help option to symfony console to see the options available for the commands.

• itkdev:vault:login
• itkdev:vault:secret

Developing

See details on contributing in the contributing docs.