Managing the Sentry Service | 5.15.x | Cloudera Documentation

Terminology

An object is an entity protected by Sentry's authorization rules. The objects supported in the current release are server, database, table, URI, collection, and config.
A role is a collection of rules for accessing a given object.
A privilege is granted to a role to govern access to an object. Sentry allows you to assign the SELECT privilege to columns (only for Hive and Impala). Supported privileges are:

Valid privilege types and the objects they apply to

Privilege Object

ALL SERVER, TABLE, DB, URI, COLLECTION, CONFIG

INSERT DB, TABLE

SELECT DB, TABLE, COLUMN

Note: In Beeline, you can also grant SELECT and INSERT on SERVER.
A user is an entity that is permitted by the authentication subsystem to access the service. This entity can be a Kerberos principal, an LDAP userid, or an artifact of some other supported pluggable authentication system.
A group connects the authentication system with the authorization system. It is a collection of one or more users who have been granted one or more authorization roles. Sentry allows a set of roles to be configured for a group.
A configured group provider determines a user’s affiliation with a group. The current release supports HDFS-backed groups and locally configured groups.

Valid privilege types and the objects they apply to
Privilege	Object
ALL	SERVER, TABLE, DB, URI, COLLECTION, CONFIG
INSERT	DB, TABLE
SELECT	DB, TABLE, COLUMN

Privilege Model

Sentry uses a role-based privilege model with the following characteristics.

Allows any user to execute show function, desc function, and show locks.
Allows the user to see only those tables, databases, collections, and configurations for which the user has privileges.
Requires a user to have the necessary privileges on the URI to execute HiveQL operations that specify a location. Examples of such operations include LOAD, IMPORT, and EXPORT.
Privileges granted on URIs are recursively applied to all subdirectories. That is, privileges only need to be granted on the parent directory.
Sentry provides column-level access control for tables in Hive and Impala. You can assign the SELECT privilege on a subset of columns in a table.
In Beeline, you can grant privileges on an object that doesn't exist. For example, you can grant role1 on table1 and then create table1.

For more information, see Authorization Privilege Model for Hive and Impala, Authorization Privilege Model for Solr, and Using Kafka with Sentry Authorization.

Granting Privileges

For example, a rule for the Select privilege on table customers from database sales is formulated as follows:

server=server1->db=sales->table=customer->action=Select

To assign the Select privilege to the sales_read role on the Id column from the customers table, the rule would be as follows:

sales_read = server=server1->db=sales->table=customers->column=Id->action=select

Each object must be specified as a hierarchy of the containing objects, from server to table, followed by the privilege granted for that object. A role can contain multiple such rules, separated by commas. For example, a role might contain the Select privilege for the customer and items tables in the sales database, and the Insert privilege for the sales_insights table in the reports database. You would specify this as follows:

sales_reporting =                                            \
server=server1->db=sales->table=customer->action=Select,     \
server=server1->db=sales->table=items->action=Select,         \
server=server1->db=reports->table=sales_insights->action=Insert

User to Group Mapping

Minimum Required Role: Configurator (also provided by Cluster Administrator, Full Administrator)

You can configure Sentry to use Hadoop groups. By default, Sentry looks up groups locally, but it can be configured to look up Hadoop groups using LDAP (for Active Directory). User/group information for Sentry, Hive and Impala must be made available for lookup on the following hosts:

Sentry - Groups are looked up on the host the Sentry Server runs on.
Hive - Groups are looked up on the hosts running HiveServer2 and the Hive Metastore.
Impala - Groups are looked up on the Catalog Server and on all of the Impala daemon hosts.

Group mappings in Sentry can be summarized as in the figure below.

The Sentry service only uses HadoopUserGroup mappings. See Configuring LDAP Group Mappings for details on configuring LDAP group mappings in Hadoop.

Authorization Privilege Model for Hive and Impala

Privileges can be granted on different objects in the Hive warehouse. Any privilege that can be granted is associated with a level in the object hierarchy. If a privilege is granted on a container object in the hierarchy, the base object automatically inherits it. For instance, if a user has ALL privileges on the database scope, then (s)he has ALL privileges on all of the base objects contained within that scope.

Object Hierarchy

Server
     URI
     Database
         Table
             Partition
             Columns
         View

Valid privilege types and objects they apply to
Privilege	Object
INSERT	DB, TABLE
SELECT	DB, TABLE, VIEW, COLUMN
ALL	SERVER, TABLE, DB, URI

Note that when you grant ALL on a URI, those permissions extend into the subdirectories in that path. For example, if a role has ALL on the following URI:

hdfs://host:port/directory_A/directory_B

That role will also have ALL on these directories:

