AbstractBlockCipherParameters (easyjce 1.1.0 API)

java.lang.Object
- org.antfarmer.ejce.parameter.AbstractAlgorithmParameters<T>
- - org.antfarmer.ejce.parameter.AbstractSymmetricAlgorithmParameters<T>
  - - org.antfarmer.ejce.parameter.AbstractBlockCipherParameters<T>

Type Parameters:

T - the concrete type of this object.

All Implemented Interfaces:

AlgorithmParameters<T>, SymmetricAlgorithmParameters<T>

Direct Known Subclasses:

Abstract128BitBlockCipherParameters, BlowfishParameters, DesEdeParameters, DesParameters, PbeParameters, Rc2Parameters, Rc5Parameters, TeaParameters, XteaParameters
```
public abstract class AbstractBlockCipherParameters<T extends AbstractBlockCipherParameters<T>>
extends AbstractSymmetricAlgorithmParameters<T>
```
Abstract AlgorithmParameters class for block cipher encryption algorithms.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BLOCK_MODE_CBC` Cipher Block Chaining Block Mode, as defined in FIPS PUB 81.
`static String`	`BLOCK_MODE_CCM` Counter/CBC Mode, as defined in NIST Special Publication SP 800-38C.
`static String`	`BLOCK_MODE_CFB` Cipher Feedback Block Mode, as defined in FIPS PUB 81.
`static String`	`BLOCK_MODE_CTR` A simplification of OFB, Counter mode updates the input block as a counter.
`static String`	`BLOCK_MODE_CTS` Cipher Text Stealing, as described in Bruce Schneier's book Applied Cryptography-Second Edition, John Wiley and Sons, 1996.
`static String`	`BLOCK_MODE_ECB` Electronic Codebook Block Mode, as defined in: The National Institute of Standards and Technology (NIST) Federal Information Processing Standard (FIPS) PUB 81, "DES Modes of Operation," U.S.
`static String`	`BLOCK_MODE_GCM` Galois/Counter Mode, as defined in NIST Special Publication SP 800-38D.
`static String`	`BLOCK_MODE_OFB` Output Feedback Block Mode, as defined in FIPS PUB 81.
`static String`	`BLOCK_MODE_PCBC` Propagating Cipher Block Chaining Block Mode, as defined by Kerberos V4.
`static int`	`DEFAULT_BLOCK_SIZE` Default block cipher size in bytes.
`static int`	`DEFAULT_PARAM_SPEC_SIZE_GCM` Default IV (parameter specification) size in bytes for GCM block mode.
`static int`	`GCM_AUTH_TAG_LEN_104` 104-bit Authentication Tag length for GCM block mode ciphers, as defined in NIST Special Publication SP 800-38D.
`static int`	`GCM_AUTH_TAG_LEN_112` 112-bit Authentication Tag length for GCM block mode ciphers, as defined in NIST Special Publication SP 800-38D.
`static int`	`GCM_AUTH_TAG_LEN_120` 120-bit Authentication Tag length for GCM block mode ciphers, as defined in NIST Special Publication SP 800-38D.
`static int`	`GCM_AUTH_TAG_LEN_128` 128-bit Authentication Tag length for GCM block mode ciphers, as defined in NIST Special Publication SP 800-38D.
`static int`	`GCM_AUTH_TAG_LEN_96` 96-bit Authentication Tag length for GCM block mode ciphers, as defined in NIST Special Publication SP 800-38D.
`static String`	`PADDING_NONE` No padding.
`static String`	`PADDING_PKCS5` The padding scheme described in: RSA Laboratories, "PKCS #5: Password-Based Encryption Standard," version 1.5, November 1993.
`static String`	`PADDING_PKCS7` The padding scheme described in: RSA Laboratories, "PKCS #7: Cryptographic Message Syntax," Version 1.5, November 1993.

Fields inherited from class org.antfarmer.ejce.parameter.AbstractAlgorithmParameters
KEY_SIZE_128, KEY_SIZE_192, KEY_SIZE_256, MAC_ALGORITHM_HMAC_MD5, MAC_ALGORITHM_HMAC_SHA1, MAC_ALGORITHM_HMAC_SHA224, MAC_ALGORITHM_HMAC_SHA256, MAC_ALGORITHM_HMAC_SHA3_224, MAC_ALGORITHM_HMAC_SHA3_256, MAC_ALGORITHM_HMAC_SHA3_384, MAC_ALGORITHM_HMAC_SHA3_512, MAC_ALGORITHM_HMAC_SHA384, MAC_ALGORITHM_HMAC_SHA512, MAC_ALGORITHM_HMAC_SHA512_224, MAC_ALGORITHM_HMAC_SHA512_256, MAC_KEY_SIZE_128, MAC_KEY_SIZE_160

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractBlockCipherParameters()` Initializes the AbstractBlockCipherParameters.
`protected`	`AbstractBlockCipherParameters(TextEncoder textEncoder)` Initializes the AbstractBlockCipherParameters with a `TextEncoder` which is used to decode the key when set as a string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AlgorithmParameterSpec`	`createParameterSpec(byte[] parameterData)` Generates an algorithm-specific `AlgorithmParameterSpec` object used to hold algorithm parameters such as an initialization vector or salt.
`String`	`getBlockMode()` Returns the blockMode value.
`int`	`getBlockSize()` Returns the blockSize value in bytes.
`int`	`getDefaultBlockSize()` Returns the defaultBlockSize in bytes.
`int`	`getGcmTagLen()` Returns the GCM block mode Authentication Tag length in bits.
`String`	`getPadding()` Returns the padding value.
`AlgorithmParameterSpec`	`getParameterSpec(byte[] messageData)` Returns an algorithm-specific `AlgorithmParameterSpec` object used to hold algorithm parameters such as an initialization vector or salt from the enciphered message.
`int`	`getParameterSpecSize()` Returns the algorithm parameter data size.
`String`	`getTransformation()` Returns the transformation value.
`T`	`setBlockMode(String blockMode)` Sets the blockMode value.
`T`	`setBlockSize(int blockSize)` Sets the blockSize value in bytes.
`T`	`setGcmTagLen(int gcmTagLen)` Sets the GCM block mode Authentication Tag length in bits.
`T`	`setPadding(String padding)` Sets the padding value.

Methods inherited from class org.antfarmer.ejce.parameter.AbstractSymmetricAlgorithmParameters
generateKeyData, getDecryptionKey, getKey, loadKey, setKey, setKey, setKey, setKeyLoader

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.antfarmer.ejce.parameter.AlgorithmParameters
generateParameterSpecData, getAlgorithm, getEncryptionKey, getKeySize, getMacAlgorithm, getMacKey, getMacKeySize, getProvider, getProviderName, setKeySize, setMacAlgorithm, setMacKey, setMacKey, setMacKey, setMacKeyLoader, setMacKeySize, setProvider, setProviderName, setSaltGenerator, setSaltMatcher

- Field Detail
  - DEFAULT_BLOCK_SIZE
```
public static final int DEFAULT_BLOCK_SIZE
```
    Default block cipher size in bytes. The default value is 8.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PARAM_SPEC_SIZE_GCM
```
public static final int DEFAULT_PARAM_SPEC_SIZE_GCM
```
    Default IV (parameter specification) size in bytes for GCM block mode. The default value is 12.
    
    See Also:
    
    Constant Field Values
  - BLOCK_MODE_CBC
```
public static final String BLOCK_MODE_CBC
```
    Cipher Block Chaining Block Mode, as defined in FIPS PUB 81.
    
    See Also:
    
    Constant Field Values
  - BLOCK_MODE_CCM
```
public static final String BLOCK_MODE_CCM
```
    Counter/CBC Mode, as defined in NIST Special Publication SP 800-38C.
    
    See Also:
    
    Constant Field Values
  - BLOCK_MODE_CFB
```
public static final String BLOCK_MODE_CFB
```
    Cipher Feedback Block Mode, as defined in FIPS PUB 81.
    
    See Also:
    
    Constant Field Values
  - BLOCK_MODE_CTR
```
public static final String BLOCK_MODE_CTR
```
    A simplification of OFB, Counter mode updates the input block as a counter.
    
    See Also:
    
    Constant Field Values
  - BLOCK_MODE_CTS
```
public static final String BLOCK_MODE_CTS
```
    Cipher Text Stealing, as described in Bruce Schneier's book Applied Cryptography-Second Edition, John Wiley and Sons, 1996.
    
    See Also:
    
    Constant Field Values
  - BLOCK_MODE_ECB
```
public static final String BLOCK_MODE_ECB
```
    Electronic Codebook Block Mode, as defined in: The National Institute of Standards and Technology (NIST) Federal Information Processing Standard (FIPS) PUB 81, "DES Modes of Operation," U.S. Department of Commerce, December 1980.
    
    See Also:
    
    Constant Field Values
  - BLOCK_MODE_GCM
```
public static final String BLOCK_MODE_GCM
```
    Galois/Counter Mode, as defined in NIST Special Publication SP 800-38D.
    
    See Also:
    
    Constant Field Values
  - BLOCK_MODE_OFB
```
public static final String BLOCK_MODE_OFB
```
    Output Feedback Block Mode, as defined in FIPS PUB 81.
    
    See Also:
    
    Constant Field Values
  - BLOCK_MODE_PCBC
```
public static final String BLOCK_MODE_PCBC
```
    Propagating Cipher Block Chaining Block Mode, as defined by Kerberos V4.
    
    See Also:
    
    Constant Field Values
  - GCM_AUTH_TAG_LEN_96
```
public static final int GCM_AUTH_TAG_LEN_96
```
    96-bit Authentication Tag length for GCM block mode ciphers, as defined in NIST Special Publication SP 800-38D.
    
    See Also:
    
    Constant Field Values
  - GCM_AUTH_TAG_LEN_104
```
public static final int GCM_AUTH_TAG_LEN_104
```
    104-bit Authentication Tag length for GCM block mode ciphers, as defined in NIST Special Publication SP 800-38D.
    
    See Also:
    
    Constant Field Values
  - GCM_AUTH_TAG_LEN_112
```
public static final int GCM_AUTH_TAG_LEN_112
```
    112-bit Authentication Tag length for GCM block mode ciphers, as defined in NIST Special Publication SP 800-38D.
    
    See Also:
    
    Constant Field Values
  - GCM_AUTH_TAG_LEN_120
```
public static final int GCM_AUTH_TAG_LEN_120
```
    120-bit Authentication Tag length for GCM block mode ciphers, as defined in NIST Special Publication SP 800-38D.
    
    See Also:
    
    Constant Field Values
  - GCM_AUTH_TAG_LEN_128
```
public static final int GCM_AUTH_TAG_LEN_128
```
    128-bit Authentication Tag length for GCM block mode ciphers, as defined in NIST Special Publication SP 800-38D.
    
    See Also:
    
    Constant Field Values
  - PADDING_NONE
```
public static final String PADDING_NONE
```
    No padding.
    
    See Also:
    
    Constant Field Values
  - PADDING_PKCS5
```
public static final String PADDING_PKCS5
```
    The padding scheme described in: RSA Laboratories, "PKCS #5: Password-Based Encryption Standard," version 1.5, November 1993.
    
    See Also:
    
    Constant Field Values
  - PADDING_PKCS7
```
public static final String PADDING_PKCS7
```
    The padding scheme described in: RSA Laboratories, "PKCS #7: Cryptographic Message Syntax," Version 1.5, November 1993.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractBlockCipherParameters
```
protected AbstractBlockCipherParameters()
```
    Initializes the AbstractBlockCipherParameters.
  - AbstractBlockCipherParameters
```
protected AbstractBlockCipherParameters(TextEncoder textEncoder)
```
    Initializes the AbstractBlockCipherParameters with a TextEncoder which is used to decode the key when set as a string.
    
    Parameters:
    
    textEncoder - the TextEncoder
- Method Detail
  - getDefaultBlockSize
```
public int getDefaultBlockSize()
```
    Returns the defaultBlockSize in bytes.
    
    Returns:
    
    the defaultBlockSize
  - getTransformation
```
public String getTransformation()
```
    Returns the transformation value.
    
    Returns:
    
    the transformation.
  - getBlockMode
```
public String getBlockMode()
```
    Returns the blockMode value.
    
    Returns:
    
    the blockMode.
  - setBlockMode
```
public T setBlockMode(String blockMode)
```
    Sets the blockMode value.
    
    Parameters:
    
    blockMode - The blockMode to set.
    
    Returns:
    
    this concrete class
  - getParameterSpecSize
```
public int getParameterSpecSize()
```
    Returns the algorithm parameter data size.
    
    Returns:
    
    the algorithm parameter data size.
  - createParameterSpec
```
public AlgorithmParameterSpec createParameterSpec(byte[] parameterData)
```
    Generates an algorithm-specific AlgorithmParameterSpec object used to hold algorithm parameters such as an initialization vector or salt.
    
    Specified by:
    
    createParameterSpec in interface AlgorithmParameters<T extends AbstractBlockCipherParameters<T>>
    
    Overrides:
    
    createParameterSpec in class AbstractAlgorithmParameters<T extends AbstractBlockCipherParameters<T>>
    
    Parameters:
    
    parameterData - the data for the AlgorithmParameterSpec
    
    Returns:
    
    an algorithm-specific AlgorithmParameterSpec object
  - getParameterSpec
```
public AlgorithmParameterSpec getParameterSpec(byte[] messageData)
                                        throws GeneralSecurityException
