com.azure.security.keyvault.keys.cryptography

Class CryptographyAsyncClient

java.lang.Object

com.azure.security.keyvault.keys.cryptography.CryptographyAsyncClient

Direct Known Subclasses:

KeyEncryptionKeyAsyncClient

public class CryptographyAsyncClient
extends Object

The CryptographyAsyncClient provides asynchronous methods to perform cryptographic operations using asymmetric and symmetric keys. The client supports encrypt, decrypt, wrap key, unwrap key, sign and verify operations using the configured key.

Samples to construct the sync client

 CryptographyAsyncClient cryptographyAsyncClient = new CryptographyClientBuilder()
     .keyIdentifier("<YOUR-KEY-ID>")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildAsyncClient();
 

See Also:

CryptographyClientBuilder

Method Summary

Modifier and Type	Method and Description
Mono<DecryptResult>	decrypt(EncryptionAlgorithm algorithm, byte[] cipherText) Decrypts a single block of encrypted data using the configured key and specified algorithm.
Mono<EncryptResult>	encrypt(EncryptionAlgorithm algorithm, byte[] plaintext) Encrypts an arbitrary sequence of bytes using the configured key.
Mono<SignResult>	sign(SignatureAlgorithm algorithm, byte[] digest) Creates a signature from a digest using the configured key.
Mono<SignResult>	signData(SignatureAlgorithm algorithm, byte[] data) Creates a signature from the raw data using the configured key.
Mono<UnwrapResult>	unwrapKey(KeyWrapAlgorithm algorithm, byte[] encryptedKey) Unwraps a symmetric key using the configured key that was initially used for wrapping that key.
Mono<VerifyResult>	verify(SignatureAlgorithm algorithm, byte[] digest, byte[] signature) Verifies a signature using the configured key.
Mono<VerifyResult>	verifyData(SignatureAlgorithm algorithm, byte[] data, byte[] signature) Verifies a signature against the raw data using the configured key.
Mono<WrapResult>	wrapKey(KeyWrapAlgorithm algorithm, byte[] key) Wraps a symmetric key using the configured key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

encrypt

public Mono<EncryptResult> encrypt(EncryptionAlgorithm algorithm,
                                   byte[] plaintext)

Encrypts an arbitrary sequence of bytes using the configured key. Note that the encrypt operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The encrypt operation is supported for both symmetric keys and asymmetric keys. In case of asymmetric keys public portion of the key is used for encryption. This operation requires the keys/encrypt permission.

The encryption algorithm indicates the type of algorithm to use for encrypting the specified plaintext. Possible values for assymetric keys include: RSA1_5, RSA_OAEP and RSA_OAEP_256. Possible values for symmetric keys include: A128CBC, A128CBC-HS256, A192CBC, A192CBC-HS384, A256CBC and A256CBC-HS512

Code Samples

Encrypts the content. Subscribes to the call asynchronously and prints out the encrypted content details when a response has been received.

 byte[] plainText = new byte[100];
 new Random(0x1234567L).nextBytes(plainText);
 cryptographyAsyncClient.encrypt(EncryptionAlgorithm.RSA_OAEP, plainText)
     .subscriberContext(reactor.util.context.Context.of(key1, value1, key2, value2))
     .subscribe(encryptResult ->
         System.out.printf("Received encrypted content of length %d with algorithm %s \n",
             encryptResult.getCipherText().length, encryptResult.getAlgorithm().toString()));
 

Parameters:

algorithm - The algorithm to be used for encryption.

plaintext - The content to be encrypted.

Returns:

A Mono containing a EncryptResult whose cipher text contains the encrypted content.

Throws:

com.azure.core.exception.ResourceNotFoundException - if the key cannot be found for encryption.

UnsupportedOperationException - if the encrypt operation is not supported or configured on the key.

NullPointerException - if algorithm or plainText is null.

decrypt

public Mono<DecryptResult> decrypt(EncryptionAlgorithm algorithm,
                                   byte[] cipherText)

Decrypts a single block of encrypted data using the configured key and specified algorithm. Note that only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The decrypt operation is supported for both asymmetric and symmetric keys. This operation requires the keys/decrypt permission.

The encryption algorithm indicates the type of algorithm to use for decrypting the specified encrypted content. Possible values for assymetric keys include: RSA1_5, RSA_OAEP and RSA_OAEP_256. Possible values for symmetric keys include: A128CBC, A128CBC-HS256, A192CBC, A192CBC-HS384, A256CBC and A256CBC-HS512

Code Samples

