com.entrust.toolkit.asn1.crmf

Class EncryptedValue

java.lang.Object

com.entrust.toolkit.asn1.crmf.EncryptedValue

All Implemented Interfaces:

ASN1Type

public class EncryptedValue
extends java.lang.Object
implements ASN1Type

This class implements the EncryptedValue structure as defined in the CRMF specification.

 EncryptedValue ::= SEQUENCE {
     intendedAlg   [0] AlgorithmIdentifier  OPTIONAL,
     -- the intended algorithm for which the value will be used
     symmAlg       [1] AlgorithmIdentifier  OPTIONAL,
     -- the symmetric algorithm used to encrypt the value
     encSymmKey    [2] BIT STRING           OPTIONAL,
     -- the (encrypted) symmetric key used to encrypt the value
     keyAlg        [3] AlgorithmIdentifier  OPTIONAL,
     -- algorithm used to encrypt the symmetric key
     valueHint     [4] OCTET STRING         OPTIONAL,
     -- a brief description or identifier of the encValue content
     -- (may be meaningful only to the sending entity, and used only
     -- if EncryptedValue might be re-examined by the sending entity
     -- in the future)
     encValue       BIT STRING
     -- the encrypted value itself
 }
 

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
EncryptedValue(ASN1Object obj) Creates an EncryptedValue object from an ASN1Object.
EncryptedValue(byte[] encValue) Creates a new EncryptedValue object with the specified component set.

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(ASN1Object obj) Decodes an EncryptedValue structure from an ASN1Object.
byte[]	getEncSymmKey() Returns the (encrypted) symmetric key used to encrypt the value, if it has been set; otherwise null is returned.
byte[]	getEncValue() Returns the encrypted value.
AlgorithmID	getIntendedAlg() Returns the intended algorithm for which the value will be used, if it has been set; otherwise null is returned.
AlgorithmID	getKeyAlg() Returns the algorithm used to encrypt the symmetric key, if it has been set; otherwise null is returned.
AlgorithmID	getSymmAlg() Returns the symmetric algorithm used to encrypt the value, if it has been set; otherwise null is returned.
byte[]	getValueHint() Returns a breif description or identifier of the encValue content, if it has been set; otherwise null is returned.
void	setEncSymmKey(byte[] encSymmKey) Sets the (encrypted) symmetric key used to encrypt the value.
void	setIntendedAlg(AlgorithmID intendedAlg) Sets the intended algorithm for which the value will be used.
void	setKeyAlg(AlgorithmID keyAlg) Sets the algorithm used to encrypt the symmetric key.
void	setSymmAlg(AlgorithmID symmAlg) Sets the symmetric algorithm used to encrypt the value.
void	setValueHint(byte[] valueHint) Sets a breif description or identifier for the content.
ASN1Object	toASN1Object() Encodes this EncryptedValue object as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this EncryptedValue object.

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptedValue

public EncryptedValue(byte[] encValue)

Creates a new EncryptedValue object with the specified component set.

Parameters:

encValue - the encrypted value

EncryptedValue

public EncryptedValue(ASN1Object obj)
               throws CodingException

Creates an EncryptedValue object from an ASN1Object.

Parameters:

obj - the ASN.1 representation of an EncryptedValue structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

setIntendedAlg

public void setIntendedAlg(AlgorithmID intendedAlg)

Sets the intended algorithm for which the value will be used.

Parameters:

intendedAlg - the intendedAlg component

setSymmAlg

public void setSymmAlg(AlgorithmID symmAlg)

Sets the symmetric algorithm used to encrypt the value.

Parameters:

symmAlg - the symmAlg component

setEncSymmKey

public void setEncSymmKey(byte[] encSymmKey)

Sets the (encrypted) symmetric key used to encrypt the value.

Parameters:

encSymmKey - the encSymmKey component

setKeyAlg

public void setKeyAlg(AlgorithmID keyAlg)

Sets the algorithm used to encrypt the symmetric key.

Parameters:

keyAlg - the keyAlg component

setValueHint

public void setValueHint(byte[] valueHint)

Sets a breif description or identifier for the content.

Parameters:

valueHint - the valueHint component

getIntendedAlg

public AlgorithmID getIntendedAlg()

Returns the intended algorithm for which the value will be used, if it has been set; otherwise null is returned.

Returns:

the intendedAlg component

getSymmAlg

public AlgorithmID getSymmAlg()

Returns the symmetric algorithm used to encrypt the value, if it has been set; otherwise null is returned.

Returns:

the symmAlg component

getEncSymmKey

public byte[] getEncSymmKey()

Returns the (encrypted) symmetric key used to encrypt the value, if it has been set; otherwise null is returned.

Returns:

the encSymmKey component

getKeyAlg

public AlgorithmID getKeyAlg()

Returns the algorithm used to encrypt the symmetric key, if it has been set; otherwise null is returned.

Returns:

the keyAlg component

getValueHint

public byte[] getValueHint()

Returns a breif description or identifier of the encValue content, if it has been set; otherwise null is returned.

Returns:

the valueHint component

getEncValue

public byte[] getEncValue()

Returns the encrypted value.

Returns:

the encValue component

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes an EncryptedValue structure from an ASN1Object.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of an EncryptedValue structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this EncryptedValue object as an ASN1Object.

Specified by:

toASN1Object in interface ASN1Type

Returns:

an ASN.1 representation of this object

toString

public java.lang.String toString()

Creates a text representation of the ASN.1 structure of this EncryptedValue object.

Overrides:

toString in class java.lang.Object

Returns:

a text representation of the ASN.1 structure of this object