keboola/azure-key-vault-client

Azure Key Vault客户端

3.0.0 2022-09-21 22:08 UTC

This package is auto-updated.

Last update: 2024-09-22 02:43:24 UTC


README

PHP版本的Azure Key Vault客户端。

支持以下身份验证方法

  • 客户端凭据通过环境变量AZURE_TENANT_IDAZURE_CLIENT_IDAZURE_CLIENT_SECRET提供
  • 托管身份如果未指定客户端凭据且可用Azure实例元数据,则自动选择。

目前仅实现了密钥加密和解密方法。

安装

composer require keboola/azure-key-vault-client

使用方法

创建客户端实例并加密数据

$client = new Client(
    new GuzzleClientFactory($logger),
    new AuthenticatorFactory(),
    'https://my-test-vault.vault.azure.net'
);

$result = $client->encrypt(
    new EncryptRequest(EncryptRequest::RSA_OAEP_256, 'test'),
    'my-test-key',
    'abcabcabcabcabcabcabcabcabcabcab'
);

开发

使用以下命令运行测试

docker-compose run --rm testsXX

其中XX是PHP版本(56 - 74),例如

docker-compose run --rm tests70

资源设置

创建资源组

az group create --name testing-azure-key-vault-php-client --location "East US"

创建服务主体

az ad sp create-for-rbac --name testing-azure-key-vault-php-client

使用响应设置.env文件中的值TEST_CLIENT_IDTEST_CLIENT_SECRETTEST_TENANT_ID

{
  "appId": "268a6f05-xxxxxxxxxxxxxxxxxxxxxxxxxxx", //-> TEST_CLIENT_ID
  "displayName": "testing-azure-key-vault-php-client",
  "name": "http://testing-azure-key-vault-php-client",
  "password": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", //-> TEST_CLIENT_SECRET
  "tenant": "9b85ee6f-xxxxxxxxxxxxxxxxxxxxxxxxxxx" //-> TEST_TENANT_ID
}

获取服务主体的ID

az ad sp list --filter "displayname eq 'testing-azure-key-vault-php-client'" --query [].objectId

获取当前用户所属的组(例如,“开发人员”)的ID

az ad group list --filter "displayname eq 'Developers'" --query [].objectId

部署密钥库,提供上一个命令中的租户ID、服务主体ID和组ID

az deployment group create --resource-group testing-azure-key-vault-php-client --template-file arm-template.json --parameters vault_name=testing-key-vault-client tenant_id=9b85ee6f-xxxxxxxxxxxxxxxxxxxxxxxxxxx service_principal_object_id=7f7a8a4c-xxxxxxxxxxxxxxxxxxxxxxxxxxx group_object_id=a1e8da73-xxxxxxxxxxxxxxxxxxxxxxxxxxx

创建密钥

az keyvault key create --name test-key --vault-name testing-key-vault-client --query key.kid

返回例如https://testing-key-vault-client.vault.azure.net/keys/test-key/b7c28xxxxxxxxxxxxxxxxxxxxxxxxxxx,使用此值在.env文件中设置值

许可证

MIT许可证,请参阅LICENSE文件。