AzureKeyVaultEncryptionKeyResolver class

Пакет:

@azure/cosmos

Реализация EncryptionKeyResolver, который использует Azure Key Vault для ключей, управляемых клиентом.

Конструкторы

AzureKeyVaultEncryptionKeyResolver(TokenCredential)

Свойства

encryptionKeyResolverName

Имя резолвера, используемого для шифрования на стороне клиента. В настоящее время поддерживается только реализация AzureKeyVault.

Методы

unwrapKey(string, string, Uint8Array)	Распаковывает заданный упакованный ключ с использованием указанного ключа, пути к ключу шифрования и алгоритма.
wrapKey(string, string, Uint8Array)	Оборачивает заданный ключ с использованием указанного ключа, пути к ключу шифрования и алгоритма.

Сведения о конструкторе

AzureKeyVaultEncryptionKeyResolver(TokenCredential)

new AzureKeyVaultEncryptionKeyResolver(credentials: TokenCredential)

Параметры

credentials

TokenCredential

Сведения о свойстве

encryptionKeyResolverName

Имя резолвера, используемого для шифрования на стороне клиента. В настоящее время поддерживается только реализация AzureKeyVault.

encryptionKeyResolverName: AzureKeyVault

Значение свойства

AzureKeyVault

Сведения о методе

unwrapKey(string, string, Uint8Array)

Распаковывает заданный упакованный ключ с использованием указанного ключа, пути к ключу шифрования и алгоритма.

function unwrapKey(encryptionKeyId: string, algorithm: string, wrappedKey: Uint8Array): Promise<Uint8Array>

Параметры

encryptionKeyId

string

путь к управляемому клиентом ключу, который будет использоваться для распаковки. Для Azure Key Vault это URL-адрес ключа в хранилище.

algorithm

string

Алгоритм, который будет использоваться для развертки.

wrappedKey

Uint8Array

завернутый ДЭК.

Возвращаемое значение

Promise<Uint8Array>

развернутый DEK.

wrapKey(string, string, Uint8Array)

Оборачивает заданный ключ с использованием указанного ключа, пути к ключу шифрования и алгоритма.

function wrapKey(encryptionKeyId: string, algorithm: string, unwrappedKey: Uint8Array): Promise<Uint8Array>

Параметры

encryptionKeyId

string

Путь к управляемому клиентом ключу, который будет использоваться для упаковки. Для Azure Key Vault это URL-адрес ключа в хранилище.

algorithm

string

Алгоритм, который будет использоваться для обертывания.

unwrappedKey

Uint8Array

Дек должен быть завернут.

Возвращаемое значение

Promise<Uint8Array>

завернутый ДЭК.