com.rsa.certj.cert.extensions

Class VeriSignTokenType

java.lang.Object
  |
  +--com.rsa.certj.cert.extensions.X509V3Extension
        |
        +--com.rsa.certj.cert.extensions.VeriSignTokenType

All Implemented Interfaces:

CertExtension, Cloneable, Serializable

public class VeriSignTokenType

extends X509V3Extension

implements Cloneable, Serializable, CertExtension

This class builds and holds the VeriSignTokenType extension. It defines hardware token characteristics.

The ASN.1 definition is as follows:

 id-pki OBJECT IDENTIFIER ::= {2 16 80 1 113733 1}
 id-extensions OBJECT IDENTIFIER ::= {id-pki extensions (6)}

 -- Description: Defines hardware token characteristics
 -- OID in decimal notation: (2.16.840.1.113733.1.6.8)
 -- Definition:
 id-tokentype OBJECT IDENTIFIER ::= {id-extensions tokentype(8)}
 TokenType ::= BIT STRING {
    private-key-storage(0), 
    generated-and-stored(1), 
    safe-export(2),
    non-exportable(3)}

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

See Also

Serialized Form

Field Summary

static int	GENERATED_AND_STORED This flag specifies generated and stored characteristics of the hardware token.
static int	NON_EXPORTABLE This flag specifies non-exportable characteristics of the hardware token.
static int	PRIVATE_KEY_STORAGE This flag specifies private key storage characteristics of the hardware token.
static int	SAFE_EXPORT This flag specifies safe export characteristics of the hardware token.
static int	TOKEN_TYPE_BITS This defines how many possible TokenType bits there are; in this implementation, it is defined as four bits.
static int	TOKEN_TYPE_MASK This defines at which bits we look; in this implementation, it is the four left-most bits.

Fields inherited from class com.rsa.certj.cert.extensions.X509V3Extension

ARCHIVE_CUTOFF, ARCHIVE_CUTOFF_OID, AUTHORITY_INFO_ACCESS, AUTHORITY_INFO_OID, AUTHORITY_KEY_ID, BASIC_CONSTRAINTS, BIO_INFO, BIO_INFO_OID, CERT_POLICIES, CERTIFICATE_ISSUER, CRL_DISTRIBUTION_POINTS, CRL_NUMBER, CRL_REFERENCE, CRL_REFERENCE_OID, DELTA_CRL_INDICATOR, EXTENDED_KEY_USAGE, HOLD_INSTRUCTION_CODE, INHIBIT_ANY_POLICY, INVALIDITY_DATE, ISSUER_ALT_NAME, ISSUING_DISTRIBUTION_POINT, KEY_USAGE, NAME_CONSTRAINTS, NETSCAPE_BASE_URL, NETSCAPE_BASE_URL_OID, NETSCAPE_CA_POLICY_URL, NETSCAPE_CA_POLICY_URL_OID, NETSCAPE_CA_REVOCATION_URL, NETSCAPE_CA_REVOCATION_URL_OID, NETSCAPE_CERT_RENEWAL_URL, NETSCAPE_CERT_RENEWAL_URL_OID, NETSCAPE_CERT_TYPE, NETSCAPE_CERT_TYPE_OID, NETSCAPE_COMMENT, NETSCAPE_COMMENT_OID, NETSCAPE_REVOCATION_URL, NETSCAPE_REVOCATION_URL_OID, NETSCAPE_SSL_SERVER_NAME, NETSCAPE_SSL_SERVER_NAME_OID, NON_STANDARD_EXTENSION, OCSP_ACCEPTABLE_RESPONSES, OCSP_ACCEPTABLE_RESPONSES_OID, OCSP_NOCHECK, OCSP_NOCHECK_OID, OCSP_NONCE, OCSP_NONCE_OID, OCSP_SERVICE_LOCATOR, OCSP_SERVICE_LOCATOR_OID, POLICY_CONSTRAINTS, POLICY_MAPPINGS, PRIVATE_KEY_USAGE_PERIOD, QC_STATEMENTS, QC_STATEMENTS_OID, REASON_CODE, SUBJECT_ALT_NAME, SUBJECT_DIRECTORY_ATTRIBUTES, SUBJECT_KEY_ID, VERISIGN_CZAG, VERISIGN_CZAG_OID, VERISIGN_FIDELITY_ID, VERISIGN_FIDELITY_ID_OID, VERISIGN_JURISDICTION_HASH, VERISIGN_JURISDICTION_HASH_OID, VERISIGN_NETSCAPE_INBOX_V1, VERISIGN_NETSCAPE_INBOX_V1_OID, VERISIGN_NETSCAPE_INBOX_V2, VERISIGN_NETSCAPE_INBOX_V2_OID, VERISIGN_NON_VERIFIED, VERISIGN_NON_VERIFIED_OID, VERISIGN_SERIAL_NUMBER, VERISIGN_SERIAL_NUMBER_OID, VERISIGN_TOKEN_TYPE, VERISIGN_TOKEN_TYPE_OID

