MediaWiki

Extension:WSOAuth

Translate this page
Languages:
Not to be confused with Extension:OAuth.
This extension requires the PluggableAuth extension to be installed first.
MediaWiki extensions manual
WSOAuth
Release status: stable
Implementation User identity , User rights
Description Extends the PluggableAuth extension to provide authentication using an OAuth provider
Author(s) Xxmarijnw (Wikibase Solutions) and others
Latest version 9.0.0 (2023-06-16)
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.35+
PHP 7.3+
Database changes Yes
License MIT License
Download
Download extension
Git [?]:
Parameters
  • $wgOAuthCustomAuthProviders
  • $wgOAuthAutoPopulateGroups
  • $wgOAuthMigrateUsersByUsername
  • $wgOAuthDisallowRemoteOnlyAccounts
  • $wgOAuthUseRealNameAsUsername
Hooks used
Hooks provided
Quarterly downloads 101 (Ranked 58th)
Translate the WSOAuth extension
Vagrant role wsoauth
Issues Open tasks · Report a bug

The WSOAuth extension (Wikibase Solutions OAuth) provide authentication using an OAuth provider. It provides a layer on top of the PluggableAuth extension to enable authentication via OAuth.[1]

The following OAuth providers are currently available by default:

  • MediaWiki (MediaWiki instance running OAuth )
  • Facebook

WSOAuth makes it easy to add new OAuth providers. You can read more about how to add a new OAuth provider on WSOAuth for Developers .

Compatibility

Compatibility Matrix
WSOAuth PluggableAuth MediaWiki
9.0+ 7.0+
MediaWiki version:
≥ 1.35
6.0-8.x 6.0-6.x
MediaWiki version:
≥ 1.35
1.0-5.x 5.7
MediaWiki version:
≥ 1.31

Configuration

Values must be provided for the following mandatory configuration variables:

