AuthUtil (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.AuthUtil

@InterfaceAudience.Public
@InterfaceStability.Stable
public 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.

Method Summary

Methods
Modifier and Type	Method and Description
`static ScheduledChore`	`getAuthChore(org.apache.hadoop.conf.Configuration conf)` 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 String`	`toGroupEntry(String name)` Returns the group entry with the group prefix for a group principal.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getAuthChore
```
public static ScheduledChore getAuthChore(org.apache.hadoop.conf.Configuration conf)
                                   throws IOException
```
    Checks if security is enabled and if so, launches chore for refreshing kerberos ticket.
    
    Parameters:
    conf - the hbase service configuration
    
    Returns:
    a ScheduledChore for renewals, if needed, and null otherwise.
    
    Throws:
    
    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.

Class AuthUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAuthChore

isGroupPrincipal

getGroupName

toGroupEntry