This Apache Druid extension adds an Authorizer which implements access control for Druid, backed by Apache Ranger. Please see Authentication and Authorization for more information on the basic facilities this extension provides.
Make sure to include
druid-ranger-security in the extensions load list.
The latest release of Apache Ranger is at the time of writing version 2.0. This version has a dependency on
log4j 1.2.17 which has a vulnerability if you configure it to use a
SocketServer (CVE-2019-17571). Next to that, it also includes Kafka 2.0.0 which has 2 known vulnerabilities (CVE-2019-12399, CVE-2018-17196). Kafka can be used by the audit component in Ranger, but is not required.
Support for Apache Ranger authorization consists of three elements:
- configuring the extension in Apache Druid
- configuring the connection to Apache Ranger
- providing the service definition for Druid to Apache Ranger
Enabling the extension
Ensure that you have a valid authenticator chain and escalator set in your
common.runtime.properties. For every authenticator your wish to use the authorizer for, set
druid.auth.authenticator.<authenticatorName>.authorizerName to the name you will give the authorizer, e.g.
Then add the following and amend to your needs (in case you need to use multiple authorizers):
The following is an example that showcases using
druid-basic-security for authentication and
druid-ranger-security for authorization.
Contrary to the documentation of
druid-basic-auth Ranger does not automatically provision a highly privileged system user, you will need to do this yourself. This system user in the case of
druid-basic-auth is named
druid_system and for the escalator it is configurable, as shown above. Make sure to take note of these user names and configure
READ access to
state:STATE and to
config:security in your ranger policies, otherwise system services will not work properly.
Properties to configure the extension in Apache Druid
|Defines the keytab to be used while authenticating against Apache Ranger to obtain policies and provide auditing||null||No|
|Defines the principal to be used while authenticating against Apache Ranger to obtain policies and provide auditing||null||No|
|Determines if groups that the authenticated user belongs to should be obtained from Hadoop's ||null||No|
Configuring the connection to Apache Ranger
The Apache Ranger authorization extension will read several configuration files. Discussing the contents of those files is beyond the scope of this document. Depending on your needs you will need to create them. The minimum you will need to have is a
ranger-druid-security.xml file that you will need to put in the classpath (e.g.
_common). For auditing, the configuration is in
Adding the service definition for Apache Druid to Apache Ranger
At the time of writing of this document Apache Ranger (2.0) does not include an out of the box service and service definition for Druid. You can add the service definition to Apache Ranger by entering the following command:
curl -u <user>:<password> -d "@ranger-servicedef-druid.json" -X POST -H "Accept: application/json" -H "Content-Type: application/json" http://localhost:6080/service/public/v2/api/servicedef/
You should get back
json describing the service definition you just added. You can now go to the web interface of Apache Ranger which should now include a widget for "Druid". Click the plus sign and create the new service. Ensure your service name is equal to what you configured in
Configuring Apache Ranger policies
When installing a new Druid service in Apache Ranger for the first time, Ranger will provision the policies to allow the administrative user
read/write access to all properties and data sources. You might want to limit this. Do not forget to add the correct policies for the
druid_system user and the
internalClientUserName of the escalator.
Loading new data sources requires
write access to the
datasource prior to the loading itself. So if you want to create a datasource
wikipedia you are required to have an
allow policy inside Apache Ranger before trying to load the spec.
For information on what HTTP methods are supported for a particular request endpoint, please refer to the API documentation.
GET requires READ permission, while POST and DELETE require WRITE permission.
Queries on Druid datasources require DATASOURCE READ permissions for the specified datasource.
Queries on the INFORMATION_SCHEMA tables will return information about datasources that the caller has DATASOURCE READ access to. Other datasources will be omitted.
Queries on the system schema tables require the following permissions:
segments: Segments will be filtered based on DATASOURCE READ permissions.
servers: The user requires STATE READ permissions.
server_segments: The user requires STATE READ permissions and segments will be filtered based on DATASOURCE READ permissions.
tasks: Tasks will be filtered based on DATASOURCE READ permissions.
If you face difficulty grasping why access is denied to certain elements, and the
audit section in Apache Ranger does not give you any detail, you can enable debug logging for
org.apache.druid.security.ranger. To do so add the following in your
<!-- Set level="debug" to see access requests to Apache Ranger -->
<Logger name="org.apache.druid.security" level="debug" additivity="false">