Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update LDAP docs with TLS encryption #274

Merged
merged 1 commit into from
Mar 13, 2024
Merged

Update LDAP docs with TLS encryption #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion admin-manual/customization/authentication.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,18 @@ 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.

.. 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
View file
Open in desktop
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
Loading