Extension:AuthDrupal

Overview
Signin integration for MediaWiki as slave of Drupal. (For the reverse setup, see Extension:DrupalIntegration.)

Current version 0.7.x is Drupal 6.x and for MW 1.13+ (verified to work with 1.15.1). Note the name of the Drupal module has changed in this version--you'll need to reinstall and re-enable the module. Previous version (http://thinkling.com/pub/src/AuthDrupal/AuthDrupal-0.6.1.tgz) works using Drupal 4.7.x and 5.x, MediaWiki 1.9, 1.10, 1.11.

Support is limited.

This code supports single signin for users of a Drupal site and a MediaWiki site. It is set up so that users sign in to the Drupal site, and as a result they automatically become logged in to the wiki.

The code replaces the wiki's own log in/register/logout links with links to the drupal front page to to force users to go through Drupal. (See below.)

User entries are still created in the wiki's user table and are kept up to date on each login with email and real name.

The login integration works as follows: when the user signs in to Drupal, an extra cookie is created containing their identity. When the user visits the wiki, the wiki extension sees the cookie, extracts the username, and logs the user in. When the user logs out of the Drupal site, both the special cookie and any of the wiki's session cookies are removed so the user is also signed out of the wiki.

Credits

 * This implementation started with the code written by TazzyTazzy (Mitch Schwenk)  available at: DCCwiki.


 * The code has changed a fair bit from the original. Modifications by Maarten van Dantzich.


 * Support for separate databases is based on Auth_phpBB.


 * For the rewrite, I looked at (and borrowed code from):
 * Auth_Shibboleth (ShibAuth) http://shibboleth.internet2.edu, Extension:Shibboleth_Authentication
 * LdapAuthentication.php by Ryan Lane  Extension:LDAP Authentication


 * Testing with Drupal 5.1 by Paul Coghlan


 * Testing with Drupal 5.1 and MediaWiki 1.10.1 by Michael Joseph


 * MediaWiki 1.13+ by Antoine Beaupré from koumbit.org

Bugs

 * DOESNT WORK with mediaWiki 1.18.0, It can be fixed patching MediaWiki Extension:


 * Login/Logout links are modified based on the existence of the DRXtrArgs cookie, should instead be based on the actual user login status. To do this, the two login_link/logout_link hook functions should be combined, and inside the hook check for the cookie and/or $wgUser->getId != 0. Thinkling 21:08, 1 April 2007 (UTC)


 * Should not keep the cookie domain setting in two places. It's currently in LocalSettings.php and in Mediawiki.module.


 * Currently there's logout code in both Mediawiki.module and in AuthDrupal.php. The code is now the same, need to test if doing it in both places is truly redundant.


 * Passwords are currently not copied into the MW database. If you use this extension and then decide the run the wiki as a standalone app with its own login system, you'll have to have passwords reset/emailed for everyone. When MW 1.10 ships, should change code to use $wgUser->setInternalPassword


 * It's been reported that creating a new account in Drupal may log you in to the Drupal site, but does not call the hook function that sets the cookie necessary to log in to Mediawiki. If someone can confirm this and/or suggest a fix, please leave a note on the discussion page.


 * Users are matched based on usernames only. If you rename a user on the Drupal site, they will not be connected with their existing login in Mediawiki. If you delete a user and create a new one by the same name, Mediawiki will connect the new user with the old account of that name on the wiki side. Look at the section "Missing Features" below for a workaround.

Missing Features

 * I have code implemented to disable editing of Real name and Email address in My Preferences but haven't gotten the patch in shape to be released yet.


 * Does NOT handle someone changing their username on the Drupal end. That user will be regarded as a new user by the wiki next time they sign in. Workaround: there is a module called User Read-Only that prevents users with a certain role from changing their username. Together with the module Auto Assign Role you can give all new users that role and prevent username change.


 * Should replace the "You have to log in to edit pages" message from code; the right way to do this would be to create a file with localizable messages and load those into the message cache, as e.g. Extension:Linksearch does.


 * When user clicks over to the Drupal page to log in, there's no mechanism to bring them back to the wiki page they came from. If anyone has tips on how to implement this, please leave a note on the talk page.

Other
The Drupal-specific issues should now be filed on Drupal.org.

Comments or Feedback?
If you have comments, questions, or improvements, please drop me a note via the discussion page, or email me via my user page.

Files
Please download the necessary files from the link above.

Instructions
If you are reading this in an INSTALL.txt file, then these instructions are for the version of the files you have.

