Erweiterung: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 |
| Virtual domain | virtual-oathauth |
|
|
|
|
|
| Herunterladen | |
| Übersetze die OATHAuth-Erweiterung, wenn sie auf translatewiki.net verfügbar ist | |
| Probleme | Offene Aufgaben · Einen Fehler melden |
The OATHAuth[1] extension provides two-factor authentication (2FA) support. It enables MediaWiki users to log in more securely, using authentication codes, security keys, or passkeys, along with their regular password. It uses the OATH (Initiative for Open Authentication) and WebAuthn standards.
OATHAuth supports the following methods of two-factor authentication:
- Password managers and authenticator apps
- Passkeys
- Security keys
- Recovery codes
OATHAuth also includes experimental support for passwordless login, and provides a 2FA framework that other extensions can plug into.
Verwendung
Die Hilfeseite zur Zwei-Faktor-Authentifizierung bietet Informationen für Endbenutzer wie diese Erweiterung genutzt werden kann.
Some policies explained on Two-factor authentication only apply to Wikimedia projects.
However, the basic instructions for using 2FA are the same for any wiki that uses Extension:OATHAuth.
The Special:AccountSecurity page guides users through adding and managing their two-factor authentication methods and recovery codes.
Installation
 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) |
Before you install OATHAuth, first install either the GMP php or BCMath php extension. WebAuthn functionality requires one of those two extensions.
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
OATHAuthim Ordnerextensions/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-devim 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 |
$wgOATHAuthAccountPrefix
|
false
|
The prefix used for the OATHAuth user account name and the issuer used for the account.
If |
$wgOATHExclusiveRights
|
[]
|
(entfernt in 1.46) Set of permissions that are revoked from users who did not login using two-factor authentication. |
$wgOATHRequiredForGroups
|
[]
|
(veraltet in 1.46) 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. This was deprecated in MediaWiki 1.46, and should be replaced by $wgRestrictedGroups; see the example. |
$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 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. |
$wgOATHRecoveryCodesCount
|
10
|
(eingeführt in 1.45) The default amount of recovery codes to generate for a given user. |
$wgOATHMaxRecoveryCodesCount
|
100
|
(eingeführt in 1.46) The maximum number of recovery codes that a user can have. Both permanent and temporary codes are counted for this limit. |
$wgOATHAdditionalRecoveryCodesValidityDays
|
7
|
(eingeführt in 1.46) Number of days for which codes generated on Special:Recover2FAForUser will be valid. |
$wgOATHMaxKeysPerUser
|
100
|
(eingeführt in 1.46) Maximum amount of keys allowed per user. |
$wgWebAuthnRelyingPartyID
|
null
|
Configures relying party ID. If not defined, this defaults to your domain. |
$wgWebAuthnRelyingPartyName
|
null
|
Configures relying party name. If not defined, this defaults to your sitename. |
$wgWebAuthnNewCredsDisabled
|
false
|
(eingeführt in 1.43) If true, new WebAuthn credentials (security keys and passkeys) cannot be added. See T354701 and git #1187476.
|
$wgOATHAuthDatabase
|
false
|
(entfernt in 1.44) The database domain. Only used in a multi-database environment. After MediaWiki 1.42, you should use $wgVirtualDomainsMapping['virtual-oathauth'] instead of this option. |
$wgOATH2FARequiredGroupRemovalPages
|
[]
|
(eingeführt in 1.46) An array of page names, where user can ask to have themselves removed from groups that require 2FA (keyed by the group name). The pages will be linked in the notice about 2FA being required for user. If there's no entry for the relevant group, key * will be used.
|
$wgOATHPasswordlessLogin
|
false
|
(eingeführt in 1.46) Allow passwordless login with passkeys. |
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 versions have to rely on user and perhaps ip-all.
See the documentation of $wgRateLimits for details.
User permissions
| User right | Description | Given by default to |
|---|---|---|
oathauth-enable
|
Allows users to configure two-factor authentication on their account, using Special:AccountSecurity. | user
|
oathauth-disable-for-user
|
Enables trusted people to remove two-factor authentication from other user's account, by using Special:DisableOATHForUser. | sysop
|
oathauth-recover-for-user
|
(eingeführt in 1.46) Users with this right can generate additional recovery codes (using Special:Recover2FAForUser) for other users, helping them to recover access to their account if they lose all their 2FA methods | sysop
|
oathauth-verify-user
|
Allows users to check if another user has two-factor authentication enabled on their account, using Special:VerifyOATHForUser. | sysop
|
oathauth-view-log
|
Grants access to Special:Log/oath, where all administrative operations related to two-factor authentication are recorded. | sysop
|
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.
Local development
To be able to create WebAuthn keys and log in with them, the wiki must be accessed over HTTPS, even if it lives on localhost.
This means that a typical setup where the wiki's URL is http://localhost:8080 will not work, and you will need to set up an HTTPS proxy.
If you're using MediaWiki-Docker, follow the HTTPS recipe, then use https://localhost:8443 to visit your wiki.
If you're not using MediaWiki-Docker, install Caddy, and put the following in /etc/caddy/Caddyfile:
localhost:8443 {
reverse_proxy 127.0.0.1:8080
tls internal
}
This will proxy https://localhost:8443 to http://localhost:8080.
If needed, change 8080 to the port MediaWiki normally runs on.
Shared database tables
| Warnung: | Due to limitations in the WebAuthn API, multi-wiki setups require special handling. See the "Cross-wiki support" section below. |
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';
Cross-wiki support
By default, users may only use their security key to log in to the wiki where they initially registered the key.
Attempting to log in on another wiki within the wiki family results in an error about an unrecognized key and restricts where the user can log in to only the wiki where they registered their key.
Limited support exists for wiki families (those with $wgVirtualDomainsMapping['virtual-oathauth'] configured) sharing the same root domain.
System administrators must first configure support for this by defining both $wgWebAuthnRelyingPartyID and $wgWebAuthnRelyingPartyName.
The Relying Party ID must be set to your root domain.
- For example, if you have wikis at
a.example.org,b.example.org, andc.example.org, the root domain isexample.organd must be set as the ID. The Relying Party name can be anything, but ideally, it should be the name of your wiki family.
Wiki families that cross different domains are supported through the "shared domain" feature in Erweiterung:CentralAuth. This is how the Wikimedia wiki family is set up, but this feature is not well documented for third-party reuse at this time.
WebAuthn browser support
A list of all WebAuthn supported web browsers can be found on Mozilla Developer Network. There are some known issues with Firefox on Linux (T415089).
Historical information
The OATHAuth extension originally provided support for TOTP[1], which started as a protocol for generating 6-digit, one-time verification codes, but became more generic over time. The messages in the OATHAuth user interface prefer the generic, more commonly-used terms: "authenticator app" instead of "TOTP", and "passkey" or "security key" instead of "WebAuthn key". However, the extension's code still uses "TOTP" and "WebAuthn" in module names.
Extension:WebAuthn was previously a separate module, but it was combined into the OATHAuth extension in late 2025 as part of MediaWiki 1.46.[2]
Siehe auch
- Product_Safety_and_Integrity/Account_Security
- Two-factor authentication (TFA)
- Initiative for Open Authentication (OATH)
References
- ↑ 1.0 1.1 OATH is the acronym for Open Authentication, which is the organization that created the standards for the HOTP and TOTP protocols that this extension provides.
- ↑ T303495
 | Diese Erweiterung wird in einem oder mehreren Wikis von Wikimedia verwendet. Das bedeutet mit hoher Wahrscheinlichkeit, dass die Erweiterung stabil ist und gut genug funktioniert, um auf solch häufig besuchten Webseiten benutzt zu werden. Suche nach dem Erweiterungs-Namen in den Wikimedia CommonSettings.php und den InitialiseSettings.php-Konfigurations-Dateien, um nachzusehen, wo es installiert ist. Eine vollständige Liste der installierten Erweiterungen in einem bestimmten Wiki wird auf Special:Version im Wiki generiert und angezeigt. |
 | Diese Erweiterung ist in den folgenden Softwarepaketen enthalten und/oder wird von den folgenden Wiki-Farmen, bzw. Wiki-Hostern verwendet: |
- Stable extensions/de
- User rights extensions/de
- Special page extensions/de
- Page action extensions/de
- Extensions which add rights/de
- AuthChangeFormFields extensions/de
- BeforePageDisplay extensions/de
- GetPreferences extensions/de
- LoadExtensionSchemaUpdates extensions/de
- ReadPrivateUserRequirementsCondition extensions/de
- UnitTestsAfterDatabaseSetup extensions/de
- UnitTestsBeforeDatabaseTeardown extensions/de
- UserModifyCreateAccountEmail extensions/de
- UserRequirementsCondition extensions/de
- GPL licensed extensions/de
- Extensions in Wikimedia version control/de
- All extensions/de
- Extensions bundled with MediaWiki 1.31/de
- Extensions requiring Composer with git/de
- Extensions used on Wikimedia/de
- Extensions included in BlueSpice/de
- Extensions included in Canasta/de
- Extensions available as Debian packages/de
- Extensions included in Miraheze/de
- Extensions included in MyWikis/de
- Extensions included in ProWiki/de
- Extensions included in semantic::core/de
- Extensions included in Weird Gloop/de
- Extensions included in wiki.gg/de
- Login extensions/de