From f0fc02e5449ab53c00d973ff0ef626a8e745e519 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Sun, 25 Nov 2018 02:13:45 -0500 Subject: [PATCH] [ldapauth] Update config file style/name --- ldapauth/README | 38 ---------------------- ldapauth/README.md | 49 ++++++++++++++++++++++++++++ ldapauth/config/ldapauth.config.php | 50 +++++++++++++++++++++++++++++ ldapauth/config/ldapauth.ini.php | 50 ----------------------------- ldapauth/ldapauth.php | 4 +-- 5 files changed, 101 insertions(+), 90 deletions(-) delete mode 100644 ldapauth/README create mode 100644 ldapauth/README.md create mode 100644 ldapauth/config/ldapauth.config.php delete mode 100644 ldapauth/config/ldapauth.ini.php diff --git a/ldapauth/README b/ldapauth/README deleted file mode 100644 index 03e8b0d4..00000000 --- a/ldapauth/README +++ /dev/null @@ -1,38 +0,0 @@ -Authenticate a user against an LDAP directory -Useful for Windows Active Directory and other LDAP-based organisations -to maintain a single password across the organisation. -Optionally authenticates only if a member of a given group in the directory. - -By default, the person must have registered with Friendica using the normal registration -procedures in order to have a Friendica user record, contact, and profile. -However, it's possible with an option to automate the creation of a Friendica basic account. - -Note when using with Windows Active Directory: you may need to set TLS_CACERT in your site -ldap.conf file to the signing cert for your LDAP server. - -The configuration options for this module may be set in the config/addon.ini.php file -e.g.: - - [ldapauth] - // ldap hostname server - required - ldap_server = host.example.com - // dn to search users - required - ldap_searchdn = ou=users,dc=example,dc=com - // attribute to find username - required - ldap_userattr = uid - - // admin dn - optional - only if ldap server dont have anonymous access - ldap_binddn = cn=admin,dc=example,dc=com - // admin password - optional - only if ldap server dont have anonymous access - ldap_bindpw = password - - // for create Friendica account if user exist in ldap - // required an email and a simple (beautiful) nickname on user ldap object - // active account creation - optional - default none - ldap_autocreateaccount = true - // attribute to get email - optional - default : 'mail' - ldap_autocreateaccount_emailattribute = mail - // attribute to get nickname - optional - default : 'givenName' - ldap_autocreateaccount_nameattribute = givenName - -...etc. diff --git a/ldapauth/README.md b/ldapauth/README.md new file mode 100644 index 00000000..f37bb9d5 --- /dev/null +++ b/ldapauth/README.md @@ -0,0 +1,49 @@ +Authenticate a user against an LDAP directory +=== + +Useful for Windows Active Directory and other LDAP-based organisations +to maintain a single password across the organisation. +Optionally authenticates only if a member of a given group in the directory. + +By default, the person must have registered with Friendica using the normal registration +procedures in order to have a Friendica user record, contact, and profile. +However, it's possible with an option to automate the creation of a Friendica basic account. + +Note when using with Windows Active Directory: you may need to set TLS_CACERT in your site +ldap.conf file to the signing cert for your LDAP server. + +The configuration options for this module may be set in the `config/addon.config.php` file +e.g.: + + 'ldapauth' => [ + // ldap hostname server - required + 'ldap_server' => '', + + // admin dn - optional - only if ldap server dont have anonymous access + 'ldap_binddn' => '', + + // admin password - optional - only if ldap server dont have anonymous access + 'ldap_bindpw' => '', + + // dn to search users - required + 'ldap_searchdn' => '', + + // attribute to find username - required + 'ldap_userattr' => '', + + // DN of the group whose member can auth on Friendica - optional + 'ldap_group' => '', + + // To create Friendica account if user exists in ldap + // Requires an email and a simple (beautiful) nickname on user ldap object + // active account creation - optional - default true + 'ldap_autocreateaccount' => true, + + // attribute to get email - optional - default : 'mail' + 'ldap_autocreateaccount_emailattribute' => 'mail', + + // attribute to get nickname - optional - default : 'givenName' + 'ldap_autocreateaccount_nameattribute' => 'givenName', + ], + +...etc. diff --git a/ldapauth/config/ldapauth.config.php b/ldapauth/config/ldapauth.config.php new file mode 100644 index 00000000..e89a2b55 --- /dev/null +++ b/ldapauth/config/ldapauth.config.php @@ -0,0 +1,50 @@ + [ + // ldap_server (String) + // ldap hostname server - required + // Example: ldap_server = host.example.com + 'ldap_server' => '', + + // ldap_binddn (String) + // admin dn - optional - only if ldap server dont have anonymous access + // Example: ldap_binddn = cn=admin,dc=example,dc=com + 'ldap_binddn' => '', + + // ldap_bindpw (String) + // admin password - optional - only if ldap server dont have anonymous access + 'ldap_bindpw' => '', + + // ldap_searchdn (String) + // dn to search users - required + // Example: ldap_searchdn = ou=users,dc=example,dc=com + 'ldap_searchdn' => '', + + // ldap_userattr (String) + // attribute to find username - required + // Example: ldap_userattr = uid + 'ldap_userattr' => '', + + // ldap_group (String) + // DN of the group whose member can auth on Friendica - optional + 'ldap_group' => '', + + // ldap_autocreateaccount (Boolean) + // To create Friendica account if user exists in ldap + // Requires an email and a simple (beautiful) nickname on user ldap object + // active account creation - optional - default true + 'ldap_autocreateaccount' => true, + + // ldap_autocreateaccount_emailattribute (String) + // attribute to get email - optional - default : 'mail' + 'ldap_autocreateaccount_emailattribute' => 'mail', + + // ldap_autocreateaccount_nameattribute (String) + // attribute to get nickname - optional - default : 'givenName' + 'ldap_autocreateaccount_nameattribute' => 'givenName', + ], +]; diff --git a/ldapauth/config/ldapauth.ini.php b/ldapauth/config/ldapauth.ini.php deleted file mode 100644 index d707550b..00000000 --- a/ldapauth/config/ldapauth.ini.php +++ /dev/null @@ -1,50 +0,0 @@ -loadConfigFile(__DIR__. '/config/ldapauth.ini.php'); + $a->loadConfigFile(__DIR__ . '/config/ldapauth.config.php'); } function ldapauth_hook_authenticate($a, &$b) -- 2.39.5