Extension:OATHAuth

**MediaWiki extensions manual**
OATHAuth; Release status: stable
Implementation	User rights, Special page, Page action
Description	Provides two-factor authentication for logging in
Author(s)	Ryan Lane
Latest version	Continuous updates
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	1.29+
Database changes	Yes
Tables	oathauth_users
License	GPL-2.0-or-later AND GPL-3.0-or-later
Download	Download extension ; Git [?]: Download Git master; browse repository (GitHub); commit history; repository contributors (GitHub); code review;
	Parameters $wgOATHRequiredForGroups; $wgOATHAuthWindowRadius; $wgOATHExclusiveRights; $wgOATHAuthAccountPrefix; $wgOATHAuthDatabase;
	Hooks used AuthChangeFormFields; BeforeCreateEchoEvent; GetPreferences; LoadExtensionSchemaUpdates; UserEffectiveGroups; UserGetRights; getUserPermissionsErrors;
Quarterly downloads	115 (Ranked 79th)
Public wikis using	1,804 (Ranked 70th)
	Translate the OATHAuth extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

Translate this page

Languages:

This extension comes with MediaWiki 1.31 and above. Thus you do not have to download it again. However, you still need to follow the other instructions provided.

The OathAuth extension provides two-factor authentication support. By default, this includes a time-based one-time password (TOTP) implementation that allows users to generate 2FA codes from their phone or desktop app. Client support is available for most feature phones, smartphones and desktops.

This extension has nothing to do with OAuth, which is a totally different protocol.

UsageEdit

The help page on Two-factor authentication provides information for end users on how to use this extension. However the special page used will also guide users.

InstallationEdit

Download and place the file(s) in a directory called OATHAuth in your extensions/ folder.
Only when installing from Git, run Composer to install PHP dependencies, by issuing composer install --no-dev in the extension directory. (See task T173141 for potential complications.)
Add the following code at the bottom of your LocalSettings.php :
```
wfLoadExtension( 'OATHAuth' );
```
Run the update script which will automatically create the necessary database tables that this extension needs.
Configure as required.
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

ConfigurationEdit

ParametersEdit

Configuration Flag	Default Value	Description
`$wgOATHAuthWindowRadius`	`4`	The number of token windows in each direction that should be valid. This tells OATH to accept tokens for a range of effectively `((1 + 2 * $wgOATHAuthWindowRadius) * 30)` seconds. This range of valid windows is centered around the current time. The purpose of this configuration variable is to account for differences between the user's clock and the server's clock. However, it is recommended to keep it as low as possible.
`$wgOATHAuthDatabase`	`false`	The database domain. Only used in a multi-database environment.
`$wgOATHAuthSecret`	`false`	The base OATHAuth secret for this wiki from which all encryption keys are derived. If `false`, the value of `$wgSecretKey` is used.
`$wgOATHAuthAccountPrefix`	`false`	The prefix used for the OATHAuth user account name and the issuer used for the account. If `false`, the value of `$wgSitename` is used.
`$wgOATHExclusiveRights`	`[]`	Set of permissions that are revoked from users who did not log in using two-factor authentication.

OATHAuth also adds a key to the $wgRateLimits array to define rate limits for authentication attempts:

		'badoath' => [
			'&can-bypass' => false,
			'user' => [ 10, 60 ],
			'user-global' => [ 10, 60 ],
		]

Note that the user-global key is available only since 1.35. Earlier version have to rely on user and perhaps ip-all. See the documentation of $wgRateLimits for details.

User permissionEdit

Granting access to enable OATHAuth

Users should be given access to the oathauth-enable user right so that they can enable it at Special:OATHAuth (a link to which appears at Special:Preferences).

$wgGroupPermissions['user']['oathauth-enable'] = true;

The above will grant all registered users access to enable OATHAuth.

AdministrationEdit

Resetting a user token

In the event that a user both loses their token generator AND the recovery tokens; two-factor authentication may be removed from the user by deleting their row from the oathauth_users database table. Alternatively, a sysadmin with shell access may type on a command line cd /path/to/mediawiki/extensions/OATHAuth/maintenance/ and then execute php disableOATHAuthForUser.php "username" where "username" is the user to have 2FA disabled.

OATHAuth Release status: stable

Implementation	User rights , Special page , Page action
Description	Provides two-factor authentication for logging in
Author(s)	Ryan Lane
Latest version	Continuous updates
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	1.29+
Database changes	Yes
Tables	oathauth_users
License	GPL-2.0-or-later AND GPL-3.0-or-later
Download	Download extension Git ^[?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Parameters $wgOATHRequiredForGroups $wgOATHAuthWindowRadius $wgOATHExclusiveRights $wgOATHAuthAccountPrefix $wgOATHAuthDatabase
Hooks used AuthChangeFormFields BeforeCreateEchoEvent GetPreferences LoadExtensionSchemaUpdates UserEffectiveGroups UserGetRights getUserPermissionsErrors
Quarterly downloads	115 (Ranked 79^th)
Public wikis using	1,804 (Ranked 70^th)
Translate the OATHAuth extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug