CryptographyClient class

Reference

Balíček:: @azure/keyvault-keys

Klient používaný k provádění kryptografických operací s klíčem služby Azure Key Vault nebo místním JsonWebKey.

Konstruktory

Vytvoří novou instanci klienta kryptografie pro daný klíč v místním režimu.

Příklad použití:

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

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

CryptographyClient(string | KeyVaultKey, TokenCredential, CryptographyClientOptions)

Vytvoří novou instanci klienta kryptografie pro daný klíč.

Příklad použití:

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

Vlastnosti

keyID	ID klíče použitého k provádění kryptografických operací pro klienta.
vaultUrl	Základní adresa URL trezoru. Pokud místní JsonWebKey použije trezorUrl, bude prázdný.

Metody

decrypt(DecryptParameters, DecryptOptions)	Dešifruje daný šifrový text zadanými parametry dešifrování. V závislosti na algoritmu použitém v parametrech dešifrování se změní sada možných parametrů dešifrování. Microsoft doporučuje, abyste CBC nepoužíli, aniž byste nejdřív zajistili integritu šifrovacího textu, například HMAC. Další informace najdete v tématu https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode. Příklad použití: `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)	Dešifruje zadaný šifrovací text pomocí zadaného kryptografického algoritmu. Příklad použití: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.decrypt("RSA1_5", encryptedBuffer);` Microsoft doporučuje, abyste CBC nepoužíli, aniž byste nejdřív zajistili integritu šifrovacího textu, například HMAC. Další informace najdete v tématu https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode.
encrypt(EncryptParameters, EncryptOptions)	Zašifruje daný prostý text zadanými parametry šifrování. V závislosti na algoritmu nastaveném v parametrech šifrování se změní sada možných parametrů šifrování. Příklad použití: `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)	Zašifruje daný prostý text pomocí zadaného kryptografického algoritmu. Příklad použití: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.encrypt("RSA1_5", Buffer.from("My Message"));`
sign(string, Uint8Array, SignOptions)	Kryptograficky podepisujte přehled zprávy. Příklad použití: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.sign("RS256", digest);`
signData(string, Uint8Array, SignOptions)	Kryptograficky podepsat blok dat Příklad použití: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.signData("RS256", message);`
unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)	Rozbalí zadaný zabalený klíč pomocí zadaného kryptografického algoritmu. Příklad použití: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.unwrapKey("RSA1_5", keyToUnwrap);`
verify(string, Uint8Array, Uint8Array, VerifyOptions)	Ověření přehledu podepsané zprávy Příklad použití: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.verify("RS256", signedDigest, signature);`
verifyData(string, Uint8Array, Uint8Array, VerifyOptions)	Ověření podepsaného bloku dat Příklad použití: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.verifyData("RS256", signedMessage, signature);`
wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)	Zabalí daný klíč pomocí zadaného kryptografického algoritmu. Příklad použití: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.wrapKey("RSA1_5", keyToWrap);`

Podrobnosti konstruktoru

CryptographyClient(JsonWebKey)

Vytvoří novou instanci klienta kryptografie pro daný klíč v místním režimu.

Příklad použití:

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

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

new CryptographyClient(key: JsonWebKey)

Parametry

key: JsonWebKey

JsonWebKey, který se má použít při kryptografických operacích.

CryptographyClient(string | KeyVaultKey, TokenCredential, CryptographyClientOptions)

Vytvoří novou instanci klienta kryptografie pro daný klíč.

Příklad použití:

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)

Parametry

key: string | KeyVaultKey

Klíč, který se má použít při kryptografických úlohách. Můžete také předat identifikátor klíče, tj. jeho adresu URL zde.

credential: TokenCredential

Objekt, který implementuje rozhraní TokenCredential použité k ověřování požadavků na službu. Pomocí balíčku @azure/identity vytvořte přihlašovací údaje, které vyhovují vašim potřebám.

pipelineOptions: CryptographyClientOptions

Možnosti kanálu používané ke konfiguraci požadavků rozhraní API služby Key Vault Tento parametr vynecháte, pokud chcete použít výchozí konfiguraci kanálu.

Podrobnosti vlastnosti

keyID

ID klíče použitého k provádění kryptografických operací pro klienta.

undefined | string keyID

Hodnota vlastnosti

undefined | string

vaultUrl

Základní adresa URL trezoru. Pokud místní JsonWebKey použije trezorUrl, bude prázdný.

string vaultUrl

Hodnota vlastnosti

string

Podrobnosti metody

decrypt(DecryptParameters, DecryptOptions)

Dešifruje daný šifrový text zadanými parametry dešifrování. V závislosti na algoritmu použitém v parametrech dešifrování se změní sada možných parametrů dešifrování.

Microsoft doporučuje, abyste CBC nepoužíli, aniž byste nejdřív zajistili integritu šifrovacího textu, například HMAC. Další informace najdete v tématu https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode.

Příklad použití:

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>

Parametry

decryptParameters: DecryptParameters

Parametry dešifrování.

options: DecryptOptions

