Made the ldap plugin work, and add a readme

This commit is contained in:
Craig Andrews 2009-11-05 13:59:19 -05:00
parent 066331bdf7
commit 73e45bbfd9
3 changed files with 130 additions and 1 deletions

View File

@ -31,8 +31,12 @@ 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();
@ -40,6 +44,9 @@ class LdapPlugin extends Plugin
function onCheckPassword($nickname, $password, &$authenticated)
{
if(ldap_check_password($nickname, $password)){
$authenticated = true;
return false;
}
}
}

16
plugins/Ldap/README Normal file
View File

@ -0,0 +1,16 @@
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'
Finally, add "addPlugin('ldap');" to the bottom of your config.php

106
plugins/Ldap/ldap.php Normal file
View File

@ -0,0 +1,106 @@
<?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){
static $ldap = null;
if($ldap!=null){
return $ldap;
}
$config = ldap_get_config();
}
$ldap = Net_LDAP2::connect($config);
if (PEAR::isError($ldap)) {
common_log(LOG_WARNING, 'Could not connect to LDAP server: '.$ldap->getMessage());
return false;
}else{
return $ldap;
}
}
function ldap_check_password($username, $password){
$ldap = ldap_get_connection();
if(!$ldap){
return false;
}
$dn = ldap_get_user_dn($username);
if(!$dn){
return false;
}else{
$config = ldap_get_config();
$config['binddn']=$dn;
$config['bindpw']=$password;
if(ldap_get_connection($config)){
return true;
}else{
return false;
}
}
}
/**
* get an LDAP user's DN given the user's username
*
* @param string $username
* @return string DN
*/
function ldap_get_user_dn($username){
$ldap = ldap_get_connection();
$filter = Net_LDAP2_Filter::create(common_config('ldap','nickname_attribute'), 'equals', $username);
$options = array(
'scope' => 'sub',
'attributes' => array()
);
$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->dn();
}else{
common_log(LOG_WARNING, 'Found ' . $search->count() . ' ldap user with the username: ' . $username);
return false;
}
}