com.rsa.certj.crmf

Class Authenticator

java.lang.Object
  |
  +--com.rsa.certj.crmf.Control
        |
        +--com.rsa.certj.crmf.Authenticator

All Implemented Interfaces:

Cloneable, Serializable

public class Authenticator

extends Control

implements Cloneable, Serializable

This class holds, encodes, and decodes the Authenticator control. An Authenticator control contains information used in an ongoing basis to establish a non-cryptographic check of identity in communication with the CA. Examples include: mother's maiden name, last four digits of social security number, or other knowledge-based information shared with the subscriber's CA; a hash of such information; or other information produced for this purpose. The value for an authenticator control may be generated by the subscriber or by the CA.

The authenticator control is typically used for initial as well as subsequent certification requests.

In some instances of use the value for Authenticator control could be a text string or a numeric quantity such as a random number. The value in the latter case could be encoded either as a binary quantity or as a text string representation of the binary quantity. To ensure a uniform encoding of values regardless of the nature of the quantity, the encoding of authenticator must be UTF8.

 authenticator ::= UTF8String

Copyright © RSA Security Inc., 2000-2001. All rights reserved.

See Also

Serialized Form

Fields inherited from class com.rsa.certj.crmf.Control

AUTHENTICATOR, NON_STANDARD, OLD_CERT_ID, PKI_ARCHIVE_OPTIONS, PKI_PUBLICATION_INFO, PROTOCOL_ENCR_KEY, REG_TOKEN

Constructor Summary

Authenticator()

Constructs an empty Authenticator object.

Method Summary

Object	clone() Gets a deeper clone than the default.
boolean	equals(Object obj) Returns true if this object and obj contain the same authenticator; otherwise, false.
byte[]	getValue() Gets the value of the Authenticator control.
void	setValue(byte[] value, int offset, int len) Sets the value of the Authenticator control.

Methods inherited from class com.rsa.certj.crmf.Control

compareOID, derEncodeControlLen, getControlType, getControlTypeString, getDEREncoding, getDERLen, getInstance, getInstance, getNextBEROffset, getOID, isControlType, setEnvironment

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Authenticator

public Authenticator()

Constructs an empty Authenticator object.

Method Detail

setValue

public void setValue(byte[] value,
                     int offset,
                     int len)
              throws CRMFException

Sets the value of the Authenticator control.

Parameters

	value		Information used in an ongoing basis to establish a non-cryptographic check of identity during communication with the CA.
	offset		The offset into value where the value begins.
	len		The length of the value

Throws

CRMFException - If the passed in value is null.

getValue

public byte[] getValue()

Gets the value of the Authenticator control.

Returns

Information used in an ongoing basis to establish a non-cryptographic check of identity during communication with the CA.

clone

public Object clone()
             throws CloneNotSupportedException

Gets a deeper clone than the default.

Overrides

clone in class Control

Returns

A copy of this object in its current state

Throws

CloneNotSupportedException - If the cloning operation is not successful.

equals

public boolean equals(Object obj)

Returns true if this object and obj contain the same authenticator; otherwise, false.

Overrides

equals in class Control

Parameters

obj

The instance of the Authenticator object.

Returns

A boolean that indicates whether these objects are equal.