hdfs://host:port/directory_A/directory_B/directory_C
hdfs://host:port/directory_A/directory_B/directory_C/directory_D
hdfs://host:port/directory_A/directory_B/directory_E

URI permissions do not affect HDFS ACL's.

Privilege hierarchy
Base Object	Granular privileges on object	Container object that contains the base object	Privileges on container object that implies privileges on the base object
DATABASE	ALL	SERVER	ALL
TABLE	INSERT	DATABASE	ALL
TABLE	SELECT	DATABASE	ALL
COLUMN	SELECT	DATABASE	ALL
VIEW	SELECT	DATABASE	ALL

Privilege Tables for Hive and Impala

The following three tables list the privileges that are required to perform operations for Hive, Impala, and operations that apply to both Hive and Impala. All possible privileges are listed for each operation. For example, to perform the ALTER DATABASE command in Hive, the user can have the ALL privilege on the SERVER or the DATABASE.

Privilege table for Hive-only operations
Operation	Required Privileges	Scope
ALTER DATABASE	ALL	SERVER, DATABASE
ALTER TABLE .. CLUSTERED BY.. SORTED BY	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. ENABLE / DISABLE	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. PARTITION ENABLE / DISABLE	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. PARTITION.. RENAME TO PARTITION	ALL	SERVER, DATABASE, TABLE
ALTER TABLE TOUCH	ALL	SERVER, DATABASE, TABLE
ALTER TABLE TOUCH PARTITION	ALL	SERVER, DATABASE, TABLE
ANALYZE TABLE	ALL	SERVER, DATABASE, TABLE
	SELECT	TABLE
	INSERT	TABLE
CREATE INDEX	ALL	SERVER, DATABASE, TABLE
CREATE INDEX	CREATE	SERVER, DATABASE, TABLE
ANALYZE TABLE	ALL	SERVER, DATABASE, TABLE
	SELECT	SERVER, DATABASE, TABLE, COLUMN
	INSERT	SERVER, DATABASE, TABLE
	REFRESH	SERVER, DATABASE, TABLE
DESCRIBE TABLE .. PARTITION	ALL	SERVER, DATABASE, TABLE
	SELECT	SERVER, DATABASE, TABLE
	INSERT	SERVER, DATABASE, TABLE
DROP INDEX	ALL	SERVER, DATABASE, TABLE
EXPORT TABLE	ALL	SERVER, DATABASE, TABLE
GRANT PRIVILEGE	Allowed only for Sentry admin users
IMPORT TABLE	ALL	SERVER, DATABASE
INSERT OVERWRITE DIRECTORY	ALL	SERVER, DATABASE, TABLE
INSERT OVERWRITE DIRECTORY	INSERT	TABLE
MSCK REPAIR TABLE	ALL	SERVER, DATABASE, TABLE
REVOKE PRIVILEGE	Allowed only for Sentry admin users
SHOW COLUMNS The output for this operation filters columns that the user does not have explicit `SELECT` access to.	ALL	SERVER, DATABASE, TABLE
	SELECT	SERVER, DATABASE, TABLE
	INSERT	SERVER, DATABASE, TABLE
SHOW INDEXES	ALL	SERVER, DATABASE, TABLE
	SELECT	SERVER, DATABASE, TABLE
	INSERT	SERVER, DATABASE, TABLE
	CREATE	SERVER
SHOW TABLE PROPERTIES	ALL	SERVER, DATABASE, TABLE
	SELECT	SERVER, DATABASE, TABLE
	INSERT	SERVER, DATABASE, TABLE

Privilege table for Impala-only operations
Operation	Required Privileges	Scope
COMPUTE INCREMENTAL STATS	ALL	SERVER, DATABASE, TABLE
COMPUTE STATS	ALL	SERVER, DATABASE, TABLE
DESCRIBE TABLE	ALL	SERVER, DATABASE, TABLE
	SELECT	SERVER, DATABASE, TABLE, COLUMN
	INSERT	SERVER, DATABASE, TABLE
	REFRESH	SERVER, DATABASE, TABLE
	CREATE	SERVER, DATABASE
EXPLAIN INSERT	ALL	SERVER, DATABASE, TABLE
EXPLAIN INSERT	INSERT	DATABASE, TABLE
EXPLAIN SELECT	ALL	SERVER, DATABASE, TABLE
EXPLAIN SELECT	SELECT	SERVER, DATABASE, TABLE, COLUMN
INVALIDATE METADATA	ALL	SERVER
INVALIDATE METADATA	REFRESH	SERVER
INVALIDATE METADATA <table name>	ALL	SERVER, DATABASE, TABLE
INVALIDATE METADATA <table name>	REFRESH	SERVER, DATABASE, TABLE
REFRESH <table name> or REFRESH <table name> PARTITION (<partition_spec>)	ALL	SERVER, DATABASE, TABLE
	REFRESH	SERVER, DATABASE, TABLE
