org.apache.hadoop.hbase.security.visibility

Class DefaultVisibilityLabelServiceImpl

java.lang.Object

org.apache.hadoop.hbase.security.visibility.DefaultVisibilityLabelServiceImpl

All Implemented Interfaces:

VisibilityLabelService

@InterfaceAudience.Private
public class DefaultVisibilityLabelServiceImpl
extends java.lang.Object
implements VisibilityLabelService

Constructor Summary

Constructors

Constructor and Description
DefaultVisibilityLabelServiceImpl()

Method Summary

Modifier and Type	Method and Description
OperationStatus[]	addLabels(java.util.List<byte[]> labels) Adds the set of labels into the system.
protected void	addSystemLabel(Region region, java.util.Map<java.lang.String,java.lang.Integer> labels, java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> userAuths)
OperationStatus[]	clearAuths(byte[] user, java.util.List<byte[]> authLabels) Removes given labels from user's globally authorized list of labels.
java.util.List<Tag>	createVisibilityExpTags(java.lang.String visExpression, boolean withSerializationFormat, boolean checkAuths) Creates tags corresponding to given visibility expression.
byte[]	encodeVisibilityForReplication(java.util.List<Tag> tags, java.lang.Byte serializationFormat) Provides a way to modify the visibility tags of type TagType .VISIBILITY_TAG_TYPE, that are part of the cell created from the WALEdits that are prepared for replication while calling ReplicationEndpoint .replicate().
protected Pair<java.util.Map<java.lang.String,java.lang.Integer>,java.util.Map<java.lang.String,java.util.List<java.lang.Integer>>>	extractLabelsAndAuths(java.util.List<java.util.List<Cell>> labelDetails)
java.util.List<java.lang.String>	getAuths(byte[] user, boolean systemCall) Deprecated.
Configuration	getConf()
protected java.util.List<java.util.List<Cell>>	getExistingLabelsWithAuths()
java.util.List<java.lang.String>	getGroupAuths(java.lang.String[] groups, boolean systemCall) Retrieve the visibility labels for the groups.
java.util.List<java.lang.String>	getUserAuths(byte[] user, boolean systemCall) Retrieve the visibility labels for the user.
VisibilityExpEvaluator	getVisibilityExpEvaluator(Authorizations authorizations) Creates VisibilityExpEvaluator corresponding to given Authorizations.
boolean	havingSystemAuth(byte[] user) Deprecated.
boolean	havingSystemAuth(User user) System checks for user auth during admin operations.
void	init(RegionCoprocessorEnvironment e) System calls this after opening of regions.
protected boolean	isReadFromSystemAuthUser()
java.util.List<java.lang.String>	listLabels(java.lang.String regex) Retrieve the list of visibility labels defined in the system.
boolean	matchVisibility(java.util.List<Tag> putVisTags, java.lang.Byte putTagsFormat, java.util.List<Tag> deleteVisTags, java.lang.Byte deleteTagsFormat) System uses this for deciding whether a Cell can be deleted by matching visibility expression in Delete mutation and the cell in consideration.
OperationStatus[]	setAuths(byte[] user, java.util.List<byte[]> authLabels) Sets given labels globally authorized for the user.
void	setConf(Configuration conf)
protected void	updateZk(boolean labelAddition)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultVisibilityLabelServiceImpl

public DefaultVisibilityLabelServiceImpl()

Method Detail

setConf

public void setConf(Configuration conf)

getConf

public Configuration getConf()

init

public void init(RegionCoprocessorEnvironment e)
          throws java.io.IOException

Description copied from interface: VisibilityLabelService

System calls this after opening of regions. Gives a chance for the VisibilityLabelService to so any initialization logic.

Specified by:

init in interface VisibilityLabelService

Parameters:

e - the region coprocessor env

Throws:

java.io.IOException

getExistingLabelsWithAuths

protected java.util.List<java.util.List<Cell>> getExistingLabelsWithAuths()
                                                                   throws java.io.IOException

Throws:

java.io.IOException

extractLabelsAndAuths

protected Pair<java.util.Map<java.lang.String,java.lang.Integer>,java.util.Map<java.lang.String,java.util.List<java.lang.Integer>>> extractLabelsAndAuths(java.util.List<java.util.List<Cell>> labelDetails)

