>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #1418186. --> Reported by: [jsherman](https://www.drupal.org/user/153371) >>> <h2>Purpose</h2> <p>ILS Authentication is a framework for authenticating users of a Drupal site against Integrated Library Systems. Each ILS requires a 'driver' to work with this module. A driver is an .inc file that connects to the ILS, queries its user database/API, and returns to the ILS Authentication module:</p> <ol> <li>a TRUE or FALSE value (depending on whether the current user credentials authenticate against the ILS); and</li> <li> optionally, an email address from the ILS account.</li> </ol> <p>Since ILS Authentication uses standard hooks to integrate with Drupal's account registration and authentication subsystems, existing and new local Drupal accounts (i.e., those created by the core user module) and accounts created by other contributed modules are unaffected by this module.</p> <p>Site admins who install ILS Authentication must select which driver to use. The 'sample' driver is installed by default. Only one driver can be active. The module only supports authentication against a single external source.</p> <p>Please note that this module will create accounts for users if they authenticate against the configured external source, regardless of whether the site administrator has choosen "Visitors can create accounts and no administrator approval is "required" under "Public registrations" at admin/user/settings. Local Drupal accounts are governed by the this setting as usual.</p> <h2>Features</h2> <ul> <li>supports new authentication sources by using 'drivers', which are PHP .inc files that contain only a few functions (documented below). This modular approach allow new drivers to be added without needing to modify the .module file.</li> <li>allows drivers to <ul> <li>add their own admin settings</li> <li>modify Drupal forms for their own purposes, such as the login form or the module settings form</li> <li>perform their own validation on the login form</li> </ul> </li> <li>allows site admins to <ul> <li>tell users (when they log in) that they must add an email address to their profile, since not all external authentication sources can provide an email address for the user.</li> <li>define driver-specific messages to be displayed when an external user requests a new password, and also to be displayed in external users' account pages. Since external users may not have email addresses (something core Drupal does not allow), external users do not receive an email when they request a new password. Instead, they see a driver-specific message telling them where to change their password (i.e., at the remote ILS). Drupal's default behavior of sending an email to users requesting new passwords still applies to local accounts.</li> <li>define default roles for user accounts created with this module.</li> <li>log usernames/passwords routed to external sources. This feature is intended to assist driver developers and should be turned off at all times other then during testing and debugging.</li> </ul> </li> </ul> <h2>Prerequisites</h2> <p>The module itself has no particular PHP, database, or Drupal requirements, other than it only works with Drupal 7.x.</p> <p>Certain PHP configuration options must be enabled to allow drivers to connect to their authentication targets. For example, if a driver connects using a URL, file_get_contents or cURL must be enabled, depending on how the driver is written. </p> <p>More information on the <a href="http://drupal.org/sandbox/jsherman/1418010">Project Page</a></p> <p>Git access:<br> <code>git clone --branch master http://git.drupal.org/sandbox/jsherman/1418010.git ilsauthen</code></p> <h2>Miscellaneous</h2> <p>The 6.x version of this module was developed by Mark Jordan, who will be a co-maintainer of this project.<br> See the 6.x version <a href="http://drupalib.interoperating.info/ilsauthen">here</a><br> I updated the module for 7.x and added a sip2 driver based on John Wohlers' GPL3 php-sip2 class library, which is included in this module, but may also be downloaded separately through svn:<br> <code>svn checkout http://php-sip2.googlecode.com/svn/trunk/ php-sip2-read-only</code> </p>