CryptographyClient Class

Definition

Namespace:

Azure.Security.KeyVault.Keys.Cryptography

Assembly:

Azure.Security.KeyVault.Keys.dll

Package:

Azure.Security.KeyVault.Keys v4.7.0

Source:

CryptographyClient.cs

A client used to perform cryptographic operations with Azure Key Vault keys.

public class CryptographyClient : Azure.Core.Cryptography.IKeyEncryptionKey

type CryptographyClient = class
    interface IKeyEncryptionKey

Public Class CryptographyClient
Implements IKeyEncryptionKey

Inheritance

Object

CryptographyClient

Implements

IKeyEncryptionKey

Constructors

CryptographyClient()	Initializes a new instance of the CryptographyClient class for mocking.
CryptographyClient(JsonWebKey)	Initializes a new instance of the CryptographyClient class. Cryptographic operations will be performed only on the local machine.
CryptographyClient(JsonWebKey, LocalCryptographyClientOptions)	Initializes a new instance of the CryptographyClient class. Cryptographic operations will be performed only on the local machine.
CryptographyClient(Uri, TokenCredential)	Initializes a new instance of the CryptographyClient class.
CryptographyClient(Uri, TokenCredential, CryptographyClientOptions)	Initializes a new instance of the CryptographyClient class.

Properties

KeyId

Gets the Id of the key used to perform cryptographic operations for the client.

Methods

CreateRSA(CancellationToken)	Creates an RSA implementation backed by this CryptographyClient.
CreateRSAAsync(CancellationToken)	Creates an RSA implementation backed by this CryptographyClient.
Decrypt(DecryptParameters, CancellationToken)	Decrypts the specified ciphertext.
Decrypt(EncryptionAlgorithm, Byte[], CancellationToken)	Decrypts ciphertext.
DecryptAsync(DecryptParameters, CancellationToken)	Decrypts ciphertext.
DecryptAsync(EncryptionAlgorithm, Byte[], CancellationToken)	Decrypts the specified ciphertext.
Encrypt(EncryptionAlgorithm, Byte[], CancellationToken)	Encrypts the specified plaintext.
Encrypt(EncryptParameters, CancellationToken)	Encrypts plaintext.
EncryptAsync(EncryptionAlgorithm, Byte[], CancellationToken)	Encrypts the specified plaintext.
EncryptAsync(EncryptParameters, CancellationToken)	Encrypts plaintext.
Sign(SignatureAlgorithm, Byte[], CancellationToken)	Signs the specified digest.
SignAsync(SignatureAlgorithm, Byte[], CancellationToken)	Signs the specified digest.
SignData(SignatureAlgorithm, Byte[], CancellationToken)	Signs the specified data.
SignData(SignatureAlgorithm, Stream, CancellationToken)	Signs the specified data.
SignDataAsync(SignatureAlgorithm, Byte[], CancellationToken)	Signs the specified data.
SignDataAsync(SignatureAlgorithm, Stream, CancellationToken)	Signs the specified data.
UnwrapKey(KeyWrapAlgorithm, Byte[], CancellationToken)	Decrypts the specified encrypted key.
UnwrapKeyAsync(KeyWrapAlgorithm, Byte[], CancellationToken)	Decrypts the specified encrypted key.
Verify(SignatureAlgorithm, Byte[], Byte[], CancellationToken)	Verifies the specified signature.
VerifyAsync(SignatureAlgorithm, Byte[], Byte[], CancellationToken)	Verifies the specified signature.
VerifyData(SignatureAlgorithm, Byte[], Byte[], CancellationToken)	Verifies the specified signature.
VerifyData(SignatureAlgorithm, Stream, Byte[], CancellationToken)	Verifies the specified signature.
VerifyDataAsync(SignatureAlgorithm, Byte[], Byte[], CancellationToken)	Verifies the specified signature.
VerifyDataAsync(SignatureAlgorithm, Stream, Byte[], CancellationToken)	Verifies the specified signature.
WrapKey(KeyWrapAlgorithm, Byte[], CancellationToken)	Encrypts the specified key.
WrapKeyAsync(KeyWrapAlgorithm, Byte[], CancellationToken)	Encrypts the specified key.

Explicit Interface Implementations

IKeyEncryptionKey.UnwrapKey(String, ReadOnlyMemory<Byte>, CancellationToken)	Decrypts the specified encrypted key using the specified algorithm.
IKeyEncryptionKey.UnwrapKeyAsync(String, ReadOnlyMemory<Byte>, CancellationToken)	Decrypts the specified encrypted key using the specified algorithm.
IKeyEncryptionKey.WrapKey(String, ReadOnlyMemory<Byte>, CancellationToken)	Encrypts the specified key using the specified algorithm.
IKeyEncryptionKey.WrapKeyAsync(String, ReadOnlyMemory<Byte>, CancellationToken)	Encrypts the specified key using the specified algorithm.