3 * StatusNet, the distributed open-source microblogging tool
5 * Plugin to enable LDAP Authentication
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Craig Andrews <candrews@integralblue.com>
25 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
34 class LdapAuthenticationPlugin extends AuthenticationPlugin
36 function onInitializePlugin(){
37 parent::onInitializePlugin();
38 if(!isset($this->attributes['nickname'])){
39 // TRANS: Exception thrown when initialising the LDAP Auth plugin fails because of an incorrect configuration.
40 throw new Exception(_m('You must specify a nickname attribute.'));
42 if($this->password_changeable && (! isset($this->attributes['password']) || !isset($this->password_encoding))){
43 // TRANS: Exception thrown when initialising the LDAP Auth plugin fails because of an incorrect configuration.
44 throw new Exception(_m('If password_changeable is set, the password attribute and password_encoding must also be specified.'));
46 $this->ldapCommon = new LdapCommon(get_object_vars($this));
49 function onAutoload($cls)
54 require_once(INSTALLDIR.'/plugins/LdapCommon/LdapCommon.php');
58 return parent::onAutoload($cls);
61 function onEndShowPageNotice($action)
63 $name = $action->trimmed('action');
69 if($this->autoregistration) {
70 // TRANS: Instructions for LDAP authentication.
71 $instr = _m('Do you have an LDAP account? Use your standard username and password.');
75 // TRANS: Instructions for LDAP authentication.
76 $instr = _m('Do you have an LDAP account? Use your standard username and password.');
83 $output = common_markup_to_html($instr);
84 $action->raw($output);
89 //---interface implementation---//
91 function checkPassword($username, $password)
93 return $this->ldapCommon->checkPassword($username,$password);
96 function autoRegister($username, $nickname)
98 if(is_null($nickname)){
99 $nickname = $username;
101 $entry = $this->ldapCommon->get_user($username,$this->attributes);
103 $registration_data = array();
104 foreach($this->attributes as $sn_attribute=>$ldap_attribute){
105 //ldap won't let us read a user's password,
106 //and we're going to set the password to a random string later anyways,
107 //so don't bother trying to read it.
108 if($sn_attribute != 'password'){
109 $registration_data[$sn_attribute]=$entry->getValue($ldap_attribute,'single');
112 if(isset($registration_data['email']) && !empty($registration_data['email'])){
113 $registration_data['email_confirmed']=true;
115 $registration_data['nickname'] = $nickname;
116 //set the database saved password to a random string.
117 $registration_data['password']=common_random_hexstr(16);
118 return User::register($registration_data);
120 //user isn't in ldap, so we cannot register him
125 function changePassword($username,$oldpassword,$newpassword)
127 return $this->ldapCommon->changePassword($username,$oldpassword,$newpassword);
130 function suggestNicknameForUsername($username)
132 $entry = $this->ldapCommon->get_user($username, $this->attributes);
134 //this really shouldn't happen
135 $nickname = $username;
137 $nickname = $entry->getValue($this->attributes['nickname'],'single');
139 $nickname = $username;
142 return common_nicknamize($nickname);
145 function onPluginVersion(array &$versions)
147 $versions[] = array('name' => 'LDAP Authentication',
148 'version' => GNUSOCIAL_VERSION,
149 'author' => 'Craig Andrews',
150 'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/LdapAuthentication',
152 // TRANS: Plugin description.
153 _m('The LDAP Authentication plugin allows for StatusNet to handle authentication through LDAP.'));