Extensão:OATHAuth

Not to be confused with Extension:OAuth.

Esta extensão acompanha o MediaWiki 1.31 e superiores. Assim, não precisa efetuar o download novamente. No entanto, ainda precisa seguir as outras instruções fornecidas.

Manual de extensões do MediaWiki

OATHAuth Estado de lançamento: estável
Implementação	Direitos do utilizador , Página espacial , Ação de página
Descrição	Fornece a autenticação de dois fatores para iniciar a sessão
Autor(es)	Ryan Lane
Última versão	Atualizações contínuas
Política de compatibilidade	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	1.29+
Alterações à base de dados	Sim
Tabelas	oathauth_users
Licença	GPL-2.0-or-later AND GPL-3.0-or-later
Transferência	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Parâmetros $wgOATHRequiredForGroups $wgOATHAuthWindowRadius $wgOATHExclusiveRights $wgOATHAuthAccountPrefix $wgOATHAuthDatabase
Permissões adicionadas oathauth-enable oathauth-api-all oathauth-disable-for-user oathauth-verify-user oathauth-view-log
Hooks utilizados AuthChangeFormFields BeforeCreateEchoEvent GetPreferences LoadExtensionSchemaUpdates UserEffectiveGroups UserGetRights getUserPermissionsErrors
Traduza a extensão OATHAuth se ela estiver disponível em translatewiki.net
Verifique a utilização e a matriz de versões
Problemas	Tarefas em aberto · Reportar um erro

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.

Utilização

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.

Instalação

• Exporte e coloque o ficheiro, ou ficheiros, num diretório chamado OATHAuth, na sua pasta extensions/.
• 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.)
• Acrescente o seguinte código ao fundo do ficheiro $LocalSettings:

  wfLoadExtension( 'OATHAuth' );
  

• Execute o script de atualização que irá criar automaticamente as tabelas da base de dados necessárias para esta extensão.
• Configure conforme necessário.
•  Pronto – Na página especial Special:Version da sua wiki verifique se a extensão foi instalada.

Configuração

Parâmetros

Configuration Flag	Valor Predefinido	Descrição
$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.

Permissão do utilizador

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.

Administração

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.

Consulte também

• Wikimedia Security Team/Two-factor Authentication for CentralAuth wikis
• Two-factor authentication (TFA)
• Extension:WebAuthn