From DLXS Documentation

(Difference between revisions)

Current revision

Main Page > Ancillary Resources > DLXS Authentication and Authorization System

[edit] Functional overview

The DLXS Authentication and Authorization system is a complete access control system designed primarily for use in digital library environments. It can interoperate with core DLXS middleware to control access to collections, or it can be used as a standalone access control system in a general web environment.

The system has the following general capabilities:

user authentication, using either a self-contained encrypted password or existing Kerberos authentication server(s)
user self-service: each user can set or reset his/her password, and will receive automated confirmation email after doing so
institutional authentication using IP address ranges
centralized management of all user, institution, and access information in an Oracle database

Designed to function with a heterogenous mix of resources, both public and restricted, this system could be useful if you are looking to do any of the following:

provide off-campus users with authenticated access to locally-hosted resources
leverage an existing Kerberos authentication infrastructure in a web environment
provide other institutions with IP address range-based access to locally-hosted resources

[edit] Technical overview

The system is made up of three components:

authentication and authorization database: Here is stored all information on user accounts and user groups, institution names and IP address ranges, collections or resources, and access permissions--which users and institutions may access which collections or resources. This must be an Oracle database.
Apache web server module: This modular extension to Apache acts as a gatekeeper to all of the material on the web server, consulting the database in real time. It uses the access control information in the database to grant access, deny access, or request authentication. In addition, it implements the user interface which accepts a username and password, or which guides new users through the process of setting their initial password.
Page templates: The Apache module uses these fully-customizable HTML templates to generate the pages in the user interface.

[edit] Requirements

This is a robust system that supplies a complete campus authentication and authorization environment, and as such, it has heavy requirements that may be out of reach for some institutions or impractical for some purposes. DLXS acknowledges this, and will also be undertaking development of a "Lite" version of this system that requires nothing beyond the [../intro/sysreq.html standard DLXS system requirements]. This product is currently being shaped, but will probably be geared strictly toward interoperation only with DLXS middleware, and will provide simple access control assuming a pre-existing web authentication mechanism. Thoughts into the preliminary design of this system are welcome...and encouraged! Please contact the author of this document to share your ideas.

The following software or systems are required:

Apache 1.3.26 or higher with mod_ssl 2.8.10 or higher and mod_so, but not Apache 2.x
Kerberos V5 1.2 or higher
OpenSSL 0.9.6 or higher
Oracle 9i Server or higher.

In addition, the following skills or staff will be required for installation and/or maintenance:

familiarity with the C programming language
administrative access to the Apache server and Oracle Server installations
familiarity with Oracle administration and with SQL syntax for inserting, deleting, and manipulating data in tables

Note: it is OK, and in fact preferred, for an instance of Apache to run on the same server with Oracle to provide only the user interface of the system. It is not recommended that Oracle Server be installed alongside Apache on servers that are intended for heavy web service use.

Note: This system will establish an Oracle session for each Apache server process. If you expect the number of Apache web servers to be high, it is recommended that you configure Oracle to use shared servers to ensure scalability.

[edit] Installation

