Download the PHP package insites-consulting/azure-key-vault without Composer
On this page you can find all versions of the php package insites-consulting/azure-key-vault. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download insites-consulting/azure-key-vault
More information about insites-consulting/azure-key-vault
Files in insites-consulting/azure-key-vault
Package azure-key-vault
Short Description Allow secrets to be easily fetched from an Azure Key Vault from within a Laravel application
License proprietary
Informations about the package azure-key-vault
Azure Key Vault wrapper for Laravel
Overview
This package allows secrets to be fetched from, or set in, an
Azure Key Vault,
with an interface similar to env()
and config()
.
Installation
Require this package with composer:
The package should be discovered by Laravel on installation.
The following environment variables must be set, if the package's default configuration is used:
AZURE_AD_CLIENT_ID
the UUID of the service principal which will be used to access the vault. This service principal needs "Get Secret" permission on that vault.AZURE_AD_CLIENT_SECRET
the shared secret for that service principal.AZURE_AD_TENANT_ID
the UUID for the tenant under which that service principal exists.
AZURE_KEY_VAULT_NAME
the name of the key vault (used as a subdomain in its hostname; e.g.fred
infred.vault.azure.net
).
This package publishes its configuration to vault.php
. This can be done with:
The configuration entries are as follows:
tenant_id
the tenant UUIDclient_id
the service principal UUIDclient_secret
the service principal shared secretvault
the vault name
Usage
This package provides a facade called Vault
, with three methods
Vault::secret()
, Vault::setSecret()
and Vault::setVault()
, as well as a
global helper function secret()
.
To fetch a secret called 'apikey':
If the secret does not exist, null
will be returned, unless a different
default value is specified, as here:
If there is an error, an
InsitesConsulting\AzureKeyVault\AzureKeyVaultException
will be thrown. Its
message will be set to the body of the error response from Azure, and its
code will be set to the HTTP status of that response.
The global helper function behaves identically to the facade method:
To set a secret called 'apikey' to the value 'longsecretvalue':
This method is void, but will throw an
InsitesConsulting\AzureKeyVault\AzureKeyVaultException
on error, in the same
manner as Vault::secret()
.
In order to work with multiple vaults, use Vault::setVault()
to change the
vault name used:
This is persistent: the newly set vault will remain until Vault::setVault()
is called again.
Calling Vault::setVault()
with no argument will reset the vault name to that
set in the config file:
All versions of azure-key-vault with dependencies
illuminate/cache Version ^8||^9
illuminate/http Version ^8||^9
illuminate/support Version ^8|^9