RsaKey Class

Package:

com.microsoft.azure.keyvault.cryptography

• java.lang.Object
• • Closeable
  • • IKey
    • • com.microsoft.azure.keyvault.cryptography.RsaKey

public class RsaKey implements IKey

Field Summary

Modifier and Type	Field and Description
int	KeySize1024
int	KeySize2048

Constructor Summary

Constructor	Description
RsaKey(String kid)
RsaKey(String kid, int keySize)
RsaKey(String kid, int keySize, Provider provider)
RsaKey(String kid, KeyPair keyPair)
RsaKey(String kid, KeyPair keyPair, Provider provider)

Method Summary

Modifier and Type	Method and Description
void	close()
ListenableFuture<byte[]>	decryptAsync(final byte[] ciphertext, final byte[] iv, final byte[] authenticationData, final byte[] authenticationTag, final String algorithm) Decrypts the specified cipher text. Note that not all algorithms require, or support, all parameters.
ListenableFuture<Triple<byte[], byte[], String>>	encryptAsync(final byte[] plaintext, final byte[] iv, final byte[] authenticationData, final String algorithm) Encrypts the specified plain text. Note that not all algorithms require, or support, all parameters.
String	getDefaultEncryptionAlgorithm() The default encryption algorithm for this key, using the representations from Json Web Key Algorithms, RFC7513.
int	getDefaultKeySize()
String	getDefaultKeyWrapAlgorithm() The default key wrap algorithm for this key, using the representations from Json Web Key Algorithms, RFC7513.
String	getDefaultSignatureAlgorithm() The default signature algorithm for this key, using the representations from Json Web Key Algorithms, RFC7513.
String	getKid() The unique key identifier for this key.
ListenableFuture<Pair<byte[], String>>	signAsync(final byte[] digest, final String algorithm) Signs the specified digest using the specified algorithm, or the keys DefaultSignatureAlgorithm if no algorithm is specified.
ListenableFuture<byte[]>	unwrapKeyAsync(final byte[] encryptedKey, final String algorithm) Unwraps (decrypts) the specified encryped key material.
ListenableFuture<Boolean>	verifyAsync(final byte[] digest, final byte[] signature, final String algorithm) Verifies the supplied signature value using the supplied digest and algorithm.
ListenableFuture<Pair<byte[], String>>	wrapKeyAsync(final byte[] key, final String algorithm) Wraps (encrypts) the specified symmetric key material using the specified algorithm, or the keys DefaultKeyWrapAlgorithm if none is specified.

Field Details

KeySize1024

public static int KeySize1024= 1024

KeySize2048

public static int KeySize2048= 2048

Constructor Details

RsaKey

public RsaKey(String kid)

Parameters:

kid

RsaKey

public RsaKey(String kid, int keySize)

Parameters:

kid

keySize

RsaKey

public RsaKey(String kid, int keySize, Provider provider)

Parameters:

kid

keySize

provider

RsaKey

public RsaKey(String kid, KeyPair keyPair)

Parameters:

kid

keyPair

RsaKey

public RsaKey(String kid, KeyPair keyPair, Provider provider)

Parameters:

kid

keyPair

provider

Method Details

close

public void close()

decryptAsync

public ListenableFuture decryptAsync(final byte[] ciphertext, final byte[] iv, final byte[] authenticationData, final byte[] authenticationTag, final String algorithm)

Decrypts the specified cipher text. Note that not all algorithms require, or support, all parameters.

Overrides:

RsaKey.decryptAsync(final byte[] ciphertext, final byte[] iv, final byte[] authenticationData, final byte[] authenticationTag, final String algorithm)

Parameters:

ciphertext - The cipher text to decrypt

iv - The initialization vector (optional with some algorithms)

authenticationData - Additional authentication data (optional with some algorithms)

authenticationTag - The authentication tag from the encrypt operation (optional with some algorithms)

algorithm - The encryption algorithm to use, must be supplied

Returns:

A ListenableFuture containing the plain text

Throws:

NoSuchAlgorithmException - the algorithm is not valid

encryptAsync

