Package com.microsoft.azure.keyvault.cryptography

Class KeyWrapAlgorithm

java.lang.Object

com.microsoft.azure.keyvault.cryptography.Algorithm

com.microsoft.azure.keyvault.cryptography.KeyWrapAlgorithm

Direct Known Subclasses:

AesKw

public abstract class KeyWrapAlgorithm
extends Algorithm

Abstract base class for all key wrap algorithms.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeyWrapAlgorithm(String name)	Constructor.

Method Summary

Modifier and Type	Method	Description
abstract ICryptoTransform	CreateDecryptor(byte[] key)	Creates a ICryptoTransform implementation for decryption.
abstract ICryptoTransform	CreateDecryptor(byte[] key, byte[] iv)	Creates a ICryptoTransform implementation for decryption using the supplied initialization vector.
abstract ICryptoTransform	CreateDecryptor(byte[] key, byte[] iv, Provider provider)	Creates a ICryptoTransform implementation for decryption using the supplied initialization vector and the specific provider for the Java Security API.
abstract ICryptoTransform	CreateDecryptor(byte[] key, Provider provider)	Creates a ICryptoTransform implementation for decryption that uses the specified provider for the Java Security API.
abstract ICryptoTransform	CreateEncryptor(byte[] key)	Creates a ICryptoTransform implementation for encryption.
abstract ICryptoTransform	CreateEncryptor(byte[] key, byte[] iv)	Creates a ICryptoTransform implementation for encryption using the supplied initialization vector.
abstract ICryptoTransform	CreateEncryptor(byte[] key, byte[] iv, Provider provider)	Creates a ICryptoTransform implementation for encryption using the supplied initialization vector and the specific provider for the Java Security API.
abstract ICryptoTransform	CreateEncryptor(byte[] key, Provider provider)	Creates a ICryptoTransform implementation for encryption that uses the specified provider for the Java Security API.

Methods inherited from class com.microsoft.azure.keyvault.cryptography.Algorithm

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyWrapAlgorithm

protected KeyWrapAlgorithm(String name)

Constructor.

Parameters:

name - The name of the algorithm.

Method Detail

CreateEncryptor

public abstract ICryptoTransform CreateEncryptor(byte[] key)
                                          throws NoSuchAlgorithmException,
                                                 NoSuchPaddingException,
                                                 InvalidKeyException,
                                                 InvalidAlgorithmParameterException

Creates a ICryptoTransform implementation for encryption. Uses the default AES-KW initialization vector.

Parameters:

key - The AES key material to be used.

Returns:

A ICryptoTransform implementation

Throws:

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

CreateEncryptor

public abstract ICryptoTransform CreateEncryptor(byte[] key,
                                                 Provider provider)
                                          throws NoSuchAlgorithmException,
                                                 NoSuchPaddingException,
                                                 InvalidKeyException,
                                                 InvalidAlgorithmParameterException

Creates a ICryptoTransform implementation for encryption that uses the specified provider for the Java Security API. Uses the default AES-KW initialization vector.

Parameters:

key - The AES key material to be used.

provider - The provider to use.

Returns:

A ICryptoTransform implementation

Throws:

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

CreateEncryptor

public abstract ICryptoTransform CreateEncryptor(byte[] key,
                                                 byte[] iv)
                                          throws NoSuchAlgorithmException,
                                                 NoSuchPaddingException,
                                                 InvalidKeyException,
                                                 InvalidAlgorithmParameterException

Creates a ICryptoTransform implementation for encryption using the supplied initialization vector.

Parameters:

key - The AES key material to be used.

iv - The initialization vector to be used.

Returns:

A ICryptoTransform implementation

Throws:

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

CreateEncryptor

public abstract ICryptoTransform CreateEncryptor(byte[] key,
                                                 byte[] iv,
                                                 Provider provider)
                                          throws NoSuchAlgorithmException,
                                                 NoSuchPaddingException,
                                                 InvalidKeyException,
                                                 InvalidAlgorithmParameterException

Creates a ICryptoTransform implementation for encryption using the supplied initialization vector and the specific provider for the Java Security API.

Parameters:

key - The AES key material to be used.

iv - The initialization vector to be used.

provider - The provider to use.

Returns:

A ICryptoTransform implementation

Throws:

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

CreateDecryptor

public abstract ICryptoTransform CreateDecryptor(byte[] key)
                                          throws NoSuchAlgorithmException,
                                                 NoSuchPaddingException,
                                                 InvalidKeyException,
                                                 InvalidAlgorithmParameterException

Creates a ICryptoTransform implementation for decryption. Uses the default AES-KW initialization vector.

Parameters:

key - The AES key material to be used.

Returns:

A ICryptoTransform implementation

Throws:

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

CreateDecryptor

public abstract ICryptoTransform CreateDecryptor(byte[] key,
                                                 Provider provider)
                                          throws NoSuchAlgorithmException,
                                                 NoSuchPaddingException,
                                                 InvalidKeyException,
                                                 InvalidAlgorithmParameterException

Creates a ICryptoTransform implementation for decryption that uses the specified provider for the Java Security API. Uses the default AES-KW initialization vector.

Parameters:

key - The AES key material to be used.

provider - The provider to use.

Returns:

A ICryptoTransform implementation

Throws:

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

CreateDecryptor

public abstract ICryptoTransform CreateDecryptor(byte[] key,
                                                 byte[] iv)
                                          throws NoSuchAlgorithmException,
                                                 NoSuchPaddingException,
                                                 InvalidKeyException,
                                                 InvalidAlgorithmParameterException

Creates a ICryptoTransform implementation for decryption using the supplied initialization vector.

Parameters:

key - The AES key material to be used.

iv - The initialization vector to be used.

Returns:

A ICryptoTransform implementation

Throws:

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException

CreateDecryptor

public abstract ICryptoTransform CreateDecryptor(byte[] key,
                                                 byte[] iv,
                                                 Provider provider)
                                          throws NoSuchAlgorithmException,
                                                 NoSuchPaddingException,
                                                 InvalidKeyException,
                                                 InvalidAlgorithmParameterException

Creates a ICryptoTransform implementation for decryption using the supplied initialization vector and the specific provider for the Java Security API.

Parameters:

key - The AES key material to be used.

iv - The initialization vector to be used.

provider - The provider to use.

Returns:

A ICryptoTransform implementation

Throws:

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

InvalidAlgorithmParameterException