EntrustSymmEncConfig ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- com.entrust.toolkit.x509.policies.EntrustSymmEncConfig

public final class EntrustSymmEncConfig
extends java.lang.Object

Configuration information for a symmetric encryption algorithm.

Contains all the information necessary to configure a symmetric encryption operation. This class also provides conversions to/from name (string) representation. This allows for easy display of symmetric encryption algorithm configuration information.

A symmetric encryption algorithm configuration contains all of the following information:

Name: A unique string identifier for this configuration (e.g. "AES-CBC-256").
Algorithm OID: The object identifier representation of this configuration (e.g. id-aes128-CBC)
Key Length: The length (in bits) of the symmetric key used with this algorithm (e.g. 256).
Algorithm parameters: The algorithm parameters used with this algorithm when performing an encryption operation (e.g. none). Algorithm parameters are optional and only present for certain algorithms.
Bits of security: The level of security (in bits) provided by this algorithm (e.g. 256)

The following symmetric encryption algorithm configurations are currently supported:

Symmetric Encryption Algorithm Configurations
Symmetric Encryption Algorithm Configuration	Name	Aliases
`AES_CBC_128`	AES-CBC-128	AES-128
`AES_CBC_192`	AES-CBC-192	AES-192
`AES_CBC_256`	AES-CBC-256	AES-256, AES
`AES_GCM_128`	AES-GCM-128
`AES_GCM_192`	AES-GCM-192
`AES_GCM_256`	AES-GCM-256
`CAST5_CBC_80`	CAST5-CBC-80	CAST5-80
`CAST5_CBC_128`	CAST5-CBC-128	CAST5-128
`DES_CBC_64`	DES-CBC-64	DES
`TRIPLEDES_CBC_192`	TRIPLEDES-CBC-192	TRIPLEDES

Since:: 8.0

Field Summary

Fields
Modifier and Type	Field and Description
`static EntrustSymmEncConfig`	`AES_CBC_128` Identifies the "AES-CBC-128" encryption algorithm configuration.
`static EntrustSymmEncConfig`	`AES_CBC_192` Identifies the "AES-CBC-192" encryption algorithm configuration.
`static EntrustSymmEncConfig`	`AES_CBC_256` Identifies the "AES-CBC-256" encryption algorithm configuration.
`static EntrustSymmEncConfig`	`AES_GCM_128` Identifies the "AES-GCM-128" encryption algorithm configuration.
`static EntrustSymmEncConfig`	`AES_GCM_192` Identifies the "AES-GCM-192" encryption algorithm configuration.
`static EntrustSymmEncConfig`	`AES_GCM_256` Identifies the "AES-GCM-256" encryption algorithm configuration.
`static EntrustSymmEncConfig`	`CAST5_CBC_128` Identifies the "CAST5-CBC-128" encryption algorithm configuration.
`static EntrustSymmEncConfig`	`CAST5_CBC_80` Identifies the "CAST5-CBC-80" encryption algorithm configuration.
`static EntrustSymmEncConfig`	`DES_CBC_64` Identifies the "DES-CBC" encryption algorithm configuration.
`static EntrustSymmEncConfig`	`TRIPLEDES_CBC_192` Identifies the "TRIPLEDES-CBC-192" encryption algorithm configuration.

Method Summary

Methods
Modifier and Type	Method and Description
`ObjectID`	`getAlgorithmOid()` Gets the symmetric encryption algorithm object identifier associated with this symmetric encryption algorithm configuration.
`java.security.spec.AlgorithmParameterSpec`	`getAlgorithmParams()` Gets the algorithm parameters associated with this symmetric encryption algorithm configuration.
`int`	`getBitsOfSecurity()` Gets the bits of security assigned to this symmetric encryption algorithm configuration.
`static EntrustSymmEncConfig`	`getInstance(AlgorithmID symmEncAlgorithmId, int keyLengthBits)` Determines the symmetric encryption algorithm configuration by examining the algorithm object identifier and length of the key being used in a symmetric encryption/decryption operation.
`static EntrustSymmEncConfig`	`getInstance(java.lang.String name)` Parses a symmetric encryption algorithm configuration from string name representation.
`int`	`getKeyLengthBits()` Gets the key length (in bits) of the symmetric key associated with this symmetric encryption algorithm configuration.
`java.lang.String`	`getName()` Gets the name of this symmetric encryption algorithm configuration.
`static java.lang.String`	`getSymmEncConfigString(AlgorithmID symmEncAlgorithmId, int keyLengthBits)` Returns a string representation of the symmetric encryption algorithm configuration identified by the provided algorithm identifier and key length.
`boolean`	`isAllowed()` Determines whether or not use of the symmetric encryption algorithm configuration is permitted by the J2SE's jurisdiction policy files.
`java.lang.String`	`toString()` Returns the string representation of this object which is the name of this symmetric encryption algorithm configuration.

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

