Package org.apache.hadoop.security.authentication.util

Class KerberosName

java.lang.Object

org.apache.hadoop.security.authentication.util.KerberosName

@LimitedPrivate({"HDFS","MapReduce"})
@Evolving
public class KerberosName
extends java.lang.Object

This class implements parsing and handling of Kerberos principal names. In particular, it splits them apart and translates them down into local operating system names.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KerberosName.BadFormatString
static class	KerberosName.NoMatchingRule

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_MECHANISM	Constant that defines the default behavior of the rule mechanism
static java.lang.String	MECHANISM_HADOOP	Constant that defines auth_to_local legacy hadoop evaluation
static java.lang.String	MECHANISM_MIT	Constant that defines auth_to_local MIT evaluation

Constructor Summary

Constructors

Constructor	Description
KerberosName(java.lang.String name)	Create a name from the full Kerberos principal name.

Method Summary

Modifier and Type	Method	Description
static java.lang.String	getDefaultRealm()	Get the configured default realm.
java.lang.String	getHostName()	Get the second component of the name.
java.lang.String	getRealm()	Get the realm of the name.
static java.lang.String	getRuleMechanism()	Get the rule evaluation mechanism
static java.lang.String	getRules()	Get the rules.
java.lang.String	getServiceName()	Get the first component of the name.
java.lang.String	getShortName()	Get the translation of the principal name into an operating system user name.
static boolean	hasRuleMechanismBeenSet()	Indicates of the rule mechanism has been set
static boolean	hasRulesBeenSet()	Indicates if the name rules have been set.
static void	resetDefaultRealm()
static void	setRuleMechanism(java.lang.String ruleMech)
static void	setRules(java.lang.String ruleString)	Set the rules.
java.lang.String	toString()	Put the name back together from the parts.

Methods inherited from class java.lang.Object

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

Field Detail

MECHANISM_HADOOP

public static final java.lang.String MECHANISM_HADOOP

Constant that defines auth_to_local legacy hadoop evaluation

See Also:

Constant Field Values

MECHANISM_MIT

public static final java.lang.String MECHANISM_MIT

Constant that defines auth_to_local MIT evaluation

See Also:

Constant Field Values

DEFAULT_MECHANISM

public static final java.lang.String DEFAULT_MECHANISM

Constant that defines the default behavior of the rule mechanism

See Also:

Constant Field Values

Constructor Detail

KerberosName

public KerberosName(java.lang.String name)

Create a name from the full Kerberos principal name.

Parameters:

name - full Kerberos principal name.

Method Detail

resetDefaultRealm

@VisibleForTesting
public static void resetDefaultRealm()

getDefaultRealm

public static java.lang.String getDefaultRealm()

Get the configured default realm. Used syncronized method here, because double-check locking is overhead.

Returns:

the default realm from the krb5.conf

toString

public java.lang.String toString()

Put the name back together from the parts.

Overrides:

toString in class java.lang.Object

getServiceName

public java.lang.String getServiceName()

Get the first component of the name.

Returns:

the first section of the Kerberos principal name

getHostName

public java.lang.String getHostName()

Get the second component of the name.

Returns:

the second section of the Kerberos principal name, and may be null

getRealm

public java.lang.String getRealm()

Get the realm of the name.

Returns:

the realm of the name, may be null

getShortName

public java.lang.String getShortName()
                              throws java.io.IOException

Get the translation of the principal name into an operating system user name.

Returns:

the short name

Throws:

java.io.IOException - throws if something is wrong with the rules

getRules

public static java.lang.String getRules()

Get the rules.

Returns:

String of configured rules, or null if not yet configured

hasRulesBeenSet

public static boolean hasRulesBeenSet()

Indicates if the name rules have been set.

Returns:

if the name rules have been set.

hasRuleMechanismBeenSet

public static boolean hasRuleMechanismBeenSet()

Indicates of the rule mechanism has been set

Returns:

if the rule mechanism has been set.

setRules

public static void setRules(java.lang.String ruleString)

Set the rules.

Parameters:

ruleString - the rules string.

setRuleMechanism

public static void setRuleMechanism(java.lang.String ruleMech)

Parameters:

ruleMech - the evaluation type: hadoop, mit 'hadoop' indicates '@' or '/' are not allowed the result evaluation. 'MIT' indicates that auth_to_local rules follow MIT Kerberos evaluation.

getRuleMechanism

public static java.lang.String getRuleMechanism()

Get the rule evaluation mechanism

Returns:

the rule evaluation mechanism