```
    Returns an algorithm-specific AlgorithmParameterSpec object used to hold algorithm parameters such as an initialization vector or salt from the enciphered message.
    
    Parameters:
    
    messageData - the message data byte array which holds the parameter data
    
    Returns:
    
    an algorithm-specific AlgorithmParameterSpec object
    
    Throws:
    
    GeneralSecurityException - GeneralSecurityException
  - getBlockSize
```
public int getBlockSize()
```
    Returns the blockSize value in bytes.
    
    Returns:
    
    the blockSize.
  - setBlockSize
```
public T setBlockSize(int blockSize)
```
    Sets the blockSize value in bytes.
    
    Parameters:
    
    blockSize - The blockSize to set.
    
    Returns:
    
    this concrete class
  - getGcmTagLen
```
public int getGcmTagLen()
```
    Returns the GCM block mode Authentication Tag length in bits.
    
    Returns:
    
    the gcmTagLen
  - setGcmTagLen
```
public T setGcmTagLen(int gcmTagLen)
```
    Sets the GCM block mode Authentication Tag length in bits.
    
    Parameters:
    
    gcmTagLen - the gcmTagLen to set
    
    Returns:
    
    the concrete class
  - getPadding
```
public String getPadding()
```
    Returns the padding value.
    
    Returns:
    
    the padding.
  - setPadding
```
public T setPadding(String padding)
```
    Sets the padding value.
    
    Parameters:
    
    padding - The padding to set.
    
    Returns:
    
    this concrete class

Class AbstractBlockCipherParameters<T extends AbstractBlockCipherParameters<T>>

Field Summary

Fields inherited from class org.antfarmer.ejce.parameter.AbstractAlgorithmParameters

Constructor Summary

Method Summary

Methods inherited from class org.antfarmer.ejce.parameter.AbstractSymmetricAlgorithmParameters

Methods inherited from class org.antfarmer.ejce.parameter.AbstractAlgorithmParameters

Methods inherited from class java.lang.Object

Methods inherited from interface org.antfarmer.ejce.parameter.AlgorithmParameters

Field Detail

DEFAULT_BLOCK_SIZE

DEFAULT_PARAM_SPEC_SIZE_GCM

BLOCK_MODE_CBC

BLOCK_MODE_CCM

BLOCK_MODE_CFB

BLOCK_MODE_CTR

BLOCK_MODE_CTS

BLOCK_MODE_ECB

BLOCK_MODE_GCM

BLOCK_MODE_OFB

BLOCK_MODE_PCBC

GCM_AUTH_TAG_LEN_96

GCM_AUTH_TAG_LEN_104

GCM_AUTH_TAG_LEN_112

GCM_AUTH_TAG_LEN_120

GCM_AUTH_TAG_LEN_128

PADDING_NONE

PADDING_PKCS5

PADDING_PKCS7

Constructor Detail

AbstractBlockCipherParameters

AbstractBlockCipherParameters

Method Detail

getDefaultBlockSize

getTransformation

getBlockMode

setBlockMode

getParameterSpecSize

createParameterSpec

getParameterSpec

getBlockSize

setBlockSize

getGcmTagLen

setGcmTagLen

getPadding

setPadding