Decrypts the encrypted content. Subscribes to the call asynchronously and prints out the decrypted content details when a response has been received.

 byte[] plainText = new byte[100];
 new Random(0x1234567L).nextBytes(plainText);
 cryptographyAsyncClient.decrypt(EncryptionAlgorithm.RSA_OAEP, plainText)
     .subscriberContext(reactor.util.context.Context.of(key1, value1, key2, value2))
     .subscribe(decryptResult ->
         System.out.printf("Received decrypted content of length %d\n", decryptResult.getPlainText().length));
 

Parameters:

algorithm - The algorithm to be used for decryption.

cipherText - The content to be decrypted.

Returns:

A Mono containing the decrypted blob.

Throws:

com.azure.core.exception.ResourceNotFoundException - if the key cannot be found for decryption.

UnsupportedOperationException - if the decrypt operation is not supported or configured on the key.

NullPointerException - if algorithm or cipherText is null.

sign

public Mono<SignResult> sign(SignatureAlgorithm algorithm,
                             byte[] digest)

Creates a signature from a digest using the configured key. The sign operation supports both asymmetric and symmetric keys. This operation requires the keys/sign permission.

The signature algorithm indicates the type of algorithm to use to create the signature from the digest. Possible values include: ES256, E384, ES512, ES246K, PS256, RS384, RS512, RS256, RS384 and RS512

Code Samples

Sings the digest. Subscribes to the call asynchronously and prints out the signature details when a response has been received.

 byte[] data = new byte[100];
 new Random(0x1234567L).nextBytes(data);
 MessageDigest md = MessageDigest.getInstance("SHA-256");
 md.update(data);
 byte[] digest = md.digest();
 cryptographyAsyncClient.sign(SignatureAlgorithm.ES256, digest)
     .subscriberContext(reactor.util.context.Context.of(key1, value1, key2, value2))
     .subscribe(signResult ->
         System.out.printf("Received signature of length %d with algorithm %s", signResult.getSignature().length));
 

Parameters:

algorithm - The algorithm to use for signing.

digest - The content from which signature is to be created.

Returns:

A Mono containing a SignResult whose signature contains the created signature.

Throws:

com.azure.core.exception.ResourceNotFoundException - if the key cannot be found for signing.

UnsupportedOperationException - if the sign operation is not supported or configured on the key.

NullPointerException - if algorithm or digest is null.

verify

public Mono<VerifyResult> verify(SignatureAlgorithm algorithm,
                                 byte[] digest,
                                 byte[] signature)

Verifies a signature using the configured key. The verify operation supports both symmetric keys and asymmetric keys. In case of asymmetric keys public portion of the key is used to verify the signature . This operation requires the keys/verify permission.

The signature algorithm indicates the type of algorithm to use to verify the signature. Possible values include: ES256, E384, ES512, ES246K, PS256, RS384, RS512, RS256, RS384 and RS512

Code Samples

Verifies the signature against the specified digest. Subscribes to the call asynchronously and prints out the verification details when a response has been received.

 cryptographyAsyncClient.verify(SignatureAlgorithm.ES256, digest, signature)
     .subscriberContext(reactor.util.context.Context.of(key1, value1, key2, value2))
     .subscribe(verifyResult ->
         System.out.printf("Verification status %s", verifyResult.isValid()));
 

Parameters:

algorithm - The algorithm to use for signing.

digest - The content from which signature is to be created.

signature - The signature to be verified.

Returns:

A Mono containing a Boolean indicating the signature verification result.

Throws:

com.azure.core.exception.ResourceNotFoundException - if the key cannot be found for verifying.

UnsupportedOperationException - if the verify operation is not supported or configured on the key.

NullPointerException - if algorithm, digest or signature is null.

wrapKey

public Mono<WrapResult> wrapKey(KeyWrapAlgorithm algorithm,
                                byte[] key)

Wraps a symmetric key using the configured key. The wrap operation supports wrapping a symmetric key with both symmetric and asymmetric keys. This operation requires the keys/wrapKey permission.

The wrap algorithm indicates the type of algorithm to use for wrapping the specified key content. Possible values include: RSA1_5, RSA_OAEP and RSA_OAEP_256

Code Samples

Wraps the key content. Subscribes to the call asynchronously and prints out the wrapped key details when a response has been received.

 byte[] key = new byte[100];
 new Random(0x1234567L).nextBytes(key);
 cryptographyAsyncClient.wrapKey(KeyWrapAlgorithm.RSA_OAEP, key)
     .subscriberContext(reactor.util.context.Context.of(key1, value1, key2, value2))
     .subscribe(keyWrapResult ->
         System.out.printf("Received encypted key of length %d with algorithm %s",
             keyWrapResult.getEncryptedKey().length, keyWrapResult.getAlgorithm().toString()));
 