Constructor Summary

VeriSignTokenType()

Constructs an empty VeriSignTokenType object.

VeriSignTokenType(int value, boolean criticality)

The constructor initializes the extension with specified values.

Method Summary

Object	clone() Overrides the default clone method to get a deeper clone.
void	decodeValue(byte[] valueBER, int offset) Decode the value.
int	derEncodeValue(byte[] encoding, int offset) Place the encoding of the value into encoding, beginning at offset.
int	derEncodeValueInit() Initialize for encoding the value.
int	getTokenType() Gets the hardware token characteristics.
void	setTokenType(int value) Sets the hardware token characteristics.

Methods inherited from class com.rsa.certj.cert.extensions.X509V3Extension

extend, getCriticality, getDEREncoding, getDERLen, getExtensionType, getExtensionTypeString, getInstance, getNextBEROffset, isExtensionType, setCriticality, setEncoding, setSpecialOID, setStandardOID

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_TYPE_BITS

public static final int TOKEN_TYPE_BITS

This defines how many possible TokenType bits there are; in this implementation, it is defined as four bits.

TOKEN_TYPE_MASK

public static final int TOKEN_TYPE_MASK

This defines at which bits we look; in this implementation, it is the four left-most bits.

PRIVATE_KEY_STORAGE

public static final int PRIVATE_KEY_STORAGE

This flag specifies private key storage characteristics of the hardware token.

GENERATED_AND_STORED

public static final int GENERATED_AND_STORED

This flag specifies generated and stored characteristics of the hardware token.

SAFE_EXPORT

public static final int SAFE_EXPORT

This flag specifies safe export characteristics of the hardware token.

NON_EXPORTABLE

public static final int NON_EXPORTABLE

This flag specifies non-exportable characteristics of the hardware token.

Constructor Detail

VeriSignTokenType

public VeriSignTokenType()

Constructs an empty VeriSignTokenType object.

VeriSignTokenType

public VeriSignTokenType(int value,
                         boolean criticality)

The constructor initializes the extension with specified values.

Parameters

	value		The hardware token characteristics using the values defined in this class.
	criticality		The user-specified criticality.

Method Detail

setTokenType

public void setTokenType(int value)

Sets the hardware token characteristics.

Parameters

value

The hardware token characteristics using the values defined in this class.

getTokenType

public int getTokenType()

Gets the hardware token characteristics.

Returns

The hardware token characteristics..

decodeValue

public void decodeValue(byte[] valueBER,
                        int offset)
                 throws CertificateException

Decode the value. The input is the BER encoding that was wrapped in the OCTET STRING.

Overrides

decodeValue in class X509V3Extension

Parameters

	valueBER		The BER encoding of the extension's value.
	offset		The offset into valueBER where the encoding begins.

Throws

CertificateException - If the encoding is invalid for this extension.

derEncodeValueInit

public int derEncodeValueInit()

Initialize for encoding the value.

Overrides

derEncodeValueInit in class X509V3Extension

Returns

How many bytes the encoding will be.

derEncodeValue

public int derEncodeValue(byte[] encoding,
                          int offset)

Place the encoding of the value into encoding, beginning at offset. This is the actual contents that are wrapped in the OCTET STRING (not the surrounding OCTET STRING tag and length).

Overrides

derEncodeValue in class X509V3Extension

Parameters

	encoding		The byte array into which the result will be placed.
	offset		The offest into encoding where the writing is to begin.

Returns

The number of bytes actually placed into encoding.

clone

public Object clone()
             throws CloneNotSupportedException

Overrides the default clone method to get a deeper clone.

Overrides

clone in class X509V3Extension

Returns

A new VeriSignTokenType object, a copy of this object.

Throws

CloneNotSupportedException - If the cloning operation is not successful.