5 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
6 # http://www.mediawiki.org/
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 2 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License along
19 # with this program; if not, write to the Free Software Foundation, Inc.,
20 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 # http://www.gnu.org/copyleft/gpl.html
24 * Authentication plugin interface. Instantiate a subclass of AuthPlugin
25 * and set $wgAuth to it to authenticate against some external tool.
27 * The default behavior is not to do anything, and use the local user
28 * database for all authentication. A subclass can require that all
29 * accounts authenticate externally, or use it only as a fallback; also
30 * you can transparently create internal wiki accounts the first time
31 * someone logs in who can be authenticated externally.
33 * This interface is new, and might change a bit before 1.4.0 final is
40 * Check whether there exists a user account with the given name.
41 * The name will be normalized to MediaWiki's requirements, so
42 * you might need to munge it (for instance, for lowercase initial
45 * @param string $username
49 function userExists( $username ) {
55 * Check if a username+password pair is a valid login.
56 * The name will be normalized to MediaWiki's requirements, so
57 * you might need to munge it (for instance, for lowercase initial
60 * @param string $username
61 * @param string $password
65 function authenticate( $username, $password ) {
71 * Return true if the wiki should create a new local account automatically
72 * when asked to login a user who doesn't exist locally but does in the
73 * external auth database.
75 * If you don't automatically create accounts, you must still create
76 * accounts in some way. It's not possible to authenticate without
79 * This is just a question, and shouldn't perform any actions.
84 function autoCreate() {
89 * Return true to prevent logins that don't authenticate here from being
90 * checked against the local database's password fields.
92 * This is just a question, and shouldn't perform any actions.
102 * When creating a user account, optionally fill in preferences and such.
103 * For instance, you might pull the email address or real name from the
104 * external user database.
106 * The User object is passed by reference so it can be modified; don't
107 * forget the & on your function declaration.
112 function initUser( &$user ) {
113 # Override this to do something.