The latest version of these instructions and of the code can be found at.

wiki/extensions/AuthDrupal/
 * download the AuthDrupal files and save or unpack them into

drupal/sites/all/modules/mediawikiauth (yes, you want AuthDrupalEncode.php in both places).
 * put mediawikiauth.module, mediawikiauth.info, and a copy of AuthDrupalEncode.php into

file. Change the database settings to match your setup. Change the cookie domain name to the domain under which your Drupal and wiki are hosted. If you're running this on localhost, leave the cookiedomain blank. ($wgCookieDomain = '')
 * Add code in AddToLocalSettings.php to the end of your wiki/LocalSettings.php

If drupal and mediawiki use the same database, just set $wgAuthDrupal_UseExtDatabase = false and ignore most of the _MySQL_ settings.

Make up a key string (something unique, think of it as a password) and set the same value for wgAuthDrupal_security_key in both LocalSettings.php and mediawikiauth.module. what you have set in LocalSettings.php. If you have multiple wikis sharing the same Drupal login, create a block of settings for each wiki. If you only have one wiki, delete the second example settings.
 * You need to assign a key to use to encode the username to prevent spoofing.
 * Edit the other settings at the top of mediawikiauth.module so that each item matches

user clicks the Edit tab, do the following:
 * To get rid of the "You must log in to edit pages" notice when a non-logged-in

** Go to the article called "MediaWiki:Whitelistedittext". ** The edit box should be preloaded with this text: "You have to $1 to edit    pages." ** Change this to the following (replace the url with whatever you've set for    $wgAuthDrupal_LoginURL):

You have to log in to edit pages.


 * go into Drupal admin pages and enable the Mediawiki module
 * Delete existing cookies for the domain as this can prevent the login redirection from working

Things should work at this point.

Optional parts:

/wiki/index.php?title=Special:Userlogin&type=signup (TODO: document how to turn off account creation)
 * you may want to ensure that account creation is blocked. Try going to

that does not stop a savvy user from going to Special:Userlogin directly. You may want to edit .htaccess to redirect that URL. There are instructions for this at the bottom of this page: 
 * even though the extension can change the login/logout link to point to Drupal,

If running on localhost
If you're using 'localhost' as your cookie domain, AuthDrupal may not work right. Edit the settings at the top of Mediawiki.module and set the cookie domain to an empty string there. That probably helps.

Replaced mcrypt
Version 0.6 no longer uses mcrypt to encode and decode the cookie containing the current user's username. The code now uses a homebrew encoding that should be hard for malicious users to spoof. If you're highly concerned about tight security, you may want to put support for mcrypt back in. (See 0.4 sources for the old version.)

Controlling behavior
These are global variables you CAN set in LocalSettings.php to control how AuthDrupal behaves:

Edits to LocalSettings.php
Please see the file AddToLocalSettings.php in the tarball for code to add to your LocalSettings.php and edit values as appropriate for your site.

Change History

 * v 0.7.2 - 2010-12


 * - fixed handling of usernames with underscores in them
 * - fixed two typo bugs, one of which may have been causing config issues


 * v 0.7.1 - 2010-03


 * - fixed propagation of Drupal user roles to MW group membership


 * v 0.7 - 2010-03


 * Minimal changes for Drupal 6.x and MW 1.13+.


 * v 0.6.1 - 2008-07


 * one of the files had whitespace after the closing php tag. oops! fixed.


 * v 0.6 - 2008-06


 * removed use of mcrypt and replaced with weaker home-grown username encoding.
 * made support for user roles optional, turned off by default, and now allows only some roles to be propagated. (This is not well tested.)
 * v 0.5 - 2007-09


 * corrected return values from hook functions as suggested by anisotropic in this comment


 * added support for pulling user roles from Drupal and setting them as group membership on the MW user object. updateUser is now called for existing session as well as new session to ensure user roles are pulled fresh from Drupal.


 * 0.4: Added support to allow multiple wikis sharing the same Drupal login front page; user is always logged in to all at the same time and logged out from all at the same time. Thinkling 23:12, 29 July 2007 (UTC)


 * 0.3.2: Fix for MW 1.10.1 and some code reformatting.


 * IP address check removed. Code used to check that user's IP address has remained the same between login to Drupal and visit to the wiki. This meant e.g. if you moved to another wifi network with your laptop, the authentication would fail such that the login/logout links at the op were in an inconsistent state. Thinkling 21:11, 1 April 2007 (UTC)