Skip to content

Commit 29915b2

Browse files
committed
add clarification about external auth methods
1 parent c91b8e4 commit 29915b2

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

DOCUMENTATION.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -853,27 +853,31 @@ Available backends:
853853
`remote_user`
854854
: Takes the username from the `REMOTE_USER` environment variable and disables
855855
HTTP authentication. This can be used to provide the username from a WSGI
856-
server.
856+
server which authenticated the client upfront. Required to validate, otherwise
857+
client can supply the header itself which is unconditionally trusted then.
857858

858859
`http_x_remote_user`
859860
: Takes the username from the `X-Remote-User` HTTP header and disables HTTP
860861
authentication. This can be used to provide the username from a reverse
861-
proxy.
862+
proxy which authenticated the client upfront. Required to validate, otherwise
863+
client can supply the header itself which is unconditionally trusted then.
862864

863865
`ldap` _(>= 3.3.0)_
864-
: Use a LDAP or AD server to authenticate users.
866+
: Use a LDAP or AD server to authenticate users by relaying credentials from client and handle result.
865867

866868
`dovecot` _(>= 3.3.1)_
867-
: Use a Dovecot server to authenticate users.
869+
: Use a Dovecot server to authenticate users by relaying credentials from client and handle result.
868870

869871
`imap` _(>= 3.4.1)_
870-
: Use an IMAP server to authenticate users.
872+
: Use an IMAP server to authenticate users by relaying credentials from client and handle result.
871873

872874
`oauth2` _(>= 3.5.0)_
873-
: Use an OAuth2 server to authenticate users.
875+
: Use an OAuth2 server to authenticate users by relaying credentials from client and handle result.
876+
Oauth2 authentication (SSO) directly on client is not supported. Use herefore `http_x_remote_user`
877+
in combination with SSO support in reverse proxy (e.g. Apache+mod_auth_openidc).
874878

875879
`pam` _(>= 3.5.0)_
876-
: Use local PAM to authenticate users.
880+
: Use local PAM to authenticate users by relaying credentials from client and handle result..
877881

878882
Default: `none` _(< 3.5.0)_ `denyall` _(>= 3.5.0)_
879883

0 commit comments

Comments
 (0)