CryptographyClient class
Az Azure Key Vault-kulcson vagy egy helyi JsonWebKey-en végzett titkosítási műveletekhez használt ügyfél.
Konstruktorok
Cryptography |
A titkosítási ügyfél új példányát hozza létre a megadott kulcshoz helyi módban. Példahasználat:
|
Cryptography |
A titkosítási ügyfél új példányát hozza létre az adott kulcshoz Példahasználat:
|
Tulajdonságok
keyID | Az ügyfél titkosítási műveleteinek végrehajtásához használt kulcs azonosítója. |
vault |
A tároló alap URL-címe. Helyi JsonWebKey használata esetén a vaultUrl üres lesz. |
Metódusok
decrypt(Decrypt |
A megadott titkosítási paraméterekkel visszafejti a megadott titkosítási szöveget. A visszafejtési paraméterekben használt algoritmustól függően a lehetséges visszafejtési paraméterek halmaza megváltozik. A Microsoft azt javasolja, hogy ne használja a CBC-t anélkül, hogy először biztosítanák a titkosítószöveg integritását, például egy HMAC használatával. További információ: https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode. Példahasználat:
|
decrypt(string, Uint8Array, Decrypt |
A megadott titkosítószöveg visszafejtése a megadott titkosítási algoritmussal Példahasználat:
A Microsoft azt javasolja, hogy ne használja a CBC-t anélkül, hogy először biztosítanák a titkosítószöveg integritását, például egy HMAC használatával. További információ: https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode. |
encrypt(Encrypt |
Titkosítja az adott egyszerű szöveget a megadott titkosítási paraméterekkel. A titkosítási paraméterekben beállított algoritmustól függően a lehetséges titkosítási paraméterek halmaza megváltozik. Példahasználat:
|
encrypt(string, Uint8Array, Encrypt |
Az adott egyszerű szöveg titkosítása a megadott titkosítási algoritmussal Példahasználat:
|
sign(string, Uint8Array, Sign |
Kriptográfiai aláírás egy üzenet kivonatához Példahasználat:
|
sign |
Kriptográfiai aláírás egy adatblokkban Példahasználat:
|
unwrap |
Bontsa ki a megadott burkolt kulcsot a megadott titkosítási algoritmus használatával Példahasználat:
|
verify(string, Uint8Array, Uint8Array, Verify |
Az aláírt üzenet kivonatának ellenőrzése Példahasználat:
|
verify |
Az aláírt adatblokk ellenőrzése Példahasználat:
|
wrap |
A megadott kulcs körbefuttatása a megadott titkosítási algoritmussal Példahasználat:
|
Konstruktor adatai
CryptographyClient(JsonWebKey_2)
A titkosítási ügyfél új példányát hozza létre a megadott kulcshoz helyi módban.
Példahasználat:
import { CryptographyClient } from "@azure/keyvault-keys";
const jsonWebKey: JsonWebKey = {
// ...
};
const client = new CryptographyClient(jsonWebKey);
new CryptographyClient(key: JsonWebKey_2)
Paraméterek
- key
- JsonWebKey
A titkosítási műveletek során használni kívánt JsonWebKey.
CryptographyClient(string | KeyVaultKey, TokenCredential, CryptographyClientOptions)
A titkosítási ügyfél új példányát hozza létre az adott kulcshoz
Példahasználat:
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)
Paraméterek
- key
-
string | KeyVaultKey
A titkosítási feladatokhoz használandó kulcs. Itt is átadhatja a kulcs azonosítóját, azaz annak URL-címét.
- credential
- TokenCredential
Egy objektum, amely a TokenCredential
szolgáltatás kéréseinek hitelesítéséhez használt felületet implementálja. @azure/identity A csomag használatával hozzon létre egy, az igényeinek megfelelő hitelesítő adatot.
- pipelineOptions
- CryptographyClientOptions
A Key Vault API-kérések konfigurálásához használt folyamatbeállítások. Ezt a paramétert kihagyva használja az alapértelmezett folyamatkonfigurációt.
Tulajdonság adatai
keyID
Az ügyfél titkosítási műveleteinek végrehajtásához használt kulcs azonosítója.
undefined | string keyID
Tulajdonság értéke
undefined | string
vaultUrl
A tároló alap URL-címe. Helyi JsonWebKey használata esetén a vaultUrl üres lesz.
string vaultUrl
Tulajdonság értéke
string
Metódus adatai
decrypt(DecryptParameters, DecryptOptions)
A megadott titkosítási paraméterekkel visszafejti a megadott titkosítási szöveget. A visszafejtési paraméterekben használt algoritmustól függően a lehetséges visszafejtési paraméterek halmaza megváltozik.
A Microsoft azt javasolja, hogy ne használja a CBC-t anélkül, hogy először biztosítanák a titkosítószöveg integritását, például egy HMAC használatával. További információ: https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode.
Példahasználat:
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>
Paraméterek
- decryptParameters
- DecryptParameters
A visszafejtési paraméterek.
- options
- DecryptOptions
További lehetőségek.
Válaszok
Promise<DecryptResult>
decrypt(string, Uint8Array, DecryptOptions)
Figyelmeztetés
Ez az API már elavult.
Use decrypt({ algorithm, ciphertext }, options)
instead.
A megadott titkosítószöveg visszafejtése a megadott titkosítási algoritmussal
Példahasználat:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.decrypt("RSA1_5", encryptedBuffer);
A Microsoft azt javasolja, hogy ne használja a CBC-t anélkül, hogy először biztosítanák a titkosítószöveg integritását, például egy HMAC használatával. További információ: https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode.
function decrypt(algorithm: string, ciphertext: Uint8Array, options?: DecryptOptions): Promise<DecryptResult>
Paraméterek
- algorithm
-
string
A használni kívánt algoritmus.
- ciphertext
-
Uint8Array
A visszafejtendő szöveg.
- options
- DecryptOptions
További lehetőségek.
Válaszok
Promise<DecryptResult>
encrypt(EncryptParameters, EncryptOptions)
Titkosítja az adott egyszerű szöveget a megadott titkosítási paraméterekkel. A titkosítási paraméterekben beállított algoritmustól függően a lehetséges titkosítási paraméterek halmaza megváltozik.
Példahasználat:
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>
Paraméterek
- encryptParameters
- EncryptParameters
A választott titkosítási algoritmuson kulcsolt titkosítási paraméterek.
- options
- EncryptOptions
További lehetőségek.
Válaszok
Promise<EncryptResult>
encrypt(string, Uint8Array, EncryptOptions)
Figyelmeztetés
Ez az API már elavult.
Use encrypt({ algorithm, plaintext }, options)
instead.
Az adott egyszerű szöveg titkosítása a megadott titkosítási algoritmussal
Példahasználat:
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>
Paraméterek
- algorithm
-
string
A használni kívánt algoritmus.
- plaintext
-
Uint8Array
A titkosítandó szöveg.
- options
- EncryptOptions
További lehetőségek.
Válaszok
Promise<EncryptResult>
sign(string, Uint8Array, SignOptions)
Kriptográfiai aláírás egy üzenet kivonatához
Példahasználat:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.sign("RS256", digest);
function sign(algorithm: string, digest: Uint8Array, options?: SignOptions): Promise<SignResult>
Paraméterek
- algorithm
-
string
A használni kívánt aláíró algoritmus.
- digest
-
Uint8Array
Az aláírandó adatok kivonata.
- options
- SignOptions
További lehetőségek.
Válaszok
Promise<SignResult>
signData(string, Uint8Array, SignOptions)
Kriptográfiai aláírás egy adatblokkban
Példahasználat:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.signData("RS256", message);
function signData(algorithm: string, data: Uint8Array, options?: SignOptions): Promise<SignResult>
Paraméterek
- algorithm
-
string
A használni kívánt aláíró algoritmus.
- data
-
Uint8Array
Az aláírandó adatok.
- options
- SignOptions
További lehetőségek.
Válaszok
Promise<SignResult>
unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)
Bontsa ki a megadott burkolt kulcsot a megadott titkosítási algoritmus használatával
Példahasználat:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.unwrapKey("RSA1_5", keyToUnwrap);
function unwrapKey(algorithm: KeyWrapAlgorithm, encryptedKey: Uint8Array, options?: UnwrapKeyOptions): Promise<UnwrapResult>
Paraméterek
- algorithm
- KeyWrapAlgorithm
A kulcs kicsomagolásához használható visszafejtési algoritmus.
- encryptedKey
-
Uint8Array
A kibontandó titkosított kulcs.
- options
- UnwrapKeyOptions
További lehetőségek.
Válaszok
Promise<UnwrapResult>
verify(string, Uint8Array, Uint8Array, VerifyOptions)
Az aláírt üzenet kivonatának ellenőrzése
Példahasználat:
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>
Paraméterek
- algorithm
-
string
Az aláírási algoritmus, amellyel ellenőrizhető.
- digest
-
Uint8Array
Az ellenőrizni kívánt kivonat.
- signature
-
Uint8Array
A kivonat ellenőrzéséhez használt aláírás.
- options
- VerifyOptions
További lehetőségek.
Válaszok
Promise<VerifyResult>
verifyData(string, Uint8Array, Uint8Array, VerifyOptions)
Az aláírt adatblokk ellenőrzése
Példahasználat:
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>
Paraméterek
- algorithm
-
string
A hitelesítéshez használni kívánt algoritmus.
- data
-
Uint8Array
Az ellenőrizendő aláírt adatblokk.
- signature
-
Uint8Array
A blokk ellenőrzéséhez használt aláírás.
- options
- VerifyOptions
További lehetőségek.
Válaszok
Promise<VerifyResult>
wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)
A megadott kulcs körbefuttatása a megadott titkosítási algoritmussal
Példahasználat:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.wrapKey("RSA1_5", keyToWrap);
function wrapKey(algorithm: KeyWrapAlgorithm, key: Uint8Array, options?: WrapKeyOptions): Promise<WrapResult>
Paraméterek
- algorithm
- KeyWrapAlgorithm
A megadott kulcs körbefuttatásához használható titkosítási algoritmus.
- key
-
Uint8Array
A becsomagolandó kulcs.
- options
- WrapKeyOptions
További lehetőségek.
Válaszok
Promise<WrapResult>