AuthPlugin Class Reference

Authentication plugin interface. More...

Collaboration diagram for AuthPlugin:

List of all members.

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.
	getDomain ()
	Get the user's domain.
	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.
	updateExternalDBGroups ($user, $addgroups, $delgroups=array())
	Update user groups 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.
Protected Attributes
string	$domain

---

Detailed Description

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.

---

Member Function Documentation

AuthPlugin::addUser	(	$	user,
		$	password,
		$	email = '',
		$	realname = ''
	)

Add a user to the external authentication database.

Return true if successful.

Parameters:

$user	User: only the name should be assumed valid at this point
$password	String
$email	String
$realname	String

Returns:

Boolean

Definition at line 246 of file AuthPlugin.php.

AuthPlugin::allowPasswordChange

(

)

Can users change their passwords?

Returns:

bool

Definition at line 174 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.

Parameters:

$prop

string

Returns:

Boolean

Definition at line 157 of file AuthPlugin.php.

AuthPlugin::allowSetLocalPassword

(

)

Should MediaWiki store passwords in its local database?

Returns:

bool

Definition at line 183 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).

Parameters:

string	$username	username.
string	$password	user password.

Returns:

bool

Definition at line 66 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.

Returns:

Boolean

Definition at line 144 of file AuthPlugin.php.

AuthPlugin::canCreateAccounts

(

)

Check to see if external accounts can be created.

Return true if external accounts can be created.

Returns:

Boolean

Definition at line 232 of file AuthPlugin.php.

AuthPlugin::domainList

(

)

Get a list of domains (in HTMLForm options format) used.

Returns:

array

Definition at line 314 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.

Parameters:

$username

string

Returns:

string

Definition at line 294 of file AuthPlugin.php.

AuthPlugin::getDomain

(

)

Get the user's domain.

Returns:

string

Definition at line 96 of file AuthPlugin.php.

AuthPlugin::getUserInstance

(

User &$

user

)

Get an instance of a User object.

Parameters:

$user

User

Returns:

AuthPluginUser

Definition at line 305 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.

Parameters:

$user	User object.
$autocreate	Boolean: True if user is being autocreated on login

Definition at line 284 of file AuthPlugin.php.

AuthPlugin::modifyUITemplate	(	&$	template,
		&$	type
	)

Modify options in the login template.

Parameters:

	$template	UserLoginTemplate object.
string	$type	'signup' or 'login'. Added in 1.16.

Definition at line 77 of file AuthPlugin.php.

AuthPlugin::setDomain

(

$

domain

)

Set the domain this plugin is supposed to use when authenticating.

Parameters:

string

$domain

authentication domain.

Definition at line 87 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.

Parameters:

	$user	User object.
string	$password	password.

Returns:

bool

Definition at line 199 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.

Returns:

Boolean

Definition at line 258 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.

Parameters:

string

$username

username.

Returns:

Boolean

Definition at line 269 of file AuthPlugin.php.

AuthPlugin::updateExternalDB

(

$

user

)

Update user information in the external authentication database.

Return true if successful.

Parameters:

$user

User object.

Returns:

Boolean

Definition at line 210 of file AuthPlugin.php.

AuthPlugin::updateExternalDBGroups	(	$	user,
		$	addgroups,
		$	delgroups = array()
	)

Update user groups in the external authentication database.

Return true if successful.

Parameters:

$user	User object.
$addgroups	Groups to add.
$delgroups	Groups to remove.

Returns:

Boolean

Definition at line 223 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.

Parameters:

$user

User object

Returns:

bool

Definition at line 126 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).

Parameters:

string

$username

username.

Returns:

bool

Definition at line 51 of file AuthPlugin.php.

AuthPlugin::validDomain

(

$

domain

)

Check to see if the specific domain is a valid domain.

Parameters:

string

$domain

authentication domain.

Returns:

bool

Definition at line 110 of file AuthPlugin.php.

---

Member Data Documentation

string AuthPlugin::$domain [protected]

Definition at line 40 of file AuthPlugin.php.

---

The documentation for this class was generated from the following file:

• includes/AuthPlugin.php