includes/AuthPlugin.php

   1 <?php
   2 /**
   3  */
   4 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
   5 # http://www.mediawiki.org/
   6 #
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 2 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License along
  18 # with this program; if not, write to the Free Software Foundation, Inc.,
  19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20 # http://www.gnu.org/copyleft/gpl.html
  21
  22 /**
  23  * Authentication plugin interface. Instantiate a subclass of AuthPlugin
  24  * and set $wgAuth to it to authenticate against some external tool.
  25  *
  26  * The default behavior is not to do anything, and use the local user
  27  * database for all authentication. A subclass can require that all
  28  * accounts authenticate externally, or use it only as a fallback; also
  29  * you can transparently create internal wiki accounts the first time
  30  * someone logs in who can be authenticated externally.
  31  */
  32 class AuthPlugin {
  33         /**
  34          * Check whether there exists a user account with the given name.
  35          * The name will be normalized to MediaWiki's requirements, so
  36          * you might need to munge it (for instance, for lowercase initial
  37          * letters).
  38          *
  39          * @param $username String: username.
  40          * @return bool
  41          */
  42         public function userExists( $username ) {
  43                 # Override this!
  44                 return false;
  45         }
  46
  47         /**
  48          * Check if a username+password pair is a valid login.
  49          * The name will be normalized to MediaWiki's requirements, so
  50          * you might need to munge it (for instance, for lowercase initial
  51          * letters).
  52          *
  53          * @param $username String: username.
  54          * @param $password String: user password.
  55          * @return bool
  56          */
  57         public function authenticate( $username, $password ) {
  58                 # Override this!
  59                 return false;
  60         }
  61
  62         /**
  63          * Modify options in the login template.
  64          *
  65          * @param $template UserLoginTemplate object.
  66          */
  67         public function modifyUITemplate( &$template ) {
  68                 # Override this!
  69                 $template->set( 'usedomain', false );
  70         }
  71
  72         /**
  73          * Set the domain this plugin is supposed to use when authenticating.
  74          *
  75          * @param $domain String: authentication domain.
  76          */
  77         public function setDomain( $domain ) {
  78                 $this->domain = $domain;
  79         }
  80
  81         /**
  82          * Check to see if the specific domain is a valid domain.
  83          *
  84          * @param $domain String: authentication domain.
  85          * @return bool
  86          */
  87         public function validDomain( $domain ) {
  88                 # Override this!
  89                 return true;
  90         }
  91
  92         /**
  93          * When a user logs in, optionally fill in preferences and such.
  94          * For instance, you might pull the email address or real name from the
  95          * external user database.
  96          *
  97          * The User object is passed by reference so it can be modified; don't
  98          * forget the & on your function declaration.
  99          *
 100          * @param User $user
 101          */
 102         public function updateUser( &$user ) {
 103                 # Override this and do something
 104                 return true;
 105         }
 106
 107
 108         /**
 109          * Return true if the wiki should create a new local account automatically
 110          * when asked to login a user who doesn't exist locally but does in the
 111          * external auth database.
 112          *
 113          * If you don't automatically create accounts, you must still create
 114          * accounts in some way. It's not possible to authenticate without
 115          * a local account.
 116          *
 117          * This is just a question, and shouldn't perform any actions.
 118          *
 119          * @return bool
 120          */
 121         public function autoCreate() {
 122                 return false;
 123         }
 124
 125         /**
 126          * Allow a property change? Properties are the same as preferences
 127          * and use the same keys. 'Realname' 'Emailaddress' and 'Nickname'
 128          * all reference this.
 129          *
 130          * @return bool
 131          */
 132         public function allowPropChange( $prop = '' ) {
 133                 if( $prop == 'realname' && is_callable( array( $this, 'allowRealNameChange' ) ) ) {
 134                         return $this->allowRealNameChange();
 135                 } elseif( $prop == 'emailaddress' && is_callable( array( $this, 'allowEmailChange' ) ) ) {
 136                         return $this->allowEmailChange();
 137                 } elseif( $prop == 'nickname' && is_callable( array( $this, 'allowNickChange' ) ) ) {
 138                         return $this->allowNickChange();
 139                 } else {
 140                         return true;
 141                 }
 142         }
 143
 144         /**
 145          * Can users change their passwords?
 146          *
 147          * @return bool
 148          */
 149         public function allowPasswordChange() {
 150                 return true;
 151         }
 152
 153         /**
 154          * Set the given password in the authentication database.
 155          * As a special case, the password may be set to null to request
 156          * locking the password to an unusable value, with the expectation
 157          * that it will be set later through a mail reset or other method.
 158          *
 159          * Return true if successful.
 160          *
 161          * @param $user User object.
 162          * @param $password String: password.
 163          * @return bool
 164          */
 165         public function setPassword( $user, $password ) {
 166                 return true;
 167         }
 168
 169         /**
 170          * Update user information in the external authentication database.
 171          * Return true if successful.
 172          *
 173          * @param $user User object.
 174          * @return bool
 175          */
 176         public function updateExternalDB( $user ) {
 177                 return true;
 178         }
 179
 180         /**
 181          * Check to see if external accounts can be created.
 182          * Return true if external accounts can be created.
 183          * @return bool
 184          */
 185         public function canCreateAccounts() {
 186                 return false;
 187         }
 188
 189         /**
 190          * Add a user to the external authentication database.
 191          * Return true if successful.
 192          *
 193          * @param User $user - only the name should be assumed valid at this point
 194          * @param string $password
 195          * @param string $email
 196          * @param string $realname
 197          * @return bool
 198          */
 199         public function addUser( $user, $password, $email='', $realname='' ) {
 200                 return true;
 201         }
 202
 203
 204         /**
 205          * Return true to prevent logins that don't authenticate here from being
 206          * checked against the local database's password fields.
 207          *
 208          * This is just a question, and shouldn't perform any actions.
 209          *
 210          * @return bool
 211          */
 212         public function strict() {
 213                 return false;
 214         }
 215
 216         /**
 217          * Check if a user should authenticate locally if the global authentication fails.
 218          * If either this or strict() returns true, local authentication is not used.
 219          *
 220          * @param $username String: username.
 221          * @return bool
 222          */
 223         public function strictUserAuth( $username ) {
 224                 return false;
 225         }
 226
 227         /**
 228          * When creating a user account, optionally fill in preferences and such.
 229          * For instance, you might pull the email address or real name from the
 230          * external user database.
 231          *
 232          * The User object is passed by reference so it can be modified; don't
 233          * forget the & on your function declaration.
 234          *
 235          * @param $user User object.
 236          * @param $autocreate bool True if user is being autocreated on login
 237          */
 238         public function initUser( &$user, $autocreate=false ) {
 239                 # Override this to do something.
 240         }
 241
 242         /**
 243          * If you want to munge the case of an account name before the final
 244          * check, now is your chance.
 245          */
 246         public function getCanonicalName( $username ) {
 247                 return $username;
 248         }
 249
 250         /**
 251          * Get an instance of a User object
 252          *
 253          * @param $user User
 254          * @public
 255          */
 256         public function getUserInstance( User &$user ) {
 257                 return new AuthPluginUser( $user );
 258         }
 259 }
 260
 261 class AuthPluginUser {
 262         function __construct( $user ) {
 263                 # Override this!
 264         }
 265
 266         public function getId() {
 267                 # Override this!
 268                 return -1;
 269         }
 270
 271         public function isLocked() {
 272                 # Override this!
 273                 return false;
 274         }
 275
 276         public function isHidden() {
 277                 # Override this!
 278                 return false;
 279         }
 280
 281         public function resetAuthToken() {
 282                 # Override this!
 283                 return true;
 284         }
 285 }