Extension:SAMLAuth

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
SAMLAuth extension

Release status: beta

Implementation Special page
Description SAML based authentication using SimpleSAMLphp
Author(s) Catalyst (Piers Harding)
MediaWiki 1.5+
License GPL/LGPL/MPL
Download SAMLAuth
Parameters

$wgSAMLAuthSimpleSAMLphpLibPath
$wgSAMLAuthSimpleSAMLphpConfigPath
$wgSAMLAuthSimpleSAMLphpentity
$wgSAMLAuthUserNameAttr
$wgSAMLAuthEmailAttr
$wgSAMLAuthAutoLogout

Hooks used
UserLogoutComplete

MediaWikiPerformAction

Check usage (experimental)

SAMLAuth extension enables SAML 2.0 based authentication as an alternative login mechanism from a dedicated SpecialPages URL.


[edit] Installation

Unpack the extension in the extensions directory.

include statement:

 require_once( "\$IP/extensions/SpecialSAMLAuth/SpecialSAMLAuth.php" );

in the LocalSettings.php file.

You must install, and configure SimpleSAMLphp as a SAML 2.0 Service Provider on the same domain as the Media Wiki instance.

Set the configuration values in $IP/extensions/SpecialSAMLAuth/SpecialSAMLAuth.php - an example is:

 $wgSAMLAuthSimpleSAMLphpLibPath = '/usr/local/simplesamlphp';  // Library path for SimpleSAMLphp
 $wgSAMLAuthSimpleSAMLphpConfigPath = '/usr/localsimplesamlphp/config';  // config.php path for SimpleSAMLphp
 $wgSAMLAuthSimpleSAMLphpentity = 'default-sp'; // The SimpeSAMLphp SP authentication entity
 $wgSAMLAuthUserNameAttr = 'eduPersonPrincipalName';     // User name attribute
 $wgSAMLAuthRealNameAttr = 'cn';      // Real Name attribute
 $wgSAMLAuthEmailAttr    = 'mail';    // email address attribute
 // auto logout from IdP?
 $wgSAMLAuthAutoLogout = true;
 // verify if user's IdP is known in the user settings?
 $wgSAMLVerifyIdP = false;
 // create user accounts for users that do not exist?
 $wgSAMLCreateUser = false;
 // activate debugging messages that go to apache error log
 $wgSamlAuthDebug = false;


[edit] Download the extension

Current version is 0.03 (as of 28/10/2010) - this is compatible with 1.15.3+. The extension can be downloaded from SAMLAuth.

Personal tools
Namespaces
Variants
Actions
Site
Support
Download
Development
Communication
Print/export
Toolbox