org.apache.hadoop.hbase.security.visibility

Class VisibilityUtils

java.lang.Object

org.apache.hadoop.hbase.security.visibility.VisibilityUtils

@InterfaceAudience.Private
public class VisibilityUtils
extends Object

Utility method to support visibility

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.hadoop.hbase.Tag	SORTED_ORDINAL_SERIALIZATION_FORMAT_TAG
static String	SYSTEM_LABEL
static String	VISIBILITY_LABEL_GENERATOR_CLASS

Constructor Summary

Constructors

Constructor and Description
VisibilityUtils()

Method Summary

Modifier and Type	Method and Description
static List<org.apache.hadoop.hbase.Tag>	createVisibilityExpTags(String visExpression, boolean withSerializationFormat, boolean checkAuths, Set<Integer> auths, VisibilityLabelOrdinalProvider ordinalProvider)
static org.apache.hadoop.hbase.filter.Filter	createVisibilityLabelFilter(Region region, org.apache.hadoop.hbase.security.visibility.Authorizations authorizations)
static Byte	extractAndPartitionTags(org.apache.hadoop.hbase.Cell cell, List<org.apache.hadoop.hbase.Tag> visTags, List<org.apache.hadoop.hbase.Tag> nonVisTags) Extracts and partitions the visibility tags and nonVisibility Tags
static Byte	extractVisibilityTags(org.apache.hadoop.hbase.Cell cell, List<org.apache.hadoop.hbase.Tag> tags) Extract the visibility tags of the given Cell into the given List
static org.apache.hadoop.hbase.security.User	getActiveUser()
static byte[]	getDataToWriteToZooKeeper(Map<String,Integer> existingLabels) Creates the labels data to be written to zookeeper.
static List<ScanLabelGenerator>	getScanLabelGenerators(org.apache.hadoop.conf.Configuration conf)
static byte[]	getUserAuthsDataToWriteToZooKeeper(Map<String,List<Integer>> userAuths) Creates the user auth data to be written to zookeeper.
static boolean	isVisibilityTagsPresent(org.apache.hadoop.hbase.Cell cell)
static List<org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabel>	readLabelsFromZKData(byte[] data) Reads back from the zookeeper.
static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.MultiUserAuthorizations	readUserAuthsFromZKData(byte[] data) Reads back User auth data written to zookeeper.

Methods inherited from class java.lang.Object

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

Field Detail

VISIBILITY_LABEL_GENERATOR_CLASS

public static final String VISIBILITY_LABEL_GENERATOR_CLASS

See Also:

Constant Field Values

SYSTEM_LABEL

public static final String SYSTEM_LABEL

See Also:

Constant Field Values

SORTED_ORDINAL_SERIALIZATION_FORMAT_TAG

public static final org.apache.hadoop.hbase.Tag SORTED_ORDINAL_SERIALIZATION_FORMAT_TAG

Constructor Detail

VisibilityUtils

public VisibilityUtils()

Method Detail

getDataToWriteToZooKeeper

public static byte[] getDataToWriteToZooKeeper(Map<String,Integer> existingLabels)

Creates the labels data to be written to zookeeper.

Parameters:

existingLabels -

Returns:

Bytes form of labels and their ordinal details to be written to zookeeper.

getUserAuthsDataToWriteToZooKeeper

public static byte[] getUserAuthsDataToWriteToZooKeeper(Map<String,List<Integer>> userAuths)

Creates the user auth data to be written to zookeeper.

Parameters:

userAuths -

Returns:

Bytes form of user auths details to be written to zookeeper.

readLabelsFromZKData

public static List<org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabel> readLabelsFromZKData(byte[] data)
                                                                                                                    throws org.apache.hadoop.hbase.exceptions.DeserializationException

Reads back from the zookeeper. The data read here is of the form written by writeToZooKeeper(Map<byte[], Integer> entries).

Parameters:

data -

Returns:

Labels and their ordinal details

Throws:

org.apache.hadoop.hbase.exceptions.DeserializationException

readUserAuthsFromZKData

public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.MultiUserAuthorizations readUserAuthsFromZKData(byte[] data)
                                                                                                                         throws org.apache.hadoop.hbase.exceptions.DeserializationException

Reads back User auth data written to zookeeper.

Parameters:

data -

Returns:

User auth details

Throws:

org.apache.hadoop.hbase.exceptions.DeserializationException

getScanLabelGenerators

public static List<ScanLabelGenerator> getScanLabelGenerators(org.apache.hadoop.conf.Configuration conf)

Parameters:

conf - The configuration to use

Returns:

Stack of ScanLabelGenerator instances. ScanLabelGenerator classes can be specified in Configuration as comma separated list using key "hbase.regionserver.scan.visibility.label.generator.class"

Throws:

IllegalArgumentException - when any of the specified ScanLabelGenerator class can not be loaded.

extractVisibilityTags

public static Byte extractVisibilityTags(org.apache.hadoop.hbase.Cell cell,
                                         List<org.apache.hadoop.hbase.Tag> tags)

Extract the visibility tags of the given Cell into the given List

Parameters:

cell - - the cell

tags - - the array that will be populated if visibility tags are present

Returns:

The visibility tags serialization format

extractAndPartitionTags

public static Byte extractAndPartitionTags(org.apache.hadoop.hbase.Cell cell,
                                           List<org.apache.hadoop.hbase.Tag> visTags,
                                           List<org.apache.hadoop.hbase.Tag> nonVisTags)

Extracts and partitions the visibility tags and nonVisibility Tags

Parameters:

cell - - the cell for which we would extract and partition the visibility and non visibility tags

visTags - - all the visibilty tags of type TagType.VISIBILITY_TAG_TYPE would be added to this list

nonVisTags - - all the non visibility tags would be added to this list

Returns:

- the serailization format of the tag. Can be null if no tags are found or if there is no visibility tag found

isVisibilityTagsPresent

public static boolean isVisibilityTagsPresent(org.apache.hadoop.hbase.Cell cell)

createVisibilityLabelFilter

public static org.apache.hadoop.hbase.filter.Filter createVisibilityLabelFilter(Region region,
                                                                                org.apache.hadoop.hbase.security.visibility.Authorizations authorizations)
                                                                         throws IOException

Throws:

IOException

getActiveUser

public static org.apache.hadoop.hbase.security.User getActiveUser()
                                                           throws IOException

Returns:

User who called RPC method. For non-RPC handling, falls back to system user

Throws:

IOException - When there is IOE in getting the system user (During non-RPC handling).

createVisibilityExpTags

public static List<org.apache.hadoop.hbase.Tag> createVisibilityExpTags(String visExpression,
                                                                        boolean withSerializationFormat,
                                                                        boolean checkAuths,
                                                                        Set<Integer> auths,
                                                                        VisibilityLabelOrdinalProvider ordinalProvider)
                                                                 throws IOException

Throws:

IOException