com.entrust.toolkit.archive

Class PemOptions

java.lang.Object

com.entrust.toolkit.archive.PemOptions

public class PemOptions
extends java.lang.Object

This class is a simple data structure used to specify the way a PEM message or Entrust Archive is protected. It controls the following options:

• Whether or not the message is encrypted
• If the message is encrypted, the algorithm used to encrypt it
• Whether or not the message is signed
• Whether or not the message is to be compressed
• Whether or not the protected message should be Base64 encoded

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
PemOptions() Constructor for PemOptions.
PemOptions(PemOptions src) Copy Constructor for PemOptions.

Method Summary

Modifier and Type	Method and Description
AlgorithmID	getEncryptionAlgorithm() Returns the encryption algorithm.
int	getKeyLength() Returns the encryption key length
boolean	isBase64Encoded() Returns the Base64-encoded flag.
boolean	isCompressed() Returns the compressed flag.
boolean	isEncrypted() Returns the encrypted flag.
boolean	isSigned() Returns the signed flag.
void	setBase64Encoded(boolean isBase64Encoded) Sets the Base64 encoded flag
void	setCompressed(boolean isCompressed) Sets the compressed flag.
void	setEncrypted(boolean isEncrypted) Sets the encrypted flag.
void	setEncryptionAlgorithm(AlgorithmID encryptionAlgorithm, int keyLength) Sets the encryption algorithm.
void	setSigned(boolean isSigned) Sets the signed flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

PemOptions

public PemOptions()

Constructor for PemOptions. Initializes to the following:

• Encrypt: true
• Encryption algorithm: 256 bit AES in CBC mode
• Sign: true
• Compress: false
• Base64 encode: false

PemOptions

public PemOptions(PemOptions src)

Copy Constructor for PemOptions.

Parameters:

src - the options to copy

Method Detail

isBase64Encoded

public boolean isBase64Encoded()

Returns the Base64-encoded flag.

Returns:

the Base64-encoded flag

isCompressed

public boolean isCompressed()

Returns the compressed flag.

Returns:

the compressed flag

isEncrypted

public boolean isEncrypted()

Returns the encrypted flag.

Returns:

the encrypted flag

isSigned

public boolean isSigned()

Returns the signed flag.

Returns:

the signed flag

getEncryptionAlgorithm

public AlgorithmID getEncryptionAlgorithm()

Returns the encryption algorithm.

Returns:

an AlgorithmID representing the encryption algorithm. Note that this value does not include algorithm parameters.

getKeyLength

public int getKeyLength()

Returns the encryption key length

Returns:

the encryption key length

setBase64Encoded

public void setBase64Encoded(boolean isBase64Encoded)

Sets the Base64 encoded flag

Parameters:

isBase64Encoded - the value of the Base64 encoded flag

setCompressed

public void setCompressed(boolean isCompressed)

Sets the compressed flag.

Parameters:

isCompressed - the value of the compressed flag

setEncrypted

public void setEncrypted(boolean isEncrypted)

Sets the encrypted flag.

Parameters:

isEncrypted - the value of the encrypted flag

setSigned

public void setSigned(boolean isSigned)

Sets the signed flag.

Parameters:

isSigned - the value of the signed flag

setEncryptionAlgorithm

public void setEncryptionAlgorithm(AlgorithmID encryptionAlgorithm,
                                   int keyLength)
                            throws ArchiveAlgorithmException

Sets the encryption algorithm. For some algorithms the key length is implied by the AlgorithmID itself, in which case the key length passed in should be set to 0. This encryption algorithm can be one of:

• AlgorithmID.CipherAlgs.id_aes128_CBC, set key length to 0
• AlgorithmID.CipherAlgs.id_aes192_CBC, set key length to 0
• AlgorithmID.CipherAlgs.id_aes256_CBC, set key length to 0
• AlgorithmID.CipherAlgs.cast5CBC, set key length to 80 or 128
• AlgorithmID.CipherAlgs.cast3CBC, set key length to 40 or 64
• AlgorithmID.CipherAlgs.ideaCBC, set key length to 0
• AlgorithmID.CipherAlgs.desCBC, set key length to 0
• AlgorithmID.CipherAlgs.des_EDE3_CBC, set key length to 0
• AlgorithmID.CipherAlgs.rc2CBC, set key length to 40 or 128

Note: any algorithm parameters set in the encryption AlgorithmID are ignored.

Parameters:

encryptionAlgorithm - The encryption algorithm to set.

keyLength - The length of the key.

Throws:

ArchiveAlgorithmException - if the encryption algorithm is not valid, or the key length is not valid for the given algorithm

See Also:

AlgorithmID