KeyWrapAlgorithm Class

Package:

com.microsoft.azure.keyvault.cryptography

• java.lang.Object
• • Algorithm
  • • com.microsoft.azure.keyvault.cryptography.KeyWrapAlgorithm

public class KeyWrapAlgorithm extends Algorithm

Abstract base class for all key wrap algorithms.

Constructor Summary

Constructor	Description
KeyWrapAlgorithm(String name)	Constructor.

Method Summary

Modifier and Type	Method and Description
abstract ICryptoTransform	CreateDecryptor(byte[] key) Creates a ICryptoTransform implementation for decryption. Uses the default AES-KW initialization vector.
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. Uses the default AES-KW initialization vector.
abstract ICryptoTransform	CreateEncryptor(byte[] key) Creates a ICryptoTransform implementation for encryption. Uses the default AES-KW initialization vector.
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. Uses the default AES-KW initialization vector.

Inherited Members

Algorithm.Algorithm(String name) Algorithm.getName()

Constructor Details

KeyWrapAlgorithm

protected KeyWrapAlgorithm(String name)

Constructor.

Parameters:

name - The name of the algorithm.

Method Details

CreateDecryptor

public abstract ICryptoTransform CreateDecryptor(byte[] key)

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, byte[] iv)

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)

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

CreateDecryptor

public abstract ICryptoTransform CreateDecryptor(byte[] key, Provider provider)

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

CreateEncryptor

public abstract ICryptoTransform CreateEncryptor(byte[] key)

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, byte[] iv)

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)

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

CreateEncryptor

public abstract ICryptoTransform CreateEncryptor(byte[] key, Provider provider)

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