docs(ldap): document how authentication.admin.users is compared - #504
Merged
Conversation
The names in `authentication.admin.users` are a block list for SSO, and a directory does not distinguish case in an account name, so 15.8 lets `authentication.admin.users.ignore.case` decide how they are compared. It ships as `auto`, which ignores case only where `ldap.provider.url` names a directory. Adds the section to the LDAP integration guide in all seven languages and the key to the English property reference, with a note on what changes for an installation that has an account whose name differs from a reserved one only in case.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents
authentication.admin.users.ignore.case, added by codelibs/fess#3316.Why
The names in
authentication.admin.usersare reserved by Fess for itself, and for SSO they act as a block list:SpnegoAuthenticatorresolves no credential for a name that matches one, and form login does not take such a name to LDAP either. A directory does not distinguish case in an account name — Active Directory issues a ticket for any casing of one — so comparing exactly let the same account log in by changing the spelling.15.8 lets
authentication.admin.users.ignore.casedecide the comparison. It ships asauto: case is ignored only whereldap.provider.urlnames a directory, and compared exactly where it does not, which is where the comparison cannot change any outcome anyway.Change
<lang>/15.8/config/ldap-integration.rst(de, en, es, fr, ja, ko, zh-cn): a new "Reserved Admin User Names" section under the LDAP administration chapter, with a table for the two properties and a note on what changes for an installation that has a directory account whose name differs from a reserved one only in case — it stops being able to log in, and stops being synchronised to the directory from the admin UI.authentication.admin.users.ignore.case=falsekeeps the previous behaviour.en/15.8/config/properties.rst: the key in the permission table.