PHPackages                             polokij/laravel-vault-env - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. polokij/laravel-vault-env

ActiveLibrary[Utility & Helpers](/categories/utility)

polokij/laravel-vault-env
=========================

Hashicorp Vault client for Laravel with possibility set the env variables from Vault secret dynamically

v0.2.1(11mo ago)44.8k↑63.3%1MITPHPPHP >=8.1CI failing

Since Oct 19Pushed 11mo ago1 watchersCompare

[ Source](https://github.com/Polokij/laravel-vault-env)[ Packagist](https://packagist.org/packages/polokij/laravel-vault-env)[ RSS](/packages/polokij-laravel-vault-env/feed)WikiDiscussions main Synced 2d ago

READMEChangelog (10)Dependencies (3)Versions (32)Used By (0)

Laravel Hashicorp. Vault API client
===================================

[](#laravel-hashicorp-vault-api-client)

This package provide the base features for Hashicorp Vault API.

### Motivation

[](#motivation)

Developing my multi-tenant application using Laravel I've faced with lacking of the package which could fetch the env variables from vault and apply it on bootstrapping the application. Here it bref implementation of the required features:

```
- Vault API Client + Service + Facade
- artisan command to unseal the vault
- artisan command for create the secret engine
- Laravel bootstraper which apply the env variables fetched from Vault

```

Requirements
------------

[](#requirements)

```
- Laravel 9+
- PHP 8+

```

Installation
------------

[](#installation)

Adding composer package

```
 composer require polokij/laravel-vault-env

```

Setting up the .env variables

```
VAULT_ADDR=http://vault:8200
# Required is no VAULT_ADDR specified
VAULT_HOST=vault
VAULT_PORT=8200
VAULT_SCHEME=https
# The storage engine thich will be used by default kv2 or secrets, or whatewhere
VAULT_DEFAULT_ENGINE=kv2
# The prefix will be added to each key on put/get requests
VAULT_KEY_PREFIX=TenantRootPath

VAULT_TOKEN=

```

Publishing the config

```
php artisan vendor:publish --provider="LaravelVault\VaultServiceProvider"

```

Usage
-----

[](#usage)

- Unseal Vault using json `php artisan vault:unseal -f secret/file.json`
- Unseal Vault using key as command arguments `php artisan vault:unseal $key`
- Check the seal status `php artisan vault:unseal -s`
- Create new secret storage `php artisan vault:storage create new_storage_name`
- Access to Secrets

```
Vault::secret('my-secret', ['foo' => 'bar']); // push the secret to Vault
Vault::secret('my-secret'); // pull the secret from Vault - return ['foo' => 'bar']
Vault::instance()->sys->get('some/not/implemented/endpoints'); // call the other endpoints on sys group
Vault::instance()->auth->get('some/not/implemented/endpoints'); // call the other endpoints on auth group
```

### Bootstrap the application with dynamic env variables

[](#bootstrap-the-application-with-dynamic-env-variables)

Example for Multi-tenant application:

**bootstrap/app.php**

```
$app = new Illuminate\Foundation\Application(
    $_ENV['APP_BASE_PATH'] ?? dirname(__DIR__)
);

$app->afterLoadingEnvironment(function () use ($app) {
    // checking is the feature enabled
    if (env('VAULT_LOAD_ENV', false)) {
        try {
            $tenantId = env('TENANT_ID');

            // resolving tenant_id by headers - make sure proxy override this header for security reason
            if (!$tenantId) {
                $headers = collect(getallheaders());
                $tenantIdHeader = env('TENANT_ID_HEADER', 'tenant-id');
                $tenantId = $headers
                    ->first(fn($value, $key) => $key === $tenantIdHeader
                        || strtolower($key) === $tenantIdHeader);
            }

            if (!$tenantId) {
                throw new Exception('Missed Tenant_id ');
            }

            $envRepository = Env::getRepository();
            $vaultDefaultPrefix = $envRepository->get('VAULT_KEY_PREFIX');
            $envRepository->set('VAULT_KEY_PREFIX', $vaultDefaultPrefix.'/'.$tenantId);

            (new LoadEnvironmentVariablesVault)->bootstrap($app);
        } catch (Throwable $e) {
            // preparing the logs for exception
            $app->instance('config', $config = new Repository([]));

            throw $e;
        }
    }
});
```

#### Alternative way

[](#alternative-way)

To enable this feature override the array of bootstrappers on *app/Console/Kernel.php* and *app/Http/Kernel.php* files **app/Console/Kernel.php**

```
use LaravelVault\LoadEnvironmentVariablesVault;

class Kernel extends ConsoleKernel
{
    /**
     * The bootstrap classes for the application.
     *
     * @var string[]
     */
    protected $bootstrappers = [
        LoadEnvironmentVariables::class,
        LoadEnvironmentVariablesVault::class, //