addSystemLabel

protected void addSystemLabel(Region region,
                              java.util.Map<java.lang.String,java.lang.Integer> labels,
                              java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> userAuths)
                       throws java.io.IOException

Throws:

java.io.IOException

addLabels

public OperationStatus[] addLabels(java.util.List<byte[]> labels)
                            throws java.io.IOException

Description copied from interface: VisibilityLabelService

Adds the set of labels into the system.

Specified by:

addLabels in interface VisibilityLabelService

Parameters:

labels - Labels to add to the system.

Returns:

OperationStatus for each of the label addition

Throws:

java.io.IOException

setAuths

public OperationStatus[] setAuths(byte[] user,
                                  java.util.List<byte[]> authLabels)
                           throws java.io.IOException

Description copied from interface: VisibilityLabelService

Sets given labels globally authorized for the user.

Specified by:

setAuths in interface VisibilityLabelService

Parameters:

user - The authorizing user

authLabels - Labels which are getting authorized for the user

Returns:

OperationStatus for each of the label auth addition

Throws:

java.io.IOException

clearAuths

public OperationStatus[] clearAuths(byte[] user,
                                    java.util.List<byte[]> authLabels)
                             throws java.io.IOException

Description copied from interface: VisibilityLabelService

Removes given labels from user's globally authorized list of labels.

Specified by:

clearAuths in interface VisibilityLabelService

Parameters:

user - The user whose authorization to be removed

authLabels - Labels which are getting removed from authorization set

Returns:

OperationStatus for each of the label auth removal

Throws:

java.io.IOException

getAuths

@Deprecated
public java.util.List<java.lang.String> getAuths(byte[] user,
                                                             boolean systemCall)
                                                      throws java.io.IOException

Deprecated.

Description copied from interface: VisibilityLabelService

Retrieve the visibility labels for the user.

Specified by:

getAuths in interface VisibilityLabelService

Parameters:

user - Name of the user whose authorization to be retrieved

systemCall - Whether a system or user originated call.

Returns:

Visibility labels authorized for the given user.

Throws:

java.io.IOException

getUserAuths

public java.util.List<java.lang.String> getUserAuths(byte[] user,
                                                     boolean systemCall)
                                              throws java.io.IOException

Description copied from interface: VisibilityLabelService

Retrieve the visibility labels for the user.

Specified by:

getUserAuths in interface VisibilityLabelService

Parameters:

user - Name of the user whose authorization to be retrieved

systemCall - Whether a system or user originated call.

Returns:

Visibility labels authorized for the given user.

Throws:

java.io.IOException

getGroupAuths

public java.util.List<java.lang.String> getGroupAuths(java.lang.String[] groups,
                                                      boolean systemCall)
                                               throws java.io.IOException

Description copied from interface: VisibilityLabelService

Retrieve the visibility labels for the groups.

Specified by:

getGroupAuths in interface VisibilityLabelService

Parameters:

groups - Name of the groups whose authorization to be retrieved

systemCall - Whether a system or user originated call.

Returns:

Visibility labels authorized for the given group.

Throws:

java.io.IOException

listLabels

public java.util.List<java.lang.String> listLabels(java.lang.String regex)
                                            throws java.io.IOException

Description copied from interface: VisibilityLabelService

Retrieve the list of visibility labels defined in the system.

Specified by:

listLabels in interface VisibilityLabelService

Parameters:

regex - The regular expression to filter which labels are returned.

Returns:

List of visibility labels

Throws:

java.io.IOException

createVisibilityExpTags

public java.util.List<Tag> createVisibilityExpTags(java.lang.String visExpression,
                                                   boolean withSerializationFormat,
                                                   boolean checkAuths)
                                            throws java.io.IOException

Description copied from interface: VisibilityLabelService

Creates tags corresponding to given visibility expression.
Note: This will be concurrently called from multiple threads and implementation should take care of thread safety.

Specified by:

createVisibilityExpTags in interface VisibilityLabelService

Parameters:

visExpression - The Expression for which corresponding Tags to be created.

withSerializationFormat - specifies whether a tag, denoting the serialization version of the tags, to be added in the list. When this is true make sure to add the serialization format Tag also. The format tag value should be byte type.

