Share via

EncryptionKeyResolver interface

  • Reference
Package:
@azure/cosmos

Provides an interface for key resolver for different key providers. All resolvers should implement this interface.

Properties

encryptionKeyResolverName

name of the resolver to use for client side encryption. Currently only AzureKeyVault implementation is supported.

Methods

unwrapKey(string, string, Uint8Array)

Unwraps the input wrapped key using the key encryption key.
wrapKey(string, string, Uint8Array)

Wraps the input key using the key encryption key.

Property Details

encryptionKeyResolverName

name of the resolver to use for client side encryption. Currently only AzureKeyVault implementation is supported.

encryptionKeyResolverName: string

Property Value

string

Method Details

unwrapKey(string, string, Uint8Array)

Unwraps the input wrapped key using the key encryption key.

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

Parameters

encryptionKeyId

string

Identifier of the customer managed key to be used for unwrapping.

algorithm

string

Algorithm to be used for unwrapping.

wrappedKey

Uint8Array

wrapped Data Encryption key.

Returns

Promise<Uint8Array>

Unwrapped Key.

wrapKey(string, string, Uint8Array)

Wraps the input key using the key encryption key.

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

Parameters

encryptionKeyId

string

Identifier of the customer managed key to be used for wrapping.

algorithm

string

Algorithm to be used for wrapping.

unwrappedKey

Uint8Array

Returns

Promise<Uint8Array>

Wrapped key.