public ListenableFuture> encryptAsync(final byte[] plaintext, final byte[] iv, final byte[] authenticationData, final String algorithm)

Encrypts the specified plain text. Note that not all algorithms require, or support, all parameters.

Overrides:

RsaKey.encryptAsync(final byte[] plaintext, final byte[] iv, final byte[] authenticationData, final String algorithm)

Parameters:

plaintext - The plain text to encrypt

iv - The initialization vector (optional with some algorithms)

authenticationData - Additional authentication data (optional with some algorithms)

algorithm - The encryption algorithm to use, defaults to the keys DefaultEncryptionAlgorithm

Returns:

A ListenableFuture containing the cipher text, the authentication tag and the algorithm that was used

Throws:

NoSuchAlgorithmException - the algorithm is not valid

getDefaultEncryptionAlgorithm

public String getDefaultEncryptionAlgorithm()

The default encryption algorithm for this key, using the representations from Json Web Key Algorithms, RFC7513.

Overrides:

RsaKey.getDefaultEncryptionAlgorithm()

Returns:

The default encryption algorithm for this key.

getDefaultKeySize

public static int getDefaultKeySize()

getDefaultKeyWrapAlgorithm

public String getDefaultKeyWrapAlgorithm()

The default key wrap algorithm for this key, using the representations from Json Web Key Algorithms, RFC7513.

Overrides:

RsaKey.getDefaultKeyWrapAlgorithm()

Returns:

The default key wrap algorithm for this key.

getDefaultSignatureAlgorithm

public String getDefaultSignatureAlgorithm()

The default signature algorithm for this key, using the representations from Json Web Key Algorithms, RFC7513.

Overrides:

RsaKey.getDefaultSignatureAlgorithm()

Returns:

The default signature algorithm for this key.

getKid

public String getKid()

The unique key identifier for this key.

Overrides:

RsaKey.getKid()

Returns:

The key identifier

signAsync

public ListenableFuture> signAsync(final byte[] digest, final String algorithm)

Signs the specified digest using the specified algorithm, or the keys DefaultSignatureAlgorithm if no algorithm is specified.

Overrides:

RsaKey.signAsync(final byte[] digest, final String algorithm)

Parameters:

digest - The digest to sign

algorithm - The signature algorithm to use

Returns:

A ListenableFuture containing the signature and the algorithm used.

Throws:

NoSuchAlgorithmException - the algorithm is not valid

unwrapKeyAsync

public ListenableFuture unwrapKeyAsync(final byte[] encryptedKey, final String algorithm)

Unwraps (decrypts) the specified encryped key material.

Overrides:

RsaKey.unwrapKeyAsync(final byte[] encryptedKey, final String algorithm)

Parameters:

encryptedKey - The encrypted key to decrypt

algorithm - The algorithm to use, must be supplied

Returns:

A ListenableFuture containing the unwrapped key

Throws:

NoSuchAlgorithmException - the algorithm is not valid

verifyAsync

public ListenableFuture verifyAsync(final byte[] digest, final byte[] signature, final String algorithm)

Verifies the supplied signature value using the supplied digest and algorithm.

Overrides:

RsaKey.verifyAsync(final byte[] digest, final byte[] signature, final String algorithm)

Parameters:

digest - The digest input

signature - The signature to verify

algorithm - The algorithm to use, must be provided

Returns:

A ListenableFuture containing the signature and the algorithm used.

Throws:

NoSuchAlgorithmException - the algorithm is not valid

wrapKeyAsync

public ListenableFuture> wrapKeyAsync(final byte[] key, final String algorithm)

Wraps (encrypts) the specified symmetric key material using the specified algorithm, or the keys DefaultKeyWrapAlgorithm if none is specified.

Overrides:

RsaKey.wrapKeyAsync(final byte[] key, final String algorithm)

Parameters:

key - The symmetric key to wrap

algorithm - The wrapping algorithm to use, defaults to the keys DefaultKeyWrapAlgorithm

Returns:

ListenableFuture containing the encrypted key and the algorithm that was used

Throws:

NoSuchAlgorithmException - the algorithm is not valid