CryptographyClient class
Azure Key Vault anahtarında veya yerel bir JsonWebKey'de şifreleme işlemleri gerçekleştirmek için kullanılan bir istemci.
Oluşturucular
Cryptography |
Yerel modda verilen anahtar için Şifreleme istemcisinin yeni bir örneğini oluşturur. Örnek kullanım:
|
Cryptography |
Verilen anahtar için Şifreleme istemcisinin yeni bir örneğini oluşturur Örnek kullanım:
|
Özellikler
keyID | İstemci için şifreleme işlemleri gerçekleştirmek için kullanılan anahtarın kimliği. |
vault |
Kasanın temel URL'si. Yerel bir JsonWebKey kullanılırsa vaultUrl boş olur. |
Yöntemler
decrypt(Decrypt |
Belirtilen şifre çözme parametreleriyle verilen şifreleme metninin şifresini çözer. Şifre çözme parametrelerinde kullanılan algoritmaya bağlı olarak, olası şifre çözme parametreleri kümesi değişir. Microsoft, önce bir HMAC kullanarak şifre metninin bütünlüğünü sağlamadan CBC kullanmamanızı önerir. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode. Örnek kullanım:
|
decrypt(string, Uint8Array, Decrypt |
Belirtilen şifreleme metninin şifresini belirtilen şifreleme algoritmasıyla çözer Örnek kullanım:
Microsoft, önce bir HMAC kullanarak şifre metninin bütünlüğünü sağlamadan CBC kullanmamanızı önerir. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode. |
encrypt(Encrypt |
Belirtilen düz metni belirtilen şifreleme parametreleriyle şifreler. Şifreleme parametrelerinde ayarlanan algoritmaya bağlı olarak, olası şifreleme parametreleri kümesi değişir. Örnek kullanım:
|
encrypt(string, Uint8Array, Encrypt |
Belirtilen düz metni belirtilen şifreleme algoritmasıyla şifreler Örnek kullanım:
|
sign(string, Uint8Array, Sign |
İletinin özetini şifreli olarak imzalama Örnek kullanım:
|
sign |
Veri bloğunu kriptografik olarak imzalama Örnek kullanım:
|
unwrap |
Belirtilen şifreleme algoritmasını kullanarak verilen sarmalanmış anahtarın işaretini kaldırın Örnek kullanım:
|
verify(string, Uint8Array, Uint8Array, Verify |
İmzalı ileti özetini doğrulama Örnek kullanım:
|
verify |
İmzalı veri bloğunu doğrulama Örnek kullanım:
|
wrap |
Belirtilen şifreleme algoritmasını kullanarak verilen anahtarı sarmalar Örnek kullanım:
|
Oluşturucu Ayrıntıları
CryptographyClient(JsonWebKey_2)
Yerel modda verilen anahtar için Şifreleme istemcisinin yeni bir örneğini oluşturur.
Örnek kullanım:
import { CryptographyClient } from "@azure/keyvault-keys";
const jsonWebKey: JsonWebKey = {
// ...
};
const client = new CryptographyClient(jsonWebKey);
new CryptographyClient(key: JsonWebKey_2)
Parametreler
- key
- JsonWebKey
Şifreleme işlemleri sırasında kullanılacak JsonWebKey.
CryptographyClient(string | KeyVaultKey, TokenCredential, CryptographyClientOptions)
Verilen anahtar için Şifreleme istemcisinin yeni bir örneğini oluşturur
Örnek kullanım:
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)
Parametreler
- key
-
string | KeyVaultKey
Şifreleme görevleri sırasında kullanılacak anahtar. Anahtarın tanımlayıcısını , yani URL'sini buraya da geçirebilirsiniz.
- credential
- TokenCredential
Hizmete yönelik isteklerin TokenCredential
kimliğini doğrulamak için kullanılan arabirimi uygulayan nesne.
@azure/identity Gereksinimlerinize uygun bir kimlik bilgisi oluşturmak için paketini kullanın.
- pipelineOptions
- CryptographyClientOptions
Key Vault API isteklerini yapılandırmak için kullanılan işlem hattı seçenekleri. Varsayılan işlem hattı yapılandırmasını kullanmak için bu parametreyi atlayın.
Özellik Ayrıntıları
keyID
İstemci için şifreleme işlemleri gerçekleştirmek için kullanılan anahtarın kimliği.
undefined | string keyID
Özellik Değeri
undefined | string
vaultUrl
Kasanın temel URL'si. Yerel bir JsonWebKey kullanılırsa vaultUrl boş olur.
string vaultUrl
Özellik Değeri
string
Yöntem Ayrıntıları
decrypt(DecryptParameters, DecryptOptions)
Belirtilen şifre çözme parametreleriyle verilen şifreleme metninin şifresini çözer. Şifre çözme parametrelerinde kullanılan algoritmaya bağlı olarak, olası şifre çözme parametreleri kümesi değişir.
Microsoft, önce bir HMAC kullanarak şifre metninin bütünlüğünü sağlamadan CBC kullanmamanızı önerir. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode.
Örnek kullanım:
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>
Parametreler
- decryptParameters
- DecryptParameters
Şifre çözme parametreleri.
- options
- DecryptOptions
Ek seçenekler.
Döndürülenler
Promise<DecryptResult>
decrypt(string, Uint8Array, DecryptOptions)
Uyarı
Bu API artık kullanım dışıdır.
Use decrypt({ algorithm, ciphertext }, options)
instead.
Belirtilen şifreleme metninin şifresini belirtilen şifreleme algoritmasıyla çözer
Örnek kullanım:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.decrypt("RSA1_5", encryptedBuffer);
Microsoft, önce bir HMAC kullanarak şifre metninin bütünlüğünü sağlamadan CBC kullanmamanızı önerir. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode.
function decrypt(algorithm: string, ciphertext: Uint8Array, options?: DecryptOptions): Promise<DecryptResult>
Parametreler
- algorithm
-
string
Kullanılacak algoritma.
- ciphertext
-
Uint8Array
Şifresi çözülecek metin.
- options
- DecryptOptions
Ek seçenekler.
Döndürülenler
Promise<DecryptResult>
encrypt(EncryptParameters, EncryptOptions)
Belirtilen düz metni belirtilen şifreleme parametreleriyle şifreler. Şifreleme parametrelerinde ayarlanan algoritmaya bağlı olarak, olası şifreleme parametreleri kümesi değişir.
Örnek kullanım:
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>
Parametreler
- encryptParameters
- EncryptParameters
Seçilen şifreleme algoritmasında anahtarlanan şifreleme parametreleri.
- options
- EncryptOptions
Ek seçenekler.
Döndürülenler
Promise<EncryptResult>
encrypt(string, Uint8Array, EncryptOptions)
Uyarı
Bu API artık kullanım dışıdır.
Use encrypt({ algorithm, plaintext }, options)
instead.
Belirtilen düz metni belirtilen şifreleme algoritmasıyla şifreler
Örnek kullanım:
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>
Parametreler
- algorithm
-
string
Kullanılacak algoritma.
- plaintext
-
Uint8Array
Şifrelenmesi gereken metin.
- options
- EncryptOptions
Ek seçenekler.
Döndürülenler
Promise<EncryptResult>
sign(string, Uint8Array, SignOptions)
İletinin özetini şifreli olarak imzalama
Örnek kullanım:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.sign("RS256", digest);
function sign(algorithm: string, digest: Uint8Array, options?: SignOptions): Promise<SignResult>
Parametreler
- algorithm
-
string
Kullanılacak imzalama algoritması.
- digest
-
Uint8Array
İmzalana verilerin özeti.
- options
- SignOptions
Ek seçenekler.
Döndürülenler
Promise<SignResult>
signData(string, Uint8Array, SignOptions)
Veri bloğunu kriptografik olarak imzalama
Örnek kullanım:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.signData("RS256", message);
function signData(algorithm: string, data: Uint8Array, options?: SignOptions): Promise<SignResult>
Parametreler
- algorithm
-
string
Kullanılacak imzalama algoritması.
- data
-
Uint8Array
İmza atacak veriler.
- options
- SignOptions
Ek seçenekler.
Döndürülenler
Promise<SignResult>
unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)
Belirtilen şifreleme algoritmasını kullanarak verilen sarmalanmış anahtarın işaretini kaldırın
Örnek kullanım:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.unwrapKey("RSA1_5", keyToUnwrap);
function unwrapKey(algorithm: KeyWrapAlgorithm, encryptedKey: Uint8Array, options?: UnwrapKeyOptions): Promise<UnwrapResult>
Parametreler
- algorithm
- KeyWrapAlgorithm
Anahtarı açmak için kullanılacak şifre çözme algoritması.
- encryptedKey
-
Uint8Array
Çözülmek için şifrelenmiş anahtar.
- options
- UnwrapKeyOptions
Ek seçenekler.
Döndürülenler
Promise<UnwrapResult>
verify(string, Uint8Array, Uint8Array, VerifyOptions)
İmzalı ileti özetini doğrulama
Örnek kullanım:
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>
Parametreler
- algorithm
-
string
Doğrulamak için kullanılacak imzalama algoritması.
- digest
-
Uint8Array
Doğrulanması gereken özet.
- signature
-
Uint8Array
Özetin doğrulanması için imza.
- options
- VerifyOptions
Ek seçenekler.
Döndürülenler
Promise<VerifyResult>
verifyData(string, Uint8Array, Uint8Array, VerifyOptions)
İmzalı veri bloğunu doğrulama
Örnek kullanım:
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>
Parametreler
- algorithm
-
string
ile doğrulamak için kullanılacak algoritma.
- data
-
Uint8Array
Doğrulanması gereken imzalı veri bloğu.
- signature
-
Uint8Array
Bloğun doğrulanması için imza.
- options
- VerifyOptions
Ek seçenekler.
Döndürülenler
Promise<VerifyResult>
wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)
Belirtilen şifreleme algoritmasını kullanarak verilen anahtarı sarmalar
Örnek kullanım:
let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.wrapKey("RSA1_5", keyToWrap);
function wrapKey(algorithm: KeyWrapAlgorithm, key: Uint8Array, options?: WrapKeyOptions): Promise<WrapResult>
Parametreler
- algorithm
- KeyWrapAlgorithm
Verilen anahtarı sarmalamada kullanılacak şifreleme algoritması.
- key
-
Uint8Array
Sarmalama anahtarı.
- options
- WrapKeyOptions
Ek seçenekler.
Döndürülenler
Promise<WrapResult>