CryptographyClient class

Paket:

@azure/keyvault-keys

En klient som används för att utföra kryptografiska åtgärder på en Azure Key Vault-nyckel eller en lokal JsonWebKey-.

Konstruktorer

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: JsonWebKey = { // ... }; const client = new CryptographyClient(jsonWebKey);

CryptographyClient(string | KeyVaultKey, TokenCredential, CryptographyClientOptions)

Konstruerar en ny instans av kryptografiklienten för den angivna nyckeln Exempel på användning: 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);

Egenskaper

keyID	ID:t för nyckeln som används för att utföra kryptografiska åtgärder för klienten.
vaultUrl	Bas-URL:en till valvet. Om en lokal JsonWebKey används är vaultUrl tomt.

Metoder

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://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode. Exempel på användning: let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.decrypt({ algorithm: "RSA1_5", ciphertext: encryptedBuffer }); let result = await client.decrypt({ algorithm: "A256GCM", iv: ivFromEncryptResult, authenticationTag: tagFromEncryptResult });
decrypt(string, Uint8Array, DecryptOptions)	Dekrypterar den angivna chiffertexten med den angivna kryptografialgoritmen Exempel på användning: let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.decrypt("RSA1_5", encryptedBuffer); 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://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode.
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: let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.encrypt({ algorithm: "RSA1_5", plaintext: Buffer.from("My Message")}); let result = await client.encrypt({ algorithm: "A256GCM", plaintext: Buffer.from("My Message"), additionalAuthenticatedData: Buffer.from("My authenticated data")});
encrypt(string, Uint8Array, EncryptOptions)	Krypterar den angivna klartexten med den angivna kryptografialgoritmen Exempel på användning: let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.encrypt("RSA1_5", Buffer.from("My Message"));
sign(string, Uint8Array, SignOptions)	Kryptografiskt signera sammanfattningen av ett meddelande Exempel på användning: let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.sign("RS256", digest);
signData(string, Uint8Array, SignOptions)	Kryptografiskt signera ett datablock Exempel på användning: let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.signData("RS256", message);
unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)	Hämtar den angivna omslutna nyckeln med den angivna kryptografialgoritmen Exempel på användning: let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.unwrapKey("RSA1_5", keyToUnwrap);
verify(string, Uint8Array, Uint8Array, VerifyOptions)	Verifiera det signerade meddelandesammandraget Exempel på användning: let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.verify("RS256", signedDigest, signature);
verifyData(string, Uint8Array, Uint8Array, VerifyOptions)	Verifiera det signerade datablocket Exempel på användning: let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.verifyData("RS256", signedMessage, signature);
wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)	Omsluter den angivna nyckeln med den angivna kryptografialgoritmen Exempel på användning: let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.wrapKey("RSA1_5", keyToWrap);

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: JsonWebKey = {
  // ...
};
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 { 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);

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 keyID

Egenskapsvärde

undefined | string

vaultUrl

Bas-URL:en till valvet. Om en lokal JsonWebKey används är vaultUrl tomt.

string vaultUrl

Egenskapsvä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://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode.

Exempel på användning:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.decrypt({ algorithm: "RSA1_5", ciphertext: encryptedBuffer });
let result = await client.decrypt({ algorithm: "A256GCM", iv: ivFromEncryptResult, authenticationTag: tagFromEncryptResult });

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:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.decrypt("RSA1_5", encryptedBuffer);

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://docs.microsoft.com/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:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.encrypt({ algorithm: "RSA1_5", plaintext: Buffer.from("My Message")});
let result = await client.encrypt({ algorithm: "A256GCM", plaintext: Buffer.from("My Message"), additionalAuthenticatedData: Buffer.from("My authenticated data")});

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:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.encrypt("RSA1_5", Buffer.from("My Message"));

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:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.sign("RS256", digest);

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:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.signData("RS256", message);

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:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.unwrapKey("RSA1_5", keyToUnwrap);

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:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.verify("RS256", signedDigest, signature);

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:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.verifyData("RS256", signedMessage, signature);

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:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.wrapKey("RSA1_5", keyToWrap);

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>