Public Member Functions | |
userExists ($username) | |
Check whether there exists a user account with the given name. | |
authenticate ($username, $password) | |
Check if a username+password pair is a valid login. | |
modifyUITemplate (&$template) | |
Modify options in the login template. | |
setDomain ($domain) | |
Set the domain this plugin is supposed to use when authenticating. | |
validDomain ($domain) | |
Check to see if the specific domain is a valid domain. | |
updateUser (&$user) | |
When a user logs in, optionally fill in preferences and such. | |
autoCreate () | |
Return true if the wiki should create a new local account automatically when asked to login a user who doesn't exist locally but does in the external auth database. | |
allowPasswordChange () | |
Can users change their passwords? | |
setPassword ($user, $password) | |
Set the given password in the authentication database. | |
updateExternalDB ($user) | |
Update user information in the external authentication database. | |
canCreateAccounts () | |
Check to see if external accounts can be created. | |
addUser ($user, $password, $email='', $realname='') | |
Add a user to the external authentication database. | |
strict () | |
Return true to prevent logins that don't authenticate here from being checked against the local database's password fields. | |
strictUserAuth ($username) | |
Check if a user should authenticate locally if the global authentication fails. | |
initUser (&$user, $autocreate=false) | |
When creating a user account, optionally fill in preferences and such. | |
getCanonicalName ($username) | |
If you want to munge the case of an account name before the final check, now is your chance. | |
getUserInstance (User &$user) | |
Get an instance of a User object. |
Instantiate a subclass of AuthPlugin and set $wgAuth to it to authenticate against some external tool.
The default behavior is not to do anything, and use the local user database for all authentication. A subclass can require that all accounts authenticate externally, or use it only as a fallback; also you can transparently create internal wiki accounts the first time someone logs in who can be authenticated externally.
Definition at line 32 of file AuthPlugin.php.
AuthPlugin::addUser | ( | $ | user, | |
$ | password, | |||
$ | email = '' , |
|||
$ | realname = '' | |||
) |
Add a user to the external authentication database.
Return true if successful.
User | $user - only the name should be assumed valid at this point | |
string | $password | |
string | ||
string | $realname |
Definition at line 180 of file AuthPlugin.php.
AuthPlugin::allowPasswordChange | ( | ) |
AuthPlugin::authenticate | ( | $ | username, | |
$ | password | |||
) |
Check if a username+password pair is a valid login.
The name will be normalized to MediaWiki's requirements, so you might need to munge it (for instance, for lowercase initial letters).
$username | String: username. | |
$password | String: user password. |
Definition at line 57 of file AuthPlugin.php.
AuthPlugin::autoCreate | ( | ) |
Return true if the wiki should create a new local account automatically when asked to login a user who doesn't exist locally but does in the external auth database.
If you don't automatically create accounts, you must still create accounts in some way. It's not possible to authenticate without a local account.
This is just a question, and shouldn't perform any actions.
Definition at line 121 of file AuthPlugin.php.
AuthPlugin::canCreateAccounts | ( | ) |
Check to see if external accounts can be created.
Return true if external accounts can be created.
Definition at line 166 of file AuthPlugin.php.
AuthPlugin::getCanonicalName | ( | $ | username | ) |
If you want to munge the case of an account name before the final check, now is your chance.
Definition at line 227 of file AuthPlugin.php.
References $username.
AuthPlugin::getUserInstance | ( | User &$ | user | ) |
Get an instance of a User object.
$user | User |
Definition at line 237 of file AuthPlugin.php.
AuthPlugin::initUser | ( | &$ | user, | |
$ | autocreate = false | |||
) |
When creating a user account, optionally fill in preferences and such.
For instance, you might pull the email address or real name from the external user database.
The User object is passed by reference so it can be modified; don't forget the & on your function declaration.
$user | User object. | |
$autocreate | bool True if user is being autocreated on login |
Definition at line 219 of file AuthPlugin.php.
AuthPlugin::modifyUITemplate | ( | &$ | template | ) |
Modify options in the login template.
$template | UserLoginTemplate object. |
Definition at line 67 of file AuthPlugin.php.
AuthPlugin::setDomain | ( | $ | domain | ) |
Set the domain this plugin is supposed to use when authenticating.
$domain | String: authentication domain. |
Definition at line 77 of file AuthPlugin.php.
AuthPlugin::setPassword | ( | $ | user, | |
$ | password | |||
) |
Set the given password in the authentication database.
As a special case, the password may be set to null to request locking the password to an unusable value, with the expectation that it will be set later through a mail reset or other method.
Return true if successful.
$user | User object. | |
$password | String: password. |
Definition at line 146 of file AuthPlugin.php.
AuthPlugin::strict | ( | ) |
Return true to prevent logins that don't authenticate here from being checked against the local database's password fields.
This is just a question, and shouldn't perform any actions.
Definition at line 193 of file AuthPlugin.php.
AuthPlugin::strictUserAuth | ( | $ | username | ) |
Check if a user should authenticate locally if the global authentication fails.
If either this or strict() returns true, local authentication is not used.
$username | String: username. |
Definition at line 204 of file AuthPlugin.php.
AuthPlugin::updateExternalDB | ( | $ | user | ) |
Update user information in the external authentication database.
Return true if successful.
$user | User object. |
Definition at line 157 of file AuthPlugin.php.
AuthPlugin::updateUser | ( | &$ | user | ) |
When a user logs in, optionally fill in preferences and such.
For instance, you might pull the email address or real name from the external user database.
The User object is passed by reference so it can be modified; don't forget the & on your function declaration.
User | $user |
Definition at line 102 of file AuthPlugin.php.
AuthPlugin::userExists | ( | $ | username | ) |
Check whether there exists a user account with the given name.
The name will be normalized to MediaWiki's requirements, so you might need to munge it (for instance, for lowercase initial letters).
$username | String: username. |
Definition at line 42 of file AuthPlugin.php.
AuthPlugin::validDomain | ( | $ | domain | ) |
Check to see if the specific domain is a valid domain.
$domain | String: authentication domain. |
Definition at line 87 of file AuthPlugin.php.