Skip to content

Commit

Permalink
Update LDAP docs with TLS encryption
Browse files Browse the repository at this point in the history
  • Loading branch information
melaniekung committed Mar 13, 2024
1 parent 2515581 commit be8ba73
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
16 changes: 15 additions & 1 deletion admin-manual/customization/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,22 @@ Protocol (IP) network" (Wikipedia). When this is enabled, users attempting to
log in will use the credentials associated with their LDAP account, instead
of local account credentials, when :ref:`logging in <log-in>` to AtoM.

.. IMPORTANT::
LDAP authentication in AtoM, by default, uses StartTLS for encryption. StartTLS
starts an unencrypted plaintext connection to the LDAP server, on port 389, then
upgrades the connection to begin Transport Layer Security (TLS) encryption. The
use of StartTLS is on by default, but can be disabled via settings in the
:ref:`app.yml <config-app-yml>`.

.. WARNING::

While StartTLS encryption on the LDAP server can be disabled, we strongly
discourage doing so in a production environment.

Enabling LDAP authentication in AtoM requires manually editing a few AtoM
configuration files. For more general information on how to do this, see
:ref:`Manage AtoM configuration files <customization-config-files>`.

.. IMPORTANT::
To enable LDAP authentication in AtoM, manually installing the ``php-ldap``
extension is required.

Expand Down
4 changes: 4 additions & 0 deletions admin-manual/customization/config-files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,10 @@ such as:
additional details.
* ``directives``: The CSP `directives` setting contains the CSP policy that will
be sent in the CSP header. See :ref:`csp-configuration` for additional details.
* ``enable_tls_encryption``: Controls StartTLS encryption for LDAP authentication.
It defaults to true, even if this variable is not defined in the file, enabling
StartTLS, but can be set to false to disable StartTLS encryption. See
:ref:`ldap-enabling` for additional details.

.. image:: images/app-yml-settings.*
:align: center
Expand Down

0 comments on commit be8ba73

Please sign in to comment.