Tableau Server that is configured to connect to an external LDAP identity store must query the LDAPÂ directory and establish a session. The process of establishing a session is called binding. There are multiple ways to bind. Tableau Server supports two methods of binding to an LDAPÂ directory:
Simple bind:Â Establishes a session by authenticating with a username and password. By default, Tableau Server will attempt StartTLS to encrypt sessions when connecting to Windows Active Directory. If Tableau Server has a valid TLSÂ certificate, then the session will be encrypted. Otherwise, LDAP with simple bind is not encrypted. If you are configuring LDAP with simple bind, we strongly recommend that you enable LDAPÂ over SSL/TLS.
GSSAPI bind: GSSAPI uses Kerberos to authenticate. When configured with a keytab file, authentication is secure during GSSAPI bind. However, subsequent traffic to the LDAPÂ server is not encrypted. We recommend configuring LDAP over SSL/TLS . Important: StartTLS is not supported for GSSAPI bind with Active Directory.
If you are running Tableau Server on Linux on a computer that is joined to an Active Directory domain, you can configure GSSAPI. See LDAP with GSSAPI (Kerberos) bind.
This topic describes how to encrypt the channel for simple LDAPÂ bind for communications between Tableau Server and LDAPÂ directory servers.
Certificate requirementsYou must have a valid PEM-encoded x509 SSL/TLS certificate that can be used for encryption. The certificate file must have an extension .crt.
Self-signed certificates are not supported.
The certificate you install must include Key Encipherment
in the key usage field to be used for SSL/TLS. Tableau Server will only use this certificate for encrypting the channel to the LDAPÂ server. The expiry, trust, and CRL and other attributes are not validated.
If you are running Tableau Server in a distributed deployment, then you must manually copy the SSLÂ certificate to each node in the cluster. Copy the certificate only to those nodes where the Tableau Server Application Server process is configured. Unlike other shared files in a cluster environment, the SSLÂ certificate used for LDAP will not be automatically distributed by the Client File Service.
If you do not have certificates already in place on your computer that are configured for the LDAPÂ server then you must obtain a SSL certificate for the LDAP server and import it into the Tableau system keystore.
Use the "keytool" Java tool to import certificates. In a default installation, this tool is installed with Tableau Server in the following location:
/opt/tableau/tableau_server/packages/repository.<installer version>/jre/bin/keytool
.
The following command imports the certificate:
sudo "<installation_directory>/packages/repository*/jre/bin/keytool -importcert -file "<cert_directory/<cert_name.crt>" -alias "<cert_alias>" -keystore /etc/opt/tableau/tableau_server/tableauservicesmanagerca.jks -storepass changeit -noprompt
The password for the Java keystore is changeit
. (Do not change the password for the Java keystore).
Tableau Server 2021.1 and newer supports two methods for encrypting the LDAPÂ channel for simple bind: StartTLS and LDAPS.
StartTLS: This is the default configuration for communicating with Active Directory in Tableau Server 2021.2. Beginning with Tableau Server 2021.2, TLS is enforced for simple bind LDAPÂ connections to Active Directory. This default TLSÂ configuration is enforced for both new installations and for upgrade scenarios.
Note:Â StartTLS is only supported on Tableau Server on Linux when communicating with Active Directory and simple bind. StartTLSÂ is not supported for communication with other LDAPÂ server types or with GSSAPI.
The StartTLSÂ method works by establishing an insecure connection with the Active Directory server. After a client-server negotiation, the connection is upgraded to a TLS encrypted connection. As the default configuration, this scenario only requires a valid TLS certificate on Tableau Server. No other configuration is required.
LDAPS: Secure LDAP, or LDAPS, is a standard encrypted channel that requires more configuration. Specifically, in addition to a TLS certificate on Tableau Server, you must set the host name and the secure LDAPÂ port for the target LDAPÂ server.
LDAPS is supported on any LDAPÂ server, including Active Directory servers.
This section describes how to configure Tableau Server to use an encrypted channel for LDAPÂ simple bind.
When to configureYou must configure Tableau Server to use an encrypted channel for LDAP simple bind before Tableau Server is initialized or as part of configuring the initial node as mentioned in the âUse the TSM CLIâ tab in Configure Initial Node Settings.
For new installations of Tableau ServerIf your organization uses an LDAPÂ directory other than Active Directory, then you cannot use the TSMÂ GUIÂ Setup to configure the identity store as part of Tableau Server installation. Instead, you must use JSONÂ entity files to configure the LDAPÂ identity store. See identityStore Entity.
Before you configure the identityStore entity, import a valid SSL/TLS certificate into the Tableau key store as documented earlier in this topic.
Configuring LDAPS requires setting the hostname and sslPort options in the identityStore JSONÂ file.
For new installations in an Active Directory environmentIf you are using Active Directory as an external identity store, you must run the GUIÂ version of Tableau Server Setup. Unlike the CLI process for installing Tableau Server, the GUI version of Setup includes logic to simplify and validate Active Directory configuration.
The Tableau Server Setup GUI where you configure Active Directory is shown here.
If you are installing a new instance of Tableau Server on Linux and you have a valid SSL/TLS certificate installed in the Tableau keystore, we recommend that you leave the default option set to StartTLS.
If you want to configure for LDAPS, then enter the hostname and secure port (typically 636) for the LDAP server, before selecting the LDAPS option.
You can make changes to these configurations after you install by signing into TSMÂ Web UI, clicking the Configuration tab, User Identity & Access, and then Identity Store.
Upgrade scenariosIf you are upgrading to a 2021.2 (or newer) version of Tableau Server and using Active Directory as your external identity store, then the encrypted channel is enforced for LDAP simple bind connections. If you do not have an encrypted channel configured, then upgrade will fail.
To successfully upgrade to version 2021.2 or newer, one of the following must be true:
If you are running Tableau Server on Linux and connecting to Active Directory, you can disable the encrypted channel requirement.
When disabled, user credentials that are used to establish the bind session with Active Directory are communicated in plaintext between Tableau Server and the Active Directory server.
Disable new installationIf you will be using Active Directory as your identity store, then you must use the TSMÂ GUIÂ to configure the Active Directory connection. See Configure Initial Node Settings.
Select LDAP (unencrypted channel) when running Setup.
Disable before upgradingIf you are upgrading to Tableau Server 2021.2 (or newer) from an earlier version, run the following commands on earlier version of Tableau Server before you upgrade:
tsm configuration set -k wgserver.domain.ldap.starttls.enabled -v false --force-keys
tsm pending-changes apply
To verify that the key has been set, run the following command:
tsm configuration get -k wgserver.domain.ldap.starttls.enabled
The command should return false
.
The following error messages may be displayed or logged. If you see these errors, do the following:
The following error will be displayed if you have misconfigured LDAPS or StartTLS when running the Setup or Upgrade GUI.
TLS handshake failed. Tableau Server and the Active Directory server could not negotiate a compatible level of security.
Vizportal logs
If you are configuring LDAPS or StartTLS using CLI, the following error message will not be displayed. Rather, the error will be logged in the vizportal logs at /var/opt/tableau/tableau_server/data/tabsvc/logs/vizportal
.
Authentication with LDAP server failed. The provided credentials or configuration are either incorrect or do not have the necessary permissions to bind.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4