more indenting rather than ```-escaping
[raven/abandoned/asp.git] / README.md
1 University of Cambridge Classic ASP/VBScript Raven Authentication Module - v.1.0 (29/04/2014)
2 ==========================================================================
3
4 Description
5 -----------
6 This software comprises a VBScript class 'Ucam_Webauth' and sample
7 files that provide a Classic ASP/VBScript implementation of a 'Raven'
8 authentication module; Raven is the web authentication protocol used
9 by the University of Cambridge, UK. The logic and code of the
10 'Ucam_Webauth' class are loosely based on the PHP Raven authentication
11 class provided at http://raven.cam.ac.uk/project/.
12 - For a full description of the latest Raven specification and an explanation
13 of how Raven works, go to http://raven.cam.ac.uk/project/.
14 - This software was originally created for the Careers Service,
15 University of Cambridge by sh801@cam.ac.uk. For support, please
16 contact raven-support@ucs.cam.ac.uk
17
18 Files and folders
19 -----------------
20 - [certificates]: Temporary location for Raven public key certificates.
21 - [js]: Folder containing Javascript cryptography libraries.
22 - [docs]: Supporting documentation.
23 - [logs]: Possible location for log files created by the module.
24 - Default.asp: A sample file showing how the 'Ucam_Webauth' class is used
25 to provide Raven authentication.
26 - Test.asp: A test file for unit testing the 'Ucam_Webauth' module using the
27 'Ucam_RavenWLS' dummy Raven server (separate project, not included).
28 - Ucam_Webauth.vbs: The main 'Ucam_Webauth' VBScript class.
29
30 Platform requirements
31 ---------------------
32 This module has been tested on IIS7 with .NET Framework set to
33 'No managed code', ie. classic ASP.
34
35 Installation
36 ------------
37 ### Cryptographic functions
38 Cryptographic functions are provided by the Javascript libraries within the
39 'js' folder. These libraries are versions of the client-side Javascript
40 libraries provided at http://kjur.github.io/jsrsasign/index.html
41 but modified to run server-side. There is no need to install any
42 additional cryptography libraries.
43
44 ### Install Raven certificates
45 The authentication module uses the Raven public key certificate at
46 https://raven.cam.ac.uk/project/keys/ to verify authentication responses.
47 Download the certificate from https://raven.cam.ac.uk/project/keys/ and copy
48 to the 'certificates' folder provided with this authentication module
49 download - the 'certificates' folder is a temporary location for the
50 certificate while you get the module up and running. You will need to supply
51 the full path to the 'certificates' folder as either a 'key_dir' argument
52 to the 'Ucam_Webauth' constructor or by modifying the 'Ucam_Webauth'
53 variable 'DEFAULT_KEY_DIR' directly.
54
55 Once you have everything working, move the 'certificates' folder
56 to a new location on your webserver that is not web- or publicly-accessible
57 and modify the 'key_dir' string accordingly.
58
59 - NOTE: you may have to change the name of the key file from 'pubkey2.crt'
60 to '2.crt'.
61
62 If you're using the Raven test server
63 (http://raven.cam.ac.uk/project/test-demo/) for testing purposes, make sure
64 you install the test server keys instead, but ensure you remove these keys
65 before using the authentication module in a production environment, as
66 recommended by the demo Raven server:
67
68 > It is vital to keep these demo keys seperate from keys
69 > used with a production service - failure to do so could
70 > allow an attacker to successfully replay a response
71 > from the demonstration server, which anyone can easily
72 > obtain, against a production service.
73
74 Getting started
75 ---------------
76
77 The 'Ucam_Webauth' VBScript class must be used within an ASP server-side page
78 as it interacts directly with a user's browser session. To use the
79 'Ucam_Webauth' VBScript class:
80
81 1. Ensure the 'Ucam_Webauth.vbs' class file and the folder 'js' are in the
82 same directory as your ASP script. The folders 'certificates' and 'logs' may
83 also be located here temporarily.
84 2. Include the 'Ucam_Webauth.vbs' class file in the 'head' of your ASP file:
85
86
87 <head>
88 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
89 <!--#include file="Ucam_Webauth.vbs"-->
90 </head>
91
92 3. Set up the initial arguments for the 'Ucam_Webauth' class:
93
94 Set args = CreateObject("Scripting.Dictionary")
95 args.Add "hostname", "localhost"
96 args.Add "auth_service", "https://demo.raven.cam.ac.uk/auth/authenticate.html"
97 args.Add "key_dir", "C:/Ucam_Webauth/certificates"
98
99
100 'args' is an associative array of *text* strings so parameter values must
101 be converted into strings, ie. numbers and booleans must be supplied within
102 quotes as in "23", "TRUE", "FALSE".
103 A full list of allowed parameters is provided at the end of this README.
104
105 4. Create an instance of the 'Ucam_Webauth' class from within your ASP
106 server page and initialize with setup variables:
107
108 ```
109 Set oUcam_Webauth = New Ucam_Webauth
110 Call oUcam_Webauth(args)
111 ```
112
113 5. Call 'Authenticate()' on the Ucam_Webauth object and act according to
114 the value returned:
115
116 ```
117 Select Case oUcam_Webauth.Authenticate()
118
119 Case oUcam_Webauth.AUTHENTICATE_INCOMPLETE
120
121 ...
122 Exit Sub
123
124 Case oUcam_Webauth.AUTHENTICATE_COMPLETE_AUTHENTICATED
125
126 ...
127
128 Case oUcam_Webauth.AUTHENTICATE_COMPLETE_NOT_AUTHENTICATED
129
130 ...
131
132 Case oUcam_Webauth.AUTHENTICATE_COMPLETE_ERROR
133
134 ...
135
136 End Select
137 ```
138
139 The four possible return values of 'Authenticate()' are:
140
141 - AUTHENTICATE_INCOMPLETE : The authentication process has yet to complete.
142 The user may have been redirected to the Raven server and has yet to enter
143 their login details.
144 - AUTHENTICATE_COMPLETE_AUTHENTICATED : The authentication process completed
145 and the user has been successfully authenticated.
146 - AUTHENTICATE_COMPLETE_NOT_AUTHENTICATED : The authentication process
147 completed and the user was not successfully authenticated.
148 The user may have clicked 'Cancel' at the Raven server.
149 - AUTHENTICATE_COMPLETE_ERROR : There was an error during the authentication
150 process forcing the authentication cycle to terminate early.
151
152 As the 'Authenticate()' function may need to send HTTP headers, it must be
153 called before any output (e.g. HTML, HTTP headers) is sent to the browser.
154
155 The 'Default.asp' file provided is a sample of a simple server page using
156 the 'Ucam_Webauth' VBScript class.
157
158 Overview of Raven process
159 -------------------------
160 A diagram of the Raven authentication process is located within the 'docs'
161 folder as [I - Overview of Raven Authentication Process.pdf].
162
163 The authentication cycle consists of the following key stages:
164
165 #### User first tries to access authenticated page
166 User tries to load an authenticated page on a particular website.
167 The 'Ucam_Webauth' class is loaded and the 'Authenticate()' function is called.
168 If no authentication cookie is found to indicate the user is authenticated,
169 the user's browser is redirected to a separate Raven server using a special
170 'Authentication Request'. The authentication request consists of a series of
171 authentication parameters encoded into the URL redirect as name/value pairs.
172
173 #### User is prompted for login information
174 The Raven server interprets the authentication request sent by the main
175 website and prompts the user for their username and password. The user may
176 then be successfully authenticated or may decide to click 'Cancel'. They are
177 redirected back to the main website with a series of 'Authentication Response'
178 parameters encoded into a 'WLS-Response' GET variable.
179
180 #### User redirected back to main webserver
181 The user's original page is loaded again and 'Authenticate()' is called a
182 second time. 'Ucam_Webauth' processes the new 'WLS-Response' GET value and,
183 if it's valid, sets an authentication cookie on the user's browser. The
184 user's original page is then loaded again.
185
186 #### User redirected back to main webserver again
187 With an authentication cookie now set, 'Authenticate()' checks the status
188 code contained in the value of the authentication cookie and returns either
189 'AUTHENTICATE_COMPLETE_AUTHENTICATED' or
190 'AUTHENTICATE_COMPLETE_NOT_AUTHENTICATED'. If
191 'AUTHENTICATE_COMPLETE_AUTHENTICATED' is returned , the original page can
192 go on to display authenticated content to the user.
193
194 Specifics of module
195 -------------------
196 The 'Authenticate()' function is the overarching authentication function of
197 'Ucam_Webauth'. It performs some basic sanity checks using 'CheckSetup()'
198 then uses 'GetCurrentState()' to establish the current state of the
199 authentication process before branching accordingly. The possible return
200 values of 'GetCurrentState()' are:
201
202 #### STATE_NEW_AUTHENTICATION
203 A completely fresh authentication. 'SendAuthenticationRequest()' [*1*] is
204 then triggered which performs some basic data checks, sets the authentication
205 cookie to 'AUTHENTICATIONCOOKIE_REDIRECT_WLS' (to record where we are in the
206 authentication process) and redirects the user's browser to the Raven
207 authentication server with a series of authentication parameters
208 encoded as name/value pairs.
209
210 #### STATE_WLS_RESPONSE_RECEIVED
211 The Raven authentication server has processed the user and has returned the
212 user's browser back to the original website with a series of authentication
213 response parameters encoded into the 'WLS-Response' GET variable.
214 'ProcessAuthenticationResponse()' [*2*] is then called which checks the
215 validity of the 'WLS-Response' value, sets an authentication cookie and
216 redirects the user back to the original page.
217
218 #### STATE_WAA_AUTHENTICATIONCOOKIE_SET
219 A valid authentication cookie has been set
220 (<> AUTHENTICATIONCOOKIE_REDIRECT_WLS).
221 'ProcessAuthenticationCookie()' [*3*] is then called which checks the
222 validity of the cookie. If the cookie has expired,
223 'SendAuthenticationRequest()' is called again in case the user needs to
224 reauthenticate themselves. If the cookie is still valid, an
225 'AUTHENTICATE_COMPLETE_XXX' value is returned, indicating that the
226 authentication cycle has completed successfully.
227 NOTE: this may be true if the user has cancelled the authentication process,
228 in which case 'AUTHENTICATE_COMPLETE_NOT_AUTHENTICATED' will be returned.
229
230 #### STATE_ERROR
231 An error occurred, breaking the authentication cycle and returning
232 AUTHENTICATE_COMPLETE_ERROR to 'Authenticate()'. This return value will
233 also be generated by the other functions above if they generate an error.
234
235 ## Accompanying diagrams
236 Detailed diagrams of the Raven process flow for (i) a successful
237 authentication (ii) a cancelled authentication, are located in the 'docs'
238 folder as [II - Ucam_Webauth - Flowchart for Valid Authentication.pdf] and
239 [III - Ucam_Webauth - Flowchart for Cancelled Authentication.pdf], respectively.
240
241 The numbers on these diagrams correspond to the three key secondary functions
242 described above:
243 - *1*. SendAuthenticationRequest()
244 - *2*. ProcessAuthenticationResponse()
245 - *3*. ProcessAuthenticationCookie()
246
247 Other important functions include:
248
249 ### ResetState()
250 Attempts to reset state as if a new user has just loaded a fresh browser
251 window. This is typically used when a user has experienced an error and we
252 want to give them a fresh opportunity to try again.
253
254 ### check_signature(...)
255 Checks the signature provided by the Raven server, when it signed the
256 'WLS-Response' variable, is a valid signature for the data. This ensures the
257 data has not been tampered with.
258
259 ### hmac_sha1(...)
260 Creates a hash value for signing the local authentication cookie.
261
262 ### wls_encode/decode(...)
263 Encoding/decoding functions to allow base64 signatures to be sent within URLs.
264
265 Possible arguments to 'Ucam_Webauth'
266 ------------------------------------
267 (Based on documentation for PHP Raven authentication module)
268
269 - log_file :
270 The location for a log file that will record progress and track possible
271 errors. The folder containing the file must be read/writable by the webserver.
272 Default: log.txt
273
274 - response_timeout :
275 Responses from the central authentication server are time-stamped.
276 This parameter sets the period of time in seconds during which these
277 responses are considered valid.
278 Default: 30 seconds.
279
280 - key_dir :
281 The name of the directory containing the public key certificate(s) required
282 to validate the authentication responses sent by the server.
283 Default: '/etc/httpd/conf/webauth_keys'.
284
285 - max_session_life :
286 The maximum period of time in seconds for which an established session will
287 be valid. This may be overriden if the authentication reply contains a
288 shorter 'life' parameter. Note that this does NOT define an expiry time for
289 the session cookie. Session cookies are always set without an expiry time,
290 causing them to expire when the browser session finishes.
291 Default: 7200 (2 hours).
292
293 - timeout_message :
294 A re-authentication by the authentication service will be triggered when an
295 established session expires. This option sets a text string which is sent to
296 the authentication server to explain to the user why they are being asked to
297 authenticate again. HTML markup is suppressed as for the description
298 parameter described below.
299 Default: 'your login to the site has expired'.
300
301 - hostname (required) :
302 The fully-qualified TCP/IP hostname that should be used in request URLs
303 referencing the Ucam_Webauth-enabled application. This *must* be set, as it
304 is needed for multiple reasons - primarily security but also to avoid varying
305 hostnames in URLs leading to failed or inconsistent authentication.
306 No default.
307
308 - cookie_key (required):
309 A random key used to protect session cookies from tampering. Any reasonably
310 unpredictable string (for example the MD5 checksum of a rapidly changing
311 logfile) will be satisfactory. This key must be the same for all uses of the
312 web authentication system that will receive the same session cookies (see the
313 cookie_name, cookie_path and cookie_domain parameters below).
314 No default.
315
316 - cookie_name :
317 The name used for the session cookie.
318 When used for access to resources over HTTPS the string '-S' is appended to
319 this name.
320 Default: 'Ucam-Webauth-Session'.
321
322 - cookie_path :
323 The 'Path' attribute for the session cookie. The default is the directory
324 component of the path to the script currently being executed. This should
325 result in the cookie being returned for future requests for this script and
326 for the other resources in the same 'directory'; see the important
327 information about the cookie_key parameter above.
328 Default: '/'.
329
330 - cookie_domain :
331 The 'Domain' attribute for the session cookie. By default the 'Domain'
332 attribute is omitted when setting the cookie. This should result in the
333 cookie being returned only to the server running the script. Be aware that
334 some people may treat with suspicion cookies with domain attributes that are
335 wider than the host setting the cookie.
336 No default.
337
338 - auth_service : The full URL for the web login service to be used.
339 Default: 'https://raven.cam.ac.uk/auth/authenticate.html'
340
341 #### Authentication request properties
342 The following setup parameters prefixed with 'authrequest_' relate to
343 properties that will be sent to the authentication server as part of an
344 authentication request:
345
346 - authrequest_desc : A text description of the resource that is requesting
347 authentication. This may be displayed to the user by the authentication
348 service. It is restricted to printable ASCII characters (0x20 - 0x7e) though
349 it may contain HTML entities representing other characters. The characters
350 '<' and '>' will be converted into HTML entities before being sent to the
351 browser and so this text cannot usefully contain HTML markup.
352 No default.
353
354 - authrequest_params : Data that will be returned unaltered to the WAA in
355 any 'authentication response message' issued as a result of this request.
356 This could be used to carry the identity of the resource originally requested
357 or other WAA state, or to associate authentication requests with their
358 eventual replies. When returned, this data will be protected by the digital
359 signature applied to the authentication response message but nothing else is
360 done to ensure the integrity or confidentiality of this data - the WAA MUST
361 take responsibility for this if necessary.
362 No default.
363
364 - authrequest_skew : Interpretation of response_timeout is difficult if the
365 clocks on the server running the PHP agent and on the authentication server
366 are out of step. Both servers should use NTP to synchronize their clocks,
367 but if they don't then this parameter should be set to an estimate of the
368 maximum expected difference between them (in seconds).
369 Default: 0.
370
371 - authrequest_fail :
372 If TRUE, sets the fail parameter in any authentication request sent to the
373 authentication server to 'yes'. This has the effect of requiring the
374 authentication server itself to report any errors that it encounters, rather
375 than returning an error indication. Note however that even with this parameter
376 set errors may be detected by this module that will result in authentication
377 failing here.
378 Default: FALSE.
379
380 - authrequest_iact :
381 If TRUE, then the 'iact' parameter provided to the authentication server is
382 set to 'yes'. If FALSE, then the 'iact' parameter is set to 'no'. If no value
383 is provided for 'authrequest_iact', the 'iact' parameter is left blank.
384 The value 'yes' for 'iact' requires that a re-authentication exchange takes
385 place with the user. This could be used prior to a sensitive transaction in
386 an attempt to ensure that a previously authenticated user is still present
387 at the browser. The value 'no' requires that the authentication request will
388 only succeed if the user's identity can be returned without interacting with
389 the user. This could be used as an optimisation to take advantage of any
390 existing authentication but without actively soliciting one. If omitted or
391 empty, then a previously established identity may be returned if the WLS
392 supports doing so, and if not then the user will be prompted as necessary.
393 Default: omitted.