CryptographyClient class
Klient používaný k provádění kryptografických operací s klíčem služby Azure Key Vault nebo místním JsonWebKey.
Konstruktory
| Cryptography |
Vytvoří novou instanci klienta kryptografie pro daný klíč v místním režimu. Příklad použití:
|
| Cryptography |
Vytvoří novou instanci klienta kryptografie pro daný klíč. Příklad použití:
|
Vlastnosti
| keyID | ID klíče použitého k provádění kryptografických operací pro klienta. |
| vault |
Základní adresa URL trezoru. Pokud místní JsonWebKey použije trezorUrl, bude prázdný. |
Metody
| decrypt(Decrypt |
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://learn.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode. Příklad použití:
|
| decrypt(string, Uint8Array, Decrypt |
Dešifruje zadaný šifrovací text pomocí zadaného kryptografického algoritmu. Příklad použití:
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://learn.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode. |
| encrypt(Encrypt |
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í:
|
| encrypt(string, Uint8Array, Encrypt |
Zašifruje daný prostý text pomocí zadaného kryptografického algoritmu. Příklad použití:
|
| sign(string, Uint8Array, Sign |
Kryptograficky podepisujte přehled zprávy. Příklad použití:
|
| sign |
Kryptograficky podepsat blok dat Příklad použití:
|
| unwrap |
Rozbalí zadaný zabalený klíč pomocí zadaného kryptografického algoritmu. Příklad použití:
|
| verify(string, Uint8Array, Uint8Array, Verify |
Ověření přehledu podepsané zprávy Příklad použití:
|
| verify |
Ověření podepsaného bloku dat Příklad použití:
|
| wrap |
Zabalí daný klíč pomocí zadaného kryptografického algoritmu. Příklad použití:
|
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 = {
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)
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 { 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)
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://learn.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode.
Příklad použití:
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>
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í:
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 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://learn.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode.
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í:
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>
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í:
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>
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í:
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>
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í:
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>
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í:
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>
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í:
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>
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í:
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>
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í:
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>
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>