Extension:Shibboleth Authentication Plus

Overview
This extension enriches the functionality of Shibboleth Authentication Extension by supporting group-based user authentication / authorization and by implementing a messaging mechanism for user notification during the authentication/authorization process. It is already in use in the Grnet Wikis MediaWiki Farm.

Current Version: 1.0

Compatibility
This extension is designed for MediaWiki 1.7 and latest versions. If you want to use this extension with the 1.6 version or previous ones, refer to bugs 5819 and 6006 and apply the SVN changes that occurred.

Shibboleth Environment Configuration
The extension requires that shibboleth environment has been configured and set up on the web server the wiki is hosted on. Once Shibboleth is running on the web server, make sure your configuration file is correctly set-up. Further assistance with the environment configuration can be provided by your IdP manager. The extension uses lazy sessions in order to allow the standard wiki authentication to co-exist alongside with the Shibboleth authentication. Therefore, the relevant environment configuration should be made as described below. Full sessions are also acceptable for use.

You will require to indicate the extension which WAYF url to use. Following is the part of the shibboleth configuration file (shibboleth.xml), where the WAYF url should be completed:

...   

Following is the part of the Apache's Vhosts configuration file (vhosts.conf) that enables lazy sessions: ...  AuthType shibboleth Require shibboleth 

If you don't want lazy sessions but instead would rather require shibboleth authentication, then use: ...  AuthType shibboleth ShibRequireSession On       Require valid-user 

Download the Extension
The code of this extension is composed of three parts. The extended code of the Shibboleth Authentication Extension, the code that implements the group-based user authentication/authorization and the code that implements the messaging mechanism. There is a detailed description of the Shibboleth Authentication Plus Extension code at the following sections.

Shibboleth Authentication Extension Code
Download the code of the Shibboleth Authentication Extension and place it in the extensions folder, in a file called ShibAuthPlugin.php. Go to the function AutoAuth, define the global variable $shib_GRP and replace the defined "if expression" with the following one:

The only changes that have been made in the code of Shibboleth Authentication Extension are the definition of the $shib_GRP variable that contains the list of user groups, the mapping of that list to the local groups and the assignment of the user to the local groups.

Shibboleth Authentication Plus Extension Code
In this section you can see the code of the Shibboleth Authentication Plus Extension. The extension implements a mechanism for group-based user authentication and authorization based on eduPersonPrincipalName and eduPersonOrgUnitDN shibboleth environmental variables. The first variable contains the unique id of a user (the value of this variable is assigned to the $shib_UN variable of the Shibboleth Authentication Extension) and the second a list of the groups (and domains) that the user belongs to (the value of this variable is assigned to the $shib_GRP variable of the Shibboleth Authentication Plus Extension). The value of the eduPersonOrgUnitDN variable has the following format: ou=group1, ou=group2, o=domain, c=suffix (e.g ou=editor, o=university, c=com). The extension collects the groups of "your_domain" and maps them to the current list of the local groups. The user takes the authorization privileges of these groups. Place the code in the extensions folder, in a file called ShibAuthPlusPlugin.php and replace the "o=your_domain,c=your_suffix" expression with your own domain.

In addition, the Shibboleth Authentication Plus Extension implements a messaging mechanism in order to inform the users during the process of his Authentication and Authorization. You can see the generated messages by simply adding the {SHIBMESSAGE} variable in your desirable wiki page. Place the code in the extensions folder, in a file called ShibAuthPlusMessaging.php.

Shibboleth Authentication Plus Extension Configuration
Now it's time to configure and load the extension. To do that, just add the following lines to LocalSettings.php in the root of the mediawiki directory (most of the configuration instructions have been taken from the Shibboleth Authentication Extension page).

require_once('extensions/ShibAuthPlusPlugin.php');
 * 1) Shibboleth Authentication Stuff
 * 2) Load ShibAuthPlusPlugin

$shib_WAYF = "idp.example.org";
 * 1) Last portion of the shibboleth WAYF url for lazy sessions.
 * 2) This value is found in your shibboleth.xml file on the setup for your SP
 * 3) WAYF url will look something like: /Shibboleth.sso/WAYF/$shib_WAYF

$shib_Https = true;
 * 1) Is the assertion consumer service located at an https address (highly recommended)
 * 2) Default for compatibility with previous version: false

$shib_LoginHint = "Login via Single Sign-on";
 * 1) Prompt for user to login

$shib_AssertionConsumerServiceURL = "/Shibboleth.sso";
 * 1) Where is the assertion consumer service located on the website?
 * 2) Default: "/Shibboleth.sso"

$shib_map_info = "true";
 * 1) Do you want to map in names from Shibboleth data?
 * 2) Feel free to use extra PHP code to munge the variables if you'd like
 * 3) Additionally if you wish to only map some of the name data, set this to true
 * 4) and either blank shib_RN and shib_email or comment them out entirely.

$olderror = error_reporting(E_ALL ^ E_NOTICE);
 * 1) Ssssh.... quiet down errors

$shib_RN = ucfirst(strtolower($_SERVER['HTTP_FIRST_NAME'])). ' '	 . ucfirst(strtolower($_SERVER['HTTP_LAST_NAME']));
 * 1) Map Real Name to what Shibboleth variable(s)?

$shib_email = $_SERVER['HTTP_EMAIL'];
 * 1) Map e-mail to what Shibboleth variable?


 * 1) Shibboleth doesn't really support logging out very well. To take care of
 * 2) this we simply get rid of the logout link when a user is logged in through
 * 3) Shib. Alternatively, you can uncomment and set the variable below to a link
 * 4) that will either clear the user's cookies or log the user out of the Idp and
 * 5) instead of deleting the logout link, the extension will change it instead.
 * 6) $shib_logout = "http://example.org";

error_reporting($olderror);
 * 1) Turn error reporting back on

SetupShibAuth;
 * 1) Activate Shibboleth Plugin


 * 1) Define here the list of your local groups and the privileges of these groups


 * 1) $wgGroupPermissions['test']['read']= true;
 * 2) $wgGroupPermissions['test']['edit']= true;
 * 3) $wgGroupPermissions['test']['createpage']= true;
 * 4) $wgGroupPermissions['test']['createtalk']= true;
 * 5) $wgGroupPermissions['test']['upload']= true;
 * 6) $wgGroupPermissions['test']['reupload']= true;
 * 7) $wgGroupPermissions['test']['minoredit']= true;
 * 8) $wgGroupPermissions['test']['delete']= true;
 * 9) $wgGroupPermissions['test']['move']= true;
 * 10) $wgGroupPermissions['test']['editinterface']= true;
 * 11) $wgGroupPermissions['test']['upload_by_url']= true;
 * 12) $wgGroupPermissions['test']['uploadlocal']= true;
 * 13) $wgGroupPermissions['test']['protect']= true;

One important point in the configuration process is the definition of the local groups list. That list has to map the list of the expected shibboleth groups. This is required for the correct operation of the Authorization process. If the extension does not map any of the shibboleth groups to any of the local groups, the user takes the privileges of an anonymous user.