Configuring LDAP authentication

Lightweight Directory Access Protocol (LDAP) is an authentication management service used with Microsoft Active Directory and other directory services. Once LDAP authentication has been configured for SQream, authorization for all existing and newly added roles must be handled by the LDAP server, except for the initial system deployment sqream role, which was immediately given full control permissions when SQream was initially deployed.

Before integrating SQream with LDAP consider the following:

  • If SQream DB is being installed within an environment where LDAP is already configured, it is best practice to ensure that the newly created SQream role names are consistent with existing LDAP user names.

  • If SQream DB has been installed and LDAP has not yet been integrated with SQream, it is best practice to ensure that the newly created LDAP user names are consistent with existing SQream role names. Previously existing SQream roles that were mistakenly not configured in LDAP or that have names which are different than in LDAP, will be recreated in SQream as roles that cannot log in, have no permissions, and have no default schema.

Before You Begin

Enable self-signed certificates for OpenLDAP by adding the following line to the ldap.conf configuration file:

``TLS_REQCERT allow``

Configuring SQream roles

Follow this procedure if you already have LDAP configured for your environment.

  1. Create a new role:

CREATE ROLE <new_role>;
  1. Grant the new role login permission:

GRANT LOGIN TO <new_role>;
  1. Grant the new role CONNECT permission:

GRANT CONNECT ON DATABASE <my_database> TO <new_role>;

You may also wish to rename SQream roles so that they are consistent with existing LDAP user names.

Configuring LDAP Authentication

Configuration Methods

To configure LDAP authentication for SQream, you may choose one of the following configuration methods:

Method

Description

Basic method

A traditional approach to authentication in which the user provides a username and password combination to authenticate with the LDAP server. In this approach, all users are given access to SQream.

Advanced method

This approach allows for compartmentalization, which means that users can be grouped into categories, and each category can be assigned or denied access to SQream. This allows administrators to control access to SQream.

Basic Method

Flag Attributes

To enable basic LDAP authentication, configure the following cluster flag attributes using the ALTER SYSTEM SET command:

Attribute

Description

authenticationMethod

Configure an authentication method: sqream or ldap. To configure LDAP authentication, choose ldap.

ldapIpAddress

Configure the IP address or the Fully Qualified Domain Name (FQDN) of your LDAP server and select a protocol: ldap or ldaps. Sqream recommends using the encrypted ldaps protocol.

ldapConnTimeoutSec

Configure the LDAP connection timeout threshold (seconds). Default = 30 seconds.

ldapPort

LDAP server port number.

ldapAdvancedMode

Configure either basic or advanced authentication method. Default = false.

ldapPrefix

String to prefix to the user name when forming the DN to bind as, when doing simple bind authentication.

ldapSuffix

String to append to the user name when forming the DN to bind as, when doing simple bind authentication.

Basic Method Configuration

Only roles with admin privileges or higher may enable LDAP Authentication.

Procedure

  1. Set the authenticationMethod attribute:

ALTER SYSTEM SET authenticationMethod = 'ldap';
  1. Set the ldapIpAddress attribute:

ALTER SYSTEM SET ldapIpAddress = '<ldaps://...>';
  1. Set the ldapPrefix attribute:

ALTER SYSTEM SET ldapPrefix = '<DN_binding_string_prefix>=';
  1. Set the ldapSuffix attribute:

ALTER SYSTEM SET ldapSuffix  = '<DN_binding_string_suffix>';
  1. To set the ldapPort attribute (Optional), run:

ALTER SYSTEM SET ldapPort = <port_number>
  1. To set the ldapConnTimeoutSec attribute (Optional), run:

ALTER SYSTEM SET ldapConnTimeoutSec = <15>;
  1. Restart all sqreamd servers.

Example

After completing the setup above, we can try to bind to a user by a distinguished name. For example, if the DN of the user is:

CN=ElonMusk,OU=Sqream Users,DC=sqream,DC=loc

We could set the ldapPrefix and ldapSuffix to

ALTER SYSTEM SET ldapPrefix = 'CN=';

