Differences

This shows you the differences between two versions of the page.

--- plugin:authenvvars [2020-05-03 12:45] – [Configuration and Settings] physiklehrer
+++ plugin:authenvvars [2021-09-05 10:28] (current) – physiklehrer
@@ Line 7: / Line 7: @@
 type       : action, auth
 lastupdate : 2020-05-02
-compatible : Frusterick Manners, 2017-02-19
+compatible : Frusterick Manners, Hogfather
 depends    :
 conflicts  :
@@ Line 29: / Line 29: @@
 protocol. The module places authentication and user information in OIDC_CLAIM_ environment variables.
-The goal of this plugin is to bypass the dokuwiki authentication mechanisms an use the webserver
+The goal of this plugin is to bypass the dokuwiki authentication mechanisms and use the webserver
 environment variables for user information. Not dokuwiki ist responseable for authentication but
 the webserver.
@@ Line 41: / Line 41: @@
 Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin.
+Be sure to enable authennvars by setting $conf['authtype'] = 'authenvvars' in conf/dokuwiki.php.
 ===== Usage =====
@@ Line 50: / Line 52: @@
 $conf['plugin']['authenvvars']['emailvar']    = 'AUTHENTICATE_MAIL';
 $conf['plugin']['authenvvars']['groupsvar']   = 'AUTHENTICATE_MEMBERUID';
+$conf['plugin']['authenvvars']['groupformat'] = 'json';
 $conf['plugin']['authenvvars']['groupattr']   = '';
+$conf['plugin']['authenvvars']['groupsep']    = ';';
 </code>
 The correct environment variable depends on the webserver modul. Consult the webserver module documentation for the provided environment variables.
@@ Line 61: / Line 65: @@
 The possible Apache configuration is shown in conjunction with the plugin configuration.
 ==== Apache: mod-authnz-ldap ====
-vhost.conf of the webserver:
+''vhost.conf'' of the webserver:
 <code apache>
 <VirtualHost *:443>
@@ Line 71: / Line 75: @@
     DocumentRoot /var/www/html/mydocroot
-    AuthLDAPUrl "ldaps://ldap.server/dc=ldap,dc=server?gecos,mail?sub?(objectClass=inetOrgPerson)"
+    AuthLDAPUrl "ldaps://ldap.server/dc=ldap,dc=server?gecos,mail,memberuid?sub?(objectClass=inetOrgPerson)"
     AuthLDAPBindDN cn=search,ou=dn,ou=to,dc=ldap,dc=server
     AuthLDAPBindPassword secret-for-binddn
@@ Line 79: / Line 83: @@
 </code>
-conf/local.php of dokuwiki:
+''conf/local.php'' of dokuwiki:
 <code php>
 $conf['plugin']['authenvvars']['useridvar']   = 'REMOTE_USER';
 $conf['plugin']['authenvvars']['usernamevar'] = 'AUTHENTICATE_GECOS';
 $conf['plugin']['authenvvars']['emailvar']    = 'AUTHENTICATE_MAIL';
-$conf['plugin']['authenvvars']['groupsvar']   = '';
+$conf['plugin']['authenvvars']['groupsvar']   = 'AUTHENTICATE_MEMBERUID';
-$conf['plugin']['authenvvars']['groupattr']   = '';
+$conf['plugin']['authenvvars']['groupformat'] = 'csv';
+$conf['plugin']['authenvvars']['groupattr']   = '';  // Not used in case of groupformat = csv
+$conf['plugin']['authenvvars']['groupsep']    = ';';
 </code>
 ==== Apache: mod-auth-openidc ====
@@ Line 114: / Line 120: @@
 $conf['plugin']['authenvvars']['emailvar']    = 'OIDC_CLAIM_email';
 $conf['plugin']['authenvvars']['groupsvar']   = 'OIDC_CLAIM_groups';
+$conf['plugin']['authenvvars']['groupformat'] = 'json';
 $conf['plugin']['authenvvars']['groupattr']   = 'act';
+$conf['plugin']['authenvvars']['groupsep']    = ';'; // Not used in case of groupformat = json
 </code>
 ===== Configuration and Settings =====
@@ Line 122: / Line 130: @@
 | ''usernamevar''  | The environment varibale which contains the users name.                                                                                                                                     |
 | ''emailvar''     | The environment varibale which contains the users email address.                                                                                                                            |
-| ''groupsvar''    | The environment varibale which contains the groups. This plugin expects an array or an object in form of a valid JSON-String. json_decode() decodes the string into an (associated) array. Only the values of that array are important.  |
+| ''groupsvar''    | The environment varibale which contains the groups. This plugin expects in case of ''groupformat=json'' an array or an object in form of a valid JSON-String. json_decode() decodes the string into an (associated) array. Only the values of that array are important. Or this plugin expects a comma-separated String of groupnames in case of ''groupformat=csv'' |
-| ''groupsattr''   | Contains the required key if the values of the group array are (associative) arrays.                                                                                                        |
+| ''groupformat'' | Possible values are json or csv |
+| ''groupattr''   | In case of ''groupformat=json'':Contains the required key if the values of the group array are (associative) arrays.                                                                                                       |
+| ''groupsep'' | Field seperator in case of ''groupformat=csv''|