Class RemoteCryptographyProvider

Package version

The remote cryptography provider is used to run crypto operations against KeyVault.

internal

Hierarchy

RemoteCryptographyProvider

Implements

CryptographyProvider

Index

Constructors

constructor

Properties

vaultUrl

Accessors

keyId

Methods

Constructors

constructor

new RemoteCryptographyProvider(key: string | KeyVaultKey, credential: TokenCredential, pipelineOptions?: CryptographyClientOptions): RemoteCryptographyProvider

- Defined in keyvault-keys/src/cryptography/remoteCryptographyProvider.ts:51
Parameters
- key: string | KeyVaultKey
- credential: TokenCredential
- Default value pipelineOptions: CryptographyClientOptions = {}
Returns RemoteCryptographyProvider

Properties

vaultUrl

vaultUrl: string

The base URL to the vault.

Accessors

keyId

get keyId(): string | undefined

- Defined in keyvault-keys/src/cryptography/remoteCryptographyProvider.ts:306
The ID of the key used to perform cryptographic operations for the client.

Returns string | undefined

Methods

decrypt

decrypt(decryptParameters: DecryptParameters, options?: DecryptOptions): Promise<DecryptResult>

Implementation of CryptographyProvider.decrypt
- Defined in keyvault-keys/src/cryptography/remoteCryptographyProvider.ts:159
Parameters
- decryptParameters: DecryptParameters
- Default value options: DecryptOptions = {}
Returns Promise<DecryptResult>

encrypt

encrypt(encryptParameters: EncryptParameters, options?: EncryptOptions): Promise<EncryptResult>

Implementation of CryptographyProvider.encrypt
- Defined in keyvault-keys/src/cryptography/remoteCryptographyProvider.ts:127
Parameters
- encryptParameters: EncryptParameters
- Default value options: EncryptOptions = {}
Returns Promise<EncryptResult>

getKey

getKey(options?: GetKeyOptions): Promise<KeyVaultKey>

- Defined in keyvault-keys/src/cryptography/remoteCryptographyProvider.ts:315
Gets the KeyVaultKey used for cryptography operations, fetching it from KeyVault if necessary.

Parameters
- Default value options: GetKeyOptions = {}
  
  Additional options.
Returns Promise<KeyVaultKey>

isSupported

isSupported(_algorithm: string, _operation: CryptographyProviderOperation): boolean

Implementation of CryptographyProvider.isSupported
- Defined in keyvault-keys/src/cryptography/remoteCryptographyProvider.ts:123
Parameters
- _algorithm: string
- _operation: CryptographyProviderOperation
Returns boolean

sign

sign(algorithm: string, digest: Uint8Array, options?: SignOptions): Promise<SignResult>

- Defined in keyvault-keys/src/cryptography/remoteCryptographyProvider.ts:233
Parameters
- algorithm: string
- digest: Uint8Array
- Default value options: SignOptions = {}
Returns Promise<SignResult>

signData

signData(algorithm: string, data: Uint8Array, options?: SignOptions): Promise<SignResult>

- Defined in keyvault-keys/src/cryptography/remoteCryptographyProvider.ts:283
Parameters
- algorithm: string
- data: Uint8Array
- Default value options: SignOptions = {}
Returns Promise<SignResult>

unwrapKey

unwrapKey(algorithm: KeyWrapAlgorithm, encryptedKey: Uint8Array, options?: UnwrapKeyOptions): Promise<UnwrapResult>

Implementation of CryptographyProvider.unwrapKey
- Defined in keyvault-keys/src/cryptography/remoteCryptographyProvider.ts:210
Parameters
- algorithm: KeyWrapAlgorithm
- encryptedKey: Uint8Array
- Default value options: UnwrapKeyOptions = {}
Returns Promise<UnwrapResult>

verify

verify(algorithm: string, digest: Uint8Array, signature: Uint8Array, options?: VerifyOptions): Promise<VerifyResult>

- Defined in keyvault-keys/src/cryptography/remoteCryptographyProvider.ts:260
Parameters
- algorithm: string
- digest: Uint8Array
- signature: Uint8Array
- Default value options: VerifyOptions = {}
Returns Promise<VerifyResult>

verifyData

verifyData(algorithm: string, data: Uint8Array, signature: Uint8Array, options?: VerifyOptions): Promise<VerifyResult>

Implementation of CryptographyProvider.verifyData
- Defined in keyvault-keys/src/cryptography/remoteCryptographyProvider.ts:248
Parameters
- algorithm: string
- data: Uint8Array
- signature: Uint8Array
- Default value options: VerifyOptions = {}
Returns Promise<VerifyResult>

wrapKey

wrapKey(algorithm: KeyWrapAlgorithm, keyToWrap: Uint8Array, options?: WrapKeyOptions): Promise<WrapResult>

Implementation of CryptographyProvider.wrapKey
- Defined in keyvault-keys/src/cryptography/remoteCryptographyProvider.ts:187
Parameters
- algorithm: KeyWrapAlgorithm
- keyToWrap: Uint8Array
- Default value options: WrapKeyOptions = {}
Returns Promise<WrapResult>

Generated using TypeDoc