ALTER SYSTEM SET ldapSuffix  = ',OU=Sqream Users,DC=sqream,DC=loc';

Logging in will be possible using the username ElonMusk using sqream client

./sqream sql --username=ElonMusk --password=sqream123 --databasename=master --port=5000

Advanced Method

Flag Attributes

To enable advanced LDAP authentication, configure the following cluster flag attributes using the ALTER SYSTEM SET command:

Attribute

Description

authenticationMethod

Configure an authentication method: sqream or ldap. To configure LDAP authentication, choose ldap.

ldapIpAddress

Configure the IP address or the Fully Qualified Domain Name (FQDN) of your LDAP server and select a protocol: ldap or ldaps. Sqream recommends using the encrypted ldaps protocol.

ldapConnTimeoutSec

Configure the LDAP connection timeout threshold (seconds). Default = 30 seconds.

ldapPort

LDAP server port number.

ldapAdvancedMode

Set ldapAdvancedMode = true.

ldapBaseDn

Root DN to begin the search for the user in, when doing advanced authentication.

ldapBindDn

DN of user with which to bind to the directory to perform the search when doing search + bind authentication.

ldapBindDnPassword

Password for user with which to bind to the directory to perform the search when doing search + bind authentication.

ldapSearchAttribute

Attribute to match against the user name in the search when doing search + bind authentication. If no attribute is specified, the uid attribute will be used.

Advanced Method Configuration

Only roles with admin privileges and higher may enable LDAP Authentication.

Procedure

  1. Set the authenticationMethod attribute:

ALTER SYSTEM SET authenticationMethod = 'ldap';
  1. Set the ldapAdvancedMode attribute:

ALTER SYSTEM SET ldapAdvancedMode = true;
  1. Set the ldapIpAddress attribute:

ALTER SYSTEM SET ldapIpAddress = '<ldaps://<IpAddress>';
  1. Set the ldapBindDn attribute:

ALTER SYSTEM SET ldapBindDn = <binding_user_DN>;
  1. Set the ldapBindDnPassword attribute:

ALTER SYSTEM SET ldapBindDnPassword = '<binding_user_password>';
  1. Set the ldapBaseDn attribute:

ALTER SYSTEM SET ldapBaseDn = '<search_root_DN>';
  1. Set the ldapSearchAttribute attribute:

ALTER SYSTEM SET ldapSearchAttribute = '<search_attribute>';
  1. To set the ldapPort attribute (Optional), run:

ALTER SYSTEM SET ldapPort = <port_number>
  1. To set the ldapConnTimeoutSec attribute (Optional), run:

ALTER SYSTEM SET ldapConnTimeoutSec = <15>;
  1. Restart all sqreamd servers.

Example

After completing the setup above we can try to bind to a user by locating it by one of its unique attributes.

User DN =

CN=ElonMusk,OU=Sqream Users,DC=sqream,DC=loc

User has value of elonm for attribute sAMAccountName.

ALTER SYSTEM SET authenticationMethod = 'ldap';

ALTER SYSTEM SET ldapAdvancedMode = true;

ALTER SYSTEM SET ldapIpAddress = 'ldaps://192.168.10.20';

ALTER SYSTEM SET ldapPort = 5000

ALTER SYSTEM SET ldapBindDn = 'CN=LDAP admin,OU=network admin,DC=sqream,DC=loc';

ALTER SYSTEM SET ldapBindDnPassword = 'sqream123';

ALTER SYSTEM SET ldapBaseDn = 'OU=Sqream Users,DC=sqream,DC=loc';

ALTER SYSTEM SET ldapSearchAttribute = 'sAMAccountName';

ALTER SYSTEM SET ldapConnTimeoutSec = 30;

Logging in will be possible using the username elonm using sqream client

./sqream sql --username=elonm --password=<elonm_password> --databasename=master --port=5000

Disabling LDAP Authentication

To disable LDAP authentication and configure sqream authentication:

  1. Execute the following syntax:

ALTER SYSTEM SET authenticationMethod = 'sqream';
  1. Restart all sqreamd servers.