Configuring LDAP authentication¶
Lightweight Directory Access Protocol (LDAP) is an authentication management service widely use with Microsoft Active Directory. Once it has been configured to authenticate SQream roles, all existing and newly added roles will be required to be authenticated by an LDAP server, with the exception of the initial system deployment sqream
role, which is granted full control permissions upon deployment.
Prior to integrating SQream with LDAP, two preconditions must be considered:
If SQream DB is being installed within an LDAP-integrated environment, it is best practice to ensure that the newly created SQream role names are consistent with existing LDAP user names.
If LDAP is being integrated with a SQream environment, it is best practice to ensure that the newly created LDAP user names are consistent with existing SQream role names. Note that after LDAP has been successfully integrated, SQream roles that were mistakenly not configured or have conflicting names with LDAP will be recreated in SQream as roles without the ability to log in, without permissions, and without a default schema.
In this topic:
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¶
Procedure
Create a new role:
CREATE ROLE <new_role>;
Grant new role login permission:
GRANT LOGIN TO <new_role>;
Grant the new role
CONNECT
permission:
GRANT CONNECT ON DATABASE <my_database> TO <new_role>;
You may also wish to rename SQream roles.
Configuring LDAP Authentication¶
Flag Attributes¶
To enable LDAP Authentication, configure the following cluster flag attributes using the ALERT SYSTEM SET
command:
Attribute |
Description |
---|---|
|
Configure an authentication method. Attribute may be set to either |
|
Configure users` domain. |
|
Configure the IP address or the Fully Qualified Domain Name (FQDN) of your LDAP server and select a protocol. Out of the |
|
Configure the LDAP connection timeout threshold (seconds). The default is 30 seconds. |
Enabling LDAP Authentication¶
Roles with admin privileges or higher may enable LDAP Authentication.
Procedure
Set the
ldapIpAddress
attribute:
ALTER SYSTEM SET ldapIpAddress = '<ldaps://...>';
Set the
ldapDomain
attribute:
ALTER SYSTEM SET ldapDomain = '<domain>';
To set the
ldapConnTimeoutSec
attribute (Optional), run:
ALTER SYSTEM SET ldapConnTimeoutSec = <...>;
Set the
authenticationMethod
attribute:
ALTER SYSTEM SET authenticationMethod = 'ldap';
Restart all sqreamd servers.
Example¶
ALTER SYSTEM SET ldapIpAddress = '<ldaps://192.168.10.20>';
ALTER SYSTEM SET ldapDomain = '<@sqream.loc>';
ALTER SYSTEM SET ldapConnTimeoutSec = <15>;
ALTER SYSTEM SET authenticationMethod = 'ldap';
Disabling LDAP Authentication¶
To disable LDAP authentication and configure sqream authentication:
Execute the following syntax:
ALTER SYSTEM SET authenticationMethod = 'sqream';
Restart all sqreamd servers.