Extension:GoogleLogin/PreAuthManager
 Release status: beta |
|
|---|---|
 |
|
| Implementation | User identity, Special page |
| Description | Provides login with Google account (using Google API) |
| Author(s) | Florian Schmidt (Florianschmidtwelzowtalk) |
| Latest version | see the version lifecycle (2015-04-23) |
| MediaWiki | see the version lifecycle |
| PHP | 5.3+ (since 0.4.0: 5.5+) |
| Database changes | Yes |
| License | MIT License |
| Download | Extension:GoogleLogin/Changelog |
|
|
|
|
| Quarterly downloads | 63 (Ranked 75th) |
| Translate the GoogleLogin/PreAuthManager extension if it is available at translatewiki.net | |
| Issues | Open tasks · Report a bug |
The GoogleLogin extension allows wiki users to login with their Google Account. The extension uses Google API to request user data. If the user logged in first time, the extension allows to create a user with the Google email address and Google username (or given name, or an own name).
Requirements
To use this extension you need:
- MediaWiki 1.23+ (for version v0.2.0 and above you need at least MediaWiki 1.24)
- MySQL (no PostgreSQL or SQLite support for now!)
- PHP 5.3+
- Google Developer Access
- Google+ API access
- API Credentials for Webapplication (Client ID and Client Secret)
- Version v0.2.1 until version 0.3.1 requires the Extension GoogleAPIClient[1], otherwise run
composer update, only.
Installation
- Download and move the extracted
GoogleLoginfolder to yourextensions/directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/GoogleLogin - Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/extensions/GoogleLogin/GoogleLogin.php";
- Run the update script which will automatically create the necessary database tables that this extension needs.
- Configure the required parameters
- Make sure ./wiki/extensions/GoogleLogin/cache is writeable for root
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Configuration
require_once" directive added for this plugin. Otherwise any custom settings will be overwritten by the default settings, as referenced here: Topic:Si6ituq6hmxb07xmThe extension provides two configuration variables to set the Client ID and Client Secret (you get this pair in Google Developer Console, remove "<" and ">").
$wgGLSecret = '<your-client-secret>';
$wgGLAppId = '<your-client-id>';
Additional Configuration parameter
| Configuration variable | since version | Default value | Description |
|---|---|---|---|
| $wgGLShowCreateReason[gerrit 1] | v0.1.1 (removed in 0.4.0) | false
|
If true, adds via GoogleLogin as reason in create account log entry. |
| $wgGLAllowedDomains[gerrit 2] | v0.1.1 | ''
|
An array of email domains, which are allowed to use with GoogleLogin, e.g. array( 'example.com' );. Default: all domains are allowed.
|
| $wgGLAllowedDomainsStrict[gerrit 2] | v0.1.1 | false
|
Only observed, if $wgGLAllowedDomains is an array. If set to true, the email domain will be checked completely against the allowed domains (instead of only the TLD), e.g.:test.example.com isn't allowed if |
| $wgGLShowKeepLogin[gerrit 3] | v0.1.2 (removed in 0.4.0) | true
|
If true, the keep login checkbox for GoogleLogin (before Login with Google button) is visible. |
| $wgGLAllowAccountCreation[gerrit 4] | v0.1.2 (removed in 0.4.0) | $wgGroupPermissions['*']['createaccount']
|
Controls, if the user can create an account with GoogleLogin or not. As default, the value of group permissions for not logged in users will be used. |
| $wgGLReplaceMWLogin[gerrit 4] | v0.1.2 (removed in 0.4.0) | false
|
If true, the MediaWiki Login-workflow will be replaced with GoogleLogin. Includes:
|
| $wgGLForceKeepLogin[gerrit 5] | v0.2.0 (removed in 0.4.0) | false
|
Control, if Keep login (which means longer login sessions) is always enabled (even if the user doesn't checked the keep log box or GoogleLogin replaces MediaWiki's login!)
This configuration doesn't overwrite $wgGLShowKeepLogin, but it will overwrite the value of the keep login checkbox, so make sure, that you set this configuration to false if you want to avoid confusion.
|
| $wgGLAPIKey[gerrit 6] | v0.2.1 | ''
|
Key for public API access. Used only for admin actions to check, if the user has a Google Plus profile or not. |
| $wgGLShowRight[gerrit 7] | v0.3.0 (removed in 0.4.0) | false
|
If set to true, the Google Login button on Special:UserLogin will move to the right side of the form. |
| $wgGLNeedsConfirmEmail[gerrit 8] | v0.3.0 (removed in 0.4.0) | true
|
Whether the user needs to confirm the google mail address after registration of a new local MediaWiki account, or not. |
Settings in Google Developer Console
To use this extension you need a Google developer account and access to the developer console. This is a simple (a very simple!) step-by-step guide (use Step 1 of the official step-by-step example with these settings):
- Open Google developer console
- Read and accept the terms of service
- Create your first project
- Go to APIS & AUTH
- Go to APIs and enable Google+ API (read and accept the terms)
- Go to Credentials
- In Section OAuth click Create new Client ID
- Select as Web application as APPLICATION TYPE, as Authorized JavaScript origins type in your domain name (no wildcards and directories allowed!)
- Type in your Authorized redirect URI like this example:
- If your domain is example.com and you have installed MediaWiki in Root of your domain, the redirect URI is as follows: http://example.com/index.php/Special:GoogleLogin
- Click create and copy the Client ID and Client Secret to the configuration variables in LocalSettings.php
"Special:GoogleLogin" or (in German for example) "Spezial:Mit_Google_anmelden"
The allowed redirect URI in Google developer console must be in content language. So, if your wiki has content language German, then type in "Spezial:Mit_Google_anmelden" and not "Special:GoogleLogin". If you used the wrong language, all Authentication requests will fail with redirect uri mismatch.
Debug
Normally, you can see the error message on all generic error pages. Sometimes there are Internal Errors, called Exceptions. In this case, please add $wgShowExceptionDetails with value true in LocalSettings.php to see the complete Exception message. For a support request, please provide always the lines of the Exception.
Use on a private wiki
If you have set your Wiki to private with
$wgGroupPermissions['*']['read'] = false;
you have to whitelist the "Special:GoogleLogin" page, so that anonymous users can access the callback URL after being redirected from the authentication provider. You can do this by adding the following line to your LocalSettings.php:
$wgWhitelistRead = array( 'Special:GoogleLogin' );
Allow account creation only via GoogleLogin
It's possible to deactivate the account creation function of MediaWiki. Normally GoogleLogin don't give the option to create a new account, too. It's possible to change this, that Users can still create an account with GoogleLogin, but can't with the vanilla account creation form. For this you need to set up the following configuration varaibles in your LocalSettings.php:
$wgGroupPermissions['*']['createaccount'] = false;
$wgGLAllowAccountCreation = true;
If you want to remove the Login form of MediaWiki, too, you can set this configuration variable, too:
$wgGLReplaceMWLogin = true;
If you want to remove GoogleLogin in the future for any reason, your users can still login into your MediaWiki installation without to register a new account. GoogleLogin creates normal MediaWiki-accounts with a random password. Your users just have to reset their password with the special page Special:PasswordReset.
MobileFrontend <-> GoogleLogin conflict (only with $wgGLReplaceMWLogin = true; and MediaWiki <= 1.26!)
| MediaWiki version: | ≤ 1.25 |
MobileFrontend, the extension to provide a mobile optimized version of your wiki, actually conflicts with GoogleLogin if you set $wgGLReplaceMWLogin to true (to disallow login with the vanilla login form). In the case, that MobileFrontend is loaded after GoogleLogin (the require_once line of MobileFrontend in your LocalSettings.php is after the one of GoogleLogin), the special page UserLogin (which handles the login with username and password) will be overwritten by GoogleLogin the first time and by MobileFrontend the second time (to provide a mobile optimized login page). In this case, MobileFrontends Replacement will win and mobile users can still login with username and passwords.
Actually this problem is solved in the MediaWiki release branch/version 1.26 (tracked in task T74910) of MobileFrontend. For older versions of MediaWiki/MobileFrontend you need to change the order in which the Extensions are loaded. Put the require_once and configuration lines of GoogleLogin somewhere after the ones of MobileFrontend in your LocalSettings.php. This workaround should be obsolete in one of the next versions of MobileFrontend.
What can this extension do
With the database update, the extension will create a new table called prefix_user_google_user which contains the needed connection between the wiki users and Google accounts. It stores only the Google UserId and the Wiki UserId.
If a user calls the special page GoogleLogin, they will instantly redirected to Google Authentication request to give your application access to some user information stored by Google . The user must accept this request (or they can not use the login with Google). After accepting, the user has the possibility, if they are not logged in as a wiki user, to create a new account. The username they can choose self or choose one of the suggestions, based on the Google user name and given name (if one s free and createable). If the chosen username is creatable (free, valid and not blocked), a new user with the username and the Google-Mail as e-mail-address will be created and linked to the Google Account.
If the user is logged in (means: they have already a wiki account) they can link this account with the Google account, this the user must do only once. If the connection is created, the user will be able to login simply by clicking Login with Google button on Special:Login.
If the wiki account and Google account is connected, the user can, if they navigate to "Special:GoogleLogin", unlink his account and Google account.
Google API PHP Client
This Extension uses the Google API PHP Client (included in versions before 0.2.1), distributed under the Apache 2.0 License. The Client can be downloaded from GitHub.
Version lifecycle
In the following table you'll find versions of the GoogleLogin extension, the corresponding MediaWiki version for which the GoogleLogin version was built for and if it's still supported (and until when) or not. Mostly the support of a version is nearly the same as the lifecycle of the corresponding MediaWiki version.
| Version | Corresponding MediaWiki version | Status | Release | End-of-life |
|---|---|---|---|---|
| 0.4.x | 1.28.x | current version | November 2017 | |
| 0.4.0 | 1.27.x (LTS) | current version | June 2019 | |
| 0.3.1 | 1.27.x (LTS) | obsolete (replaced by 0.4.0) | ||
| 0.3.0 | 1.26.x | legacy version | n/a | November 2016 |
| 0.2.1 | 1.25.x | discontinued | n/a | |
| 0.2.0 | 1.24.x | discontinued | n/a | |
| 0.1.3 | 1.23.x (LTS) | discontinued | n/a |
Versions included in the above table that are marked as discontinued will not receive any fixes. They may contain critical security vulnerabilities and other major bugs, including the threat of possible data loss and/or corruption. The developer has also issued a strong recommendation that only versions listed above as current version or at least legacy version should be used in a production environment. Legacy versions will most likely get fixes for reported bugs that harms the core functionality of the extension, while current versions get fixes for most of the reported bugs (even if they're not part of the core functionality). New features will most likely be part of new versions. Backporting features to older versions of GoogleLogin is up to the developer(s).