CryptographyClient Sınıf

Azure Key Vault anahtarlarını kullanarak şifreleme işlemleri gerçekleştirir.

Bu istemci, gerekli anahtar malzemeyle birlikte başlatıldığında veya bu malzemeyi Key Vault'dan alabildiğinde işlemleri yerel olarak gerçekleştirir. Gerekli anahtar malzemesi kullanılamadığında şifreleme işlemleri Key Vault hizmeti tarafından gerçekleştirilir.

Devralma

azure.keyvault.keys._shared.client_base.KeyVaultClientBase

CryptographyClient

Oluşturucu

CryptographyClient(key: KeyVaultKey | str, credential: TokenCredential, **kwargs)

Parametreler

key

KeyVaultKey

Gerekli

tarafından get_keydöndürülen bir KeyVaultKey örnek veya dize. Bir dize ise, değerin Azure Key Vault anahtarının tanımlayıcısı olması gerekir. Sürüm ekleme önerilir.

credential

TokenCredential

Gerekli

Kasa için erişim belirteci sağlayabilen bir nesne, örneğin identity

api_version

ApiVersion

Kullanılacak hizmet API'sinin sürümü. Varsayılan olarak en son değeri kullanır.

verify_challenge_resource

bool

Kimlik doğrulama sınaması kaynağının Key Vault veya Yönetilen HSM etki alanıyla eşleşip eşleşmediğini doğrulama. Varsayılan değer True'dır.

Yöntemler

close	İstemci tarafından açılan yuvaları kapatın. İstemciyi bağlam yöneticisi olarak kullanırken bu yöntemi çağırmak gereksizdir.
decrypt	İstemcinin anahtarını kullanarak tek bir şifrelenmiş veri bloğunun şifresini çözme. Anahtarlar/şifre çözme izni gerektirir. Bu yöntem, boyutu anahtar ve şifreleme algoritmasına bağlı olan tek bir veri bloğunun şifresini çözer.
encrypt	İstemcinin anahtarını kullanarak baytları şifreleyin. Anahtarlar/şifreleme izni gerektirir. Bu yöntem, boyutu anahtara ve şifreleme algoritmasına bağlı olan tek bir veri bloğunu şifreler.
from_jwk	Yalnızca yerel olarak şifreleme işlemleri gerçekleştirebilen bir istemci oluşturur.
send_request	İstemcinin mevcut işlem hattını kullanarak bir ağ isteği çalıştırır. İstek URL'si kasa URL'sine göre olabilir. İstek için kullanılan hizmet API'sinin sürümü, aksi belirtilmedikçe istemcinin sürümüyle aynıdır. Yanıt bir hataysa bu yöntem tetiklenmez; özel durum tetiklemek için döndürülen yanıt nesnesinde raise_for_status() öğesini çağırın. Bu yöntemle özel istek gönderme hakkında daha fazla bilgi için bkz https://aka.ms/azsdk/dpcodegen/python/send_request. .
sign	İstemcinin anahtarını kullanarak özetten imza oluşturun. Anahtarlar/imzalama izni gerektirir.
unwrap_key	Daha önce istemcinin anahtarıyla sarmalanmış bir anahtarın işaretini kaldırın. Anahtarlar/unwrapKey izni gerektirir.
verify	İstemcinin anahtarını kullanarak imzayı doğrulayın. Anahtarlar/doğrulama izni gerektirir.
wrap_key	Anahtarı istemcinin anahtarıyla sarmalama. Anahtarlar/wrapKey izni gerektirir.

close

İstemci tarafından açılan yuvaları kapatın.

İstemciyi bağlam yöneticisi olarak kullanırken bu yöntemi çağırmak gereksizdir.

close() -> None

decrypt

İstemcinin anahtarını kullanarak tek bir şifrelenmiş veri bloğunun şifresini çözme.

Anahtarlar/şifre çözme izni gerektirir. Bu yöntem, boyutu anahtar ve şifreleme algoritmasına bağlı olan tek bir veri bloğunun şifresini çözer.

decrypt(algorithm: EncryptionAlgorithm, ciphertext: bytes, **kwargs) -> DecryptResult

Parametreler

algorithm

EncryptionAlgorithm

Gerekli

Kullanılacak şifreleme algoritması

ciphertext

bytes

Gerekli

Şifresi çözülecek şifrelenmiş baytlar. 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.

iv

bytes veya None

Şifreleme sırasında kullanılan başlatma vektöru. AES şifre çözme için gereklidir.

authentication_tag

bytes veya None

Şifreleme sırasında oluşturulan kimlik doğrulama etiketi. Yalnızca AES-GCM şifre çözme için gereklidir.

additional_authenticated_data

bytes veya None

Kimliği doğrulanmış ancak şifrelenmemiş isteğe bağlı veriler. AES-GCM şifre çözme ile kullanım için.

Dönüş türü

DecryptResult

Özel durumlar

ValueError

Belirtilen algoritmayla uyumlu olmayan parametreler sağlanıyorsa.

encrypt

İstemcinin anahtarını kullanarak baytları şifreleyin.