- Field Detail
  - AES_CBC_128
```
public static final EntrustSymmEncConfig AES_CBC_128
```
    Identifies the "AES-CBC-128" encryption algorithm configuration.
    - Name: "AES-CBC-128"
    - Algorithm OID: 2.16.840.1.101.3.4.1.2 (id-aes128-CBC)
    - Key Length: 128-bits
    - Algorithm Parameters: none
    - Bits of Security: 128-bits
  - AES_CBC_192
```
public static final EntrustSymmEncConfig AES_CBC_192
```
    Identifies the "AES-CBC-192" encryption algorithm configuration.
    - Name: "AES-CBC-192"
    - Algorithm OID: 2.16.840.1.101.3.4.1.22 (id-aes192-CBC)
    - Key Length: 192-bits
    - Algorithm Parameters: none
    - Bits of Security: 192-bits
  - AES_CBC_256
```
public static final EntrustSymmEncConfig AES_CBC_256
```
    Identifies the "AES-CBC-256" encryption algorithm configuration.
    - Name: "AES-CBC-256"
    - Algorithm OID: 2.16.840.1.101.3.4.1.42 (id-aes256-CBC)
    - Key Length: 256-bits
    - Algorithm Parameters: none
    - Bits of Security: 256-bits
  - AES_GCM_128
```
public static final EntrustSymmEncConfig AES_GCM_128
```
    Identifies the "AES-GCM-128" encryption algorithm configuration.
    - Name: "AES-GCM-128"
    - Algorithm OID: 2.16.840.1.101.3.4.1.6 (id-aes128-GCM)
    - Key Length: 128-bits
    - Algorithm Parameters: GCMParameterSpec (with parameter values: IV length = 12, AT length = 16)
    - Bits of Security: 128-bits
  - AES_GCM_192
```
public static final EntrustSymmEncConfig AES_GCM_192
```
    Identifies the "AES-GCM-192" encryption algorithm configuration.
    - Name: "AES-GCM-192"
    - Algorithm OID: 2.16.840.1.101.3.4.1.26 (id-aes192-GCM)
    - Key Length: 192-bits
    - Algorithm Parameters: GCMParameterSpec (with parameter values: IV length = 12, AT length = 16)
    - Bits of Security: 192-bits
  - AES_GCM_256
```
public static final EntrustSymmEncConfig AES_GCM_256
```
    Identifies the "AES-GCM-256" encryption algorithm configuration.
    - Name: "AES-GCM-256"
    - Algorithm OID: 2.16.840.1.101.3.4.1.46 (id-aes256-GCM)
    - Key Length: 256-bits
    - Algorithm Parameters: GCMParameterSpec (with parameter values: IV length = 12, AT length = 16)
    - Bits of Security: 256-bits
  - CAST5_CBC_80
```
public static final EntrustSymmEncConfig CAST5_CBC_80
```
    Identifies the "CAST5-CBC-80" encryption algorithm configuration.
    - Name: "CAST5-CBC-80"
    - Algorithm OID: 1.2.840.113533.7.66.10 (cast5CBC)
    - Key Length: 80-bits
    - Algorithm Parameters: none
    - Bits of Security: 80-bits
  - CAST5_CBC_128
```
public static final EntrustSymmEncConfig CAST5_CBC_128
```
    Identifies the "CAST5-CBC-128" encryption algorithm configuration.
    - Name: "CAST5-CBC-128"
    - Algorithm OID: 1.2.840.113533.7.66.10 (cast5CBC)
    - Key Length: 128-bits
    - Algorithm Parameters: none
    - Bits of Security: 128-bits
  - DES_CBC_64
```
public static final EntrustSymmEncConfig DES_CBC_64
```
    Identifies the "DES-CBC" encryption algorithm configuration.
    - Name: "DES-CBC-64"
    - Algorithm OID: 1.3.14.3.2.7 (desCBC)
    - Key Length: 64-bits
    - Algorithm Parameters: none
    - Bits of Security: 56-bits
  - TRIPLEDES_CBC_192
```
public static final EntrustSymmEncConfig TRIPLEDES_CBC_192
```
    Identifies the "TRIPLEDES-CBC-192" encryption algorithm configuration.
    - Name: "TRIPLEDES-CBC-192"
    - Algorithm OID: 1.2.840.113549.3.7 (des-EDE3-CBC)
    - Key Length: 192-bits
    - Algorithm Parameters: none
    - Bits of Security: 112-bits
- Method Detail
  - getInstance