Unpack the distribution archive. The system is distributed as a compressed tar archive. Extract the contents of the archive into an area on your system where software is typically installed; e.g., /usr/local/dlps_auth .
Set up the Oracle tablespace. The following instructions will create an Oracle user, tablespace, and tables to support the system. Ideally, you should have your Oracle administrator at least looking over your shoulder for this portion of the installation.
1. Change to the directory where SQL scripts are supplied with the command (e.g.) cd /usr/local/dlps_auth/sql .
2. Carefully edit the file create_tablespace.sql , substituting the correct local customizations for Oracle data file locations as needed.
3. Carefully edit the file create_tables.sql , substituting the correct system administrator email address for sysadmin@your.domain on line 133.
4. Start the SQL monitor with the command sqlplus system (you will be prompted for the Oracle system password).
5. Create the schema and tablespace with the command @create_tablespace .
6. Set a new password for the dlps_auth user, exit from the SQL monitor, and restart the SQL monitor with the command sqlplus dlps_auth (you will be prompted for the new dlps_auth password).
7. Create all required tables with the command @create_tables .
8. Create the unique identifier and timestamp triggers with the command @create_triggers.
9. Define the primary keys with the command @key .
10. Create the auxiliary indexes with the command @index .
11. Define the stored procedures with the command @dlps_auth .
Modify the module source code. Several behaviors and settings are still compiled into the module source (mod_dlps_auth.c ), and will require hand customization.
1. Starting on line 345, the function change_passwd contains user interface logic that lets a user select one of two Kerberos realms, and is specific to the UM environment. This section will probably need modification based on your local authentication environment.
2. Starting on line 686, the confirmation email message that is sent when a user successfully changes his/her password will need modification as is appropriate to your environment.
3. On line 1437, the domain name associated with the cookie that is used for persistent authentication should be changed to your local domain.
Compile and install the module.
1. Carefully edit the file Makefile, substituting the installation paths of Kerberos, OpenSSL, and Oracle as appropriate.
2. Compile the module with the command make .
3. Install the module into your Apache installation with the command make install.
Configure and activate the system. The following instructions will modify your Apache configuration and immediately create some amount of load on your Oracle server. Ideally, you should have your Apache administrator at least looking over your shoulder for this portion of the installation.
1. Carefully edit the configuration file (e.g.) /usr/local/dlps_auth/etc/dlps_auth.conf , substituting the appropriate local values, as indicated below:
  1. Set DLPSAuthOracleHome to your Oracle installation home directory.
  2. Set DLPSAuthOracleTNSName to the global TNS name of your Oracle server.
  3. Set DLPSAuthOraclePassword to the password you assigned for the dlps_auth user in Step 2.6.
  4. Set DLPSAuthEncryptionKey to 16 random characters.
  5. Set DLPSAuthEnterPasswordServer to the server name you'll use to host the login page.
  6. Set DLPSAuthCookieLifetime to the number of seconds you'd like authentication to persist, or 0 if you'd like authentication to expire when the user's browser is closed.
  7. Set DLPSAuthChangePasswordServer to the server name you'll use to host the login page.
  8. Set DLPSAuthPasswordResultsServer to the server name you'll use to host the login page.
  9. Set DLPSAuthDefDestOnAuthenSuccess to a URL that the system should redirect users to after successful authentication if, for some reason, it is unable to determine the referring page.
  10. Set DLPSAuthDelayOnAuthenSuccess to the number of seconds to display the page that informs the user that he/she authenticated successfully (before redirecting him/her back to the referring page).
  11. Set DLPSAuthDocumentRoot to the directory containing the HTML templates, e.g. /usr/local/dlps_auth/html/templates .
  12. Set DLPSAuthHelpContact to the email address that should receive replies to password change confirmation emails from users.
  13. Set DLPSAuthSysAdminContact to the email address that should receive bounced delivery attempts to password confirmation emails
2. Reference this configuration file in your Apache configuration file with the directive (e.g.) Include /usr/local/dlps_auth/etc/dlps_auth.conf .
3. Restart Apache with the command apachectl restart , and check the error log to ensure that the server restarted successfully. If it didn't, you can easily remove the system from your configuration by placing a # character in front of the Include directive above and restarting Apache.

If all went well, the system is now running and ready to accept access controls!

[edit] Adding access controls

In the database, an access control is made up of three parts: 1) a collection record, which is essentially one or more server names and directory paths; 2) a user or institution record; and 3) an access record indicating the user or institution and the collection. In this way, collections, users, and institutions can be defined, and access permissions can be given in any combination.

The following sequence of example SQL commands will demonstrate the routine tasks associated with maintaining access controls in the database.

[edit] Example: Creating a collection record