Anahtarlar/şifreleme izni gerektirir. Bu yöntem, boyutu anahtara ve şifreleme algoritmasına bağlı olan tek bir veri bloğunu şifreler.

encrypt(algorithm: EncryptionAlgorithm, plaintext: bytes, **kwargs) -> EncryptResult

Parametreler

algorithm

EncryptionAlgorithm

Gerekli

Kullanılacak şifreleme algoritması

plaintext

bytes

Gerekli

Şifrelenmesi gereken bayt sayısı

iv

bytes veya None

Başlatma vektör. Yalnızca AES-CBC(PAD) şifrelemesi için gereklidir. Kendi IV'nizi geçirirseniz kriptografik olarak rastgele, tekrarlanmayan bir IV kullandığınızdan emin olun. Atlanırsa, yerel şifreleme için os.urandom aracılığıyla IV oluşturma girişiminde bulunulacaktır; uzaktan şifreleme için Key Vault bir IV oluşturur.

additional_authenticated_data

bytes veya None

Kimliği doğrulanmış ancak şifrelenmemiş isteğe bağlı veriler. AES-GCM şifrelemesi ile kullanmak için.

Dönüş türü

EncryptResult

Özel durumlar

ValueError

belirtilen algoritmayla uyumsuz parametreler sağlanıyorsa veya geçerli platformda IV oluşturulamıyorsa.

from_jwk

Yalnızca yerel olarak şifreleme işlemleri gerçekleştirebilen bir istemci oluşturur.

from_jwk(jwk: JsonWebKey | Dict[str, Any]) -> CryptographyClient

Parametreler

jwk

JsonWebKey veya Dict[str, Any]

Gerekli

anahtarın şifreleme malzemesini JsonWebKey veya sözlük olarak kullanın.

Dönüş türü

CryptographyClient

send_request

İstemcinin mevcut işlem hattını kullanarak bir ağ isteği çalıştırır.

İstek URL'si kasa URL'sine göre olabilir. İstek için kullanılan hizmet API'sinin sürümü, aksi belirtilmedikçe istemcinin sürümüyle aynıdır. Yanıt bir hataysa bu yöntem tetiklenmez; özel durum tetiklemek için döndürülen yanıt nesnesinde raise_for_status() öğesini çağırın. Bu yöntemle özel istek gönderme hakkında daha fazla bilgi için bkz https://aka.ms/azsdk/dpcodegen/python/send_request. .

send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse

Parametreler

request

HttpRequest

Gerekli

Yapmak istediğiniz ağ isteği.

stream

bool

Yanıt yükünün akışla aktarılıp aktarılmayacağı. Varsayılan değer False'tur.

Döndürülenler

Ağ çağrınızın yanıtı. Yanıtınızda hata işleme yapmaz.

Dönüş türü

HttpResponse

sign

İstemcinin anahtarını kullanarak özetten imza oluşturun.

Anahtarlar/imzalama izni gerektirir.

sign(algorithm: SignatureAlgorithm, digest: bytes, **kwargs) -> SignResult

Parametreler

algorithm

SignatureAlgorithm

Gerekli

imzalama algoritması

digest

bytes

Gerekli

imzalanan karma baytlar

Dönüş türü

SignResult

unwrap_key

Daha önce istemcinin anahtarıyla sarmalanmış bir anahtarın işaretini kaldırın.

Anahtarlar/unwrapKey izni gerektirir.

unwrap_key(algorithm: KeyWrapAlgorithm, encrypted_key: bytes, **kwargs) -> UnwrapResult

Parametreler

algorithm

KeyWrapAlgorithm

Gerekli

kullanılacak sarmalama algoritması

encrypted_key

bytes

Gerekli

sarmalanmış anahtar

Dönüş türü

UnwrapResult

verify

İstemcinin anahtarını kullanarak imzayı doğrulayın.

Anahtarlar/doğrulama izni gerektirir.

verify(algorithm: SignatureAlgorithm, digest: bytes, signature: bytes, **kwargs) -> VerifyResult

Parametreler

algorithm

SignatureAlgorithm

Gerekli

doğrulama algoritması

digest

bytes

Gerekli

İmzaya karşılık gelen önceden karma özet. Kullanılan karma algoritması ile algorithmuyumlu olmalıdır.

signature

bytes

Gerekli

doğrulamak için imza

Dönüş türü

VerifyResult

wrap_key

Anahtarı istemcinin anahtarıyla sarmalama.

Anahtarlar/wrapKey izni gerektirir.

wrap_key(algorithm: KeyWrapAlgorithm, key: bytes, **kwargs) -> WrapResult

Parametreler

algorithm

KeyWrapAlgorithm

Gerekli

kullanılacak sarmalama algoritması

key

bytes

Gerekli

kaydıracak anahtar

Dönüş türü

WrapResult

Öznitelikler

key_id

İstemci anahtarının tam tanımlayıcısı.

bir istemci ile from_jwkoluşturulduğunda bu özellik None olabilir.

Dönüş türü

str,

None

vault_url

İstemci anahtarının temel kasa URL'si.

bir istemci ile from_jwkoluşturulduğunda bu özellik None olabilir.

Dönüş türü

str,

None