SHOW COLUMN STATS	ALL	SERVER, DATABASE, TABLE
	SELECT	SERVER, DATABASE, TABLE
	INSERT	SERVER, DATABASE, TABLE
	REFRESH	SERVER, DATABASE, TABLE

Privilege table for Hive & Impala operations
Operation	Required Privileges	Scope
ALTER TABLE .. ADD COLUMNS	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. ADD PARTITION	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. ADD PARTITION or ALTER TABLE .. ADD PARTITION LOCATION	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. CHANGE COLUMN	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. DROP COLUMN	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. DROP PARTITION	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. SET FILEFORMAT	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. PARTITION SET SERDEPROPERTIES	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. RENAME	ALL	SERVER, DATABASE
ALTER TABLE .. REPLACE COLUMNS	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. SET FILE FORMAT	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. SET LOCATION	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. SET SERDEPROPERTIES	ALL	SERVER, DATABASE, TABLE
ALTER TABLE .. SET TBLPROPERTIES	ALL	SERVER, DATABASE, TABLE
ALTER VIEW This operation is allowed if you have column-level `SELECT` access to the columns being used.	ALL	SERVER, DATABASE, VIEW
ALTER VIEW .. RENAME	ALL	SERVER, DATABASE, VIEW
CREATE DATABASE	ALL	SERVER
CREATE DATABASE	CREATE	SERVER
CREATE FUNCTION	ALL	SERVER, DATABASE
CREATE FUNCTION	CREATE	SERVER, DATABASE
CREATE TABLE	ALL	SERVER, DATABASE
CREATE TABLE	CREATE	SERVER, DATABASE
CREATE TABLE .. AS SELECT This operation is allowed if you have column-level `SELECT` access to the columns being used.	ALL	SERVER, DATABASE
CREATE VIEW This operation is allowed if you have column-level `SELECT` access to the columns being used.	ALL	SERVER, DATABASE
DESCRIBE DATABASE	ALL	SERVER, DATABASE
	SELECT	SERVER, DATABASE
	INSERT	SERVER, DATABASE
	REFRESH	SERVER, DATABASE
DROP DATABASE	ALL	SERVER, DATABASE
DROP FUNCTION	ALL	SERVER, DATABASE
DROP TABLE	ALL	SERVER, DATABASE,TABLE
DROP VIEW	ALL	SERVER, DATABASE, VIEW
INSERT	ALL	SERVER, DATABASE, TABLE
INSERT	INSERT	SERVER, DATABASE, TABLE
INSERT OVERWRITE TABLE	ALL	SERVER, DATABASE, TABLE
INSERT OVERWRITE TABLE	INSERT	SERVER, DATABASE, TABLE
LOAD DATA	ALL	SERVER, DATABASE, TABLE
LOAD DATA	INSERT	SERVER, DATABASE, TABLE
SELECT	ALL	SERVER, DATABASE, TABLE
SELECT	SELECT	SERVER, DATABASE, TABLE, COLUMN
SELECT COLUMN	ALL	SERVER, DATABASE, TABLE
SELECT COLUMN	SELECT	SERVER, DATABASE, TABLE, COLUMN
SELECT TABLE	ALL	SERVER, DATABASE, TABLE
SELECT TABLE	SELECT	SERVER, DATABASE, TABLE
SELECT TABLE .. JOIN	ALL	SERVER, DATABASE, TABLE
SELECT TABLE .. JOIN	SELECT	SERVER, DATABASE, TABLE
SELECT VIEW You can grant the SELECT VIEW privilege on a view to give users access to specific columns of a table that they do not otherwise have access to.	ALL	SERVER, DATABASE, VIEW
	SELECT	SERVER, DATABASE, VIEW
SHOW CREATE TABLE	ALL	SERVER, DATABASE, TABLE
	SELECT	SERVER, DATABASE, TABLE
	INSERT	DATABASE, TABLE
	REFRESH	SERVER, DATABASE, TABLE
SHOW GRANT ROLE	ALL	SERVER, DATABASE, TABLE
	SELECT	SERVER, DATABASE, TABLE
	INSERT	SERVER, DATABASE, TABLE
SHOW PARTITIONS	ALL	SERVER, DATABASE, TABLE
	SELECT	SERVER, DATABASE, TABLE
	INSERT	SERVER, DATABASE, TABLE
	REFRESH	SERVER, DATABASE, TABLE
