Share via

CryptographyClient class

  • Referentie
Pakket:
@azure/keyvault-keys

Een client die wordt gebruikt om cryptografische bewerkingen uit te voeren op een Azure Key Vault-sleutel of een lokale JsonWebKey.

Constructors

CryptographyClient(JsonWebKey_2)

Hiermee maakt u een nieuw exemplaar van de cryptografieclient voor de opgegeven sleutel in de lokale modus.

Gebruiksvoorbeeld:

import { CryptographyClient } from "@azure/keyvault-keys";

const jsonWebKey: JsonWebKey = {
  // ...
};
const client = new CryptographyClient(jsonWebKey);
CryptographyClient(string | KeyVaultKey, TokenCredential, CryptographyClientOptions)

Hiermee wordt een nieuw exemplaar van de cryptografieclient voor de opgegeven sleutel gemaakt

Gebruiksvoorbeeld:

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);

Eigenschappen

keyID

De id van de sleutel die wordt gebruikt voor het uitvoeren van cryptografische bewerkingen voor de client.
vaultUrl

De basis-URL naar de kluis. Als een lokale JsonWebKey wordt gebruikt, is vaultUrl leeg.

Methoden

decrypt(DecryptParameters, DecryptOptions)

Ontsleutelt de opgegeven coderingstekst met de opgegeven ontsleutelingsparameters. Afhankelijk van het algoritme dat wordt gebruikt in de ontsleutelingsparameters, wordt de set mogelijke ontsleutelingsparameters gewijzigd.

Microsoft raadt u aan CBC niet te gebruiken zonder eerst de integriteit van de coderingstekst te garanderen met behulp van bijvoorbeeld een HMAC. Zie https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode voor meer informatie.

Gebruiksvoorbeeld:

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)

Ontsleutelt de opgegeven coderingstekst met het opgegeven cryptografie-algoritme

Gebruiksvoorbeeld:

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

Microsoft raadt u aan CBC niet te gebruiken zonder eerst de integriteit van de coderingstekst te garanderen met behulp van bijvoorbeeld een HMAC. Zie https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode voor meer informatie.
encrypt(EncryptParameters, EncryptOptions)

Versleutelt de opgegeven tekst zonder opmaak met de opgegeven versleutelingsparameters. Afhankelijk van het algoritme dat is ingesteld in de versleutelingsparameters, wordt de set mogelijke versleutelingsparameters gewijzigd.

Gebruiksvoorbeeld:

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)

Versleutelt de opgegeven tekst zonder opmaak met het opgegeven cryptografie-algoritme

Gebruiksvoorbeeld:

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

De samenvatting van een bericht cryptografisch ondertekenen

Gebruiksvoorbeeld:

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

Een blok met gegevens cryptografisch ondertekenen

Gebruiksvoorbeeld:

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

De opgegeven verpakte sleutel uitpakken met behulp van het opgegeven cryptografie-algoritme

Gebruiksvoorbeeld:

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

De samenvatting van het ondertekende bericht controleren

Gebruiksvoorbeeld:

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

Het ondertekende gegevensblok controleren

Gebruiksvoorbeeld:

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

Verpakt de opgegeven sleutel met behulp van het opgegeven cryptografie-algoritme

Gebruiksvoorbeeld:

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

Constructordetails

CryptographyClient(JsonWebKey_2)

Hiermee maakt u een nieuw exemplaar van de cryptografieclient voor de opgegeven sleutel in de lokale modus.

Gebruiksvoorbeeld:

import { CryptographyClient } from "@azure/keyvault-keys";

const jsonWebKey: JsonWebKey = {
  // ...
};
const client = new CryptographyClient(jsonWebKey);

new CryptographyClient(key: JsonWebKey_2)

Parameters

key
JsonWebKey

De JsonWebKey die moet worden gebruikt tijdens cryptografiebewerkingen.

CryptographyClient(string | KeyVaultKey, TokenCredential, CryptographyClientOptions)

Hiermee wordt een nieuw exemplaar van de cryptografieclient voor de opgegeven sleutel gemaakt

Gebruiksvoorbeeld:

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)

Parameters

key

string | KeyVaultKey

De sleutel die moet worden gebruikt tijdens cryptografietaken. U kunt hier ook de id van de sleutel doorgeven, dat wil zeggen de URL.

credential
TokenCredential

Een object dat de TokenCredential interface implementeert die wordt gebruikt om aanvragen voor de service te verifiëren. Gebruik het @azure/identity pakket om een referentie te maken die aan uw behoeften voldoet.

pipelineOptions
CryptographyClientOptions

Pijplijnopties die worden gebruikt voor het configureren van Key Vault API-aanvragen. Laat deze parameter weg om de standaardpijplijnconfiguratie te gebruiken.

Eigenschapdetails

keyID

De id van de sleutel die wordt gebruikt voor het uitvoeren van cryptografische bewerkingen voor de client.

undefined | string keyID

Waarde van eigenschap

undefined | string

vaultUrl

De basis-URL naar de kluis. Als een lokale JsonWebKey wordt gebruikt, is vaultUrl leeg.

string vaultUrl

Waarde van eigenschap

string

Methodedetails

decrypt(DecryptParameters, DecryptOptions)

