Package org.mozilla.jss.pkix.crmf

Class ProofOfPossession

java.lang.Object

org.mozilla.jss.pkix.crmf.ProofOfPossession

All Implemented Interfaces:

ASN1Value

public class ProofOfPossession
extends Object
implements ASN1Value

CRMF ProofOfPossession:

 ProofOfPossession ::= CHOICE {
      raVerified          [0] NULL,
      signature           [1] POPOSigningKey,
      keyEncipherment     [2] POPOPrivKey,
      keyAgreement        [3] POPOPrivKey }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProofOfPossession.Template	A Template for decoding a ProofOfPossession.
static class	ProofOfPossession.Type	The type of ProofOfPossesion.

Field Summary

Fields

Modifier and Type	Field	Description
static ProofOfPossession.Type	KEY_AGREEMENT
static ProofOfPossession.Type	KEY_ENCIPHERMENT
private POPOPrivKey	keyAgreement
private POPOPrivKey	keyEncipherment
static ProofOfPossession.Type	RA_VERIFIED
private POPOSigningKey	signature
static ProofOfPossession.Type	SIGNATURE
private ProofOfPossession.Type	type

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ProofOfPossession()
private	ProofOfPossession(ProofOfPossession.Type type, POPOSigningKey signature, POPOPrivKey keyEncipherment, POPOPrivKey keyAgreement)

Method Summary

Modifier and Type	Method	Description
static ProofOfPossession	createKeyAgreement(POPOPrivKey keyAgreement)	Creates a new ProofOfPossesion with the given keyAgreement field.
static ProofOfPossession	createKeyEncipherment(POPOPrivKey keyEncipherment)	Creates a new ProofOfPossesion with the given keyEncipherment field.
static ProofOfPossession	createRaVerified()	Creates a new ProofOfPossesion with an raVerified field.
static ProofOfPossession	createSignature(POPOSigningKey signature)	Creates a new ProofOfPossesion with the given signature field.
void	encode(OutputStream ostream)	Write this value's DER encoding to an output stream using its own base tag.
void	encode(Tag implicitTag, OutputStream ostream)	Write this value's DER encoding to an output stream using an implicit tag.
POPOPrivKey	getKeyAgreement()	If type == KEY_AGREEMENT, returns the keyAgreement field.
POPOPrivKey	getKeyEncipherment()	If type == KEY_ENCIPHERMENT, returns the keyEncipherment field.
POPOSigningKey	getSignature()	If type == SIGNATURE, returns the signature field.
Tag	getTag()	Returns the base tag for this type, not counting any tags that may be imposed on it by its context.
ProofOfPossession.Type	getType()	Returns the type of ProofOfPossesion: RA_VERIFIED SIGNATURE KEY_ENCIPHERMENT KEY_AGREEMENT

Methods inherited from class java.lang.Object

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

Field Details

RA_VERIFIED

public static ProofOfPossession.Type RA_VERIFIED

SIGNATURE

public static ProofOfPossession.Type SIGNATURE

KEY_ENCIPHERMENT

public static ProofOfPossession.Type KEY_ENCIPHERMENT

KEY_AGREEMENT

public static ProofOfPossession.Type KEY_AGREEMENT

type

private ProofOfPossession.Type type

signature

private POPOSigningKey signature

keyEncipherment

private POPOPrivKey keyEncipherment

keyAgreement

private POPOPrivKey keyAgreement

Constructor Details

ProofOfPossession

private ProofOfPossession()

ProofOfPossession

private ProofOfPossession(ProofOfPossession.Type type,
 POPOSigningKey signature,
 POPOPrivKey keyEncipherment,
 POPOPrivKey keyAgreement)

Method Details

getType

public ProofOfPossession.Type getType()

Returns the type of ProofOfPossesion:

• RA_VERIFIED
• SIGNATURE
• KEY_ENCIPHERMENT
• KEY_AGREEMENT

getSignature

public POPOSigningKey getSignature()

If type == SIGNATURE, returns the signature field. Otherwise, returns null.

getKeyEncipherment

public POPOPrivKey getKeyEncipherment()

If type == KEY_ENCIPHERMENT, returns the keyEncipherment field. Otherwise, returns null.

getKeyAgreement

public POPOPrivKey getKeyAgreement()

If type == KEY_AGREEMENT, returns the keyAgreement field. Otherwise, returns null.

createRaVerified

public static ProofOfPossession createRaVerified()

Creates a new ProofOfPossesion with an raVerified field.

createSignature

public static ProofOfPossession createSignature(POPOSigningKey signature)

Creates a new ProofOfPossesion with the given signature field.

createKeyEncipherment

public static ProofOfPossession createKeyEncipherment(POPOPrivKey keyEncipherment)

Creates a new ProofOfPossesion with the given keyEncipherment field.

createKeyAgreement

public static ProofOfPossession createKeyAgreement(POPOPrivKey keyAgreement)

Creates a new ProofOfPossesion with the given keyAgreement field.

getTag

public Tag getTag()

Description copied from interface: ASN1Value

Returns the base tag for this type, not counting any tags that may be imposed on it by its context.

Specified by:

getTag in interface ASN1Value

Returns:

Base tag.

encode

public void encode(OutputStream ostream)
            throws IOException

Description copied from interface: ASN1Value

Write this value's DER encoding to an output stream using its own base tag.

Specified by:

encode in interface ASN1Value

Parameters:

ostream - Output stream.

Throws:

IOException - If an error occurred.

encode

public void encode(Tag implicitTag,
 OutputStream ostream)
            throws IOException

Description copied from interface: ASN1Value

Write this value's DER encoding to an output stream using an implicit tag.

Specified by:

encode in interface ASN1Value

Parameters:

implicitTag - Implicit tag.

ostream - Output stream.

Throws:

IOException - If an error occurred.