Parameters:

algorithm - The encryption algorithm to use for wrapping the key.

key - The key content to be wrapped

Returns:

A Mono containing a WrapResult whose encrypted key contains the wrapped key result.

Throws:

com.azure.core.exception.ResourceNotFoundException - if the key cannot be found for wrap operation.

UnsupportedOperationException - if the wrap operation is not supported or configured on the key.

NullPointerException - if algorithm or key is null.

unwrapKey

public Mono<UnwrapResult> unwrapKey(KeyWrapAlgorithm algorithm,
                                    byte[] encryptedKey)

Unwraps a symmetric key using the configured key that was initially used for wrapping that key. This operation is the reverse of the wrap operation. The unwrap operation supports asymmetric and symmetric keys to unwrap. This operation requires the keys/unwrapKey permission.

The wrap algorithm indicates the type of algorithm to use for unwrapping the specified encrypted key content. Possible values for asymmetric keys include: RSA1_5, RSA_OAEP and RSA_OAEP_256. Possible values for symmetric keys include: A128KW, A192KW and A256KW

Code Samples

Unwraps the key content. Subscribes to the call asynchronously and prints out the unwrapped key details when a response has been received.

 cryptographyAsyncClient.unwrapKey(KeyWrapAlgorithm.RSA_OAEP, encryptedKey)
     .subscriberContext(reactor.util.context.Context.of(key1, value1, key2, value2))
     .subscribe(keyUnwrapResult ->
         System.out.printf("Received key of length %d", keyUnwrapResult.getKey().length));
 

Parameters:

algorithm - The encryption algorithm to use for wrapping the key.

encryptedKey - The encrypted key content to unwrap.

Returns:

A Mono containing a the unwrapped key content.

Throws:

com.azure.core.exception.ResourceNotFoundException - if the key cannot be found for wrap operation.

UnsupportedOperationException - if the unwrap operation is not supported or configured on the key.

NullPointerException - if algorithm or encryptedKey is null.

signData

public Mono<SignResult> signData(SignatureAlgorithm algorithm,
                                 byte[] data)

Creates a signature from the raw data using the configured key. The sign data operation supports both asymmetric and symmetric keys. This operation requires the keys/sign permission.

The signature algorithm indicates the type of algorithm to use to sign the digest. Possible values include: ES256, E384, ES512, ES246K, PS256, RS384, RS512, RS256, RS384 and RS512

Code Samples

Signs the raw data. Subscribes to the call asynchronously and prints out the signature details when a response has been received.

 byte[] data = new byte[100];
 new Random(0x1234567L).nextBytes(data);
 cryptographyAsyncClient.sign(SignatureAlgorithm.ES256, data)
     .subscriberContext(reactor.util.context.Context.of(key1, value1, key2, value2))
     .subscribe(signResult ->
         System.out.printf("Received signature of length %d with algorithm %s", signResult.getSignature().length));
 

Parameters:

algorithm - The algorithm to use for signing.

data - The content from which signature is to be created.

Returns:

A Mono containing a SignResult whose signature contains the created signature.

Throws:

com.azure.core.exception.ResourceNotFoundException - if the key cannot be found for signing.

UnsupportedOperationException - if the sign operation is not supported or configured on the key.

NullPointerException - if algorithm or data is null.

verifyData

public Mono<VerifyResult> verifyData(SignatureAlgorithm algorithm,
                                     byte[] data,
                                     byte[] signature)

Verifies a signature against the raw data using the configured key. The verify operation supports both symmetric keys and asymmetric keys. In case of asymmetric keys public portion of the key is used to verify the signature . This operation requires the keys/verify permission.

The signature algorithm indicates the type of algorithm to use to verify the signature. Possible values include: ES256, E384, ES512, ES246K, PS256, RS384, RS512, RS256, RS384 and RS512

Code Samples

Verifies the signature against the raw data. Subscribes to the call asynchronously and prints out the verification details when a response has been received.

 cryptographyAsyncClient.verify(SignatureAlgorithm.ES256, data, signature)
     .subscriberContext(reactor.util.context.Context.of(key1, value1, key2, value2))
     .subscribe(verifyResult ->
         System.out.printf("Verification status %s", verifyResult.isValid()));
 

Parameters:

algorithm - The algorithm to use for signing.

data - The raw content against which signature is to be verified.

signature - The signature to be verified.

Returns:

The Boolean indicating the signature verification result.

Throws:

com.azure.core.exception.ResourceNotFoundException - if the key cannot be found for verifying.

UnsupportedOperationException - if the verify operation is not supported or configured on the key.

NullPointerException - if algorithm, data or signature is null.