org.apache.kerby.kerberos.kerb.type.base

Class PrincipalName

java.lang.Object

org.apache.kerby.asn1.type.Asn1Object

org.apache.kerby.asn1.type.Asn1Encodeable

org.apache.kerby.asn1.type.AbstractAsn1Type<org.apache.kerby.asn1.type.Asn1CollectionType>

org.apache.kerby.asn1.type.Asn1CollectionType

org.apache.kerby.asn1.type.Asn1SequenceType

org.apache.kerby.kerberos.kerb.type.KrbSequenceType

org.apache.kerby.kerberos.kerb.type.base.PrincipalName

All Implemented Interfaces:

org.apache.kerby.asn1.Asn1Dumpable, org.apache.kerby.asn1.type.Asn1Type

public class PrincipalName
extends KrbSequenceType

The PrincipalName as defined in RFC 4120 :

 PrincipalName   ::= SEQUENCE {
     name-type       [0] Int32,
     name-string     [1] SEQUENCE OF KerberosString
 }
 

The possible name-type are :

• NT-UNKNOWN (0) : Name type not known
• NT-PRINCIPAL (1) : Just the name of the principal as in DCE, or for users
• NT-SRV-INST (2) : Service and other unique instance (krbtgt)
• NT-SRV-HST (3) : Service with host name as instance (telnet, rcommands)
• NT-SRV-XHST (4) : Service with host as remaining components
• NT-UID (5) : Unique ID
• NT-X500-PRINCIPAL (6) : Encoded X.509 Distinguished name [RFC2253]
• NT-SMTP-NAME (7) : Name in form of SMTP email name (e.g., user@example.com)
• NT-ENTERPRISE (10) : Enterprise name - may be mapped to principal name
• NT_WELLKNOWN (11) : Well-known principal names (RFC 6111).

The name-string contains

Author:

Apache Directory Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PrincipalName.PrincipalNameField The possible fields

Nested classes/interfaces inherited from interface org.apache.kerby.asn1.type.Asn1Type

org.apache.kerby.asn1.type.Asn1Type.EncodingType

Field Summary

Fields inherited from class org.apache.kerby.asn1.type.Asn1Encodeable

bodyLength, outerEncodeable

Constructor Summary

Constructors

Constructor and Description
PrincipalName() Creates a PrincipalName instance
PrincipalName(List<String> nameStrings, NameType nameType) Creates a PrincipalName instance, using a given type and a list of components
PrincipalName(String nameString) Creates a PrincipalName instance, using a NT_PRINCIPAL name
PrincipalName(String nameString, NameType type) Creates a PrincipalName instance, using a given type

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
static String	extractName(String principal) Get the name part of the PrincipalName, ie, discading the realm part of it.
static String	extractRealm(String principal) Get the Realm from the name.
String	getName()
List<String>	getNameStrings()
NameType	getNameType()
String	getRealm()
int	hashCode()
static String	makeSalt(PrincipalName principalName) Create a SALT based on the PrincipalName, accordingly to RFC 4120 : "The default salt string, if none is provided via pre-authentication data, is the concatenation of the principal's realm and name components, in order, with no separators."
void	setNameStrings(List<String> nameStrings) Stores the components of a PrincipalName into the associated ASN1 structure
void	setNameType(NameType nameType) Set the NameType field of this PrincipalName
void	setRealm(String realm) Store a Realm in this PrincipalName
String	toString()

Methods inherited from class org.apache.kerby.kerberos.kerb.type.KrbSequenceType

getFieldAsInt, getFieldAsTime, setField, setFieldAsString, setFieldAsTime

Methods inherited from class org.apache.kerby.asn1.type.Asn1SequenceType

createCollection

Methods inherited from class org.apache.kerby.asn1.type.Asn1CollectionType

decodeBody, dumpWith, encodeBody, encodingBodyLength, getFieldAs, getFieldAsAny, getFieldAsInteger, getFieldAsObjId, getFieldAsOctets, getFieldAsString, setAnyFieldValueType, setFieldAs, setFieldAsAny, setFieldAsInt, setFieldAsInt, setFieldAsObjId, setFieldAsOctets

Methods inherited from class org.apache.kerby.asn1.type.AbstractAsn1Type

getValue, setValue

Methods inherited from class org.apache.kerby.asn1.type.Asn1Encodeable

decode, decode, decode, encode, encode, encodingHeaderLength, encodingLength, getBodyLength, getHeaderLength, isBER, isCER, isDefinitiveLength, isDER, isImplicit, isPrimitive, resetBodyLength, taggedDecode, taggedDecode, taggedDecode, taggedEncode, taggedEncode, taggedEncodingLength, useBER, useCER, useDefinitiveLength, useDER, useImplicit, usePrimitive

Methods inherited from class org.apache.kerby.asn1.type.Asn1Object

isAppSpecific, isCollection, isContextSpecific, isEOC, isNull, isSimple, isTagSpecific, isUniversal, simpleInfo, tag, tagFlags, tagNo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.kerby.asn1.type.Asn1Type

tag

Constructor Detail

PrincipalName

public PrincipalName()

Creates a PrincipalName instance

PrincipalName

public PrincipalName(String nameString)

Creates a PrincipalName instance, using a NT_PRINCIPAL name

Parameters:

nameString - The PrincipalName as a String

PrincipalName

public PrincipalName(String nameString,
                     NameType type)

Creates a PrincipalName instance, using a given type

Parameters:

nameString - The PrincipalName as a String

type - The nameType to use

PrincipalName

public PrincipalName(List<String> nameStrings,
                     NameType nameType)

Creates a PrincipalName instance, using a given type and a list of components

Parameters:

nameStrings - The components to use

nameType - The nameType to use

Method Detail

extractRealm

public static String extractRealm(String principal)

Get the Realm from the name.

Parameters:

principal - The PrincipalName from which we want to extract the Realm

Returns:

The extracted Realm

extractName

public static String extractName(String principal)

Get the name part of the PrincipalName, ie, discading the realm part of it.

Parameters:

principal - The PrincipalName to split

Returns:

The extracted components (primary/instances)

makeSalt

public static String makeSalt(PrincipalName principalName)

Create a SALT based on the PrincipalName, accordingly to RFC 4120 : "The default salt string, if none is provided via pre-authentication data, is the concatenation of the principal's realm and name components, in order, with no separators."

Parameters:

principalName - The PrincipalName for which we want to create a salt

Returns:

The created salt

getNameType

public NameType getNameType()

Returns:

The NameType of this PirncipalName

setNameType

public void setNameType(NameType nameType)

Set the NameType field of this PrincipalName

Parameters:

nameType - The NameType to store

getNameStrings

public List<String> getNameStrings()

Returns:

The PrincipalName's components as a list of String

setNameStrings

public void setNameStrings(List<String> nameStrings)

Stores the components of a PrincipalName into the associated ASN1 structure

Parameters:

nameStrings - The PrincipalName's components

getRealm

public String getRealm()

Returns:

The PrincipalName's Realm

setRealm

public void setRealm(String realm)

Store a Realm in this PrincipalName

Parameters:

realm - The Realm to store

getName

public String getName()

Returns:

A String representation of this PrincipalName, as primary [ '/' instance ]* [ '@' realm ]

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

toString

public String toString()

Overrides:

toString in class org.apache.kerby.asn1.type.AbstractAsn1Type<org.apache.kerby.asn1.type.Asn1CollectionType>

See Also:

Object.toString()