Extension:GoogleLogin

From MediaWiki.org
Jump to: navigation, search
Translate this page; This page contains changes which are not marked for translation.

Other languages:
Deutsch • ‎English • ‎español • ‎italiano • ‎日本語 • ‎Nederlands • ‎occitan • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎sicilianu
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
GoogleLogin

Release status:Extension status beta

GoogleLogin-Screenshot.PNG
ImplementationTemplate:Extension#type User identity, Special page
DescriptionTemplate:Extension#description Provides login with Google account (using Google API)
Author(s)Template:Extension#username Florian Schmidt (Florianschmidtwelzowtalk)
Latest versionTemplate:Extension#version see the version lifecycle (2015-04-23)
MediaWikiTemplate:Extension#mediawiki see the version lifecycle
PHPTemplate:Extension#php 5.3+ (since 0.4.0: 5.5+)
Database changesTemplate:Extension#needs-updatephp Yes
LicenseTemplate:Extension#license MIT License
Download
Extension:GoogleLogin/Changelog
Hooks usedTemplate:Extension#hook
UserLogoutCompleteManual:Hooks/UserLogoutComplete
LoadExtensionSchemaUpdatesManual:Hooks/LoadExtensionSchemaUpdates
UserLoginFormManual:Hooks/UserLoginForm
UserCreateFormManual:Hooks/UserCreateForm
PersonalUrlsManual:Hooks/PersonalUrls
SpecialPage_initListManual:Hooks/SpecialPage_initList
GetPreferencesManual:Hooks/GetPreferences
RecentChange_saveManual:Hooks/RecentChange_save
ListDefinedTagsManual:Hooks/ListDefinedTags
ChangeTagsListActiveManual:Hooks/ChangeTagsListActive

Translate the GoogleLogin extension if it is available at translatewiki.net

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug
If you're installing GoogleLogin for a MediaWiki installation with the new authentication system (also referred to as AuthManager), please see the sub page which explains the new installation steps and requirements. Thanks.

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 e-mail-address and Google username (or given name, or an own name).

Requirements[edit source]

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[edit source]

  • Download and place the file(s) in a directory called GoogleLogin in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
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
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration[edit source]

Note Note: Ensure that all settings reside under the "require_once" directive added for this plugin. Otherwise any custom settings will be overwritten by the default settings, as referenced here: Topic:Si6ituq6hmxb07xm

The 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[edit source]

Configuration variable since version Default value Description
$wgGLShowCreateReason[gerrit 1] v0.1.1 (removed in v0.4.0) false If true, adds via GoogleLogin as reason in create account log entry.
$wgGLAllowedDomains[gerrit 2] v0.1.1 '' An array of E-Maildomains, 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 E-Maildomain will be checked completly against the allowed domains (instead of only the TLD), e.g.:

test.example.com isn't allowed if $wgGLAllowedDomainsStrict is true and example.com is an allowed domain.
test.example.com is allowed if $wgGLAllowedDomainsStrict is false and example.com is an allowed domain.

$wgGLShowKeepLogin[gerrit 3] v0.1.2 (removed in v0.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 v0.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 v0.4.0) false If true, the MediaWiki Login-workflow will be replaced with GoogleLogin. Includes:
  • Login-Link in Personal URLs
  • replace of Special:UserLogin to Special:GoogleLogin
$wgGLForceKeepLogin[gerrit 5] v0.2.0 (removed in v0.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!)

Note Note: 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 v0.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 v0.4.0) true Whether the user needs to confirm the google mail adress after registration of a new local MediaWiki account, or not.

Settings in Google Developer Console[edit source]

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):

  1. Open Google developer console
  2. Read and accept the terms of service
  3. Create your first project
  4. Go to APIS & AUTH
  5. Go to APIs and enable Google+ API (read and accept the terms)
  6. Go to Credentials
  7. In Section OAuth click Create new Client ID
  8. Select as Web application as APPLICATION TYPE, as Authorized JavaScript origins type in your domain name (no wildcards and directories allowed!)
  9. 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
  10. 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"[edit source]

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[edit source]

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[edit source]

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[edit source]

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!)[edit source]

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[edit source]

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, he 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 he can not use the login with Google). After accepting, the user has the possibility, if he isn't logged in as a wiki user, to create a new account. The username he 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: he has already a wiki account) he 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 he navigates to "Special:GoogleLogin", unlink his account and Google account.

Google API PHP Client[edit source]

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[edit source]

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.xMediaWiki 1.28 current version 2016-06-18 November 2017
0.4.0 1.27.xMediaWiki 1.27#Release schedule (LTS) current version 2016-07-20 June 2019
0.3.1 1.27.xMediaWiki 1.27#Release schedule (LTS) obsolete (replaced by 0.4.0) 2016-06-10 2017-07-20
0.3.0 1.26.xMediaWiki 1.26#Release schedule legacy version n/a November 2016
0.2.1 1.25.xMediaWiki 1.25#Release schedule discountinued n/a 2016-06-18
0.2.0 1.24.xMediaWiki 1.24#Release schedule discountinued n/a 2016-06-18
0.1.3 1.23.xMediaWiki 1.23#Release schedule (LTS) discountinued n/a 2016-06-18

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).


References[edit source]

Gerrit Code review[edit source]

  1. https://gerrit.wikimedia.org/r/#/c/142805/
  2. 2.0 2.1 https://gerrit.wikimedia.org/r/#/c/142741/
  3. https://gerrit.wikimedia.org/r/#/c/147519/
  4. 4.0 4.1 https://gerrit.wikimedia.org/r/#/c/147559
  5. https://gerrit.wikimedia.org/r/#/c/189215
  6. https://gerrit.wikimedia.org/r/#/c/187999/
  7. https://gerrit.wikimedia.org/r/218662
  8. https://gerrit.wikimedia.org/r/249470
  1. https://www.mediawiki.org/wiki/Extension:GoogleLogin/Changelog/v0.2.1