Section 3.93. <AuthBy SIP2>

3.93. <AuthBy SIP2>

This clause authenticates users with 3M Standard Interchange Protocol 2 as used in 3Ms Automated Circulation Systems (ACS) for book libraries. AuthBy SIP2 supports TCPIP connection to 3M ACS systems, and authenticates against library patron name and password.

Works with EAP-GTC and PAP and therefore with e.g. EAP-TTLS/PAP. See goodies/ sip2.cfg for an example configuration file.

Tip

SIP2 is not related to Session Initiation Protocol (SIP) used for Voice Over IP and other multimedia applications.

<AuthBy SIP2> understands also the same parameters as <AuthBy xxxxxx>. For more information, see Section 3.32. <AuthBy xxxxxx>.

3.93.1. Port

Port specifies the TCP port name or number of the ACS server. Defaults to 6001.

3.93.2. Host

Host specifies the name or address of the ACS server. Defaults to localhost.

3.93.3. Delimiter

The field delimiter ACS server uses. Defaults to "|".

3.93.4. Timeout

Timeout interval in seconds that Radiator will wait for when trying to contact the SIP2 server. Defaults to 3.

3.93.5. Retries

This is an integer that specifies the number of times Radiator tries to send a request and wait for the reply from the SIP2 server before disconnecting and initiating possible failure backoff. The default value is 3.

If the SIP2 server returns its desired reply count and this reply count is smaller than the Retries value, the server's desired value is used.

3.93.6. FailureBackoffTime

This is an optional integer that specifies for how long time a failed SIP2 server is marked as failed. If no reply is received from the requested SIP2 server after all retries are used, the server is marked as failed. It is not connected again until FailureBackoffTime has been expired. The unit is seconds and the default value is 0, which means that the server is never marked as failed and always expected to be working.

3.93.7. LoginUserID

User ID that Radiator will use to log into the ACS server. If this is defined as an empty string, then the login phase will not be performed. You need to be sure that this matches what the SIP2 server expects from clients. Many servers do not require a login phase. Defaults to scclient.

# LoginUserID is empty to skip the login phase
LoginUserID

3.93.8. LoginPassword

Password that Radiator will use to log into the ACS server. Defaults to clientpwd.

LoginPassword clientpwd

3.93.9. LocationCode

Location code that Radiator will use to log into the ACS server. Defaults to ‘Radiator’.

3.93.10. TerminalPassword

Terminal Password that Radiator will use to log into the ACS server. Not all installations require this.

TerminalPassword terminal password

3.93.11. Institution

The library's institution ID that Radiator will use Patron Information and Status Request messages. Defaults to not set. When set, overrides the value learnt from ACS Status message.

Institution UWOLS

3.93.12. SendChecksum

This optional flag tells Radiator to send checksums in every request sent to ACS. This must agree with the configuration of the ACS and defaults to off.

# This ACS requires sending checksums
SendChecksum

3.93.13. VerifyChecksum

Tells Radiator to verify checksums sent by ACS are present and correct. This must agree with the configuration of the ACS and defaults to off.

# We want to verify the checksums this ACS sends
VerifyChecksum

3.93.14. SIP2Hook

Perl hook that is run for each request handled by SIP2. This hook can be used for further authorisation checks. The hook is passed the following arguments:

Reference to the current AuthBy SIP2 object
Response received from the ACS
Reference to the current request

The hook return value must be one of:

$main::ACCEPT
$main::REJECT
$main::IGNORE
$main::CHALLENGE
$main::REJECT_IMMEDIATE

Note

When the optional parameter NoCheckPassword is enabled, the hook return value determines the authentication result. See goodies/sip2hook.pl for an example.

SIP2Hook file:"%D/sip2hook.pl"