SHOW TABLES The output includes all the tables the user has table-level or column-level access to.	ALL	SERVER, DATABASE, TABLE
	SELECT	SERVER, DATABASE, TABLE, COLUMN, VIEW
	INSERT	SERVER, DATABASE, TABLE
	CREATE	SERVER, DATABASE
	REFRESH	SERVER, DATABASE, TABLE
USE	ALL	SERVER, DATABASE, TABLE
	SELECT	SERVER, DATABASE, TABLE, COLUMN, VIEW
	INSERT	SERVER, DATABASE, TABLE
	CREATE	SERVER, DATABASE, TABLE
	REFRESH	SERVER, DATABASE, TABLE

Authorization Privilege Model for Solr

The tables below refer to the request handlers defined in the generated solrconfig.xml.secure. If you are not using this configuration file, the below may not apply.

admin is a special collection in Sentry used to represent administrative actions. A non-administrative request may only require privileges on the collection or config on which the request is being performed. This is called either collection1 or config1 in these tables. An administrative request may require privileges on both the admin collection and collection1. This is denoted as admin, collection1 in the tables below.

Privilege table for non-administrative request handlers
Request Handler	Required Collection Privilege	Collections that Require Privilege
`select`	`QUERY`	`collection1`
`query`	`QUERY`	`collection1`
`get`	`QUERY`	`collection1`
`browse`	`QUERY`	`collection1`
`tvrh`	`QUERY`	`collection1`
`clustering`	`QUERY`	`collection1`
`terms`	`QUERY`	`collection1`
`elevate`	`QUERY`	`collection1`
`analysis/field`	`QUERY`	`collection1`
`analysis/document`	`QUERY`	`collection1`
`update`	`UPDATE`	`collection1`
`update/json`	`UPDATE`	`collection1`
`update/csv`	`UPDATE`	`collection1`

Privilege table for collections admin actions
Collection Action	Required Collection Privilege	Collections that Require Privilege
`create`	`UPDATE`	`admin`, `collection1`
`delete`	`UPDATE`	`admin`, `collection1`
`reload`	`UPDATE`	`admin`, `collection1`
`createAlias`	`UPDATE`	`admin`, `collection1` Note: `collection1` here refers to the name of the alias, not the underlying collection(s). For example, `http://YOUR-HOST:8983/ solr/admin/collections?action= CREATEALIAS&name=collection1 &collections=underlyingCollection`
`deleteAlias`	`UPDATE`	`admin`, `collection1` Note: `collection1` here refers to the name of the alias, not the underlying collection(s). For example, `http://YOUR-HOST:8983/ solr/admin/collections?action= DELETEALIAS&name=collection1`
`syncShard`	`UPDATE`	`admin`, `collection1`
`splitShard`	`UPDATE`	`admin`, `collection1`
`deleteShard`	`UPDATE`	`admin`, `collection1`

Privilege table for core admin actions
Collection Action	Required Collection Privilege	Collections that Require Privilege
`create`	`UPDATE`	`admin`, `collection1`
`rename`	`UPDATE`	`admin`, `collection1`
`load`	`UPDATE`	`admin`, `collection1`
`unload`	`UPDATE`	`admin`, `collection1`
`status`	`UPDATE`	`admin`, `collection1`
`persist`	`UPDATE`	`admin`
`reload`	`UPDATE`	`admin`, `collection1`
`swap`	`UPDATE`	`admin`, `collection1`
`mergeIndexes`	`UPDATE`	`admin`, `collection1`
`split`	`UPDATE`	`admin`, `collection1`
`prepRecover`	`UPDATE`	`admin`, `collection1`
`requestRecover`	`UPDATE`	`admin`, `collection1`
`requestSyncShard`	`UPDATE`	`admin`, `collection1`
`requestApplyUpdates`	`UPDATE`	`admin`, `collection1`

Privilege table for Info and AdminHandlers
Request Handler	Required Collection Privilege	Collections that Require Privilege
`LukeRequestHandler`	`QUERY`	`admin`
`SystemInfoHandler`	`QUERY`	`admin`
`SolrInfoMBeanHandler`	`QUERY`	`admin`
`PluginInfoHandler`	`QUERY`	`admin`
`ThreadDumpHandler`	`QUERY`	`admin`
`PropertiesRequestHandler`	`QUERY`	`admin`
`LoginHandler`	`QUERY`, `UPDATE` (or `*`)	`admin`
`ShowFileRequestHandler`	`QUERY`	`admin`

Privilege table for Config Admin actions
Config Action	Required Collection Privilege	Collections that Require Privilege	Required Config Privilege	Configs that Require Privilege
`CREATE`	`UPDATE`	`admin`	`*`	`config1`
`DELETE`	`UPDATE`	`admin`	`*`	`config1`