CryptographyClient class 
En klient som används för att utföra kryptografiska åtgärder på en Azure Key Vault-nyckel eller en lokal JsonWebKey-.
Konstruktorer
| Cryptography | Konstruerar en ny instans av kryptografiklienten för den angivna nyckeln i lokalt läge. Exempel på användning:  | 
| Cryptography | Konstruerar en ny instans av kryptografiklienten för den angivna nyckeln Exempel på användning:  | 
Egenskaper
| keyID | ID:t för nyckeln som används för att utföra kryptografiska åtgärder för klienten. | 
| vault | Bas-URL:en till valvet. Om en lokal JsonWebKey används är vaultUrl tomt. | 
Metoder
| decrypt(Decrypt | Dekrypterar den angivna chiffertexten med de angivna dekrypteringsparametrarna. Beroende på vilken algoritm som används i dekrypteringsparametrarna ändras uppsättningen möjliga dekrypteringsparametrar. Microsoft rekommenderar att du inte använder CBC utan att först säkerställa chiffertextens integritet med till exempel en HMAC. Mer information finns i https://free.blessedness.top/dotnet/standard/security/vulnerabilities-cbc-mode. Exempel på användning:  | 
| decrypt(string, Uint8Array, Decrypt | Dekrypterar den angivna chiffertexten med den angivna kryptografialgoritmen Exempel på användning: Microsoft rekommenderar att du inte använder CBC utan att först säkerställa chiffertextens integritet med till exempel en HMAC. Mer information finns i https://free.blessedness.top/dotnet/standard/security/vulnerabilities-cbc-mode. | 
| encrypt(Encrypt | Krypterar den angivna klartexten med de angivna krypteringsparametrarna. Beroende på vilken algoritm som anges i krypteringsparametrarna ändras uppsättningen med möjliga krypteringsparametrar. Exempel på användning:  | 
| encrypt(string, Uint8Array, Encrypt | Krypterar den angivna klartexten med den angivna kryptografialgoritmen Exempel på användning:  | 
| sign(string, Uint8Array, Sign | Kryptografiskt signera sammanfattningen av ett meddelande Exempel på användning:  | 
| sign | Kryptografiskt signera ett datablock Exempel på användning:  | 
| unwrap | Hämtar den angivna omslutna nyckeln med den angivna kryptografialgoritmen Exempel på användning:  | 
| verify(string, Uint8Array, Uint8Array, Verify | Verifiera det signerade meddelandesammandraget Exempel på användning:  | 
| verify | Verifiera det signerade datablocket Exempel på användning:  | 
| wrap | Omsluter den angivna nyckeln med den angivna kryptografialgoritmen Exempel på användning:  | 
Konstruktorinformation
		CryptographyClient(JsonWebKey)
	   
	Konstruerar en ny instans av kryptografiklienten för den angivna nyckeln i lokalt läge.
Exempel på användning:
import { CryptographyClient } from "@azure/keyvault-keys";
const jsonWebKey = {
  kty: "RSA",
  kid: "test-key-123",
  use: "sig",
  alg: "RS256",
  n: new Uint8Array([112, 34, 56, 98, 123, 244, 200, 99]),
  e: new Uint8Array([1, 0, 1]),
  d: new Uint8Array([45, 67, 89, 23, 144, 200, 76, 233]),
  p: new Uint8Array([34, 89, 100, 77, 204, 56, 29, 77]),
  q: new Uint8Array([78, 99, 201, 45, 188, 34, 67, 90]),
  dp: new Uint8Array([23, 45, 78, 56, 200, 144, 32, 67]),
  dq: new Uint8Array([12, 67, 89, 144, 99, 56, 23, 45]),
  qi: new Uint8Array([78, 90, 45, 201, 34, 67, 120, 55]),
};
const client = new CryptographyClient(jsonWebKey);
new CryptographyClient(key: JsonWebKey)Parametrar
- key
- JsonWebKey
JsonWebKey som ska användas under kryptografiåtgärder.
		CryptographyClient(string | KeyVaultKey, TokenCredential, CryptographyClientOptions)
	      
	Konstruerar en ny instans av kryptografiklienten för den angivna nyckeln
Exempel på användning:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new KeyClient(url, credential);
// Create or retrieve a key from the keyvault
const myKey = await client.createKey("MyKey", "RSA");
// Lastly, create our cryptography client and connect to the service
const cryptographyClient = new CryptographyClient(myKey, credential);
new CryptographyClient(key: string | KeyVaultKey, credential: TokenCredential, pipelineOptions?: CryptographyClientOptions)Parametrar
- key
- 
				string | KeyVaultKey 
Nyckeln som ska användas under kryptografiuppgifter. Du kan också skicka id:t för nyckeln, dvs dess url här.
- credential
- TokenCredential
Ett objekt som implementerar det TokenCredential gränssnitt som används för att autentisera begäranden till tjänsten. Använd @azure/identity-paketet för att skapa en autentiseringsuppgift som passar dina behov.
- pipelineOptions
- CryptographyClientOptions
Pipelinealternativ som används för att konfigurera Api-begäranden för Key Vault. Utelämna den här parametern för att använda standardkonfigurationen för pipelinen.
Egenskapsinformation
keyID
ID:t för nyckeln som används för att utföra kryptografiska åtgärder för klienten.
undefined | string keyIDEgenskapsvärde
undefined | string
		vaultUrl
	 
	Bas-URL:en till valvet. Om en lokal JsonWebKey används är vaultUrl tomt.
string vaultUrlEgenskapsvärde
string
Metodinformation
		decrypt(DecryptParameters, DecryptOptions)
	  
	Dekrypterar den angivna chiffertexten med de angivna dekrypteringsparametrarna. Beroende på vilken algoritm som används i dekrypteringsparametrarna ändras uppsättningen möjliga dekrypteringsparametrar.
Microsoft rekommenderar att du inte använder CBC utan att först säkerställa chiffertextens integritet med till exempel en HMAC. Mer information finns i https://free.blessedness.top/dotnet/standard/security/vulnerabilities-cbc-mode.
Exempel på användning:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new KeyClient(url, credential);
const myKey = await client.createKey("MyKey", "RSA");
const cryptographyClient = new CryptographyClient(myKey.id, credential);
const encryptResult = await cryptographyClient.encrypt({
  algorithm: "RSA1_5",
  plaintext: Buffer.from("My Message"),
});
console.log("encrypt result: ", encryptResult.result);
const decryptResult = await cryptographyClient.decrypt({
  algorithm: "RSA1_5",
  ciphertext: encryptResult.result,
});
console.log("decrypt result: ", decryptResult.result.toString());
function decrypt(decryptParameters: DecryptParameters, options?: DecryptOptions): Promise<DecryptResult>Parametrar
- decryptParameters
- DecryptParameters
Dekrypteringsparametrarna.
- options
- DecryptOptions
Ytterligare alternativ.
Returer
Promise<DecryptResult>
		decrypt(string, Uint8Array, DecryptOptions)
	 
	Varning
Det här API:et är nu inaktuellt.
Use decrypt({ algorithm, ciphertext }, options) instead.
Dekrypterar den angivna chiffertexten med den angivna kryptografialgoritmen
Exempel på användning:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new KeyClient(url, credential);
const myKey = await client.createKey("MyKey", "RSA");
const cryptographyClient = new CryptographyClient(myKey.id, credential);
const encryptResult = await cryptographyClient.encrypt({
  algorithm: "RSA1_5",
  plaintext: Buffer.from("My Message"),
});
console.log("encrypt result: ", encryptResult.result);
const decryptResult = await cryptographyClient.decrypt({
  algorithm: "RSA1_5",
  ciphertext: encryptResult.result,
});
console.log("decrypt result: ", decryptResult.result.toString());
Microsoft rekommenderar att du inte använder CBC utan att först säkerställa chiffertextens integritet med till exempel en HMAC. Mer information finns i https://free.blessedness.top/dotnet/standard/security/vulnerabilities-cbc-mode.
function decrypt(algorithm: string, ciphertext: Uint8Array, options?: DecryptOptions): Promise<DecryptResult>Parametrar
- algorithm
- 
				string 
Algoritmen som ska användas.
- ciphertext
- 
				Uint8Array 
Texten som ska dekrypteras.
- options
- DecryptOptions
Ytterligare alternativ.
Returer
Promise<DecryptResult>
		encrypt(EncryptParameters, EncryptOptions)
	  
	Krypterar den angivna klartexten med de angivna krypteringsparametrarna. Beroende på vilken algoritm som anges i krypteringsparametrarna ändras uppsättningen med möjliga krypteringsparametrar.
Exempel på användning:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new KeyClient(url, credential);
const myKey = await client.createKey("MyKey", "RSA");
const cryptographyClient = new CryptographyClient(myKey.id, credential);
const encryptResult = await cryptographyClient.encrypt({
  algorithm: "RSA1_5",
  plaintext: Buffer.from("My Message"),
});
console.log("encrypt result: ", encryptResult.result);
function encrypt(encryptParameters: EncryptParameters, options?: EncryptOptions): Promise<EncryptResult>Parametrar
- encryptParameters
- EncryptParameters
Krypteringsparametrarna, som är viktiga för den valda krypteringsalgoritmen.
- options
- EncryptOptions
Ytterligare alternativ.
Returer
Promise<EncryptResult>
		encrypt(string, Uint8Array, EncryptOptions)
	 
	Varning
Det här API:et är nu inaktuellt.
Use encrypt({ algorithm, plaintext }, options) instead.
Krypterar den angivna klartexten med den angivna kryptografialgoritmen
Exempel på användning:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new KeyClient(url, credential);
const myKey = await client.createKey("MyKey", "RSA");
const cryptographyClient = new CryptographyClient(myKey.id, credential);
const encryptResult = await cryptographyClient.encrypt({
  algorithm: "RSA1_5",
  plaintext: Buffer.from("My Message"),
});
console.log("encrypt result: ", encryptResult.result);
function encrypt(algorithm: string, plaintext: Uint8Array, options?: EncryptOptions): Promise<EncryptResult>Parametrar
- algorithm
- 
				string 
Algoritmen som ska användas.
- plaintext
- 
				Uint8Array 
Texten som ska krypteras.
- options
- EncryptOptions
Ytterligare alternativ.
Returer
Promise<EncryptResult>
		sign(string, Uint8Array, SignOptions)
	 
	Kryptografiskt signera sammanfattningen av ett meddelande
Exempel på användning:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
import { createHash } from "node:crypto";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new KeyClient(url, credential);
let myKey = await client.createKey("MyKey", "RSA");
const cryptographyClient = new CryptographyClient(myKey, credential);
const signatureValue = "MySignature";
const hash = createHash("sha256");
const digest = hash.update(signatureValue).digest();
console.log("digest: ", digest);
const signResult = await cryptographyClient.sign("RS256", digest);
console.log("sign result: ", signResult.result);
function sign(algorithm: string, digest: Uint8Array, options?: SignOptions): Promise<SignResult>Parametrar
- algorithm
- 
				string 
Signeringsalgoritmen som ska användas.
- digest
- 
				Uint8Array 
Sammanfattningen av de data som ska signeras.
- options
- SignOptions
Ytterligare alternativ.
Returer
Promise<SignResult>
		signData(string, Uint8Array, SignOptions)
	  
	Kryptografiskt signera ett datablock
Exempel på användning:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new KeyClient(url, credential);
const myKey = await client.createKey("MyKey", "RSA");
const cryptographyClient = new CryptographyClient(myKey, credential);
const signResult = await cryptographyClient.signData("RS256", Buffer.from("My Message"));
console.log("sign result: ", signResult.result);
function signData(algorithm: string, data: Uint8Array, options?: SignOptions): Promise<SignResult>Parametrar
- algorithm
- 
				string 
Signeringsalgoritmen som ska användas.
- data
- 
				Uint8Array 
De data som ska signeras.
- options
- SignOptions
Ytterligare alternativ.
Returer
Promise<SignResult>
		unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)
	     
	Hämtar den angivna omslutna nyckeln med den angivna kryptografialgoritmen
Exempel på användning:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new KeyClient(url, credential);
const myKey = await client.createKey("MyKey", "RSA");
const cryptographyClient = new CryptographyClient(myKey, credential);
const wrapResult = await cryptographyClient.wrapKey("RSA-OAEP", Buffer.from("My Key"));
console.log("wrap result:", wrapResult.result);
const unwrapResult = await cryptographyClient.unwrapKey("RSA-OAEP", wrapResult.result);
console.log("unwrap result: ", unwrapResult.result);
function unwrapKey(algorithm: KeyWrapAlgorithm, encryptedKey: Uint8Array, options?: UnwrapKeyOptions): Promise<UnwrapResult>Parametrar
- algorithm
- KeyWrapAlgorithm
Dekrypteringsalgoritmen som ska användas för att packa upp nyckeln.
- encryptedKey
- 
				Uint8Array 
Den krypterade nyckeln som ska packas upp.
- options
- UnwrapKeyOptions
Ytterligare alternativ.
Returer
Promise<UnwrapResult>
		verify(string, Uint8Array, Uint8Array, VerifyOptions)
	 
	Verifiera det signerade meddelandesammandraget
Exempel på användning:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
import { createHash } from "node:crypto";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new KeyClient(url, credential);
const myKey = await client.createKey("MyKey", "RSA");
const cryptographyClient = new CryptographyClient(myKey, credential);
const hash = createHash("sha256");
hash.update("My Message");
const digest = hash.digest();
const signResult = await cryptographyClient.sign("RS256", digest);
console.log("sign result: ", signResult.result);
const verifyResult = await cryptographyClient.verify("RS256", digest, signResult.result);
console.log("verify result: ", verifyResult.result);
function verify(algorithm: string, digest: Uint8Array, signature: Uint8Array, options?: VerifyOptions): Promise<VerifyResult>Parametrar
- algorithm
- 
				string 
Signeringsalgoritmen som ska användas för att verifiera med.
- digest
- 
				Uint8Array 
Sammanfattningen som ska verifieras.
- signature
- 
				Uint8Array 
Signaturen för att verifiera sammandraget mot.
- options
- VerifyOptions
Ytterligare alternativ.
Returer
Promise<VerifyResult>
		verifyData(string, Uint8Array, Uint8Array, VerifyOptions)
	  
	Verifiera det signerade datablocket
Exempel på användning:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new KeyClient(url, credential);
const myKey = await client.createKey("MyKey", "RSA");
const cryptographyClient = new CryptographyClient(myKey, credential);
const buffer = Buffer.from("My Message");
const signResult = await cryptographyClient.signData("RS256", buffer);
console.log("sign result: ", signResult.result);
const verifyResult = await cryptographyClient.verifyData("RS256", buffer, signResult.result);
console.log("verify result: ", verifyResult.result);
function verifyData(algorithm: string, data: Uint8Array, signature: Uint8Array, options?: VerifyOptions): Promise<VerifyResult>Parametrar
- algorithm
- 
				string 
Algoritmen som ska användas för att verifiera med.
- data
- 
				Uint8Array 
Det signerade datablocket som ska verifieras.
- signature
- 
				Uint8Array 
Signaturen som blocket ska verifieras mot.
- options
- VerifyOptions
Ytterligare alternativ.
Returer
Promise<VerifyResult>
		wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)
	     
	Omsluter den angivna nyckeln med den angivna kryptografialgoritmen
Exempel på användning:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
const credential = new DefaultAzureCredential();
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;
const client = new KeyClient(url, credential);
const myKey = await client.createKey("MyKey", "RSA");
const cryptographyClient = new CryptographyClient(myKey, credential);
const wrapResult = await cryptographyClient.wrapKey("RSA-OAEP", Buffer.from("My Key"));
console.log("wrap result:", wrapResult.result);
function wrapKey(algorithm: KeyWrapAlgorithm, key: Uint8Array, options?: WrapKeyOptions): Promise<WrapResult>Parametrar
- algorithm
- KeyWrapAlgorithm
Krypteringsalgoritmen som ska användas för att omsluta den angivna nyckeln.
- key
- 
				Uint8Array 
Nyckeln som ska omslutas.
- options
- WrapKeyOptions
Ytterligare alternativ.
Returer
Promise<WrapResult>