Extension:EmailAuth

Not to be confused with: Extension:Email Authorization.

MediaWiki extensions manual

EmailAuth Release status: stable
Implementation	User identity
Description	Two-factor authentication via email
Author(s)	Tgrtalk
Latest version	0.1.0
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	1.27+
Parameters $wgEmailAuthAccountRecoveryTokenExpiry $wgEmailAuthZendeskUrl $wgEmailAuthEnableAccountRecovery $wgEmailAuthZendeskToken $wgEmailAuthZendeskTags $wgEmailAuthZendeskCustomFields $wgEmailAuthZendeskHTTPProxy $wgEmailAuthZendeskTicketFormId $wgEmailAuthZendeskEmail $wgEmailAuthUnmaskedDomains $wgEmailAuthZendeskSubjectLine
Hooks used AuthChangeFormFields
Hooks provided EmailAuthRequireToken
Licence	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Browse repository (GitHub) Gerrit code review Git commit log Download source tarball
Help	Help:Extension:EmailAuth
Translate the EmailAuth extension if it is available at translatewiki.net
Vagrant role	emailauth
Issues	Open tasks · Report a bug

The EmailAuth extension allows secondary authentication via email. While this is less secure than other two-factor methods such as Extension:OATHAuth , it does not have to be set up by the user, it only requires an email address. This makes it useful for stopping password guessing attacks or securing suspicious logins.

The EmailAuthRequireToken hook is used to decide when the second factor is required. Without adding a handler for that hook e.g. in site configuration, the extension will not do anything.

• 
  The verification form shown during login
• 
  The verification email

Installation

• Download and move the extracted EmailAuth folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/EmailAuth
  

• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'EmailAuth' );
  

• Add a hook handler for the EmailAuthRequireToken hook.
• Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration variables

Name	Description	Default
$wgEmailAuthUnmaskedDomains	Email domains that are not masked during their display in EmailAuth UI components. (All other domains will be replaced with ***.***.) MW 1.45+	gmail.com, googlemail.com, hotmail.com, yahoo.com

See also

• Help:Extension:EmailAuth
• EmailAuthHooks in WikimediaEvents, for Wikimedia's version of the EmailAuthRequireToken hook.
• wikitech:EmailAuth (Wikimedia operations docs)
• Extension:LoginNotify , an extension that provides a "known device" flag that can be used in the EmailAuthRequireToken hook.
• Extension:EmailAuthorization - non-Wikimedia extension that uses email instead of normal login