org.bouncycastle.asn1.x509

Class X509Name

Implemented Interfaces:
DEREncodable

public class X509Name
extends ASN1Encodable

     RDNSequence ::= SEQUENCE OF RelativeDistinguishedName

     RelativeDistinguishedName ::= SET SIZE (1..MAX) OF AttributeTypeAndValue

     AttributeTypeAndValue ::= SEQUENCE {
                                   type  OBJECT IDENTIFIER,
                                   value ANY }
 

Field Summary

static DERObjectIdentifier
C
country code - StringType(SIZE(2))
static DERObjectIdentifier
CN
common name - StringType(SIZE(1..64))
static DERObjectIdentifier
DC
static Hashtable
DefaultLookUp
look up table translating common symbols into their OIDS.
static boolean
DefaultReverse
determines whether or not strings should be processed and printed from back to front.
static Hashtable
DefaultSymbols
default look up table translating OID values into their common symbols following the convention in RFC 2253 with a few extras
static DERObjectIdentifier
E
email address in Verisign certificates
static DERObjectIdentifier
EmailAddress
Email address (RSA PKCS#9 extension) - IA5String.
static DERObjectIdentifier
GENERATION
static DERObjectIdentifier
GIVENNAME
static DERObjectIdentifier
INITIALS
static DERObjectIdentifier
L
locality name - StringType(SIZE(1..64))
static DERObjectIdentifier
O
organization - StringType(SIZE(1..64))
static Hashtable
OIDLookUp
look up table translating OID values into their common symbols - this static is scheduled for deletion
static DERObjectIdentifier
OU
organizational unit name - StringType(SIZE(1..64))
static Hashtable
RFC2253Symbols
look up table translating OID values into their common symbols following the convention in RFC 2253 with a few extras
static DERObjectIdentifier
SN
device serial number name - StringType(SIZE(1..64))
static DERObjectIdentifier
ST
state, or province name - StringType(SIZE(1..64))
static DERObjectIdentifier
SURNAME
Naming attributes of type X520name
static Hashtable
SymbolLookUp
look up table translating string values into their OIDS - this static is scheduled for deletion
static DERObjectIdentifier
T
Title
static DERObjectIdentifier
UID
LDAP User id.
static DERObjectIdentifier
UNIQUE_IDENTIFIER
static DERObjectIdentifier
UnstructuredAddress
static DERObjectIdentifier
UnstructuredName
more from PKCS#9

Constructor Summary

X509Name(Hashtable attributes)
constructor from a table of attributes.
X509Name(String dirName)
Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or some such, converting it into an ordered set of name attributes.
X509Name(String dirName, X509NameEntryConverter converter)
Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or some such, converting it into an ordered set of name attributes with each string value being converted to its associated ASN.1 type using the passed in converter.
X509Name(Vector ordering, Hashtable attributes)
Constructor from a table of attributes with ordering.
X509Name(Vector ordering, Hashtable attributes, X509DefaultEntryConverter converter)
Constructor from a table of attributes with ordering.
X509Name(Vector oids, Vector values)
Takes two vectors one of the oids and the other of the values.
X509Name(Vector oids, Vector values, X509NameEntryConverter converter)
Takes two vectors one of the oids and the other of the values.
X509Name(boolean reverse, Hashtable lookUp, String dirName)
Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or some such, converting it into an ordered set of name attributes.
X509Name(boolean reverse, Hashtable lookUp, String dirName, X509NameEntryConverter converter)
Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or some such, converting it into an ordered set of name attributes.
X509Name(boolean reverse, String dirName)
Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or some such, converting it into an ordered set of name attributes.
X509Name(boolean reverse, String dirName, X509NameEntryConverter converter)
Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or some such, converting it into an ordered set of name attributes with each string value being converted to its associated ASN.1 type using the passed in converter.
X509Name(ASN1Sequence seq)
Constructor from ASN1Sequence the principal will be a list of constructed sets, each containing an (OID, String) pair.

Method Summary

boolean
equals(Object _obj)
test for equality - note: case is ignored.
boolean
equals(Object _obj, boolean inOrder)
static X509Name
getInstance(Object obj)
static X509Name
getInstance(ASN1TaggedObject obj, boolean explicit)
Return a X509Name based on the passed in tagged object.
Vector
getOIDs()
return a vector of the oids in the name, in the order they were found.
Vector
getValues()
return a vector of the values found in the name, in the order they were found.
int
hashCode()
DERObject
toASN1Object()
String
toString()
String
toString(boolean reverse, Hashtable oidSymbols)
convert the structure to a string - if reverse is true the oids and values are listed out starting with the last element in the sequence (ala RFC 2253), otherwise the string will begin with the first element of the structure.

Methods inherited from class org.bouncycastle.asn1.ASN1Encodable

equals, getDERObject, getEncoded, hashCode, toASN1Object

Field Details

C

public static final DERObjectIdentifier C
country code - StringType(SIZE(2))


CN

public static final DERObjectIdentifier CN
common name - StringType(SIZE(1..64))


DC

public static final DERObjectIdentifier DC


DefaultLookUp

public static Hashtable DefaultLookUp
look up table translating common symbols into their OIDS.


DefaultReverse

public static boolean DefaultReverse
determines whether or not strings should be processed and printed from back to front.


DefaultSymbols

public static Hashtable DefaultSymbols
default look up table translating OID values into their common symbols following the convention in RFC 2253 with a few extras


E

public static final DERObjectIdentifier E
email address in Verisign certificates


EmailAddress

public static final DERObjectIdentifier EmailAddress
Email address (RSA PKCS#9 extension) - IA5String.

Note: if you're trying to be ultra orthodox, don't use this! It shouldn't be in here.


GENERATION

public static final DERObjectIdentifier GENERATION


GIVENNAME

public static final DERObjectIdentifier GIVENNAME


INITIALS

public static final DERObjectIdentifier INITIALS


L

public static final DERObjectIdentifier L
locality name - StringType(SIZE(1..64))


O

public static final DERObjectIdentifier O
organization - StringType(SIZE(1..64))


OIDLookUp

public static Hashtable OIDLookUp
look up table translating OID values into their common symbols - this static is scheduled for deletion


OU

public static final DERObjectIdentifier OU
organizational unit name - StringType(SIZE(1..64))


RFC2253Symbols

public static Hashtable RFC2253Symbols
look up table translating OID values into their common symbols following the convention in RFC 2253 with a few extras


SN

public static final DERObjectIdentifier SN
device serial number name - StringType(SIZE(1..64))


ST

public static final DERObjectIdentifier ST
state, or province name - StringType(SIZE(1..64))


SURNAME

public static final DERObjectIdentifier SURNAME
Naming attributes of type X520name


SymbolLookUp

public static Hashtable SymbolLookUp
look up table translating string values into their OIDS - this static is scheduled for deletion


T

public static final DERObjectIdentifier T
Title


UID

public static final DERObjectIdentifier UID
LDAP User id.


UNIQUE_IDENTIFIER

public static final DERObjectIdentifier UNIQUE_IDENTIFIER


UnstructuredAddress

public static final DERObjectIdentifier UnstructuredAddress


UnstructuredName

public static final DERObjectIdentifier UnstructuredName
more from PKCS#9

Constructor Details

X509Name

public X509Name(Hashtable attributes)
constructor from a table of attributes.

it's is assumed the table contains OID/String pairs, and the contents of the table are copied into an internal table as part of the construction process.

Note: if the name you are trying to generate should be following a specific ordering, you should use the constructor with the ordering specified below.


X509Name

public X509Name(String dirName)
Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or some such, converting it into an ordered set of name attributes.


X509Name

public X509Name(String dirName,
                X509NameEntryConverter converter)
Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or some such, converting it into an ordered set of name attributes with each string value being converted to its associated ASN.1 type using the passed in converter.


X509Name

public X509Name(Vector ordering,
                Hashtable attributes)
Constructor from a table of attributes with ordering.

it's is assumed the table contains OID/String pairs, and the contents of the table are copied into an internal table as part of the construction process. The ordering vector should contain the OIDs in the order they are meant to be encoded or printed in toString.


X509Name

public X509Name(Vector ordering,
                Hashtable attributes,
                X509DefaultEntryConverter converter)
Constructor from a table of attributes with ordering.

it's is assumed the table contains OID/String pairs, and the contents of the table are copied into an internal table as part of the construction process. The ordering vector should contain the OIDs in the order they are meant to be encoded or printed in toString.

The passed in converter will be used to convert the strings into their ASN.1 counterparts.


X509Name

public X509Name(Vector oids,
                Vector values)
Takes two vectors one of the oids and the other of the values.


X509Name

public X509Name(Vector oids,
                Vector values,
                X509NameEntryConverter converter)
Takes two vectors one of the oids and the other of the values.

The passed in converter will be used to convert the strings into their ASN.1 counterparts.


X509Name

public X509Name(boolean reverse,
                Hashtable lookUp,
                String dirName)
Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or some such, converting it into an ordered set of name attributes. lookUp should provide a table of lookups, indexed by lowercase only strings and yielding a DERObjectIdentifier, other than that OID. and numeric oids will be processed automatically.
If reverse is true, create the encoded version of the sequence starting from the last element in the string.

Parameters:
reverse - true if we should start scanning from the end (RFC 2553).
lookUp - table of names and their oids.
dirName - the X.500 string to be parsed.


X509Name

public X509Name(boolean reverse,
                Hashtable lookUp,
                String dirName,
                X509NameEntryConverter converter)
Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or some such, converting it into an ordered set of name attributes. lookUp should provide a table of lookups, indexed by lowercase only strings and yielding a DERObjectIdentifier, other than that OID. and numeric oids will be processed automatically. The passed in converter is used to convert the string values to the right of each equals sign to their ASN.1 counterparts.

Parameters:
reverse - true if we should start scanning from the end, false otherwise.
lookUp - table of names and oids.
dirName - the string dirName
converter - the converter to convert string values into their ASN.1 equivalents


X509Name

public X509Name(boolean reverse,
                String dirName)
Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or some such, converting it into an ordered set of name attributes. If reverse is true, create the encoded version of the sequence starting from the last element in the string.


X509Name

public X509Name(boolean reverse,
                String dirName,
                X509NameEntryConverter converter)
Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or some such, converting it into an ordered set of name attributes with each string value being converted to its associated ASN.1 type using the passed in converter. If reverse is true the ASN.1 sequence representing the DN will be built by starting at the end of the string, rather than the start.


X509Name

public X509Name(ASN1Sequence seq)
Constructor from ASN1Sequence the principal will be a list of constructed sets, each containing an (OID, String) pair.

Method Details

equals

public boolean equals(Object _obj)
test for equality - note: case is ignored.
Overrides:
equals in interface ASN1Encodable


equals

public boolean equals(Object _obj,
                      boolean inOrder)

Parameters:
inOrder - if true the order of both X509 names must be the same, as well as the values associated with each element.


getInstance

public static X509Name getInstance(Object obj)


getInstance

public static X509Name getInstance(ASN1TaggedObject obj,
                                   boolean explicit)
Return a X509Name based on the passed in tagged object.

Parameters:
obj - tag object holding name.
explicit - true if explicitly tagged false otherwise.

Returns:
the X509Name


getOIDs

public Vector getOIDs()
return a vector of the oids in the name, in the order they were found.


getValues

public Vector getValues()
return a vector of the values found in the name, in the order they were found.


hashCode

public int hashCode()
Overrides:
hashCode in interface ASN1Encodable


toASN1Object

public DERObject toASN1Object()
Overrides:
toASN1Object in interface ASN1Encodable


toString

public String toString()


toString

public String toString(boolean reverse,
                       Hashtable oidSymbols)
convert the structure to a string - if reverse is true the oids and values are listed out starting with the last element in the sequence (ala RFC 2253), otherwise the string will begin with the first element of the structure. If no string definition for the oid is found in oidSymbols the string value of the oid is added. Two standard symbol tables are provided DefaultSymbols, and RFC2253Symbols as part of this class.

Parameters:
reverse - if true start at the end of the sequence and work back.
oidSymbols - look up table strings for oids.