insert into aa_coll (uniqueIdentifier, commonName, description, dlpsClass, dlpsSource, dlpsAuthenMethod, dlpsAuthzType, dlpsPartlyPublic, manager, lastModifiedTime, lastModifiedBy, dlpsDeleted) values ('jbt', 'Journal of Bobbles and Trinkets', 'An online resource focusing on the study of buttons, plastic toys, do-nothing machines, and the like', 'local', 'local', 'any', 'n', 'f', 0, SYSDATE, 'root', 'f');	Description of database columns: {\| width="100%" cellspacing="2" cellpadding="2"	`uniqueIdentifier`	the (unique) collection identifier
`commonName`	the collection name
`description`	a textual description of the collection
`dlpsClass`	the collection class (for use with DLXS middleware classes)
`dlpsSource`	the source of the material
`dlpsAuthenMethod`	the authentication method to use: either 'ip' (IP address range-based authentication, 'pw' (forced password authentication), or 'any' (a combination of the two)
`dlpsAuthzType`	the authorization type to use: either 'n' (normal) or 'd' (delegated)
dlpsPartlyPublic	a flag indicating whether the material is public: either 't' (true) or 'f' (false)
`manager`	the user group responsible for managing this collection entry
`lastModifiedTime`	the date and time this record was last modified
`lastModifiedBy`	the username of the user who last modified this record
`dlpsDeleted`	a flag indicating whether this record is deleted: either 't' (true) or 'f' (false)

|}

[edit] Example: Associating a server and directory with a collection

insert into aa_coll_obj (dlpsServer, dlpsPath, coll, lastModifiedTime, lastModifiedBy, dlpsDeleted) values ('www.your.domain', '/usr/local/apache/htdocs/jbt%', 'jbt', SYSDATE, 'root', 'f');	Description of database columns: {\| width="100%" cellspacing="2" cellpadding="2"	dlpsServer	the hostname of the web server
dlpsPath	the full file system path where the material is stored; note the "%" wildcard at the end of the path, which allows the access control to be applied to all contained files and directories
coll	the corresponding collection identifier
lastModifiedTime	the date and time this record was last modified
lastModifiedBy	the username of the user who last modified this record
dlpsDeleted	a flag indicating whether this record is deleted: either 't' (true) or 'f' (false)

|}

At this point, any attempt to access this resource, which is non-public and yet has no access permissions, should result in a prompt for authentication.

[edit] Example: Creating an institution record

insert into aa_inst (uniqueIdentifier, organizationName, manager, lastModifiedTime, lastModifiedBy, dlpsDeleted) values (1000, 'University of Michigan', 0, SYSDATE, 'root', 'f');	Description of database columns: {\| width="100%" cellspacing="2" cellpadding="2"	`uniqueIdentifier`	the (unique) institution identifier
`organizationName`	the institution name
`manager`	the user group responsible for managing this collection entry
`lastModifiedTime`	the date and time this record was last modified
`lastModifiedBy`	the username of the user who last modified this record
`dlpsDeleted`	a flag indicating whether this record is deleted: either 't' (true) or 'f' (false)

|}

[edit] Example: Associating an IP address range with an institution

insert into aa_network (dlpsCIDRAddress, dlpsAddressStart, dlpsAddressEnd, dlpsAccessSwitch, inst, lastModifiedTime, lastModifiedBy, dlpsDeleted) values ('141.211.0.0/15', 2379415552,2379546623, 'allow', 1000, SYSDATE, 'root', 'f');	Description of database columns: {\| width="100%" cellspacing="2" cellpadding="2"	dlpsCIDRAddress	the IP address range in CIDR format
dlpsAddressStart	the numeric starting address of the range
dlpsAddressEnd	the numeric ending address of the range
dlpsAccessSwitch	a flag indicating whether this address range is to be allowed or denied: either 'allow' or 'deny'
inst	the corresponding institution identifier
lastModifiedTime	the date and time this record was last modified
lastModifiedBy	the username of the user who last modified this record
dlpsDeleted	a flag indicating whether this record is deleted: either 't' (true) or 'f' (false)

|}

The system allows multiple IP address ranges to be associated with each institution.

[edit] Example: Permitting an institution to a collection

insert into aa_may_access (inst, coll, lastModifiedTime, lastModifiedBy, dlpsDeleted) values (1000, 'jbt', SYSDATE, 'root', 'f');	Description of database columns: {\| width="100%" cellspacing="2" cellpadding="2"	inst	the corresponding institution identifier
coll	the corresponding collection identifier
lastModifiedTime	the date and time this record was last modified
lastModifiedBy	the username of the user who last modified this record
dlpsDeleted	a flag indicating whether this record is deleted: either 't' (true) or 'f' (false)

|}

At this point, the resource will be accessible from the UM campus, but any attempt to access it from elsewhere should result in a prompt for authentication. However, as no users currently exist, it will not be possible to authenticate.

[edit] Example: Creating a user

insert inst aa_user (userid, givenName, initials, surname, rfc822Mailbox, dlpsKey, userPassword, lastModifiedTime, lastModifiedBy, dlpsDeleted) values ('cufarley', 'Charles', 'U.', 'Farley', 'cufarley@your.domain', '123-45-6789', '!none', SYSDATE, 'root', 'f');	Description of database columns: {\| width="100%" cellspacing="2" cellpadding="2"	userid	the (unique) user identifier
givenName	the given (first) name
initials	the middle initial(s)
surname	the surname
rfc822Mailbox	the email address
dlpsKey	the "key" value which will permit the user to establish or change their password using the self-serve user interface; this should be known only to the user
userPassword	the encrypted password or Kerberos authentication realm; this should be initially set to '!none', and will be set by the user
lastModifiedTime	the date and time this record was last modified
lastModifiedBy	the username of the user who last modified this record
dlpsDeleted	a flag indicating whether this record is deleted: either 't' (true) or 'f' (false)

|}

[edit] Example: Associating a user with an institution

insert into aa_is_member_of_inst (userid, inst, lastModifiedTime, lastModifiedBy, dlpsDeleted) values ('cufarley', 1000, SYSDATE, 'root', 'f');	Description of database columns: {\| width="100%" cellspacing="2" cellpadding="2"	userid	the corresponding user identifier
inst	the corresponding institution identifier
lastModifiedTime	the date and time this record was last modified
lastModifiedBy	the username of the user who last modified this record
dlpsDeleted	a flag indicating whether this record is deleted: either 't' (true) or 'f' (false)

|}

At this point, after being prompted for authentication, the user may authenticate and will be given access to the resource.

[edit] Example: Permitting a user to a collection

Access to collections may be given to individual users directly instead of via association with an institution. The following commands would modify the database to remove the association of the user with the institution, and explicitly permit the user to the collection. (Compare with Permitting an institution to a collection, above.)




         delete from aa_is_member_of_inst


         where userid = 'cufarley' and inst = 1000;


         


         insert into aa_may_access (userid, coll,


         lastModifiedTime, lastModifiedBy,


         dlpsDeleted)


         values ('cufarley', 'jbt',


         SYSDATE, 'root', 'f');

[edit] Example: Creating a DLXS text class collection record

Collections served by DLXS class middleware use a special mode of the system called "delegated authorization", which will be explained in more detail in the next example. First, though, to trigger this mode, DLXS class collections must specify both their class (e.g. text or image) and the appropriate authorization type flag, as shown below:




         insert into aa_coll (uniqueIdentifier,


         commonName,


         description,


         dlpsClass, dlpsSource,


         dlpsAuthenMethod, dlpsAuthzType,


         dlpsPartlyPublic,


         manager,


         lastModifiedTime, lastModifiedBy,


         dlpsDeleted)


         values ('jbt-text',


         'Journal of Bobbles and Trinkets',


         'An online resource focusing on the


         study of buttons, plastic toys,


         do-nothing machines, and the like',


         'text', 'local',


         'any', 'd',


         'f',


         0,


         SYSDATE, 'root', 'f');

Description of database columns, where different from Creating a collection record. above:
{| width="100%" cellspacing="2" cellpadding="2"

dlpsClass

the collection class (for use with DLXS middleware classes)

dlpsAuthzType the authorization type to use: either 'n' (normal) or 'd' (delegated)

|}

[edit] Example: Permitting an institution to a DLXS text class collection

When a permission is given to a collection that is set for delegated authorization, as above, the system behaves in a completely different way. Instead of acting as a gatekeeper, the system instead collects all pertinent authorization information and passes that information via environment variables to the DLXS middleware. The DLXS middleware will then use that information to decide which collections to present to the user.

This mode is necessary because DLXS middleware supports searching across multiple collections. Because any given user may have different access permissions based on institutional associations or explicit permissions, it is impossible to simply grant or deny access on a global basis. Instead, the DLXS middleware must be supplied with a customized list of authorized collections on a per-transaction basis in order to present the user with all of the material they are permitted to access, and none of the material for which they are not. The authorization type is referred to as "delegated" because the system is "delegating" the authorization decision to the DLXS middleware.

For a description of the information that is passed from the system to the DLXS middleware and how it is used, see [../auth/index.html DLXS Authentication and Authorization].

As you can see below, the command required to add the permission is the same regardless of the authorization type:

insert into aa_may_access (inst, coll, lastModifiedTime, lastModifiedBy, dlpsDeleted) values (1000, 'jbt-text', SYSDATE, 'root', 'f');	Description of database columns: {\| width="100%" cellspacing="2" cellpadding="2"	inst	the corresponding institution identifier
coll	the corresponding collection identifier
lastModifiedTime	the date and time this record was last modified
lastModifiedBy	the username of the user who last modified this record
dlpsDeleted	a flag indicating whether this record is deleted: either 't' (true) or 'f' (false)

|}

[edit] Appendix: Features of the UM Digital Library Services installation

Our local installation of this system includes the following:

Oracle configuration. Two Oracle 9i servers are installed in two different, and distant, parts of campus. These servers use replication features of Oracle to stay in near-real-time synchronization; if a change is made on one server, that change will be replicated to the other server in less than one minute. All Oracle client software has been configured with connect-time and session failover capabilities so that the Oracle server which is physically closest is preferred under normal circumstances, but the other will be chosen in the event of a failure. One server is Sun hardware running Solaris, and the other is Intel hardware running Linux.
Apache web server configuration. Apache, equipped with mod_ssl and the DLXS authentication and authorization system, is running alongside Oracle on each server. Each Apache installation is configured with a copy of a server certificate for the name "login.umdl.umich.edu" and has identical appearance in all respects.
Load balancing and failover. A DNS-based system has been put in place to dynamically direct users' browsers to the Apache server that is physically closest under normal circumstances, to the least loaded server under heavy usage conditions, or to the only available server in the event of a failure. A user accessing the server "login.umdl.umich.edu" may transparently hit either server.
Locally-hosted text and image resources. Servers that are dedicated to serving text and image content are equipped with the DLXS authentication and authorization system if they host any non-public content. The database is maintained with records which restrict access to these materials as needed. At the time of this writing, there are approximately 500 active institutions records in the database for institutions with subscriptions to resources hosted by DLS.
Library web server. The library's main web server also has the system installed, and restricted access to materials such as course reserves and staff-only areas of the website is provided through the system via IP address range or password authentication, as appropriate.
Library catalog. The Web-accessible interface to the library's catalog has been enhanced to honor the authentication cookie used by the system, and uses that to enable saved record sets, patron self-service functions, and other functions requiring authentication.
Library proxy server. The library's proxy server, EZProxy, was enhanced with a small custom script to honor the authentication cookie used by the system to initialize a proxy session. UM affiliates who have authenticated for other reasons are automatically granted a proxy session.

Top

DLXS Authentication and Authorization System