Setting Up LDAP enterprise

To establish LDAP authentication, do the following on all coordinator nodes prior to deploying the Dremio cluster:

1. Configure Dremio to use LDAP authentication (via the dremio.conf file).
2. Configure LDAP (via the ad.json file).

Once the cluster is configured and deployed in LDAP mode,

• Dremio uses the users and groups defined in LDAP. Administrators cannot create additional users within Dremio.
• The first user to login with valid LDAP credentials is marked as the Administrator. At this point, other groups/users can be assigned as administrators.

Configuring Dremio for LDAP

To configure Dremio for LDAP, edit the dremio.conf file, and add the following properties:

services: {
  coordinator.enabled: true,
  coordinator.web.auth.type: "ldap",
  coordinator.web.auth.ldap_config: "ad.json"
}

Configuring LDAP

To configure LDAP, edit the ad.json file and add your properties.

This file located under the Dremio configuration directory (same as dremio.conf path) and is specified in the dremio.conf file as a coordinator service.

Properties

"CN=admin,DC=drem,DC=io"

Defining Users

The following examples show how to define users.

Example: Using userDNs

In the following example, a list of templates for user DNs are specified. The placeholder {0} is replaced with the username entered by the user and that DN is used during LDAP bind. Dremio attempts binding to the provided userDNs in the order they are specified.

"userDNs": ["cn={0},dc=staticsecurity,dc=dremio,dc=com"],
"userAttributes": {
	"firstname": "givenName",
	"lastname": "sn",
	"email": "mail"
}

Example: Using userAttributes

In this example, you are mapping LDAP user attributes to Dremio user attributes.

"userAttributes": {
	"baseDNs": [
		"OU=test,OU=ad,DC=drem,DC=io"
	],
	"searchScope": "SUB_TREE",
	"id": "sAMAccountName",
	"firstname": "givenName",
	"lastname": "sn",
	"email": "mail"
}

Example: Using userFilter

The following example using the userFilter property to limit access to members of the engineering group.

"userFilter": "&(objectClass=user)(memberOf=cn=engineering,OU=Groups,OU=ad,DC=drem,DC=io)",

Defining Groups

The following examples show how to define groups.

Example: Using groupDNs

In the following example, a list of templates for group DNs are specified. The placeholder {0} is replaced with the group name entered by the user. Dremio attempts searching given groupDNs in the order they are specified.

"groupDNs": ["cn={0},OU=engg,OU=test,OU=ad,DC=drem,DC=io"]

Example: Using groupAttributes

In this example, the groupAttributes property is used to specify a list of baseDNs and group name IDs. These properties map LDAP group attributes to Dremio group attributes. The baseDNs, searchScope, id properties are required.

"groupAttributes": {
    "baseDNs": ["dc=roles,dc=dremio,dc=com"],
    "searchScope": "SUB_TREE",
    "id": "CN"
 }

Defining User-Group Relationships

The relationship between users and groups can be defined with one of the following methods:

• Group membership
• Group lists

Group Membership

This method implements user entries in LDAP that list their group membership. (The user entries in LDAP are configured to list their group membership via the internal field memberOf.) See Sample Group Membership Configuration for a full example with the properties in context.

To establish this user-group relationship:

• Specify groupMembership property.
• Specify (if applicable) the groupRecursive property.

For example, if Dan is part of the BI group and the BI group is part of the engineering group, groupMembership property will contain only the BI group but the groupRecursive property will contain the engineering group.

"groupMembership": "memberOf",
"groupRecursive": "transitive-memberOf",

In addition, you can specify the "userGroupRelationship": "USER_ENTRY_LISTS_GROUPS" property-value, however, this property is optional since it is the default.

Group Lists

This method implements group entries in LDAP that lists users(by using the IDs of the users) that belong to that group . In the following sample, uid is the ID attribute that is used for the user entry and memberUid is the ID attribute that is used for the group entry.

"userGroupRelationship": "GROUP_ENTRY_LISTS_USERS",
  "groupEntryListsUsers": {
    "userEntryUserIdAttribute: "uid",
    "groupEntryUserIdAttribute": "memberUid"
  }

For example, Dan’s ID is 1234 and is represented by the attribute uid in Dan’s LDAP records. Dan is part of the BI group and the LDAP entry for group BI lists memberUid = 1234. This indicates that Dan is a valid member of the group.

Encrypting the LDAP Bind Password

When configuring Dremio, you might want to provide credentials to access third-party services. A common service that requires credential entry is the LDAP provider, which may request a password in order to bind Dremio to an LDAP external server for the purpose of obtaining user details during login. For customers with security standards and requirements, the use of password encryption offers a secure way to communicate key information with the LDAP service.

This is accomplished using the CLI command dremio-admin encrypt. Upon entering the command, Dremio then prompts for the entry of a string for use as the secret. The output URI may then be copied and pasted directly to the Dremio configuration file.

Example

This example goes through the process of LDAP encryption using the bind password.

To begin, you should perform the following command:

bin/dremio-admin encrypt thisIsSecret

Where thisIsSecret is the secret to be used for authentication purposes. Dremio then outputs a series of characters:

secret:1.FxLevnDdoHx58x7VZmBpNExUiM76_u7XAXo1SJ8mCJxzeC1SirK2Jm5aBRR-h2_r8iypOAcRYSzH4uyP33Vg6Fh94bV6evuQ.wENZ7fgdJBw92wy4DiPhpJRzNP07wBaVpspv8KygjMfYV2en3YPFZw==

