Note: This is a WIP revision of the current "Setting up LDAP/Shibboleth" page. Note that the use of a forwardslash in naming the aforementioned page caused MediaWiki to create a directory structure in which the "Shibboleth" page is contained in the "Setting up LDAP" subdir, which could probably stand to be corrected.
Also: I'm in favour of rearranging this guide so that Shibboleth is discussed before LDAP, as I think it's easier to explain the difference between the two after having outlined what an SSO system does.
Finally: This guide previously stated falsely that OCS did not ship with LDAP -- in fact, I was able to get it running out of the box with OCS 2.3.2. Because user variables are consistent across OxS, it would seem to be that Shibboleth could be ported to OCS by simply adding the commented-out code within config.inc.php and including the plugins\implicitAuth dir from OJS, but I am unable to verify this as working.
- 1 Introduction
- 2 Setting up Shibboleth
- 3 Setting up LDAP
- 4 Frequently Asked Questions
- 4.1 I can't log in to OxS with my LDAP credentials.
- 4.2 OxS seems to hash passwords differently than in LDAP. How to I get OxS to conform to LDAP's hashing technique?
- 4.3 How can I use OxS attributes to authenticate other sources with LDAP?
- 4.4 I get this error when trying to connect to my LDAP server:
- 5 Resources
For synchronizing user accounts across multiple applications, OJS and OCS support Shibboleth and LDAP, both of which have varying degrees of support in other applications, including phpBB, Drupal, WordPress, and other content management systems.
Shibboleth is a popular open-source Single-Sign On (SSO) standard. SSO allows users to authenticate at any system login point using a common username and password combination, in a familiar interface, and be automatically signed in without ever seeing a password entry field within OJS. SSO is popular among universities, who need to manage a large, controlled userbase, as it provides a more seamless integration between your web applications. However, Shibboleth can be much more complex to install and configure than LDAP, as explained in some detail at https://spaces.internet2.edu/display/SHIB2/NativeSPOneMany.
LDAP, the "lightweight directory access protocol" cannot be used as a Single-Sign On (SSO) solution. It can be used to preserve meaningful connections between users’ existing accounts on a server (ensuring, for example, that each new OJS user must be linked to one of a controlled list of email addresses, which can be specified externally), as well as for centralizing authentication (i.e. simplifying system architecture). A free, easy-to-configure Java LDAP server is available at http://www.opends.org.
Setting up Shibboleth
Note: Please note that Shibboleth support has not yet been ported to OCS. For future updates, see http://pkp.sfu.ca/bugzilla/show_bug.cgi?id=4224.
Shibboleth is maintained by the Internet2 Middleware Initiative (http://shibboleth.internet2.edu/), and their website provides a central location for downloads and documentation. Currently, they provide Shibboleth Service Provider 2.1 in binary form for all major operating systems, as well as providing source code. For further information on installing and setting up the Shibboleth Service Provider, please consult Internet2's support documentation.
Once Shibboleth is set up on your system, integration with your PKP application requires editing the config.inc.php file found in the base directory, in the [security] section. The variables in question all fall under the implicit_auth variable--Uncomment that by deleting the semicolon, and uncomment all of the other variables that begin with implicit_auth. Note that none of the other implicit_auth variables are consulted if the main variable is commented or not set to 'On'. By turning implicit_auth on, the login process will go through Shibboleth and several forms will be modified to not ask for personal information that is stored in Shibboleth.
Remember that integration with an SSO system disallows manual username and password entry within OJS, meaning that all user accounts must be mainained externally. This is to avoid leading SSO-naive users to register duplicate accounts.
Initially, all of the variables are set to generic values such as implicit_auth_header_first_name = HTTP_GIVENNAME and you will likely have to change the values to reflect your Shibboleth settings. If your application is part of an institutional federation, consult your technical support for these values. Otherwise, you will have to investigate the configuration files in Shibboleth. This can get complicated, and there is a difference between variables in Shibboleth 1.x and Shibboleth 2.x. As of Shibboleth 2.0, these values are stored as web server environment variables, and you can determine them by looking in the attribute-map.xml file (usually in the shibboleth_dir/etc/shibboleth/ directory), where the attribute is denoted by the 'id' attribute of each Attribute element. By default, the values should be Shib-EP-[AttributeId] where [AttributeId] is the value in the 'id' attribute, with the first letter capitalized. These values may also be in the form HTTP_SHIB_EP_[AttributeID] with [AttributeID] in all caps.
The implicit_auth_admin_list variable contains a list of UINs (email addresses) separated by spaces. If a user logs in with one of these UINs, they will automatically be logged in with administrator privileges. The implicit_auth_wayf_url can be found in the shibboleth.xml or shibboleth2.xml file (depending on what version you are using). It will be located in a <SessionInitiator> tag, as the URL attribute.
Setting up LDAP
Setting up an LDAP server is beyond the scope of this guide, but please consult the resources section for guides to doing so. Likewise, please consult the documentation for your other web applications for help with LDAP integration.
To set up LDAP in OJS and OCS, log in as the Site Administrator, and under 'Site Management' on the Administrator's home page, click on 'Authentication Sources'. Under 'Create authentication source', select 'LDAP' and click 'Create'. This will bring up the LDAP settings page.
The title for your LDAP setup is arbitrary; leave it as is or choose your own title. The next three settings customize the level of integration between OJS/OCS and your LDAP server.
- Enable user profile synchronization. If checked, user information (e.g. passwords, name, email address, phone number and other personal data) will automatically be synchronized between the LDAP source and OJS/OCS, allowing for a consistent user profile across applications.
- Enable user password modification. If checked, allows users to change their password and recover lost passwords.
- Enable user creation. If checked, any user created within OJS/OCS will automatically be added to the LDAP source, rather than having to specify users externally.
The next set of settings configures OJS/OCS to allow communication with the LDAP server.
- Server hostname. The domain/IP address of the server that hosts the LDAP source. If OJS/OCS is running on the same server as LDAP, you can enter 'localhost'.
- Server port. If LDAP is running on a non-standard port, enter the number here. Leave it blank if you're not sure.
- Base DN. This is where it gets a little complicated. LDAP is designed like a directory tree, much like your computer file system. To identify the directory entry to search for users, the LDAP plugin requires the base DN or 'Distinguished Name', on which to begin the search. In the example provided, ou=people,dc=example,dc=com, 'ou' (or 'Organization Unit') signifies the main group of users, which you should be able to determine from your LDAP source's configuration files. Likewise, the 'dc' (or 'Domain Component') should be under 'suffix' in your LDAP source's configuration file. Each domain component signifies a component of your domain name (e.g. example.com has the two domain components 'example' and 'com'. If you are using a localhost, use "dc=localhost,dc=localdomain".
- Manager DN. Like the Base DN, but this setting is required for the plugin to communicate with the LDAP source as an administrator, i.e. to make administrative changes. The domain components should be the same as the base DN, but the cn (or 'Common Name', i.e. the nickname of the root user) should be 'Manager' or whatever was set in your LDAP server configuration.
- Account name attribute. This value uniquely identifies a user object, and should be 'uid' for OpenLDAP, but may be different for other LDAP sources (e.g., it would be sAMAccountName for Microsoft Active Directory).
- Manager password. The password for the manager account (only required if the user profile/password synchronization or user creation options are enabled).
- Password encryption. For security reasons, it is recommended you use some form of password encryption. If you have PHP version 4.3.0 or greater, we suggest using SSHA.
Optionally, if your PHP is version 5.0 or greater, you can configure LDAP to use SASL (Simple Authentication and Security Layer) for authentication. As this feature is for advanced users, please consult the links in the Resources section for more information.
Frequently Asked Questions
I can't log in to OxS with my LDAP credentials.
A major component of OxS is a consistent record of user activity, especially in respect to submissions and editing. If user records are stored outside of OxS, there is no guarantee that the record will stick around or stay consistent, causing problems with OxS. Thus, LDAP credentials won't work unless there is a matching user in OxS.
That said, there are several ways to get your LDAP users into your OxS database. If you wish to do a one time dump of users into OxS, you could build an XML file with user information to import into OxS (see the Users XML plugin). Further, code could be written to automatically insert users into the database when registered in another application. The execute function in classes/manager/form/UserManagementForm.inc.php shows how users are registered into OJS, and can be modeled in user registration functions in another application. Likely a variety of other solutions can be implemented to overcome this.
OxS seems to hash passwords differently than in LDAP. How to I get OxS to conform to LDAP's hashing technique?
By default, OJS and OCS append the username to the password before hashing. To change this behavior, modify the encryptCredentials function in classes/security/Validation.inc.php. If you change the password hashing behavior, you will have to reset all existing passwords in the database.
How can I use OxS attributes to authenticate other sources with LDAP?
If, instead of using LDAP entries to authenticate OxS, you wanted to give a certain OxS user role (e.g. journal managers) access to other server resources via LDAP, you would first need to add user attributes to your LDAP source. This is outside the scope of this guide, but should be detailed in your LDAP source's manual. Next, you'd need to alter the ToAttr() function in the LDAP function roughly as follows:
$roleDao = &DAORegistry::getDAO('RoleDAO');
if ($roleDao->roleExists($journal->getJournalId(), $editorId, ROLE_ID_READER)) $role = 'reader';
else if ($roleDao->roleExists($journal->getJournalId(), $editorId, ROLE_ID_JOURNAL_MANAGER)) $role = 'manager';
// Other role constants are defined in classes/security/Role.inc.php
if ($role) $attr['role'] = $role;
I get this error when trying to connect to my LDAP server:
PHP fatal error: Call to undefined function ldap_connect()
PHP's LDAP extension is not included by default, and may have to be compiled. See http://ca.php.net/manual/en/ldap.installation.php for more information.
- Quick HOWTO : Ch31 : Centralized Logins Using LDAP and RADIUS - http://www.linuxhomenetworking.com/wiki/index.php/Quick_HOWTO_:_Ch31_:_Centralized_Logins_Using_LDAP_and_RADIUS
- How to setup and maintain OpenLDAP server for your network - http://fedoranews.org/mediawiki/index.php/How_to_setup_and_maintain_OpenLDAP_server_for_your_network
- OpenLDAP 2.1 Administrator's Guide: Using SASL - http://www.openldap.org/doc/admin21/sasl.html
- Java OpenDS LDAP Server - http://www.opends.org/
- Cyrus SASL for System Administrators - http://www.sendmail.org/~ca/email/cyrus/sysadmin.html
- Shibboleth Documentation - https://spaces.internet2.edu/display/SHIB/