Package version
Constructs a new instance of the Cryptography client for the given key
Example usage:
import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";
let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();
let keyClient = new KeyClient(vaultUrl, credentials);
let keyVaultKey = await keyClient.getKey("MyKey");
let client = new CryptographyClient(keyVaultKey.id, credentials);
// or
let client = new CryptographyClient(keyVaultKey, credentials);The key to use during cryptography tasks.
An object that implements the TokenCredential interface used to authenticate requests to the service. Use the @azure/identity package to create a credential that suits your needs.
The base URL to the vault
Decrypts the given ciphertext with the specified cryptography algorithm
Example usage:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.decrypt("RSA1_5", encryptedBuffer);The algorithm to use.
The text to decrypt.
Encrypts the given plaintext with the specified cryptography algorithm
Example usage:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.encrypt("RSA1_5", Buffer.from("My Message"));The algorithm to use.
The text to encrypt.
Cryptographically sign the digest of a message
Example usage:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.sign("RS256", digest);The signing algorithm to use.
The digest of the data to sign.
Cryptographically sign a block of data
Example usage:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.signData("RS256", message);The signing algorithm to use.
The data to sign.
Unwraps the given wrapped key using the specified cryptography algorithm
Example usage:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.unwrapKey("RSA1_5", keyToUnwrap);The decryption algorithm to use to unwrap the key.
The encrypted key to unwrap.
Verify the signed message digest
Example usage:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.verify("RS256", signedDigest, signature);The signing algorithm to use to verify with.
The digest to verify.
The signature to verify the digest against.
Verify the signed block of data
Example usage:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.verifyData("RS256", signedMessage, signature);The algorithm to use to verify with.
The signed block of data to verify.
The signature to verify the block against.
Wraps the given key using the specified cryptography algorithm
Example usage:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.wrapKey("RSA1_5", keyToWrap);The encryption algorithm to use to wrap the given key.
The key to wrap.
Generated using TypeDoc
A client used to perform cryptographic operations with Azure Key Vault keys.