Ontsleutelt de opgegeven coderingstekst met de opgegeven ontsleutelingsparameters. Afhankelijk van het algoritme dat wordt gebruikt in de ontsleutelingsparameters, wordt de set mogelijke ontsleutelingsparameters gewijzigd.

Microsoft raadt u aan CBC niet te gebruiken zonder eerst de integriteit van de coderingstekst te garanderen met behulp van bijvoorbeeld een HMAC. Zie https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode voor meer informatie.

Gebruiksvoorbeeld:

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>

Parameters

decryptParameters
DecryptParameters

De ontsleutelingsparameters.

options
DecryptOptions

Aanvullende opties.

Retouren

Promise<DecryptResult>

decrypt(string, Uint8Array, DecryptOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use decrypt({ algorithm, ciphertext }, options) instead.

Ontsleutelt de opgegeven coderingstekst met het opgegeven cryptografie-algoritme

Gebruiksvoorbeeld:

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

Microsoft raadt u aan CBC niet te gebruiken zonder eerst de integriteit van de coderingstekst te garanderen met behulp van bijvoorbeeld een HMAC. Zie https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode voor meer informatie.

function decrypt(algorithm: string, ciphertext: Uint8Array, options?: DecryptOptions): Promise<DecryptResult>

Parameters

algorithm

string

Het algoritme dat moet worden gebruikt.

ciphertext

Uint8Array

De tekst die moet worden ontsleuteld.

options
DecryptOptions

Aanvullende opties.

Retouren

Promise<DecryptResult>

encrypt(EncryptParameters, EncryptOptions)

Versleutelt de opgegeven tekst zonder opmaak met de opgegeven versleutelingsparameters. Afhankelijk van het algoritme dat is ingesteld in de versleutelingsparameters, wordt de set mogelijke versleutelingsparameters gewijzigd.

Gebruiksvoorbeeld:

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>

Parameters

encryptParameters
EncryptParameters

De versleutelingsparameters, die zijn gebaseerd op het gekozen versleutelingsalgoritmen.

options
EncryptOptions

Aanvullende opties.

Retouren

Promise<EncryptResult>

encrypt(string, Uint8Array, EncryptOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use encrypt({ algorithm, plaintext }, options) instead.

Versleutelt de opgegeven tekst zonder opmaak met het opgegeven cryptografie-algoritme

Gebruiksvoorbeeld:

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>

Parameters

algorithm

string

Het te gebruiken algoritme.

plaintext

Uint8Array

De tekst die moet worden versleuteld.

options
EncryptOptions

Aanvullende opties.

Retouren

Promise<EncryptResult>

sign(string, Uint8Array, SignOptions)

De samenvatting van een bericht cryptografisch ondertekenen

Gebruiksvoorbeeld:

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

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

Parameters

algorithm

string

Het ondertekeningsalgoritme dat moet worden gebruikt.

digest

Uint8Array

De samenvatting van de gegevens die moeten worden ondertekend.

options
SignOptions

Aanvullende opties.

Retouren

Promise<SignResult>

signData(string, Uint8Array, SignOptions)

Een blok met gegevens cryptografisch ondertekenen

Gebruiksvoorbeeld:

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

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

Parameters

algorithm

string

Het ondertekeningsalgoritme dat moet worden gebruikt.

data

Uint8Array

De gegevens die moeten worden ondertekend.

options
SignOptions

Aanvullende opties.

Retouren

Promise<SignResult>

unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)

De opgegeven verpakte sleutel uitpakken met behulp van het opgegeven cryptografie-algoritme

Gebruiksvoorbeeld:

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

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

Parameters

algorithm
KeyWrapAlgorithm

Het ontsleutelingsalgoritmen dat moet worden gebruikt om de sleutel uit te pakken.

encryptedKey

Uint8Array

De versleutelde sleutel om uit te pakken.

options
UnwrapKeyOptions

Aanvullende opties.

Retouren

Promise<UnwrapResult>

verify(string, Uint8Array, Uint8Array, VerifyOptions)

De samenvatting van het ondertekende bericht controleren

Gebruiksvoorbeeld:

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>

Parameters

algorithm

string

Het ondertekeningsalgoritme waarmee moet worden geverifieerd.

digest

Uint8Array

De samenvatting die moet worden gecontroleerd.

signature

Uint8Array

De handtekening om de samenvatting tegen te verifiëren.

options
VerifyOptions

Aanvullende opties.

Retouren

Promise<VerifyResult>

verifyData(string, Uint8Array, Uint8Array, VerifyOptions)

Het ondertekende gegevensblok controleren

Gebruiksvoorbeeld:

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>

Parameters

algorithm

string

Het algoritme waarmee moet worden geverifieerd.

data

Uint8Array

Het ondertekende blok met gegevens om te verifiëren.

signature

Uint8Array

De handtekening om het blok tegen te verifiëren.

options
VerifyOptions

Aanvullende opties.

Retouren

Promise<VerifyResult>

wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)

Verpakt de opgegeven sleutel met behulp van het opgegeven cryptografie-algoritme

Gebruiksvoorbeeld:

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

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

Parameters

algorithm
KeyWrapAlgorithm

Het versleutelingsalgoritmen dat moet worden gebruikt om de opgegeven sleutel te verpakken.

key

Uint8Array

De sleutel om in te pakken.

options
WrapKeyOptions

Aanvullende opties.

Retouren

Promise<WrapResult>