Flag Default Description
$wgPluggableAuth_Config (see Extension:PluggableAuth#Configuration) [] A mandatory array of arrays specifying the OAuth providers and their configuration. The data field of the array should be an array with the following keys:
type The OAuth provider the extension will use (e.g. mediawiki or facebook) Required
uri The OAuth application authentication URI[2]. optional for some providers
clientId The consumer key received from the OAuth application. Required
clientSecret The consumer secret received from the OAuth application. Required
redirectUri The default callback URI[2] to which the OAuth application returns after a successful authentication request. required for some providers
extensionData An array containing additional data required by the provider. required for some providers
migrateUsersByUsername Whether or not to allow usurpation of existing accounts. This overwrites the globally set $wgOAuthMigrateUsersByUsername. Optional
disallowRemoteOnlyAccounts Whether or not to allow accounts to not have a local counterpart. This overwrites the globally set $wgOAuthDisallowRemoteOnlyAccounts. Optional
useRealNameAsUsername Whether to use the real name as the username. This overwrites the globally set $wgOAuthUseRealNameAsUsername. Optional
autoPopulateGroups An array containing a list of MediaWiki group names that must be automatically assigned to the user after they are authenticated. This overwrites the globally set $wgOAuthAutoPopulateGroups. Since WSOAuth 9.0, this requires you to also configure how groups are synchronised. Optional

In addition, the following optional configuration variables are provided:

Flag Default Description
$wgOAuthCustomAuthProviders false An array containing a list of custom OAuth providers together with their class name (see WSOAuth for Developers for more information).
$wgOAuthAutoPopulateGroups [] An array containing a list of MediaWiki group names that must be automatically assigned to the user after they are authenticated. Since WSOAuth 9.0, this requires you to also configure how groups are synchronised.
$wgOAuthMigrateUsersByUsername false Whether or not to allow usurpation of existing accounts. If a user is already registered on your wiki before installing WSOAuth with the same username as a user that is logging in via OAuth, this setting will determine whether that existing account will be given to the user signing in (true), or whether the user singing in through OAuth will be prevented from doing so because the user already exists (false). Once an account has been migrated, the user associated with that account will always be able to sign in through OAuth, even after this setting is changed to false. It is safer to leave this value as false and let the user connect their remote account manually through Special:Preferences.
$wgOAuthDisallowRemoteOnlyAccounts false Whether or not to allow accounts to not have a local counterpart.
$wgOAuthUseRealNameAsUsername false Whether to use the real name as the username.

An example of the $wgPluggableAuth_Config for a single providers is as follows: 

$wgPluggableAuth_Config['nlwiki'] = [
    'plugin' => 'WSOAuth',
    'data' => [
        'type' => 'mediawiki',
        'uri' => 'https://nl.wikipedia.org/wiki/Special:OAuth',
        'clientId' => '...',
        'clientSecret' => '...'
    ],
    'buttonLabelMessage' => 'dutch-wikipedia-login-button-label'
];
The key of the configuration (in the example above nlwiki) is used to identify the OAuth provider internally and MUST NOT change.

An example of the $wgPluggableAuth_Config for multiple providers is as follows: 

$wgPluggableAuth_Config['nlwiki'] = [
    'plugin' => 'WSOAuth',
    'data' => [
        'type' => 'mediawiki',
        'uri' => 'https://nl.wikipedia.org/wiki/Special:OAuth',
        'clientId' => '...',
        'clientSecret' => '...'
    ],
    'buttonLabelMessage' => 'dutch-wikipedia-login-button-label'
];

$wgPluggableAuth_Config['facebook'] = [
    'plugin' => 'WSOAuth',
    'data' => [
        'type' => 'facebook',
        'clientId' => '...',
        'clientSecret' => '...',
        'redirectUri' => '...'
    ],
    'buttonLabelMessage' => 'facebook-login-button-label'
];

Group synchronisation

See also: Extension:PluggableAuth#Group Synchronization


To configure group synchronisation, you need to add a groupsyncs array to the $wgPluggableAuth_Config array. This array must contain zero or more sub-arrays that specify how groups are synced. For detailed information, see Extension:PluggableAuth#Group Synchronization.

The most common use-case is to synchronise all groups, which can be achieved using the syncall group synchronisation algorithm. The configuration below will achieve similar functionality to older version of WSOAuth (<= 8.0.0). 

$wgPluggableAuth_Config['nlwiki'] = [
    'plugin' => 'WSOAuth',
    'data' => [
        'type' => 'mediawiki',
        'uri' => 'https://nl.wikipedia.org/wiki/Special:OAuth',
        'clientId' => '...',
        'clientSecret' => '...',
        'autoPopulateGroups' => ['mygroups' => ['sysop', 'bureaucrat']]
    ],
    'groupsyncs' => [
        'mygroupsync' => [
            'type' => 'syncall',
            'groupattributename' => 'mygroups'
        ]
    ]
    'buttonLabelMessage' => 'dutch-wikipedia-login-button-label'
];

OAuth providers

If you want to add a new OAuth provider, see WSOAuth for Developers.

Currently, the following OAuth providers are supported:

  • MediaWiki OAuth (MediaWiki instance running OAuth )
  • Facebook

MediaWiki OAuth

Follow the steps below to enable authentication and authorization via MediaWiki OAuth.

  1. Register a new OAuth 1.0a application on the wiki you are delegating access to.
    • For example - to register with wikimedia visit: https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration/propose
    • Do not use an RSA key pair for authentication and let MediaWiki generate the secret for you. Use https://<local wiki url>/wiki/index.php?title=Special:PluggableAuthLogin as OAuth "callback" URL[3]. Select User identity verification only, no ability to read pages or act on a user's behalf. under Types of grants being requested.
  2. Write down the key and secret you received from MediaWiki.
  3. Set the following in your LocalSettings.php:
    $wgPluggableAuth_Config['mywikiauth'] = [
    'plugin' => 'WSOAuth',
    'data' => [
        'type' => 'mediawiki',
        'uri' => 'https://<central wiki>/w/index.php?title=Special:OAuth',
        'clientId' => '<The client ID (key) you received from MediaWiki when you registered your app>',
        'clientSecret' => '<The secret you received from MediaWiki when you registered your app>'
    ]
];
    The key of the configuration (in the example above mywikiauth) is used to identify the OAuth provider internally and MUST NOT change.

To exclusively use MediaWiki as your sign-on system and to automatically log in when visiting the wiki, also set the following in LocalSettings.php:

$wgPluggableAuth_EnableAutoLogin = true;
$wgPluggableAuth_EnableLocalLogin = false;

For OAuth applications that utilize a "callback" prefix, a redirect URI[2] must be set through the redirectUri key. This redirect URI must have the prefix specified.

Facebook

Follow the steps below to enable authentication and authorization via Facebook.

  1. Create a new app on Facebook for Developers.
  2. Under Add a Product, select Facebook Login.
  3. In the menu on the left, select Settings under Facebook Login.
  4. Add the domain of your wiki to the list of Valid OAuth Redirect URIs and hit save.
  5. In the menu on the left, click Settings, then Basic and write down the App ID and App Secret.
  6. Set the following in your LocalSettings.php:
    $wgPluggableAuth_Config['myfacebookauth'] = [
    'plugin' => 'WSOAuth',
    'data' => [
        'type' => 'facebook',
        'clientId' => '<The App ID>',
        'clientSecret' => '<The App Secret>',
        'redirectUri' => 'https://<wiki domain>/index.php/Special:PluggableAuthLogin'
    ]
];
    The key of the configuration (in the example above myfacebookauth) is used to identify the OAuth provider internally and MUST NOT change.

To exclusively use Facebook as your sign-on system and to automatically log in when visiting the wiki, also set the following in LocalSettings.php: 

$wgPluggableAuth_EnableAutoLogin = true;
$wgPluggableAuth_EnableLocalLogin = false;

Upgrading from before 6.0

The database schema had to be changed in order to support multiple authentication providers after version 6.0. If you are running a MediaWiki instance with a version of WSOAuth older than 6.0, you must migrate your existing external users to the new database schema if you want to upgrade.

You can use the maintenance script multiAuthMigrate.php located in the extension's maintenance folder to migrate: 

$ php extensions/WSOAuth/maintenance/multiAuthMigrate.php --provider=mywikiauth

The provider option in the example above determines which provider to migrate existing users to.

System messages

Here some useful system messages, related to this extension, that can be personalized:

Message title Default message Position Tip 
wsoauth-user-already-exists-message
 The username "{{{1}}}" is already taken. Text displayed is the login screen error message when an user tries to login with OAuth, but there is a user in that wiki who has the same username. It may happen that a user first registers on the wiki via the regular user registration and then tries to login through OAuth, encountering this error message. If this may happen in your wiki, you can personalize this message to invite users to authorize remote logins from their preferences. Here a screenshot:[upref 1]
 
The page Special:Preferences with WSOAuth installed showing the "Connect a remote account" button
  1. ↑ restricted preferences
To change a system message, edit the MediaWiki:Message title page on your wiki.

Installation

This extension requires the PluggableAuth extension.
  • Download and move the extracted WSOAuth 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/WSOAuth
  • 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.)
  • Add the following code at the bottom of your LocalSettings.php file: 
    $wgGroupPermissions['*']['autocreateaccount'] = true;

wfLoadExtension( 'PluggableAuth' );
wfLoadExtension( 'WSOAuth' );
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Configure as required.
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.


Vagrant installation:

  • If using Vagrant , install with vagrant roles enable wsoauth --provision

Notes

  1. ↑ Open Authorization (OAuth)
  2. ↑ 2.0 2.1 2.2 Uniform Resource Identifier (URI)
  3. ↑ Uniform Resource Locator (URL)
  •  
    Login page with local and remote authentication enabled.
  •  
    User preferences showing the "connect a remote account" button.
    Discussion: phab:T283908


Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:WSOAuth/en&oldid=6289062"