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          * Can users change their passwords?
 127          *
 128          * @return bool
 129          */
 130         public function allowPasswordChange() {
 131                 return true;
 132         }
 133
 134         /**
 135          * Set the given password in the authentication database.
 136          * As a special case, the password may be set to null to request
 137          * locking the password to an unusable value, with the expectation
 138          * that it will be set later through a mail reset or other method.
 139          *
 140          * Return true if successful.
 141          *
 142          * @param $user User object.
 143          * @param $password String: password.
 144          * @return bool
 145          */
 146         public function setPassword( $user, $password ) {
 147                 return true;
 148         }
 149
 150         /**
 151          * Update user information in the external authentication database.
 152          * Return true if successful.
 153          *
 154          * @param $user User object.
 155          * @return bool
 156          */
 157         public function updateExternalDB( $user ) {
 158                 return true;
 159         }
 160
 161         /**
 162          * Check to see if external accounts can be created.
 163          * Return true if external accounts can be created.
 164          * @return bool
 165          */
 166         public function canCreateAccounts() {
 167                 return false;
 168         }
 169
 170         /**
 171          * Add a user to the external authentication database.
 172          * Return true if successful.
 173          *
 174          * @param User $user - only the name should be assumed valid at this point
 175          * @param string $password
 176          * @param string $email
 177          * @param string $realname
 178          * @return bool
 179          */
 180         public function addUser( $user, $password, $email='', $realname='' ) {
 181                 return true;
 182         }
 183
 184
 185         /**
 186          * Return true to prevent logins that don't authenticate here from being
 187          * checked against the local database's password fields.
 188          *
 189          * This is just a question, and shouldn't perform any actions.
 190          *
 191          * @return bool
 192          */
 193         public function strict() {
 194                 return false;
 195         }
 196
 197         /**
 198          * Check if a user should authenticate locally if the global authentication fails.
 199          * If either this or strict() returns true, local authentication is not used.
 200          *
 201          * @param $username String: username.
 202          * @return bool
 203          */
 204         public function strictUserAuth( $username ) {
 205                 return false;
 206         }
 207
 208         /**
 209          * When creating a user account, optionally fill in preferences and such.
 210          * For instance, you might pull the email address or real name from the
 211          * external user database.
 212          *
 213          * The User object is passed by reference so it can be modified; don't
 214          * forget the & on your function declaration.
 215          *
 216          * @param $user User object.
 217          * @param $autocreate bool True if user is being autocreated on login
 218          */
 219         public function initUser( &$user, $autocreate=false ) {
 220                 # Override this to do something.
 221         }
 222
 223         /**
 224          * If you want to munge the case of an account name before the final
 225          * check, now is your chance.
 226          */
 227         public function getCanonicalName( $username ) {
 228                 return $username;
 229         }
 230
 231         /**
 232          * Get an instance of a User object
 233          *
 234          * @param $user User
 235          * @public
 236          */
 237         public function getUserInstance( User &$user ) {
 238                 return new AuthPluginUser( $user );
 239         }
 240 }
 241
 242 class AuthPluginUser {
 243         function __construct( $user ) {
 244                 # Override this!
 245         }
 246
 247         public function getId() {
 248                 # Override this!
 249                 return -1;
 250         }
 251
 252         public function isLocked() {
 253                 # Override this!
 254                 return false;
 255         }
 256
 257         public function isHidden() {
 258                 # Override this!
 259                 return false;
 260         }
 261
 262         public function resetAuthToken() {
 263                 # Override this!
 264                 return true;
 265         }
 266 }