org.apache.hadoop.hbase

类 AuthUtil

java.lang.Object

org.apache.hadoop.hbase.AuthUtil

已过时。

since 2.2.0, to be removed in hbase-3.0.0.

@Deprecated
 @InterfaceAudience.Public
public final class AuthUtil
extends Object

Utility methods for helping with security tasks. Downstream users may rely on this class to handle authenticating via keytab where long running services need access to a secure HBase cluster. Callers must ensure:

• HBase configuration files are in the Classpath
• hbase.client.keytab.file points to a valid keytab on the local filesystem
• hbase.client.kerberos.principal gives the Kerberos principal to use

 
   ChoreService choreService = null;
   // Presumes HBase configuration files are on the classpath
   final Configuration conf = HBaseConfiguration.create();
   final ScheduledChore authChore = AuthUtil.getAuthChore(conf);
   if (authChore != null) {
     choreService = new ChoreService("MY_APPLICATION");
     choreService.scheduleChore(authChore);
   }
   try {
     // do application work
   } finally {
     if (choreService != null) {
       choreService.shutdown();
     }
   }
 
 

See the "Running Canary in a Kerberos-enabled Cluster" section of the HBase Reference Guide for an example of configuring a user of this Auth Chore to run on a secure cluster.

This class will be internal used only from 2.2.0 version, and will transparently work for kerberized applications. For more, please refer Client-side Configuration for Secure Operation

字段概要

字段

限定符和类型	字段和说明
static String	HBASE_CLIENT_KERBEROS_PRINCIPAL 已过时。 Client principal
static String	HBASE_CLIENT_KEYTAB_FILE 已过时。 Client keytab file

方法概要

限定符和类型	方法和说明
static ScheduledChore	getAuthChore(org.apache.hadoop.conf.Configuration conf) 已过时。 Deprecated since 2.2.0, this method will be internal use only after 3.0.0.
static ScheduledChore	getAuthRenewalChore(org.apache.hadoop.security.UserGroupInformation user) 已过时。 Checks if security is enabled and if so, launches chore for refreshing kerberos ticket.
static String	getGroupName(String aclKey) 已过时。 Returns the actual name for a group principal (stripped of the group prefix).
static boolean	isGroupPrincipal(String name) 已过时。 Returns whether or not the given name should be interpreted as a group principal.
static User	loginClient(org.apache.hadoop.conf.Configuration conf) 已过时。 For kerberized cluster, return login user (from kinit or from keytab if specified).
static String	toGroupEntry(String name) 已过时。 Returns the group entry with the group prefix for a group principal.

从类继承的方法 java.lang.Object

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

字段详细资料

HBASE_CLIENT_KEYTAB_FILE

public static final String HBASE_CLIENT_KEYTAB_FILE

已过时。

Client keytab file

另请参阅:

常量字段值

HBASE_CLIENT_KERBEROS_PRINCIPAL

public static final String HBASE_CLIENT_KERBEROS_PRINCIPAL

已过时。

Client principal

另请参阅:

常量字段值

方法详细资料

loginClient

@InterfaceAudience.Private
public static User loginClient(org.apache.hadoop.conf.Configuration conf)
                                                   throws IOException

已过时。

For kerberized cluster, return login user (from kinit or from keytab if specified). For non-kerberized cluster, return system user.

参数:

conf - configuartion file

返回:

user

抛出:

IOException - login exception

getAuthRenewalChore

@InterfaceAudience.Private
public static ScheduledChore getAuthRenewalChore(org.apache.hadoop.security.UserGroupInformation user)

已过时。

Checks if security is enabled and if so, launches chore for refreshing kerberos ticket.

返回:

a ScheduledChore for renewals.

getAuthChore

@Deprecated
public static ScheduledChore getAuthChore(org.apache.hadoop.conf.Configuration conf)
                                               throws IOException

已过时。 Deprecated since 2.2.0, this method will be internal use only after 3.0.0.

Checks if security is enabled and if so, launches chore for refreshing kerberos ticket.

参数:

conf - the hbase service configuration

返回:

a ScheduledChore for renewals, if needed, and null otherwise.

抛出:

IOException

isGroupPrincipal

@InterfaceAudience.Private
public static boolean isGroupPrincipal(String name)

已过时。

Returns whether or not the given name should be interpreted as a group principal. Currently this simply checks if the name starts with the special group prefix character ("@").

getGroupName

@InterfaceAudience.Private
public static String getGroupName(String aclKey)

已过时。

Returns the actual name for a group principal (stripped of the group prefix).

toGroupEntry

@InterfaceAudience.Private
public static String toGroupEntry(String name)

已过时。

Returns the group entry with the group prefix for a group principal.