Interface CryptographyProvider

Package version

Represents an object that can perform cryptography operations.

internal

Hierarchy

CryptographyProvider

Implemented by

Index

Methods

Methods

decrypt

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

- Defined in keyvault-keys/src/cryptography/models.ts:68
Decrypts the given ciphertext with the specified decryption parameters.

internal

Parameters
- decryptParameters: DecryptParameters
  
  The decryption parameters.
- Optional options: DecryptOptions
  
  Additional options.
Returns Promise<DecryptResult>

encrypt

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

- Defined in keyvault-keys/src/cryptography/models.ts:59
Encrypts the given plaintext with the specified encryption parameters.

internal

Parameters
- encryptParameters: EncryptParameters
  
  The encryption parameters, keyed on the encryption algorithm chosen.
- Optional options: EncryptOptions
  
  Additional options.
Returns Promise<EncryptResult>

isSupported

isSupported(algorithm: string, operation: CryptographyProviderOperation): boolean

- Defined in keyvault-keys/src/cryptography/models.ts:75
Parameters
- algorithm: string
  
  The algorithm to check support for.
- operation: CryptographyProviderOperation
  
  The CryptographyProviderOperation to check support for.
Returns boolean

sign

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

- Defined in keyvault-keys/src/cryptography/models.ts:113
Cryptographically sign the digest of a message

internal

Parameters
- algorithm: SignatureAlgorithm
  
  The signing algorithm to use.
- digest: Uint8Array
  
  The digest of the data to sign.
- Optional options: SignOptions
  
  Additional options.
Returns Promise<SignResult>

signData

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

- Defined in keyvault-keys/src/cryptography/models.ts:127
Cryptographically sign a block of data

internal

Parameters
- algorithm: SignatureAlgorithm
  
  The signing algorithm to use.
- data: Uint8Array
  
  The data to sign.
- Optional options: SignOptions
  
  Additional options.
Returns Promise<SignResult>

unwrapKey

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

- Defined in keyvault-keys/src/cryptography/models.ts:99
Unwraps the given wrapped key using the specified cryptography algorithm

internal

Parameters
- algorithm: KeyWrapAlgorithm
  
  The decryption algorithm to use to unwrap the key.
- encryptedKey: Uint8Array
  
  The encrypted key to unwrap.
- Optional options: UnwrapKeyOptions
  
  Additional options.
Returns Promise<UnwrapResult>

verify

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

- Defined in keyvault-keys/src/cryptography/models.ts:142
Verify the signed message digest

internal

Parameters
- algorithm: SignatureAlgorithm
  
  The signing algorithm to use to verify with.
- digest: Uint8Array
  
  The digest to verify.
- signature: Uint8Array
  
  The signature to verify the digest against.
- Optional options: VerifyOptions
  
  Additional options.
Returns Promise<VerifyResult>

verifyData

verifyData(algorithm: string, data: Uint8Array, signature: Uint8Array, updatedOptions: OperationOptions): Promise<VerifyResult>

- Defined in keyvault-keys/src/cryptography/models.ts:158
Verify the signed block of data

internal

Parameters
- algorithm: string
  
  The algorithm to use to verify with.
- data: Uint8Array
  
  The signed block of data to verify.
- signature: Uint8Array
  
  The signature to verify the block against.
- updatedOptions: OperationOptions
  
  Additional options.
Returns Promise<VerifyResult>

wrapKey

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

- Defined in keyvault-keys/src/cryptography/models.ts:85
Wraps the given key using the specified cryptography algorithm

internal

Parameters
- algorithm: KeyWrapAlgorithm
  
  The encryption algorithm to use to wrap the given key.
- keyToWrap: Uint8Array
  
  The key to wrap.
- Optional options: WrapKeyOptions
  
  Additional options.
Returns Promise<WrapResult>

Generated using TypeDoc