checkAuths - denotes whether to check individual labels in visExpression against user's global auth label.

Returns:

The list of tags corresponds to the visibility expression. These tags will be stored along with the Cells.

Throws:

java.io.IOException

updateZk

protected void updateZk(boolean labelAddition)
                 throws java.io.IOException

Throws:

java.io.IOException

getVisibilityExpEvaluator

public VisibilityExpEvaluator getVisibilityExpEvaluator(Authorizations authorizations)
                                                 throws java.io.IOException

Description copied from interface: VisibilityLabelService

Creates VisibilityExpEvaluator corresponding to given Authorizations.
Note: This will be concurrently called from multiple threads and implementation should take care of thread safety.

Specified by:

getVisibilityExpEvaluator in interface VisibilityLabelService

Parameters:

authorizations - Authorizations for the read request

Returns:

The VisibilityExpEvaluator corresponding to the given set of authorization labels.

Throws:

java.io.IOException

isReadFromSystemAuthUser

protected boolean isReadFromSystemAuthUser()
                                    throws java.io.IOException

Throws:

java.io.IOException

havingSystemAuth

@Deprecated
public boolean havingSystemAuth(byte[] user)
                                     throws java.io.IOException

Deprecated.

Description copied from interface: VisibilityLabelService

System checks for user auth during admin operations. (ie. Label add, set/clear auth). The operation is allowed only for users having system auth. Also during read, if the requesting user has system auth, he can view all the data irrespective of its labels.

Specified by:

havingSystemAuth in interface VisibilityLabelService

Parameters:

user - User for whom system auth check to be done.

Returns:

true if the given user is having system/super auth

Throws:

java.io.IOException

havingSystemAuth

public boolean havingSystemAuth(User user)
                         throws java.io.IOException

Description copied from interface: VisibilityLabelService

System checks for user auth during admin operations. (ie. Label add, set/clear auth). The operation is allowed only for users having system auth. Also during read, if the requesting user has system auth, he can view all the data irrespective of its labels.

Specified by:

havingSystemAuth in interface VisibilityLabelService

Parameters:

user - User for whom system auth check to be done.

Returns:

true if the given user is having system/super auth

Throws:

java.io.IOException

matchVisibility

public boolean matchVisibility(java.util.List<Tag> putVisTags,
                               java.lang.Byte putTagsFormat,
                               java.util.List<Tag> deleteVisTags,
                               java.lang.Byte deleteTagsFormat)
                        throws java.io.IOException

Description copied from interface: VisibilityLabelService

System uses this for deciding whether a Cell can be deleted by matching visibility expression in Delete mutation and the cell in consideration. Also system passes the serialization format of visibility tags in Put and Delete.
Note: This will be concurrently called from multiple threads and implementation should take care of thread safety.

Specified by:

matchVisibility in interface VisibilityLabelService

Parameters:

putVisTags - The visibility tags present in the Put mutation

putTagsFormat - The serialization format for the Put visibility tags. A null value for this format means the tags are written with unsorted label ordinals

deleteVisTags - - The visibility tags in the delete mutation (the specified Cell Visibility)

deleteTagsFormat - The serialization format for the Delete visibility tags. A null value for this format means the tags are written with unsorted label ordinals

Returns:

true if matching tags are found

Throws:

java.io.IOException

See Also:

VisibilityConstants.SORTED_ORDINAL_SERIALIZATION_FORMAT

encodeVisibilityForReplication

public byte[] encodeVisibilityForReplication(java.util.List<Tag> tags,
                                             java.lang.Byte serializationFormat)
                                      throws java.io.IOException

Description copied from interface: VisibilityLabelService

Provides a way to modify the visibility tags of type TagType .VISIBILITY_TAG_TYPE, that are part of the cell created from the WALEdits that are prepared for replication while calling ReplicationEndpoint .replicate(). VisibilityReplicationEndpoint calls this API to provide an opportunity to modify the visibility tags before replicating.

Specified by:

encodeVisibilityForReplication in interface VisibilityLabelService

Parameters:

tags - the visibility tags associated with the cell

serializationFormat - the serialization format associated with the tag

Returns:

the modified visibility expression in the form of byte[]

Throws:

java.io.IOException