summaryrefslogtreecommitdiff
path: root/plugins/Ldap
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/Ldap')
-rw-r--r--plugins/Ldap/LdapPlugin.php105
-rw-r--r--plugins/Ldap/README23
-rw-r--r--plugins/Ldap/ldap.php108
3 files changed, 236 insertions, 0 deletions
diff --git a/plugins/Ldap/LdapPlugin.php b/plugins/Ldap/LdapPlugin.php
new file mode 100644
index 000000000..755562f54
--- /dev/null
+++ b/plugins/Ldap/LdapPlugin.php
@@ -0,0 +1,105 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Plugin to enable LDAP Authentication and Authorization
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category Plugin
+ * @package StatusNet
+ * @author Craig Andrews <candrews@integralblue.com>
+ * @copyright 2009 Craig Andrews http://candrews.integralblue.com
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link http://status.net/
+ */
+
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+ exit(1);
+}
+
+require_once INSTALLDIR.'/plugins/Ldap/ldap.php';
+
+class LdapPlugin extends Plugin
+{
+ private $config = array();
+
+ function __construct()
+ {
+ parent::__construct();
+ }
+
+ function onCheckPassword($nickname, $password, &$authenticated)
+ {
+ if(ldap_check_password($nickname, $password)){
+ $authenticated = true;
+ //stop handling of other events, because we have an answer
+ return false;
+ }
+ if(common_config('ldap','authoritative')){
+ //a false return stops handler processing
+ return false;
+ }
+ }
+
+ function onAutoRegister($nickname)
+ {
+ $user = User::staticGet('nickname', $nickname);
+ if (! is_null($user) && $user !== false) {
+ common_log(LOG_WARNING, "An attempt was made to autoregister an existing user with nickname: $nickname");
+ return;
+ }
+
+ $attributes=array();
+ $config_attributes = array('nickname','email','fullname','homepage','location');
+ foreach($config_attributes as $config_attribute){
+ $value = common_config('ldap', $config_attribute.'_attribute');
+ if($value!==false){
+ array_push($attributes,$value);
+ }
+ }
+ $entry = ldap_get_user($nickname,$attributes);
+ if($entry){
+ $registration_data = array();
+ foreach($config_attributes as $config_attribute){
+ $value = common_config('ldap', $config_attribute.'_attribute');
+ if($value!==false){
+ if($config_attribute=='email'){
+ $registration_data[$config_attribute]=common_canonical_email($entry->getValue($value,'single'));
+ }else if($config_attribute=='nickname'){
+ $registration_data[$config_attribute]=common_canonical_nickname($entry->getValue($value,'single'));
+ }else{
+ $registration_data[$config_attribute]=$entry->getValue($value,'single');
+ }
+ }
+ }
+ //set the database saved password to a random string.
+ $registration_data['password']=common_good_rand(16);
+ $user = User::register($registration_data);
+ //prevent other handlers from running, as we have registered the user
+ return false;
+ }
+ }
+
+ function onChangePassword($nickname,$oldpassword,$newpassword,&$errormsg)
+ {
+ //TODO implement this
+ $errormsg = _('Sorry, changing LDAP passwords is not supported at this time');
+
+ //return false, indicating that the event has been handled
+ return false;
+ }
+}
diff --git a/plugins/Ldap/README b/plugins/Ldap/README
new file mode 100644
index 000000000..617738e0b
--- /dev/null
+++ b/plugins/Ldap/README
@@ -0,0 +1,23 @@
+The LDAP plugin allows for StatusNet to handle authentication, authorization, and user information through LDAP.
+
+Installation
+============
+Add configuration entries to config.php. These entries are:
+
+The following are documented at http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
+$config['ldap']['binddn']
+$config['ldap']['bindpw']
+$config['ldap']['basedn']
+$config['ldap']['host']
+
+$config['ldap']['nickname_attribute'] Set this to the name of the ldap attribute that holds the username. For example, on Microsoft's Active Directory, this should be set to 'sAMAccountName'
+$config['ldap']['nickname_email'] Set this to the name of the ldap attribute that holds the user's email address. For example, on Microsoft's Active Directory, this should be set to 'mail'
+$config['ldap']['nickname_fullname'] Set this to the name of the ldap attribute that holds the user's full name. For example, on Microsoft's Active Directory, this should be set to 'displayName'
+$config['ldap']['nickname_homepage'] Set this to the name of the ldap attribute that holds the the url of the user's home page.
+$config['ldap']['nickname_location'] Set this to the name of the ldap attribute that holds the user's location.
+
+$config['ldap']['authoritative'] Set to true if LDAP's responses are authoritative (meaning if LDAP fails, do check the any other plugins or the internal password database)
+$config['ldap']['autoregister'] Set to true if users should be automatically created when they attempt to login
+
+Finally, add "addPlugin('ldap');" to the bottom of your config.php
+
diff --git a/plugins/Ldap/ldap.php b/plugins/Ldap/ldap.php
new file mode 100644
index 000000000..d92a058fb
--- /dev/null
+++ b/plugins/Ldap/ldap.php
@@ -0,0 +1,108 @@
+<?php
+/*
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2008, 2009, StatusNet, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
+
+require_once 'Net/LDAP2.php';
+
+function ldap_get_config(){
+ static $config = null;
+ if($config == null){
+ $config = array();
+ $keys = array('host','port','version','starttls','binddn','bindpw','basedn','options','scope');
+ foreach($keys as $key){
+ $value = common_config('ldap', $key);
+ if($value!==false){
+ $config[$key]=$value;
+ }
+ }
+ }
+ return $config;
+}
+
+function ldap_get_connection($config = null){
+ if($config == null){
+ $config = ldap_get_config();
+ }
+
+ //cannot use Net_LDAP2::connect() as StatusNet uses
+ //PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, 'handleError');
+ //PEAR handling can be overridden on instance objects, so we do that.
+ $ldap = new Net_LDAP2($config);
+ $ldap->setErrorHandling(PEAR_ERROR_RETURN);
+ $err=$ldap->bind();
+ if (Net_LDAP2::isError($err)) {
+ common_log(LOG_WARNING, 'Could not connect to LDAP server: '.$err->getMessage());
+ return false;
+ }
+ return $ldap;
+}
+
+function ldap_check_password($username, $password){
+ $ldap = ldap_get_connection();
+ if(!$ldap){
+ return false;
+ }
+ $entry = ldap_get_user($username);
+ if(!$entry){
+ return false;
+ }else{
+ $config = ldap_get_config();
+ $config['binddn']=$entry->dn();
+ $config['bindpw']=$password;
+ if(ldap_get_connection($config)){
+ return true;
+ }else{
+ return false;
+ }
+ }
+}
+
+/**
+ * get an LDAP entry for a user with a given username
+ *
+ * @param string $username
+ * $param array $attributes LDAP attributes to retrieve
+ * @return string DN
+ */
+function ldap_get_user($username,$attributes=array()){
+ $ldap = ldap_get_connection();
+ $filter = Net_LDAP2_Filter::create(common_config('ldap','nickname_attribute'), 'equals', $username);
+ $options = array(
+ 'scope' => 'sub',
+ 'attributes' => $attributes
+ );
+ $search = $ldap->search(null,$filter,$options);
+
+ if (PEAR::isError($search)) {
+ common_log(LOG_WARNING, 'Error while getting DN for user: '.$search->getMessage());
+ return false;
+ }
+
+ if($search->count()==0){
+ return false;
+ }else if($search->count()==1){
+ $entry = $search->shiftEntry();
+ return $entry;
+ }else{
+ common_log(LOG_WARNING, 'Found ' . $search->count() . ' ldap user with the username: ' . $username);
+ return false;
+ }
+}
+
generated by cgit v1.2.3-54-g00ecf (git 2.45.2) at 2024-09-10 10:52:27 +0000