- Generated on Wed Oct 1 2014 21:36:55 for MediaWiki by
1.7.6.1
|
MediaWiki
REL1_19
|
Authentication plugin interface. More...
Public Member Functions | |
| addUser ($user, $password, $email= '', $realname= '') | |
| Add a user to the external authentication database. | |
| allowPasswordChange () | |
| Can users change their passwords? | |
| allowPropChange ($prop= '') | |
| Allow a property change? Properties are the same as preferences and use the same keys. | |
| allowSetLocalPassword () | |
| Should MediaWiki store passwords in its local database? | |
| authenticate ($username, $password) | |
| Check if a username+password pair is a valid login. | |
| 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. | |
| canCreateAccounts () | |
| Check to see if external accounts can be created. | |
| domainList () | |
| Get a list of domains (in HTMLForm options format) used. | |
| 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. | |
| initUser (&$user, $autocreate=false) | |
| When creating a user account, optionally fill in preferences and such. | |
| modifyUITemplate (&$template, &$type) | |
| Modify options in the login template. | |
| setDomain ($domain) | |
| Set the domain this plugin is supposed to use when authenticating. | |
| setPassword ($user, $password) | |
| Set the given password in the 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. | |
| updateExternalDB ($user) | |
| Update user information in the external authentication database. | |
| updateUser (&$user) | |
| When a user logs in, optionally fill in preferences and such. | |
| userExists ($username) | |
| Check whether there exists a user account with the given name. | |
| validDomain ($domain) | |
| Check to see if the specific domain is a valid domain. | |
Authentication plugin interface.
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 36 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 |
| $password | String |
| String | |
| $realname | String |
Definition at line 214 of file AuthPlugin.php.
| AuthPlugin::allowPropChange | ( | $ | prop = '' | ) |
Allow a property change? Properties are the same as preferences and use the same keys.
'Realname' 'Emailaddress' and 'Nickname' all reference this.
| $prop | string |
Definition at line 138 of file AuthPlugin.php.
Should MediaWiki store passwords in its local database?
Definition at line 164 of file AuthPlugin.php.
| 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 61 of file AuthPlugin.php.
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 125 of file AuthPlugin.php.
Check to see if external accounts can be created.
Return true if external accounts can be created.
Definition at line 200 of file AuthPlugin.php.
Get a list of domains (in HTMLForm options format) used.
Definition at line 280 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 260 of file AuthPlugin.php.
| AuthPlugin::getUserInstance | ( | User &$ | user | ) |
Get an instance of a User object.
| $user | User |
Definition at line 271 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 | Boolean: True if user is being autocreated on login |
Definition at line 252 of file AuthPlugin.php.
| AuthPlugin::modifyUITemplate | ( | &$ | template, |
| &$ | type | ||
| ) |
Modify options in the login template.
| $template | UserLoginTemplate object. |
| $type | String 'signup' or 'login'. Added in 1.16. |
Definition at line 72 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 82 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 180 of file AuthPlugin.php.
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 226 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 237 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 191 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 object |
Definition at line 107 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 46 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 92 of file AuthPlugin.php.
1.7.6.1