You would then copy the entire output via ad.json bindPassword.

Regarding schemes, you may set this to either env or file. For env scheme, the bindPassword could be env:ldap with the env variable set to export ldap <secret> where <secret> is the output. For the file scheme, the bindPassword could be set to file:///tmp/test.file where the file specified contains the output secret. For both of these methods, this only applies to the local node. If you are using a multi-coordinator configuration, you need to do this for each coordinator node. However, this method contains the raw secret in both the env scheme and file.

Another scheme you may use is data, where the secret is in base64 format. You would use the same process above for establishing the secret, but with the bindPassword set to data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==.

Note:

The data, env, and file schemes all do not have encryption capabilities. Only secret may encrypt.

Note:

Dremio still accepts the old style bin password format.

Securing the Connection

The LDAP connection can be secured by specifying either ANY_SSL or TRUSTED_SSL. The default, PLAIN, is an unencrypted connection.

To set up TRUSTED_SSL mode, do the following:

• Update ad.json with the connectionMode set to TRUSTED_SSL.
• Update dremio.conf with javax.net.ssl settings for trustStore and trustStorePassword.

// ad.json entry for TRUSTED_SSL mode
"connectionMode": "TRUSTED_SSL",


// dremio.conf entry for TRUSTED_SSL mode with a self-signed certificate**
javax.net.ssl {
    trustStore: "<path/to/truststore/jks/file>",
    trustStorePassword: "trustStorePassword"
    }

Sample Group List Configuration

In the following example, the group list method is being implemented. You are defining the user-group relationship where the group entry lists the users that belong to that group).

To establish this user-group relationship:

• Set userGroupRelationship to GROUP_ENTRY_LISTS_USERS.
• Specify the groupEntryListsUsers property and it’s sub-properties, userEntryUserIdAttribute and groupEntryUserIdAttribute.

In the following example, uid is the ID attribute that is used for the user entry and memberUid is the ID attribute that is used for the group entry.

{
    "connectionMode": "PLAIN",
    "servers": [
        {
            "hostname": "host_ip",
            "port": 389
        }
    ],
    "names": {
        "bindDN": "CN=admin,DC=drem,DC=io",
        "bindMethod": "UNAUTHENTICATED",
        "bindPassword": "admin",
        "baseDN": "dc=drem,dc=io",
        "userFilter": "&(objectClass=posixAccount)",
        "userAttributes": {
            "baseDNs": [
                "OU=Users,OU=ldaptest,DC=drem,DC=io",
            ],
            "id": "uid",
            "firstname": "givenName",
            "lastname": "sn",
            "email": "mail"
        },
        "userGroupRelationship": "GROUP_ENTRY_LISTS_USERS",
        "groupEntryListsUsers": {
            "userEntryUserIdAttribute": "uid",
            "groupEntryUserIdAttribute": "memberUid"
        },
        "groupDNs": ["cn={0},OU=test,OU=ldaptest,DC=drem,DC=io",
                     "cn={0},OU=dev,OU=ldaptest,DC=drem,DC=io"],
        "groupFilter": "|(objectClass=posixGroup)(objectClass=sub)",
        "autoAdminFirstUser": false
    }
}

Sample Group Membership Configuration

The following sample is a Microsoft AD configuration that illustrates the group membership method (the user entry lists the groups that the user is a member of).

{
	"connectionMode": "PLAIN",
	"servers": [
		{
			"hostname": "<LDAP_HOST>",
			"port": 389
		}
	],
	"names": {
		"bindDN": "CN=Admin,OU=Users,OU=ad,DC=drem,DC=io",
		"bindPassword": "password",
		"baseDN": "dc=dremio,dc=io",
		"userFilter": "&(objectClass=user)(|(memberOf=CN=QA,OU=temps,OU=test,OU=ad,DC=drem,DC=io)(memberOf=CN=qa,OU=engg,OU=test,OU=ad,DC=drem,DC=io))",
		"userAttributes": {
			"baseDNs": [
				"OU=test,OU=ad,DC=drem,DC=io"
			],
			"searchScope": "SUB_TREE",
			"id": "sAMAccountName",
			"firstname": "givenName",
			"lastname": "sn",
			"email": "mail"
		},
		"groupMembership": "memberOf",
		"groupRecursive": "transitive-memberOf",
		"groupDNs": ["cn={0},OU=engg,OU=test,OU=ad,DC=drem,DC=io"],
		"groupFilter": "(objectClass=group)",
		"autoAdminFirstUser": true
	}
}

Granting Admin Privileges at Configuration Time

By default, the first valid LDAP user to log in to Dremio is given the Admin role. This is done via the autoAdminFirstUser: true property in the ad.json file. The assignment of the first valid user to Admin occurs during initial login.

Alternatively, you can specify a list of users and/or groups to be given the Admin role. This is valid only during initial login; it is used for boot-strapping only.

To specify users/groups as administrators up-front, during initial login:

1. In the ad.json file, set autoAdminFirstUser to false.

   Set autoAdminFirstUser to false

   autoAdminFirstUser: false
   

2. Create a file called bootstrap-admin-users.json under the Dremio configuration directory and add users and groups property information.

   Example settings for users and groups properties

   {
   users: ["joe", "bob"],
   groups: ["marketers", "sales wizards"]
   }
   

Deleting Users