Extension:OATHAuth

Not to be confused with Extension:OAuth

MediaWiki extensions manualManual:Extensions

OATHAuth Release status:Extension status stable
ImplementationTemplate:Extension#type	User rights, Special page, Page action
DescriptionTemplate:Extension#description	An HMAC based One Time Password extension, providing two-factor authentication.
Author(s)Template:Extension#username	Ryan Lane
Latest versionTemplate:Extension#version	0.2.2 (2017-01-01)
MediaWikiTemplate:Extension#mediawiki	1.25+
Database changesTemplate:Extension#needs-updatephp	Yes
LicenseTemplate:Extension#license	GNU General Public License 2.0 or later
Download	Download snapshot (Git master) Git [?]: repo summary browse file tree (GitHub) commit history code review
Hooks usedTemplate:Extension#hook AuthChangeFormFieldsManual:Hooks/AuthChangeFormFields TwoFactorIsEnabled LoadExtensionSchemaUpdatesManual:Hooks/LoadExtensionSchemaUpdates GetPreferencesManual:Hooks/GetPreferences
Translate the OATHAuth extension if it is available at translatewiki.net
Check usage and version matrix.
IssuesPhabricator	Open tasks · Report a bug

The OATHAuth extension is a time-based one-time password (TOTP) implementation. It provides two-factor authentication via something you have (your phone or desktop client) and something you know (your user name/password). Client support is available for most feature phones, smartphones and desktops (see Client implementations). This extension has nothing to do with OAuth, which is a totally different protocol.

Installation

• Download and place the file(s) in a directory called OATHAuth in your extensions/ folder.
• 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.
• Y Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'OATHAuth' );, you need to use:

require_once "$IP/extensions/OATHAuth/OATHAuth.php";

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.

Changelog

0.1 - May 9, 2012

• Initial version
• Missing functionality to act as a standalone extension, currently reuses a hook in LdapAuthentication. Standalone support to come in next version.

0.2 - March 28, 2014

• Added use of TwoFactorIsEnabled hook
• Switched from using ChainAuth hook to using AbortChangePassword and AbortLogin hooks
• Added use of $wgRedactedFunctionArguments variable

0.2.1 - May 11, 2014

• Code-base cleanup

0.2.2 - October 11, 2016

• Switch to using extension.json
• Added "oathvalidate" API action
• Added caching of OATH tokens
• Added SQLite support
• Removed support for pre-AuthManager MediaWiki

See also

• Help:Two-factor authentication
• Wikimedia Security Team/Two-factor Authentication for CentralAuth wikis
• meta:Help:Two-factor authentication