org.apache.hive.service.auth.ldap

Class LdapUtils

java.lang.Object

org.apache.hive.service.auth.ldap.LdapUtils

public final class LdapUtils
extends Object

Static utility methods related to LDAP authentication module.

Method Summary

Modifier and Type	Method and Description
static List<String>	createCandidatePrincipals(HiveConf conf, String user) Creates a list of principals to be used for user authentication.
static String	extractBaseDn(String dn) Extracts a base DN from the provided distinguished name.
static String	extractFirstRdn(String dn) Extracts the first Relative Distinguished Name (RDN).
static String	extractUserName(String userDn) Extracts username from user DN.
static String	getShortName(String rdn) Gets value part of the first attribute in the provided RDN.
static boolean	hasDomain(String userName) Check for a domain part in the provided username.
static boolean	isDn(String name) Detects DN names.
static List<String>	parseDnPatterns(HiveConf conf, HiveConf.ConfVars var) Reads and parses DN patterns from Hive configuration.
static List<String>	patternsToBaseDns(Collection<String> patterns) Converts a collection of Distinguished Name patterns to a collection of base DNs.

Methods inherited from class java.lang.Object

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

Method Detail

extractBaseDn

public static String extractBaseDn(String dn)

Extracts a base DN from the provided distinguished name.
Example:
"ou=CORP,dc=mycompany,dc=com" is the base DN for "cn=user1,ou=CORP,dc=mycompany,dc=com"

Parameters:

dn - distinguished name

Returns:

base DN

extractFirstRdn

public static String extractFirstRdn(String dn)

Extracts the first Relative Distinguished Name (RDN).
Example:
For DN "cn=user1,ou=CORP,dc=mycompany,dc=com" this method will return "cn=user1"

Parameters:

dn - distinguished name

Returns:

first RDN

extractUserName

public static String extractUserName(String userDn)

Extracts username from user DN.
Examples:

 LdapUtils.extractUserName("UserName")                        = "UserName"
 LdapUtils.extractUserName("UserName@mycorp.com")             = "UserName"
 LdapUtils.extractUserName("cn=UserName,dc=mycompany,dc=com") = "UserName"
 

Parameters:

userDn -

Returns:

getShortName

public static String getShortName(String rdn)

Gets value part of the first attribute in the provided RDN.
Example:
For RDN "cn=user1,ou=CORP" this method will return "user1"

Parameters:

rdn - Relative Distinguished Name

Returns:

value part of the first attribute

hasDomain

public static boolean hasDomain(String userName)

Check for a domain part in the provided username.
Example:

 LdapUtils.hasDomain("user1@mycorp.com") = true
 LdapUtils.hasDomain("user1")            = false
 

Parameters:

userName - username

Returns:

true if userName contains @<domain> part

isDn

public static boolean isDn(String name)

Detects DN names.
Example:

 LdapUtils.isDn("cn=UserName,dc=mycompany,dc=com") = true
 LdapUtils.isDn("user1")                           = false
 

Parameters:

name - name to be checked

Returns:

true if the provided name is a distinguished name

parseDnPatterns

public static List<String> parseDnPatterns(HiveConf conf,
                                           HiveConf.ConfVars var)

Reads and parses DN patterns from Hive configuration.
If no patterns are provided in the configuration, then the base DN will be used.

Parameters:

conf - Hive configuration

var - variable to be read

Returns:

a list of DN patterns

See Also:

HiveConf.ConfVars.HIVE_SERVER2_PLAIN_LDAP_BASEDN, HiveConf.ConfVars.HIVE_SERVER2_PLAIN_LDAP_GUIDKEY, HiveConf.ConfVars.HIVE_SERVER2_PLAIN_LDAP_GROUPDNPATTERN, HiveConf.ConfVars.HIVE_SERVER2_PLAIN_LDAP_USERDNPATTERN

patternsToBaseDns

public static List<String> patternsToBaseDns(Collection<String> patterns)

Converts a collection of Distinguished Name patterns to a collection of base DNs.

Parameters:

patterns - Distinguished Name patterns

Returns:

a list of base DNs

See Also:

HiveConf.ConfVars.HIVE_SERVER2_PLAIN_LDAP_GROUPDNPATTERN, HiveConf.ConfVars.HIVE_SERVER2_PLAIN_LDAP_USERDNPATTERN

createCandidatePrincipals

public static List<String> createCandidatePrincipals(HiveConf conf,
                                                     String user)

Creates a list of principals to be used for user authentication.

Parameters:

conf - Hive configuration

user - username

Returns:

a list of user's principals