com.entrust.toolkit.asn1.cmpv1.gkm

Class EntrustProofOfRA

java.lang.Object

com.entrust.toolkit.asn1.cmpv1.gkm.EntrustProofOfRA

All Implemented Interfaces:

ASN1Type

public class EntrustProofOfRA
extends java.lang.Object
implements ASN1Type

This class implements the ASN.1 structure for EntrustProofOfRA, as defined by Entrust.

 -- EntrustProofOfRASyntax ::= SIGNED {EntrustProofOfRAInfo}
 EntrustProofOfRASyntax ::= SEQUENCE {
     entrustProofOfRAInfo   EntrustProofOfRAInfo,
     algorithm              AlgorithmIdentifier,
     signature              BIT STRING   -- signature is on
                                         -- entrustProofOfRAInfo encoding
 }
 
 entrustProofOfRA OBJECT-TYPE
     SYNTAX EntrustProofOfRASyntax
         ACCESS read-write
         STATUS mandatory
         ::= { 2 16 840 1 114027 50 15  }
 

Since:

7.1sp1

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectID	oid The object identifier for a EntrustProofOfRA.

Constructor Summary

Constructors

Constructor and Description
EntrustProofOfRA(ASN1Object obj) A constructor; create a new EntrustProofOfRA by decoding the provided ASN1Object.
EntrustProofOfRA(EntrustProofOfRAInfo proofOfRAInfo, AlgorithmID algorithm, byte[] signature) A constructor; creates a new EntrustProofOfRA by constructing it from the provided components.
EntrustProofOfRA(EntrustProofOfRAInfo proofOfRAInfo, java.security.PrivateKey raSigningKey, AlgorithmID signatureAlg) A constructor; creates a new EntrustProofOfRA by generating a signature over the provided EntrustProofOfRAInfo structure the RA signing key and the indicated signature algorithm.

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(ASN1Object obj) Decodes an EntrustProofOfRA from an ASN1Object.
AlgorithmID	getAlgorithm() Returns the signature algorithm.
EntrustProofOfRAInfo	getProofOfRAInfo() Returns the proof of RA information that was signed.
byte[]	getSignature() Returns the signature.
ASN1Object	toASN1Object() Encodes this EntrustProofOfRA object as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this EntrustProofOfRA object.
boolean	verify(java.security.cert.X509Certificate raVerificationCert) Verifies the signature using the indicated certificate.

Methods inherited from class java.lang.Object

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

Field Detail

oid

public static final ObjectID oid

The object identifier for a EntrustProofOfRA.

Constructor Detail

EntrustProofOfRA

public EntrustProofOfRA(EntrustProofOfRAInfo proofOfRAInfo,
                java.security.PrivateKey raSigningKey,
                AlgorithmID signatureAlg)
                 throws java.security.InvalidKeyException,
                        java.security.SignatureException,
                        java.security.NoSuchAlgorithmException

A constructor; creates a new EntrustProofOfRA by generating a signature over the provided EntrustProofOfRAInfo structure the RA signing key and the indicated signature algorithm.

Parameters:

proofOfRAInfo - the proof of RA information to be signed

raSigningKey - the RA signing key used to create the signature

signatureAlg - the signature algorithm to be used

Throws:

java.security.NoSuchAlgorithmException - if an implementation of the specified signature algorithm is not available through the JCA

java.security.InvalidKeyException - if the RA signing key is inappropriate for the signature algorithm that was selected

java.security.SignatureException - if an error occurs while generating the signature

java.lang.IllegalArgumentException - if any of the parameters are null

EntrustProofOfRA

public EntrustProofOfRA(EntrustProofOfRAInfo proofOfRAInfo,
                AlgorithmID algorithm,
                byte[] signature)

A constructor; creates a new EntrustProofOfRA by constructing it from the provided components.

Parameters:

proofOfRAInfo - the EntrustProofOfRASyntax.entrustProofOfRAInfo component

algorithm - the EntrustProofOfRASyntax.algorithm component

signature - the EntrustProofOfRASyntax.signature component

EntrustProofOfRA

public EntrustProofOfRA(ASN1Object obj)
                 throws CodingException

A constructor; create a new EntrustProofOfRA by decoding the provided ASN1Object.

The ASN1Object must be an EntrustProofOfRASyntax structure.

Parameters:

obj - the ASN.1 representation of an EntrustProofOfRASyntax structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getProofOfRAInfo

public EntrustProofOfRAInfo getProofOfRAInfo()

Returns the proof of RA information that was signed.

Returns:

the proof of RA information

getAlgorithm

public AlgorithmID getAlgorithm()

Returns the signature algorithm.

Returns:

the signature algorithm

getSignature

public byte[] getSignature()

Returns the signature.

Returns:

the signature

verify

public boolean verify(java.security.cert.X509Certificate raVerificationCert)
               throws java.security.NoSuchAlgorithmException,
                      java.security.InvalidKeyException,
                      java.security.SignatureException

Verifies the signature using the indicated certificate.

Parameters:

raVerificationCert - the RA verification certificate

Returns:

true if the signature verifies successfully, false otherwise (data may have been tampered)

Throws:

java.security.NoSuchAlgorithmException - if an implementation of the signature algorithm is not available through the JCA

java.security.InvalidKeyException - if the RA verification certificate contains a public key that is inappropriate for the signature algorithm

java.security.SignatureException - if an error occurs while verifying the signature (signature may have been tampered)

java.lang.IllegalArgumentException - if the RA verification certificate is null

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes an EntrustProofOfRA from an ASN1Object. The ASN1Object must an EntrustProofOfRASyntax structure.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of an EntrustProofOfRASyntax structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this EntrustProofOfRA object as an ASN1Object.

Specified by:

toASN1Object in interface ASN1Type

Returns:

an ASN.1 representation of the EntrustProofOfRASyntax structure

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

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