Další možnosti

Návraty

Promise<DecryptResult>

decrypt(string, Uint8Array, DecryptOptions)

Upozornění

Toto rozhraní API je teď zastaralé.

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

Dešifruje zadaný šifrovací text pomocí zadaného kryptografického algoritmu.

Příklad použití:

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

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

Parametry

algorithm: string

Algoritmus, který se má použít.

ciphertext: Uint8Array

Text k dešifrování.

options: DecryptOptions

Další možnosti

Návraty

Promise<DecryptResult>

encrypt(EncryptParameters, EncryptOptions)

Zašifruje daný prostý text zadanými parametry šifrování. V závislosti na algoritmu nastaveném v parametrech šifrování se změní sada možných parametrů šifrování.

Příklad použití:

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>

Parametry

encryptParameters: EncryptParameters

Parametry šifrování, které jsou klíčovány podle zvoleného šifrovacího algoritmu.

options: EncryptOptions

Další možnosti

Návraty

Promise<EncryptResult>

encrypt(string, Uint8Array, EncryptOptions)

Upozornění

Toto rozhraní API je teď zastaralé.

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

Zašifruje daný prostý text pomocí zadaného kryptografického algoritmu.

Příklad použití:

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>

Parametry

algorithm: string

Algoritmus, který se má použít.

plaintext: Uint8Array

Text, který chcete zašifrovat.

options: EncryptOptions

Další možnosti

Návraty

Promise<EncryptResult>

sign(string, Uint8Array, SignOptions)

Kryptograficky podepisujte přehled zprávy.

Příklad použití:

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

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

Parametry

algorithm: string

Podpisový algoritmus, který se má použít.

digest: Uint8Array

Hodnota hash dat, která se mají podepsat.

options: SignOptions

Další možnosti

Návraty

Promise<SignResult>

signData(string, Uint8Array, SignOptions)

Kryptograficky podepsat blok dat

Příklad použití:

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

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

Parametry

algorithm: string

Podpisový algoritmus, který se má použít.

data: Uint8Array

Data, která se mají podepsat.

options: SignOptions

Další možnosti

Návraty

Promise<SignResult>

unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)

Rozbalí zadaný zabalený klíč pomocí zadaného kryptografického algoritmu.

Příklad použití:

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

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

Parametry

algorithm: KeyWrapAlgorithm

Algoritmus dešifrování, který se má použít k rozbalení klíče.

encryptedKey: Uint8Array

Šifrovaný klíč k rozbalení.

options: UnwrapKeyOptions

Další možnosti

Návraty

Promise<UnwrapResult>

verify(string, Uint8Array, Uint8Array, VerifyOptions)

Ověření přehledu podepsané zprávy

Příklad použití:

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>

Parametry

algorithm: string

Podpisový algoritmus, který se má použít k ověření.

digest: Uint8Array

Hodnota hash, která se má ověřit.

signature: Uint8Array

Podpis pro ověření digestu.

options: VerifyOptions

Další možnosti

Návraty

Promise<VerifyResult>

verifyData(string, Uint8Array, Uint8Array, VerifyOptions)

Ověření podepsaného bloku dat

Příklad použití:

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>

Parametry

algorithm: string

Algoritmus, který se má použít k ověření.

data: Uint8Array

Podepsaný blok dat, který chcete ověřit.

signature: Uint8Array

Podpis k ověření bloku.

options: VerifyOptions

Další možnosti

Návraty

Promise<VerifyResult>

wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)

Zabalí daný klíč pomocí zadaného kryptografického algoritmu.

Příklad použití:

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

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

Parametry

algorithm: KeyWrapAlgorithm

Šifrovací algoritmus, který se má použít k zabalení daného klíče.

key: Uint8Array

Klíč, který se má zabalit.

options: WrapKeyOptions

Další možnosti

Návraty

Promise<WrapResult>

Sdílet prostřednictvím

CryptographyClient class

Konstruktory

Vlastnosti

Metody

Podrobnosti konstruktoru

CryptographyClient(JsonWebKey)

Parametry

CryptographyClient(string | KeyVaultKey, TokenCredential, CryptographyClientOptions)

Parametry

Podrobnosti vlastnosti

keyID

Hodnota vlastnosti

vaultUrl

Hodnota vlastnosti

Podrobnosti metody

decrypt(DecryptParameters, DecryptOptions)

Parametry

Návraty

decrypt(string, Uint8Array, DecryptOptions)

Parametry

Návraty

encrypt(EncryptParameters, EncryptOptions)

Parametry

Návraty

encrypt(string, Uint8Array, EncryptOptions)

Parametry

Návraty

sign(string, Uint8Array, SignOptions)

Parametry

Návraty

signData(string, Uint8Array, SignOptions)

Parametry

Návraty

unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)

Parametry

Návraty

verify(string, Uint8Array, Uint8Array, VerifyOptions)

Parametry

Návraty

verifyData(string, Uint8Array, Uint8Array, VerifyOptions)

Parametry

Návraty

wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)

Parametry

Návraty

Další materiály