```
public static EntrustSymmEncConfig getInstance(java.lang.String name)
```
    Parses a symmetric encryption algorithm configuration from string name representation.
    All algorithms listed in the class documentation of EntrustSymmEncConfig are supported by this API.
    
    Parameters:
    name - name of the symmetric encryption algorithm configuration
    
    Returns:
    the symmetric encryption algorithm configuration (parsed from string representation)
    
    Throws:
    
    java.lang.IllegalArgumentException - if the provided name is invalid (invalid string name or alias for a symmetric encryption algorithm configuration)
  - getInstance
```
public static EntrustSymmEncConfig getInstance(AlgorithmID symmEncAlgorithmId,
                               int keyLengthBits)
```
    Determines the symmetric encryption algorithm configuration by examining the algorithm object identifier and length of the key being used in a symmetric encryption/decryption operation.
    All algorithms listed in the class documentation of EntrustSymmEncConfig are supported by this API.
    
    This API is useful when decrypting an encrypted value. At decryption time only an algorithm identifier and symmetric key are normally available (i.e. a symmetric encryption algorithm configuration name is not encoded in an encrypted value structure). This allows the recipient to determine the symmetric encryption algorithm configuration being used simply by examining an encrypted value structure.
    
    Note: The key length is only used when the algorithm object identifier does not indicate the key length (e.g. the CAST5-CBC object identifier does not indicate a key length); otherwise the key length is ignored.
    
    Parameters:
    symmEncAlgorithmId - the algorithm identifier of the symmetric encryption algorithm configuration
    keyLengthBits - the length of the symmetric key in bits
    
    Returns:
    the symmetric encryption algorithm configuration used to encrypt/decrypt the encrypted value
    
    Throws:
    
    java.lang.IllegalArgumentException - if the algorithm identifier and key do not correspond to a supported symmetric encryption algorithm configuration
  - getSymmEncConfigString
```
public static java.lang.String getSymmEncConfigString(AlgorithmID symmEncAlgorithmId,
                                      int keyLengthBits)
```
    Returns a string representation of the symmetric encryption algorithm configuration identified by the provided algorithm identifier and key length.
    The string representation is the symmetric encryption algorithm configuration name for supported symmetric encryption algorithms (see getName()) or the string 'UNSUPPORTED (oid), x-bit' for unsupported symmetric encryption algorithms (where 'oid' is the object identifier from the algorithm identifier, and 'x' is the key size).
    
    All symmetric encryption algorithm configurations supported by the getInstance(AlgorithmID, int) are also supported by this API. This API was designed for use in exception messages and log messages.
    
    Parameters:
    symmEncAlgorithmId - the algorithm identifier of the symmetric encryption algorithm configuration
    keyLengthBits - the length of the symmetric key in bits
    
    Returns:
    string representation of the symmetric encryption algorithm configuration
  - getName
```
public java.lang.String getName()
```
    Gets the name of this symmetric encryption algorithm configuration.
    
    Returns:
    the configuration name
  - getAlgorithmOid
```
public ObjectID getAlgorithmOid()
```
    Gets the symmetric encryption algorithm object identifier associated with this symmetric encryption algorithm configuration.
    
    Returns:
    the algorithm object identifier
  - getKeyLengthBits
```
public int getKeyLengthBits()
```
    Gets the key length (in bits) of the symmetric key associated with this symmetric encryption algorithm configuration.
    
    Returns:
    the configuration name
  - getAlgorithmParams
```
public java.security.spec.AlgorithmParameterSpec getAlgorithmParams()
```
    Gets the algorithm parameters associated with this symmetric encryption algorithm configuration.
    Algorithm parameters are optional; some symmetric encryption algorithm configurations will not contain algorithm parameters
    
    Returns:
    the algorithm parameters; null if there are no algorithm parameters
  - getBitsOfSecurity
```
public int getBitsOfSecurity()
```
    Gets the bits of security assigned to this symmetric encryption algorithm configuration.
    
    Returns:
    the bits of security
  - toString
```
public java.lang.String toString()
```
    Returns the string representation of this object which is the name of this symmetric encryption algorithm configuration.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the string representation of this object
  - isAllowed
```
public boolean isAllowed()
```
    Determines whether or not use of the symmetric encryption algorithm configuration is permitted by the J2SE's jurisdiction policy files.
    
    Returns:
    true if use of the algorithm is permitted; false otherwise
    
    Throws:
    
    EntrustProviderMissingException - if the Entrust CSP has not been installed
    
    EntrustProviderTamperedException - if the Entrust CSP has been tampered
    Since:
    
    8.0

Class EntrustSymmEncConfig

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AES_CBC_128

AES_CBC_192

AES_CBC_256

AES_GCM_128

AES_GCM_192

AES_GCM_256

CAST5_CBC_80

CAST5_CBC_128

DES_CBC_64

TRIPLEDES_CBC_192

Method Detail

getInstance

getInstance

getSymmEncConfigString

getName

getAlgorithmOid

getKeyLengthBits

getAlgorithmParams

getBitsOfSecurity

toString

isAllowed