Difference between revisions of "TLS/STARTTLS Localconfig Values"

(added History section, reformatted, updated descriptions and headings too)
(moved related external auth settings to SecureConfiguration / best practices page)
Line 46: Line 46:
  zmlocalconfig -e ldap_common_require_tls=0
  zmlocalconfig -e ldap_common_require_tls=0
= Related LDAP Authentication Settings =
When using external LDAP auth, check the following config option on the domain and servers. As a security best practice, servers and/or domains should be configured as the following:
zmprov gs `zmhostname` zimbraAuthLdapStartTlsEnabled
zimbraAuthLdapStartTlsEnabled: TRUE
In the rare event that authentication happens across a secure network '''and''' use of LDAP STARTTLS for authentication is causing performance problems, this option can be set to FALSE:
zmprov ms `zmhostname` zimbraAuthLdapStartTlsEnabled FALSE
zmprov md example.com zimbraAuthLdapStartTlsEnabled FALSE
= History =
= History =

Latest revision as of 18:56, 5 February 2016

TLS/STARTTLS LocalConfig Values

   KB 5766        Last updated on 2016-02-5  

(0 votes)

The following are security-related localconfig values. They following commands are run as the user zimbra. Restarting ZCS is required for the localconfig changes to go into effect.


zimbra_require_interprocess_security - LC key, defaults to 1 (True).

This setting determines if ZCS requires SSL/TLS for inter-process communications, such as LDAP and SMTP. As of ZCS8, it is recommended that this is always left enabled.

zmlocalconfig -e zimbra_require_interprocess_security=1

Note: Versions prior to ZCS8 sometimes set this to 0 to work around limitation in the mechanisms that were used to talk to LDAP over TLS which could limit performance and connection fail-over. Those issues were fixed in ZCS8. If necessary, disable it with:

zmlocalconfig -e zimbra_require_interprocess_security=0

See also: Zimbra Performance Tuning


ldap_starttls_supported - LC key, defaults to 1 (True).

Enables/disables if the LDAP server supports STARTTLS, and whether the LDAP client in the mailbox server, Postfix, and Amavis servers use TLS to communicate with the LDAP server. It is recommended to leave this enabled:

zmlocalconfig -e ldap_starttls_supported=1


ldap_starttls_required - LC key, defaults to "true".

Determines if starttls is required for java LDAP clients when connecting to the Zimbra LDAP server. As of ZCS8, it is recommended that this is always left enabled.

zmlocalconfig -e ldap_starttls_required=true

Note: Similar to zimbra_require_interprocess_security above, if TLS is causing performance issues on older ZCS installations (before ZCS8), disable it with:

zmlocalconfig -e ldap_starttls_required=false


ldap_common_require_tls - LC key, defaults to "0".

Controls OpenLDAP's required Security Strength Factors (SSF) level, which is an indication of relative strength of protection. A SSF greater than one (>1) roughly correlates to the effective encryption key length. The value sets the minimum security strength to require for connections. In general, this will be 128, but it depends on the strength of your generated cert/keys. You can view your ldap log level at 256 level to see what current strength incoming connections are using.

To disable it (if not still at the default):

zmlocalconfig -e ldap_common_require_tls=0


The following bugs may be useful when looking back at how various SSL/TLS related settings have evolved in the product:

Verified Against: Zimbra Collaboration 8.0, 7.0, 6.0 Date Created: 04/16/2014
Article ID: https://wiki.zimbra.com/index.php?title=TLS/STARTTLS_Localconfig_Values Date Modified: 2016-02-05

Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search