LP#1817645: RemoteAuth documentation
[working/Evergreen.git] / docs / TechRef / remoteauth.adoc
1 Configurable APIs for Patron Authentication and Retrieval
2 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3
4 Summary
5 +++++++
6
7 Many external services need to authenticate patrons and retrieve information about their accounts from Evergreen.  Most of these services support some form of HTTP-based authentication, but every service has its own requirements and none of them support native Evergreen authentication.  Meanwhile, libraries often need to restrict access to these external services based on patron type, current status, standing penalties, and so on.
8
9 To meet these needs, Evergreen now has support for separate, configurable HTTP API endpoints for remote patron authentication and retrieval.  Each RemoteAuth endpoint handles a different external service or authentication method.  You set up the endpoints you want in your Apache config; each one uses a generic mod_perl handler to manage incoming requests, and specifies a Perl module that can actually talk to the external service, as well as an authentication profile that determines which patrons can be authenticated at this endpoint.  Support for https://tools.ietf.org/html/rfc7617["Basic" HTTP Authentication] is provided as a reference implementation.
10
11
12
13 How it works
14 ++++++++++++
15
16 . Client submits a request to a RemoteAuth endpoint containing user credentials and any additional requirements.
17 . RemoteAuth loads the handler module for this endpoint.
18 . Handler processes the request and authorizes the client.
19 . Handler loads this endpoint's configuration from the database.
20 . Handler authenticates the user using the credentials provided, and tests whether auth is permitted for this user at this endpoint.
21 . Handler returns an appropriate response to RemoteAuth, which passes the response to the client.
22
23
24 Apache configuration
25 ++++++++++++++++++++
26
27 To define a new RemoteAuth endpoint, add a new Location directive in your `eg_vhost.conf` file.  The default configuration for Basic auth looks like this:
28
29 ....
30 <Location /api/basicauth>
31     SetHandler perl-script
32     PerlHandler OpenILS::WWW::RemoteAuth
33     Options +ExecCGI
34
35     # access restricted to localhost by default; since this module provides no
36     # client authentiation, restricting access by IP or other means is stongly
37     # recommended
38     Require local
39
40     # remoteauth profile name
41     PerlSetVar OILSRemoteAuthProfile "Basic"
42     # Perl module for processing requests
43     PerlSetVar OILSRemoteAuthHandler "OpenILS::WWW::RemoteAuth::Basic"
44
45     # staff username/password for profile lookup and patron retrieval
46     PerlSetVar OILSRemoteAuthClientUsername "admin"
47     PerlSetVar OILSRemoteAuthClientPassword "demo123"
48 </Location>
49 ....
50
51 Here, the URL path `/api/basicauth` is our endpoint.  External clients send appropriately-constructed requests to this URL and get a response indicating whether auth succeeded (and containing patron account information, depending on how the endpoint is configured).
52
53 Since different external services have different requirements for patron auth, each RemoteAuth endpoint handles requests differently.  All endpoints use `OpenILS::WWW::RemoteAuth` as the main mod_perl handler, but specific implementation details are handled by the module specified by the OILSRemoteAuthHandler variable -- in this case, `OpenILS::WWW::RemoteAuth::Basic` for Basic HTTP Authentication endpoints.
54
55 The OILSRemoteAuthProfile variable specifies the name of a profile in the config.remoteauth_profile database table (see "Database configuration" below).
56
57 OILSRemoteAuthClientUsername and OILSRemoteAuthClientPassword are the username and password of an Evergreen user account that has the permissions necessary to (1) view users at this location and (2) retrieve config entries from the config.remoteauth_profile table.  Ideally, these credentials would be provided in the actual request.  Where that's not possible, as in the present case, we include the client credentials in our Apache configuration.
58
59 When an endpoint doesn't use client-provided authorization credentials, we may wish to restrict access to the endpoint by IP address or other means.  By default, Basic auth only allows connections originating from the same server ("Require local").  To make an endpoint publicly accessible, use "Require all granted".  To restrict access by IP, use "Require ip <ip-address>".
60
61
62 Database configuration
63 ++++++++++++++++++++++
64
65 In each endpoint's Apache configuration, the OILSRemoteAuthProfile variable specifies the name of an entry in the config.remoteauth_profile table (see "Apache configuration" above).  The profile tells us the context org unit for requests at this endpoint and defines rules for permitting auth requests.  Supported rules include:
66
67 * *perm:* a permission which the user must have in order to be authenticated via RemoteAuth
68 * *restrict_to_org:* only allow users belonging to this location to be authenticated, even if the client can retrieve users at other locations
69 * *allow_inactive:* allow authentication for inactive users
70 * *allow_expired:* allow authentication for expired users
71 * *block_list:* authentication is not permitted if the user has a standing penalty at this location with one of these blocks
72
73 RemoteAuth uses the actor.permit_remoteauth database function to apply these rules during an authentication request.  For example, if allow_expired is false and the user is expired, the database function will respond with "expired" and RemoteAuth will deny the authentication request.
74
75 You can use the same configuration for multiple endpoints.  For example, suppose you need separate endpoints for EZProxy and Basic HTTP Authentication, but you want both endpoints to use the same auth rules.  In that case, each endpoint gets a separate entry in `eg_vhost.conf`, but the profile name specified by the OILSRemoteAuthProfile variable will be the same for both endpoints.
76
77
78 Test plan
79 +++++++++
80
81 . Install the branch on a test server and load concerto data.  Basic auth will be enabled by default for localhost access only.
82 . Generate base64-encoded credentials for your test user: `echo -n "<username>:<password>" | base64`
83 . Query the basic auth endpoint: `curl -k -s -o /dev/null -I -w "%{http_code}\n" https://localhost/api/basicauth -H "Authorization: Basic <base64-encoded-credentials>"`
84
85 This will return 200 if auth is successful, and 403 if auth fails or is not permitted.
86
87 There's also a Perl live test.  However, the live test may fail in some environments due to an https://github.com/libwww-perl/libwww-perl/issues/83#issuecomment-405233929[upstream bug] in `LWP::Protocol::https` that prevents us from skipping certificate verification.  The packaged version of that module in Ubuntu 16.04 is affected; installing `LWP::Protocol::https` version >=6.07 from CPAN resolves the problem.
88