Configuring LDAP in AWS Edition enterprise

It is best to choose either Dremio-managed user authentication or LDAP authentication at the start of your Project. Switching from Dremio-managed to LDAP requires you to delete all existing internal users. Any user-specific data will be lost in this process.

As Dremio requires at least one user to create access credentials upon initial provisioning of Dremio, in all cases there will be at least one internal user. This will require an initial setup of deleting all existing users.

Important information when switching to LDAP-managed user control

• delete-all-users is a dremio-admin CLI command that allows the admin to delete all internal users, roles, and home spaces associated with the users. This command runs successfully when the Dremio server is not running as it accesses the KV store.
• When you restart Dremio in non-ldap mode, you will be directed to the first-user creation page. If you restart in ldap mode, you will be directed to the login page.
• When the delete-all-users command is executed, all internal users, roles, and home spaces (i.e any data residing within the home spaces) will be lost.

To switch from Dremio-managed user authentication to LDAP-managed user authentication

1. Enter license activation key into the Dremio UI to enable enterprise features. Admin -> Engine -> Activation
2. SSH into the coordinator node
3. Stop Dremio (sudo service dremio stop)
4. Cd into /opt/dremio/bin
5. Delete all existing internal users, roles, and home spaces (sudo -u dremio ./dremio-admin delete-all-users)
6. Create ad.json in /opt/dremio/conf
7. Add config to /opt/dremio/conf/dremio.conf
   • services.coordinator.web.auth.type=ldap
   • services.coordinator.web.auth.ldap_config=ad.json
8. Start dremio (sudo service dremio start)
9. Log in with LDAP credentials

Configuring Dremio for LDAP

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 Microsoft AD 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.

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.

   autoAdminFirstUser setting

   autoAdminFirstUser : false
   

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

   Example users and groups properties

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

Deleting Users