Compatibility

Prerequisites

• The authn_simple distribution: authn_simple-1.1.0-distro.zip
• A suitable deployed container (here assumed to be glassfish) to support a web application. Testing has been carried out with Glassfish 4.0. Glassfish installation instructions are available.
• Python (version 2.4 to 2.7) installed on the server.

Summary of steps

1. Please follow the generic installation instructions
2. Update the icat.properties file for icat.server to see the authenticator and restart icat to see the change. The easiest way is to rerun the setup script for the icat.server.
3. Check that it works.

The authn_simple.setup.properties file

container

May be either glassfish or wildfly - though only glassfish is working fully at the moment.

home

is the top level of the container installation. For glasssfish it must contain "glassfish/domains" and for wildfly it must contain jboss-modules.jar.

port

is the administration port of the container which is typically 4848 for glassfish and 9990 for wildfly.

secure

must be set to true or false. If true then only https and not http connections will be allowed.

The authn_simple.properties file

user.list

Space separated list of user names that this plugin authenticates.

user.<user>.password

For each user given in user.list, this sets the password this user. This may either be a clear text password or a cryptographic hash of a password.
A password hash must start with a "$" character and be in the same form as found in the shadow(5) password file. It may be created using the mkpasswd(1) utility on Debian systems or grub-crypt on Red Hat derived systems or the python crypt module. The supported hash algorithms are MD5, SHA-256, and SHA-512.
A clear text password must not start with a "$" character.

ip

If access to the SIMPLE authentication should only be allowed from certain IP addresses then provide a space separated list of allowed values. These take the form of an IPV4 or IPV6 address followed by the number of bits (starting from the most significant) to consider.

mechanism

if specified is a label to appear before the user name as it is made available to ICAT for authorization. For example if this is set to 'simple' then a user with an entry of 'fred' will be provided to ICAT as 'simple/fred', but if no mechanism is specified it will be provided simply as 'fred'.

Update the icat.properties file for your ICAT

This is required for icat to see the new authenticator. As any earlier version of this authenticator will have been removed then it is important to perform this next step promptly.

If you still have the installation directory for icat then edit the icat.properties to refer to the new authenticator and type: ./setup install . This is the recommended way to avoid errors. Otherwise edit the icat.properties file in the config directory for your domain and restart the glassfish domain.

Check that authn_simple works

Use testicat (which is installed with ICAT) with one of the entries in the authn_simple.properties file. It should report that it logs in but may or may not have the permission to run the rest of the test. If it does not report that it has logged in then please check the server.log and the authn_simple.log files which can both be found in the logs directory below your domain.