Erweiterung:OATHAuth

Nicht zu verwechseln mit Extension:OAuth.

MediaWiki-Erweiterungen

OATHAuth Freigabestatus: stabil
Einbindung	Benutzerrechte , Spezialseite , Seitenaktivität
Beschreibung	Ermöglicht 2-Faktor Authentifizierung um sich Anzumelden
Autor(en)	Ryan Lane
Letzte Version	Laufende Aktualisierungen
Kompatibilitätspolitik	Snapshots werden zusammen mit MediaWiki veröffentlicht. Der Master ist nicht abwärtskompatibel.
Datenbankänderungen	Ja
Tabellen	oathauth_types oathauth_devices oathauth_users
Lizenz	GPL-2.0-or-later AND GPL-3.0-or-later
Herunterladen	Erweiterung herunterladen Git [?]: Repository durchsuchen (Phabricator · GitHub) Code-Review Ergänzungen und Änderungen Download source tarball
Parameter $wgOATHRequiredForGroups $wgOATHRolloutPercent $wgOATHAllowMultipleModules $wgOATHExclusiveRights $wgOATHSecretKey $wgOATHAuthWindowRadius $wgOATHAuthNewUI $wgOATHAuthAccountPrefix $wgOATHPrioritizedModules
Hinzugefügte Rechte oathauth-enable oathauth-api-all oathauth-disable-for-user oathauth-view-log oathauth-verify-user
Verwendete Hooks AuthChangeFormFields GetPreferences LoadExtensionSchemaUpdates UnitTestsAfterDatabaseSetup UnitTestsBeforeDatabaseTeardown UserEffectiveGroups UserGetRights getUserPermissionsErrors
Übersetze die OATHAuth-Erweiterung, wenn sie auf translatewiki.net verfügbar ist
Probleme	Offene Aufgaben · Einen Fehler melden

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. Unterstützung von Clients ist für die meisten Mobiltelefone, Smartphones und Desktops verfügbar.

Diese Erweiterung hat nichts mit OAuth zu tun, das ist ein völlig anderes Protokoll.

Verwendung

Die Hilfeseite zur Zwei-Faktor-Authentifizierung bietet Informationen für Endbenutzer wie diese Erweiterung genutzt werden kann. However, the special page will also guide users.

Installation

Diese Erweiterung ist in MediaWiki 1.31 und darüber enthalten. The remaining configuration instructions must still be followed.

Warnung:

There is a bug with this extension where it does not update properly from the web (mw-config) updater and must instead use the update.php command line update script (phab:T371849)

• Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens OATHAuth im Ordner extensions/ ablegen.
  Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:

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

• Wird von git aus installiert, ist Composer auszuführen, um PHP-Abhängigkeiten zu installieren, indem composer install --no-dev im Erweiterungsverzeichnis ausgeführt wird. (Siehe T173141 für mögliche Komplikationen.)
• Folgenden Code am Ende deiner LocalSettings.php -Datei einfügen:

  wfLoadExtension( 'OATHAuth' );
  

• Führe das Aktualisierungsskript aus, welches automatisch die notwendigen Datenbanktabellen erstellt, die diese Erweiterung braucht.
• Konfiguriere nach Bedarf.
• It is strongly recommended to setup caching when using OATHAuth. This will improve performance, but also the security of your wiki if you're using OATHAuth. If you are only running one application/web server and have php-apcu installed, and no specific cache configured, MediaWiki will likely fallback to using APCu. If you are using multiple application/web server it is advised to set up local cluster caching that all hosts can use. Examples include Memcached .
• Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.

Konfiguration

Parameter

Configuration Flag	Standardwert	Beschreibung
$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 and server's clock. However, keeping it as low as possible is recommended.
$wgOATHAuthDatabase	false	(veraltet) The database domain. Only used in a multi-database environment. After MediaWiki 1.42, you should use $wgVirtualDomainsMapping['virtual-oathauth'] instead of this option.
$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 login using two-factor authentication.
$wgOATHRequiredForGroups	[]	Sets a list of user groups that are required to have two-factor authentication enabled. Use 'user' if you want all logged-in users required to enable two-factor authentication.
$wgOATHRolloutPercent	0	Percentage of users to add to two-factor authentication rollout.
$wgOATHAllowMultipleModules	false	(veraltet) Temporary (in the MW 1.45 development cycle) feature flag to allow users to have multiple two-factor authentication modules active at the same time.
$wgOATHAuthNewUI	false	(veraltet) Temporary (in the MW 1.45 development cycle) feature flag for the redesigned UI. (T401774)
$wgOATHSecretKey	false	(eingeführt in 1.45) Update to 1.45 (or later) and run the update script before enabling this feature and running its own maintenance script! A secret key value for encrypting OATH-related data which should be SODIUM_CRYPTO_SECRETBOX_KEYBYTES hexadecimal bytes (64 chars) in length. This variable is currently considered immutable. Do not publicly set this value. There are a few ways to create a cryptographically-secure, random key value, such as the unix command: $ hexdump -vn32 -e'8/8 "%08X" "\n"' /dev/urandom. Run maintenance/UpdateTOTPSecretsToEncryptedFormat.php after setting this value to encrypt existing database rows. Note that it is not currently possible to change this value once it is set, and be able to update existing encrypted codes. See T403180 for more information.

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 permission

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.

Verwaltung

Resetting a user token

If a user loses both their token generator and the recovery tokens, two-factor authentication may be removed from the user by running the disableOATHAuthForUser maintenance script:

MediaWiki Version:

1.40

$ ./maintenance/run OATHAuth:disableOATHAuthForUser <user>

MediaWiki Version:

≤ 1.39

$ php ./extensions/OATHAuth/maintenance/disableOATHAuthForUser.php <user>

Where ‎<user> is the name of the user to have 2FA disabled.

Shared database tables

Some Wikis may want to share the 2FA data amongst multiple Wikis. Shared database tables , the previous method for doing so is deprecated in MediaWiki 1.42 and later. For new wiki-farm installations where you want users to share their 2FA token amongst multiple wikis, please use $wgVirtualDomainsMapping and the extensions will automatically make its tables use the specified database name.

$wgVirtualDomainsMapping['virtual-oathauth'] = [ 'db' => 'sharedbname' ]

When using shared database tables, i.e., the same set of users for different wikis, add oathauth_devices and oathauth_types to $wgSharedTables.

$wgSharedTables[] = 'oathauth_devices';
$wgSharedTables[] = 'oathauth_types';

Siehe auch

• Product_Safety_and_Integrity/Account_Security
• Two-factor authentication (TFA)
• Extension:WebAuthn - module for the OATHAuth extension that provides support for U2F devices (such as YubiKey) and password managers.
• Initiative for Open Authentication (OATH)

References