chiark / gitweb /
_chain_params: make an internal-only function as seems to have little plausible exter...
[cgi-auth-flexible.git] / caf.pod
1 # -*- fundamental -*-
2
3 =head1 NAME
4
5 CGI::Auth::Flexible - web authentication optionally using cookies
6
7 =head1 SYNOPSYS
8
9  my $verifier = CGI::Auth::Flexible->new_verifier(setting => value,...);
10  my $authreq = $verifier->new_request($cgi);
11
12  # simple applications
13  $authreq->check_ok() or return;
14
15  # sophisticated applications
16  my $divert_kind = $authreq->check_divert();
17  if ($divert_kind) { ... print diversion page and quit ... }
18
19  # while handling the request
20  $user = $authreq->get_username();
21  $authreq->check_mutate();
22
23 =head1 DESCRIPTION
24
25 CGI::Auth::Flexible is a library which you can use to add a
26 forms/cookie-based login facility to a Perl web application.
27
28 CGI::Auth::Flexible doesn't interfere with your application's URL path
29 namespace and just needs a few (configurable) form parameter and
30 cookie name(s) for its own use.  It tries to avoid making assumptions
31 about the implementation structure of your application.
32
33 Because CGI::Auth::Flexible is licenced under the AGPLv3, you will
34 probably need to provide a facility to allow users (even ones not
35 logged in) to download the source code for your web app.  Conveniently
36 by default CGI::Auth::Flexible provides (for pure Perl webapps) a
37 mechanism for users to get the source.
38
39 CGI::Auth::Flexible is designed to try to stop you accidentally
40 granting access by misunderstanding the API.  (Also it, of course,
41 guards against cross-site scripting.)  You do need to make sure to
42 call CGI::Auth::Flexible before answering AJAX requests as well as
43 before generating HTML pages, of course, and to call it in every
44 entrypoint to your system.
45
46 =head2 CHECKLIST
47
48 As a minimum you need to do all of the things on this checklist, where
49 applicable.  The items marked SECURITY are the ones that you might
50 forget: without them your application may appear to work, but will be
51 insecure.
52
53 =over
54
55 =item *
56
57 Call C<new_verifier> (once at application startup)
58
59 =item *
60
61 Call C<new_request> (once per request)
62
63 =item *
64
65 B<SECURITY>: Call C<check_ok> or C<check_divert> on every request, and
66 honour the return value.
67
68 =item *
69
70 If you're using C<check_ok>, implement either the
71 C<username_password_error> or C<login_ok> hook and provide it as
72 a setting to C<new_verifier>.
73
74 =item *
75
76 Provide the setting C<dir> (or provide absolute paths for all the
77 other relevant settings).
78
79 =item *
80
81 Call C<get_username> when you need to know who's logged in.
82
83 =item *
84
85 B<SECURITY>: Call C<check_mutate> or C<mutate_ok>, if you specified
86 C<promise_check_mutate>.
87
88 =item *
89
90 B<SECURITY>: Call C<check_nonpage> for every request which is not a page load
91 (if your application has any of those).
92
93 =item *
94
95 When generating URLs and forms (including AJAX requests), include the
96 hidden form parameter using C<secret_hidden_val> or
97 C<secret_hidden_html> when appropriate (see below).
98
99 =item *
100
101 B<SECURITY>: If you do not override the source provision facility (see
102 L</SOURCE CODE DOWNLOAD>), check that the assumptions it makes aren't
103 going to leak security-critical data.
104
105 =item *
106
107 Set up HTTPS on your webserver, or set the C<encrypted_only> setting
108 to a false value.
109
110 =back
111
112 These points will now be covered in more detail.
113
114 =head2 INITIALISATION
115
116 Your application should, on startup (eg, when it is loaded by
117 mod_perl) do
118 C<< $verifier = CGI::Auth::Flexible->new_verifier(settings...) >>.
119 This call can be expensive and is best amortised.
120
121 The resulting verifier object can be used to process individual
122 requests, in each case with
123 C<< $authreq = CGI::Auth::Flexible->new_request($cgi) >>.
124
125 See L</SETTINGS>.
126
127 =head2 CHECKING AND RESPONSE GENERATION
128
129 If the user is logged in, your application is to handle the request.
130 Otherwise, the user needs to be presented with a login form or error
131 message, as appropriate.  CGI::Auth::Flexible provides two alternative
132 interfaces for this:
133
134 =head3 Simple applications
135
136 The simplist usage is to call C<< $request->check_ok() >> which will
137 check the user's authentication.  If the user is not logged in it will
138 generate a login form (or redirection or other appropriate page) and
139 return false; your application should not then processing that request
140 any further.  If the user is logged in it will return true.
141
142 Various hooks are provided to customise the responses generated by
143 C<check_ok>.
144
145 After C<check_ok> returns true you should go ahead and process the
146 request; you can use C<< $request->get_username >> to find out which
147 user the request came from.
148
149 =head2 Sophisticated applications
150
151 If you want to handle the control flow and to generate login forms,
152 redirections, etc., yourself, you can say
153 C<< $divert = $request->check_divert >>.  This returns undef if
154 the user is logged in, or I<divert spec> if some kind of login
155 page or diversion should be generated.  See L</DIVERT SPEC> below for
156 details of how to deal with the return value.
157
158 =head2 MUTATING OPERATIONS AND EXTERNAL LINKS
159
160 =head3 Mutation-ignorant applications
161
162 By default CGI::Auth::Flexible does not permit external links into
163 your site.  All GET requests give a "click to continue" page which
164 submits a form which loads your app's main page.  In this
165 configuration all your application's forms and AJAX requests should
166 use C<POST>.  This restriction arises from complicated deficiencies
167 in the web's security architecture.
168
169 Such applications are also not able to provide user-specific CSS
170 stylesheets, javascript, favicons, etc.
171
172 =head3 Mutation-aware applications
173
174 The alternative is for your application to always make a special check
175 when the incoming request is going to do some kind of action (such as
176 modifying the user's setup, purchasing goods, or whatever) rather than
177 just retrieve and/or display information.  We term such requests
178 "mutating" requests.
179
180 Then non-mutating pages can be linked to from other, untrustworthy,
181 websites.
182
183 To support external links, and C<GET> requests, pass
184 C<< promise_check_mutate => 1 >> in I<settings>, and then call
185 C<< $authreq->check_mutate() >> before taking any actions.  If the
186 incoming request is not suitable then C<< $authreq->check_mutate() >>
187 will call C<die>.
188
189 There have to be no mutating C<GET> requests in your application (but
190 you shouldn't have any of those anyway); if there are, they won't
191 work.  (CGI::Auth::Flexible will spot them and cause them to fail,
192 rather than allow them to be insecure.)
193
194 =head2 GENERATING URLS, FORMS AND AJAX QUERIES
195
196 When you generate a URL, C<POST> form or AJAX request you may need to
197 include a secret hidden form parameter for the benefit of
198 CGI::Auth::Generic.  This form parameter will be checked by
199 C<check_ok>/C<check_divert> and should be ignored by your application.
200
201 By default the hidden parameter is called C<caf_assochash>.
202
203 After calling C<check_ok> or C<check_divert> the value to put in your
204 form can be obtained from C<secret_hidden_val>; C<secret_hidden_html>
205 will generate the whole HTML C<< <input...> >> element.
206
207 =head3 Mutation-ignorant applications
208
209 For mutation-ignorant applications (see above), all forms etc. should
210 include the hidden parameter (and as discussed, they must all use
211 POST rather than GET).
212
213 =head3 Mutation-aware applications
214
215 For mutation-aware applications, whether to include the secret
216 parameter depends on the kind of request.  CGI::Auth::Flexible knows
217 when it is necessary.  You should find out by calling
218 C<need_add_hidden>.
219
220 If it is inconvenient to call C<need_add_hidden> at runtime, you can
221 rely instead on the following promises:  All POST requests (which
222 includes all mutating requests) need the parameter.  The return value
223 of need_add_hidden depends only on the $method and $reqtype
224 parameters, so you can query it once and remember the answer.
225 HTML page load GETs do not need the parameter.  It is better to
226 err on the side of including the parameter.
227
228 If you really must, you can call C<need_add_hidden> "on the bench"
229 during development and bake the answer into your application code
230 structure.  However, if you do that and a new vulnerability was
231 discovered which is fixed by changing the answer, updating
232 CGI::Auth::Flexible wouldn't be sufficient to fix it.
233
234 =head3 Mutation-aware applications - non-page requests
235
236 If your mutation-aware application supports non-page resources (AJAX
237 and JSON requests, stylesheets, favicons, etc.) it must inform
238 CGI::Auth::Flexible when it is handling such a request, by calling
239 C<check_nonpage>.
240
241 Normally C<check_nonpage> will simply return (and you can ignore the
242 return value).  However, if there is an attack (or, perhaps, a bug) it
243 will die, stopping the attack.
244
245 (You do not need to call C<check_nonpage> for POST requests, but it is
246 harmless to do so.)
247
248 =head3 Mutation-aware applications - novel kinds of request
249
250 If you want to support a kind of request perhaps not yet known about
251 by CGI::Auth::Flexible, you can provide information about that new
252 request kind using C<update_get_need_add_hidden>.
253
254 =head2 DATA STORAGE
255
256 CGI::Auth::Flexible needs to store various information in plain files;
257 it does this in the directory specified by the C<dir> parameter.
258
259 =head1 SOURCE CODE DOWNLOAD
260
261 By default, CGI::Auth::Flexible provides a facility for users to
262 download the source code for the running version of your web
263 application.
264
265 This facility makes a number of important assumptions which you need
266 to check.  Note that if the provided facility is not sufficient
267 because your application is more sophisticated than it copes with (or
268 if you disable the builtin facility), you may need to implement a
269 functioning alternative to avoid violating the AGPLv3 licence.
270
271 Here are the most important (default) assumptions:
272
273 =over
274
275 =item *
276
277 Your app's source code is available by looking at @INC, $0 and
278 S<$ENV{'SCRIPT_FILENAME'}> (the B<source items>).  See
279 C<srcdump_listitems>.  Where these point to files or directories under
280 revision control, the source item is the whole containing vcs tree.
281
282 =item *
283
284 Specifically, there are no compiled or autogenerated Perl
285 files, Javascript resources, etc., which are not contained in one of
286 the source item directories.  (Files which came with your operating
287 system install don't need to be shipped as they fall under the system
288 library exception.)
289
290 =item *
291
292 You have not installed any modified versions of system
293 libraries (including system-supplied Perl modules) in C</usr> outside
294 C</usr/local>.  See C<srcdump_system_dir>.
295
296 =item *
297
298 For each source item in a dvcs, the entire dvcs history does
299 not contain anything confidential (or libellous).  Also, all files which
300 contain secrets are in the dvcs's I<.ignore> file.  See
301 C<srcdump_vcsscript_git> et al.
302
303 =item *
304
305 For each source item NOT in a dvcs, there are no confidential
306 files with the world-readable bit set (being in a world-inaccessible
307 directory is not sufficient).  See C<srcdump_excludes>.
308
309 =item *
310
311 You have none of your app's source code in C</etc>.
312
313 =item *
314
315 You don't regard pathnames on your server as secret.
316
317 =item *
318
319 You don't intentionally load Perl code by virtue of C<.>
320 being in C<@INC> by default.  (See C<srcdump_filter_cwd>.)
321
322 =back
323
324 =head1 MAIN FUNCTIONS AND METHODS
325
326 =over
327
328 =item C<< CGI::Auth::Flexible->new_verifier(setting => value, ...) >>
329
330 Initialises an instance and returns a verifier object.
331 The arguments are setting pairs like a hash initialiser.
332 See L</SETTINGS> below.
333
334 =item C<< $verifier->new_request($cgi) >>
335
336 Prepares to process a request.  I<$cgi> should normally
337 be the query object from L<CGI(3perl)>.  Most of the default
338 hook methods assume that it is; however if you replace enough of
339 the hook methods then you can pass any value you like and it
340 will be passed to your hooks.
341
342 The return value is the authentication request object (I<$authreq>)
343 which is used to check the incoming request and will contain
344 information about its credentials.
345
346 =item C<< $authreq->check_divert() >>
347
348 Checks whether the user is logged in.  Returns undef if the user is
349 logged in and we should service the request.  Otherwise returns a
350 divert spec (see L</DIVERT SPEC>) saying what should happen instead.
351
352 This method may die if it doesn't like the request, in which case
353 the request needs to be rejected.
354
355 =item C<< $authreq->check_ok() >>
356
357 Checks whether the user is logged in.  Returns true if the user is
358 logged in and we should service the request.
359
360 Otherwise it handles the request itself, generating any appropriate
361 redirect, login form, or continuation page.  It then returns false and
362 the application should not process the request further.
363
364 =item C<< $verifier->disconnect() >>
365
366 Discards the resources (open files, etc.) in the verifier object.
367
368 =back
369
370 =head REQUEST-RELATED FUNCTIONS AND METHODS
371
372 All of these are only valid after C<check_divert> or C<check_ok> has
373 been called.  (In the case of C<check_ok> it won't normally be sensible
374 to call these functions unless C<check_ok> returned true.)
375
376 =item C<< $authreq->get_divert() >>
377
378 Returns the value previously returned by C<check_divert>.
379
380 =item C<< $authreq->get_username() >>
381
382 Returns the name of the logged-in user.  If the user was not logged
383 in (or their session had timed out, or something), returns undef.
384
385 =item C<< $authreq->check_mutate() >>
386
387 Declares to CGI::Auth::Generic that the request being handled will
388 "mutate".  That is, it will modify some server-side state (eg, adding
389 items to shopping baskets, posting messages to blogs, sending emails,
390 or whatever).
391
392 If you have set the setting C<promise_check_mutate> you must call
393 C<check_mutate> whenever appropriate.  If you haven't then it's
394 irrelevant.  See L<MUTATING OPERATIONS AND EXTERNAL LINKS>.
395
396 C<check_mutate> will either return successfully, indicating that all
397 is well and the request should proceed, or it will die.  If it dies
398 that means that the request was improper, which can only result from a
399 bug or an attack.  So an "internal server error" is a suitable
400 response.
401
402 =item C<< $authreq->check_nonpage($method, $reqtype) >>
403
404 Declares to CGI::Auth::Generic that the request is not a page request,
405 but rather a request of type I<$reqtype>.
406
407 If your application has set the setting C<promise_check_mutate>,
408 whenever it is handling anything except an HTML page loads, it must
409 call this function.  See L</REQUEST TYPES>, and
410 L<GENERATING URLS, FORMS AND AJAX QUERIES>.
411
412 C<check_mutate> will either return successfully, indicating that all
413 is well and the request should proceed, or it will die, like
414 C<check_mutate>.
415
416 =head RESPONSE-RELATED FUNCTIONS AND METHODS
417
418 =item C<< $authreq->url_with_query_params($params, [$nonpagetype]) >>
419
420 Convenience function which returns a url for a GET request to this
421 application.
422
423 I<$params> is a hashref specifying the parameters and the PATH_INFO.
424 The keys are the parameter names, and the values are array refs with
425 the parameter value(s) (as strings, as yet unquoted).  (They are array
426 refs because it is possible to pass multiple values for the same
427 parameter in a single request; normally each arrayref would be a
428 singleton.)
429
430 The request path will be the path to the application.  If a parameter
431 with name C<< '' >> is supplied, it is taken as the PATH_INFO - its
432 value will be appended to the application path.  (It should normally
433 start with C<< / >>, and only one value should be supplied.)
434
435 =item C<< something->need_add_hidden($method, $reqtype) >>
436
437 Enquires whether a request of type I<$reqtype> using HTTP method
438 I<$method> needs the hidden form parameter.  See L</REQUEST TYPES>.
439
440 =item C<< something->secret_hidden_val() >>
441
442 Returns the value of the hidden form parameter.  This should be
443 included in all POST requests to your application (and thus be a
444 hidden form parameter in all forms).
445
446 It should also be in some (maybe all) GET requests.  If your
447 application is mutation-ignorant, it should be in all GET requests.
448 If you are mutation-aware, you need to consult C<need_add_hidden>.
449
450 The name of the hidden parameter is the setting C<assoc_param_name>,
451 C<caf_hassochash> by default.  xxx rename param and setting
452
453 =item C<< something->secret_hidden_html() >>
454
455 Returns the HTML for an C<INPUT> element specifying the hidden form
456 parameter.
457
458 =item C<< something->secret_cookie_val() >>
459
460 Returns the value of the secret cookie.  CGI::Auth::Flexible sets this
461 cookie in the forms generated by C<check_ok>.  You may also set it
462 yourself (and indeed you must do so if you use C<check_divert>).
463
464 =back
465
466 =head OTHER FUNCTIONS AND METHODS
467
468 =over
469
470 =item C<< $verifier_or_authreq->hash($data) >>
471
472 Hashes the supplied data using the hash function specified by the
473 C<hash_algorithm> setting, and converts the result to a string of hex
474 digits.
475
476 =item C<< something->update_get_need_add_hidden($reqtype, $value, [$force]) >>
477
478 Updates CGI::Auth::Generic's knowledge about the various kinds of
479 request, and whether they need the hidden form parameter.  This
480 function applies only to GET requests - POST requests always use the
481 parameter.
482
483 I<$reqtype> is the request type (the value which will be passed to
484 C<check_nonpage> and C<need_add_hidden>.  If you are supporting a new
485 I<$reqtype> you shouuld coordinate with CGI::Auth::Flexible upstrea,
486 or other users, to assign a unique request type name.
487
488 This method may be called on an authreq or a verifier, in which case
489 it will affect all authreqs using the same verifier.  Or it may be
490 called on the class as a whole, in which case it will affect the
491 global default list for all verifiers.
492
493 If I<$force> is supplied and true, this will override
494 CGI::Auth::Flexible's existing knowledge.  Otherwise this new setting
495 will be ignored if CGI::Auth::Flexible already knows about the request
496 type.  (When called on a verifier or authreq, it will ignore the
497 update in favour of existing knowledge recorded both globally in the
498 class or due to previous requests on the same verifier.)
499
500 See L</REQUEST TYPES>.
501
502 =item C<< CGI::Auth::Flexible::srcdump_dir_cpio($cgi,$verifier,$dumpdir,$dir,$outfn,$how,$script) >>
503
504 Helper function for implementing the C<srcdump_process_item> hook.
505 Generates a tarball using cpio and includes it in the prepared source
506 code distribution.
507
508 The arguments are mostly the same as for that hook.  C<$dir> is the
509 root directory at which to start the archive.  C<$how> is a short text
510 string which will be mentioned in the log.
511
512 C<$script> is a shell script fragment which must output a
513 nul-separated list of filenames (e.g. the output of C<find -print0>).
514 It is textually surrounded by C<( )> and will be executed with C<set -e>
515 in force.  Its cwd will be C<$dir>.
516
517 =item C<< $verifier_or_authreq->($data) | CGI::Auth::Flexible-> >>
518
519 Hashes the supplied data using the hash function specified by the
520 C<hash_algorithm> setting, and converts the result to a string of hex
521 digits.
522
523 =back
524
525 =head1 SETTINGS
526
527 C<new_verifier> and C<new_request> each take a list of settings, as
528 a list of pairs C<< key => value >> (like a Perl hash assignment).
529
530 The settings supplied to C<new_verifier> are stored in the verifier
531 and will apply to all authreqs made from it unless overridden in the
532 call to C<new_request>
533
534 When a setting is described as a hook function, it should be a
535 coderef.  The first argument will be the query object from
536 L<CGI(3perl)> (strictly, it will be whatever value was passed to
537 C<new_request>).  The second argument will be the authreq object (the
538 return value from C<new_request>).
539 Ie, C<< sub some_hook ($$...) { my ($cgi,$authreq,@stuff) = @_ ... >>
540
541 In bullet point headings, the hook functions are shown in the form
542 C<< some_hook($cgi,$authreq,@stuff) >> even though this would not be
543 legal syntax.  This should be read to mean that the
544 %implicit_settings_hash{'some_hook'}($cgi,$authreq,@stuff)
545 would be a legal call.  (However, the settings hash is not exposed.)
546
547 When a hook's default implementation is mentioned and named, that
548 function won't also be described in the section on the module's
549 functions.
550
551 =over
552
553 =head2 GENERAL SETTINGS
554
555 =item C<dir>
556
557 The directory CGI::Auth::Generic should use for its data storage.
558 This is actually just a default absolute path used when the other
559 path settings are relative values.
560
561 Must be an absolute filename.
562
563 =item C<assocdb_dbh>
564
565 CGI::Auth::Flexible needs a database for recording users' login
566 session.  This database needs to be shared across all instances of the
567 web application, so in a multi-node cluster it needs to be your actual
568 database.
569
570 CGI::Auth::Flexible will create the table and index it needs if they
571 don't already exist, and will manage their contents.  You do not need
572 to integrate them into the rest of your webapp's data storage.  (In
573 particular, there is no need for transactional integrity across
574 changes made by CAF and your own application.)
575
576 By default, CAF uses a sqlite3 database stored on local disk in the
577 file named by C<assocdb_path>.  This will be suitable for all
578 applications which run on a single host.
579
580 This value, if supplied, should be a DBI handle for the database.
581
582 =item C<assocdb_dsn>
583
584 This is the DSN to pass to C<< DBI->connect >>.  Used only if
585 C<assocdb_dbh> is not supplied.
586
587 =item C<assocdb_path>
588
589 Path to the sqlite3 database used for CAF's session storage.  The
590 default is currently C<caf-assocs.db> but will change in the future.
591
592 Used only if neither C<assocdb_dbh> or C<assocdb_dsn> are supplied.
593
594 If this is a relative path, it is in C<dir>.
595
596 =item C<assocdb_table>
597
598 Prefix for the SQL tables and indices to use (and to create, if
599 necessary).
600
601 See L</DATABASE TABLES>.
602
603 =item C<keys_path>
604
605 Path to the keys file used by CAF.  This arrangement will change in
606 the future.  See L</BUGS>.
607
608 =item C<random_source>
609
610 Special file to read random numbers from.  Should return
611 cryptographically secure (pseudo)-random bytes, unpredictable to
612 adversaries (even ones on the same machine).
613
614 On Linux, there is no device which is properly suitable.  This is a
615 bug in Linux.  You can use C</dev/random> which can block
616 unnecessarily even though the kernel PRNG has been properly seeded and
617 is fine, or C</dev/urandom> which might return values which attackers
618 can predict if the kernel PRNG has not been properly seeded.
619
620 The default is C</dev/urandom>.
621
622 =item C<secretbits>
623
624 Length of the assoc secret.  Defaults to 128.
625
626 =item C<hash_algorithm>
627
628 Must be a string suitable for use with C<new Digest>.
629 Defaults to C<SHA-256>.
630
631 =item C<login_timeout>
632
633 A user will be logged out this many seconds after they first logged
634 in.  Default: 86400 (one day).
635
636 =item C<login_form_timeout>
637
638 A login form becomes invalid this many seconds after it has been sent.
639 Default: 3600 seconds (one hour).
640
641 =item C<key_rollover>
642
643 The key used for generating assoc secrets is rolled over approximately
644 this often (in seconds).  Default: 86400.
645
646 =item C<assoc_param_name>
647
648 Name of the hidden form parameter.  Default: C<caf_assochash>.
649
650 =item C<cookie_name>
651
652 Name of the cookie used for login sessions.  Default:
653 C<caf_assocsecret>.
654
655 =item C<password_param_name>
656
657 Name of the password field in the login form.  Default: C<password>.
658
659 Used by C<login_ok_password> (the default C<login_ok> hook),
660 C<gen_plain_login_form> and the default C<is_login> hook.
661
662 =item C<username_param_names>
663
664 Arrayref of name(s) of username form parameters.
665
666 The first entry is used by C<login_ok_password> (the default
667 C<login_ok> hook) to pass to the C<username_password_error> hook and
668 used as the username if all is well.
669
670 All the entries are used by C<gen_plain_login_fork> (the default
671 C<gen_login_form> hook for C<check_ok>) to generate form entry fields.
672
673 The default is C<['username']>.
674
675 =item C<logout_param_names>
676
677 Arrayref of name(s) of form parameters indicating that the request is
678 a logout request.
679
680 Used by the default C<is_logout> hook.
681
682 If you want users to be able to explicitly log out, you need to
683 provide a logout button, something like
684 C<< <input type="submit" name="caf_logout" ...>>
685
686 The default is C<['caf_logout']>
687
688 =item C<logged_param_names>
689
690 Arrayref of name(s) of form parameters indicating that user has just
691 logged out.  (During the logout process, the actual logout action is a
692 POST request, whose response redirects to the "you have been logged
693 out" page; these form parameters are for this second page.)
694
695 Used by the default C<is_loggedout> hook.
696
697 The first entry is used by C<check_ok> to generate the redirection.
698
699 The default is C<['caf_loggedout']>
700
701 =item C<promise_check_mutate>
702
703 Boolean.  If true, is a declaration by the application that it is
704 mutatin-aware.  See L</MUTATING OPERATIONS AND EXTERNAL LINKS>.
705
706 The default is 0.
707
708 =item C<encrypted_only>
709
710 Boolean.  If true, CAF will insist that all transactions be done over
711 an encrypted http connection.  It will redirect unencrypted requests
712 to the https instance of the applicattion, and will set the encrypted
713 only flag on its cookie.
714
715 The default is 1.
716
717 =back
718
719 =item C<< get_url($cgi,$authreq) >>
720
721 Hook which returns the URL of this web application.  By default, we
722 call C<< $cgi->url() >> for each request, but you can fix this if you
723 prefer.
724
725 =item C<< is_login,is_logout,is_loggedout($cgi,$authreq) >>
726
727 Hook which returns a boolean indicating whether the request was,
728 respectively: a login form submission (ie, username and password); a
729 logout request (submission resulting from the user pressing the
730 "logout" button); "logged out" page (redirection from the logout
731 POST).
732
733 The default is to check whether any of the corresponding request
734 parameters (C<< login_param_names >> etc.) was supplied, using the
735 C<get_param> hook.
736
737 =back
738
739 =head2 SETTINGS (HOOKS) RELATED TO THE CGI REQUEST OBJECT
740
741 =over
742
743 =item C<< get_param($cgi,$authreq,$param) >>
744
745 Returns the value of a single-valued form parameter.
746 The default is to call C<< $cgi->param($param) >>.
747 The semantics are the same as that of C<CGI::param>.
748
749 =item C<< get_params($cgi,$authreq) >>
750
751 Returns a hash of the parameters.  The return value is a hashref whose
752 keys are the parameter names and whose values are arrayrefs, one entry
753 in the arrayref for each value.
754
755 The default is to call C<< $cgi->Vars() >>, expect the
756 results to look like those from C<CGI::Vars>, and massage them into
757 the required form with split.
758
759 =item C<< get_path_info($cgi,$authreq) >>
760
761 Returns the PATH_INFO of the request.  The default is to
762 call C<< $cgi->path_info() >>.
763
764 =item C<< get_cookie($cgi,$authreq) >>
765
766 Returns the value of the CAF cookie sent with the request, or undef if
767 none was supplied.  The default is to call C<<
768 $cgi->cookie($cookie_name) >> (where C<$cookie_name> is from the
769 setting of the same name).  The return value should be the scalar
770 value of the cookie.
771
772 =item C<< get_method($cgi,$authreq) >>
773
774 Returns the HTTP method as a string.  The default is to call
775 C<< $cgi->request_method() >>.
776
777 =back
778
779 =item C<< is_https($cgi,$authreq) >>
780
781 Returns a boolean indicating whether the request was over an encrypted
782 channel.  The default is C<< !!$cgi->https() >>.  See C<encrypted_only>.
783
784 =back
785
786 =head2 SETTINGS RELATED TO HTML GENERATION
787
788 These are only used if you call C<check_ok> or xxx some other functions?.
789
790 Settings whose names are of the form C<gen_...> are hooks which each
791 return an array of strings, normally HTML strings, for use by
792 C<check_ok> (or, in turn, other hooks, or your application).  These
793 are often documented simply by showing the output produced.  In many
794 cases parts of the output are in turn obtained from other hooks.  In
795 some cases the default implementations have been given names for
796 convenient use by your application.  They will be called in array
797 context.
798
799 We'll write C<gettext(something)> even though actually there is a hook
800 to control the translation function used.
801
802 =over
803
804 =item C<handle_divert>($cgi,$authreq,$divert))
805
806 C<check_ok> calls this hook before producing output of its own.  If
807 you want to handle some but not all diversions yourself, you may set
808 this hook.  The hook should either do nothing and return false, or
809 return true if it has handled the request (or arrange for the request
810 to be handled).  If the hook returns true then C<check_ok> simply
811 returns 0.
812
813 =item C<gen_login_form>($cgi,$authreq,$divert))
814
815 Default: a table (used mostly for layout) containing input fields for
816 a login form.  Must be within a C<< <form> >> element, but doesn't
817 generate it.  Has text fields for every entry in
818 C<username_param_names> (in each case associated with a description
819 C<< gettext(ucfirst $parameter_name) >>, a password field (with
820 description C<gettext("Password")>, and a login submit button (with
821 description C<gettext("Login")>.
822
823 Default is available as the module function C<gen_plain_login_form>.
824
825 =item C<gen_login_link>($cgi,$authreq))
826
827 Default:
828
829  <a href="http:...">gettext(Log in again to continue.)</a>
830
831 Default is available as the module function C<gen_plain_login_link>.
832
833 =item C<gen_postmainpage_form>($cgi,$authreq,$params))
834
835 Default: form contents (but not the C<< <form> >> element):
836
837 C<$params> (in the form returned by the C<get_params> hook) as hidden
838 fields, and also:
839
840  <input type="submit" ... value=getext('Continue')>
841
842 Default is available as the module function C<gen_postmainpage_form>.
843
844 =item C<gen_start_html>($cgi,$authreq,$title)
845
846 Default: C<$cgi->start_html($title)>
847
848 =item C<gen_end_html>($cgi,$authreq,$title)
849
850 Default: C<$cgi->end_html($title)>
851
852 =item C<gen_footer_html>($cgi,$authreq)>
853
854 Default:
855
856  <hr><address>
857  Powered by Free / Libre / Open Source Software
858  according to the [gen_licence_link_html].
859  [gen_source_link_html].
860  </address>
861
862 Default is available as the module function C<gen_plain_footer_html>.
863
864 =item C<gen_licence_link_html>($cgi,$authreq)>
865
866 Default: uses C<url_with_query_params> to generate a URL for
867 downloading the licence, and returns:
868   <a href="...">GNU Affero GPL</a>
869
870 Default is available as the module function C<gen_plain_licence_link_html>.
871
872 =item C<gen_source_link_html>($cgi,$authreq)>
873
874 Default: uses C<url_with_query_params> to generate a URL for
875 downloading the source, and returns:
876   <a href="...">Source available</a>
877
878 Default is available as the module function C<gen_plain_source_link_html>.
879
880 =item C<form_entry_size>
881
882 Size of generated text entry fields.  Default is 60.
883
884 =item C<dummy_param_name_prefix>
885
886 Some of CAF's HTML-generating functions need to invent form parameter
887 names.  They will all start with this string.  Default: C<caf__>.
888
889 =head2 SETTINGS FOR SOURCE CODE DOWNLOAD FACILITY
890
891 =over
892
893 =item C<srcdump_param_name>
894
895 Form parameter name used to indicate that this is a source download
896 request.  If this parameter is supplied, C<check_ok> and
897 C<check_divert> will arrange for the applicaton source code to be
898 delivered as the response (in C<check_ok>'s case by doing it itself
899 and in C<check_divert>'s case by asking your application to do so.
900
901 Default is C<caf_srcdump>.
902
903 =item C<srcdump_path>
904
905 Path to the directory used for storing pre-prepared source downloads.
906 Defaults to C<caf-srcdump>.
907
908 If this is a relative path, it is in C<dir>.
909
910 =item C<srcdump_dump($cgi,$authreq,$srcobj)>
911
912 Dump the source code (C<$srcobj='source'> or licence data
913 (C<$srcobj='licence'>).  The default implementation checks that
914 C<$srcobj> has reasonable syntax and uses the files C<$srcobj.data>
915 and C<$srcobj.ctype> with the C<dump> hook.
916
917 =item C<dump($cgi,$authreq,$contenttype,$datafilehandle)>
918
919 Responds to the request by sending the contents of $datafilehandle
920 (which should just have been opened) and specifying a content type of
921 $contenttype.
922
923 The default implmentation uses the C<print> hook, and also calls
924 C<$cgi->header('-type' => $contenttype>, and is available as the
925 module function C<dump_plain>.
926
927 =item C<srcdump_prepare($cgi,$verifier)>
928
929 Prepares the source code for download when requested.  Invoked by
930 C<new_verifier>, always, immediately before it returns the
931 just-created verifier object.
932
933 The default implementation is the module function
934 C<srcdump_dirscan_prepare>, which prepares a manifest, licence file
935 and source code tarball of tarballs, as follows:
936
937 It processes each entry in the return value from C<srcdump_listitems>.
938 These are the software's include directories and any other directories
939 containing source code.  It handles C<.> specially (see
940 C<srcdump_filter_cwd>).
941
942 For each entry it looks, relative to that, for the licence as a file
943 with a name mentioned in C<srcdump_licence_files>.  The first such
944 file found is considered to be the licence.  It then calls the hook
945 C<srcdump_process_item> for the entry.
946
947 The licence, a manifest file, and all the outputs generated by the
948 calls to C<srcdump_process_item>, are tarred up and compressed as a
949 single source tarball.
950
951 It uses the directory named by C<srcdump_path> as its directory for
952 working and output files.  It uses the filename patterns
953 C<generate.*>, C<licence.*>, C<s.[a-z][a-z][a-z].*>, C<manifest.*>,
954 C<source.*> in that directory.
955
956 =item C<srcdump_process_item>($cgi,$verifier,$dumpdir,$item,\&outfn,\$needlicence,\%dirsdone)>
957
958 Processes a single include directory or software entry, so as to
959 include the source code found there.  Called only by the default
960 implementation of C<srcdump_prepare>.
961
962 C<$dumpdir> is the directory for working and output files.  C<$item>
963 is the real (no symlinks) absolute path to the item.
964
965 C<\$needlicence> is a ref to a scalar: this scalar is undef if we have
966 already found the licence file; otherwise it is the filename to which
967 the licence should be copied.  If the referent is undef on entry,
968 C<srcdump_process_item> needs to see if it finds the licence; if it
969 does it should copy it to the named file and then set the scalar to
970 undef.
971
972 C<\%dirsdone> is a ref to the hash used by C<srcdump_prepare> to avoid
973 including a single directory more than once.  If
974 C<srcdump_process_item> decides to process a directory other than
975 C<$item> it should check this hash with the real absolute path of the
976 other directoy as a key: if the hash entry is true, it has already
977 been done and should be skipped; otherwise the hash entry should be set.
978
979 C<\&outfn> is a coderef which C<srcdump_process_item> should call each
980 time it wants to generate a file which should be included as part of
981 the source code.  It should be called using one of these patterns:
982    $outfn->("message for log");
983    $outfile = $outfn->("message for log", "extension");
984 The former simply logs this message (along with the associated
985 C<$item>, so there is no need to mention that).  The latter logs the
986 message but also generates and returns a filename which should then
987 be created and filled with some appropriate data.  C<"extension">
988 should be a string for the file extension, eg C<"txt">.  The output
989 can be written directly to the named file: there is no need to
990 write to a temporary file and rename.
991
992 The default implementation is the module function
993 C<srcdump_process_item>.
994
995 It skips directories for which C<srcdump_system_dir> returns true.
996
997 It then searches the item and its parent
998 directories for a vcs metadata directory (one of the names in
999 C<srcdump_vcs_dirs>); if found, it calls the C<srcdump_byvcs> hook
1000 (after checking and updaeing C<%dirsdone>).
1001 Otherwise it calls the C<srcdump_novcs> hook.
1002
1003 =item C<srcdump_novcs($cgi,$verifier,$dumpdir,$item,$outfn)>
1004
1005 Called by the default implementation of C<srcdump_process_item>, with
1006 the same arguments, if it doesn't find vcs metadata.
1007
1008 The default implementation is the module function C<srcdump_novcs>.
1009
1010 If C<$item> is a directory, it uses C<srcdump_dir_cpio> to prepare a
1011 tarball of all the files under C<$item> which have the world read bit
1012 set.  Directories are not included (and their permissions are
1013 disregarded).  The contents of C<srcdump_excludes> are excluded.
1014
1015 If it's a plain file it uses C<srcdump_file> to include the file.
1016
1017 =item C<srcdump_byvcs($cgi,$verifier,$dumpdir,$item,$outfn,$vcs)>
1018
1019 Called by the default implementation of C<srcdump_process_item>, with
1020 the same arguments, if it finds vcs metadata.  The additional argument
1021 C<$vcs> is derived from the entry of C<srcump_vcs_dirs> which was
1022 used: it's the first sequence of word characters, lowercased.
1023
1024 The default implementation is the module function C<srcdump_byvcs>.
1025 It simply calls C<srcdump_dir_cpio> with a script from the setting
1026 C<srcdump_vcsscript>.
1027
1028 =item C<srcdump_vcs_dirs>
1029
1030 Array ref of leaf names of vcs metadata directories.  Used by the
1031 default implementation of C<srcdump_process_item>.  The default value
1032 is C<['.git','.hg','.bzr','.svn']>.
1033
1034 =item C<srcdump_vcs_script>
1035
1036 Hash ref of scripts for generating vcs metadata.  Used by the default
1037 implementation of C<srcdump_byvcs>.  The keys are values of C<$vcs>
1038 (see C<srcdump_byvcs>); the values are scripts as for
1039 C<srcdump_dir_cpio>.
1040
1041 The default has an entry only for C<git>:
1042   git ls-files -z
1043   git ls-files -z --others --exclude-from=.gitignore
1044   find .git -print0
1045
1046 =item C<srcdump_excludes>
1047
1048 Array ref of exclude glob patterns, used by the default implementation
1049 of C<srcdump_novcs>.  The default value is C<['*~','*.bak','*.tmp','#*#']>.
1050
1051 Entries must not contain C<'> or C<\>.
1052
1053 =item C<srcdump_listitems($cgi,$verifier)>
1054
1055 Returns an array of directories which might contain source code of the
1056 web application and which should be therefore be considered for
1057 including in the source code delivery.
1058
1059 Used by the default implementation of C<srcdump_prepare>.
1060
1061 Entries must be directories, plain files, or nonexistent; they may
1062 also be symlinks which resolve to one of those.
1063
1064 If C<.> is included it may be treated specially - see
1065 C<srcdump_filter_cwd>.
1066
1067 The default implementation returns 
1068 C<(@INC, $ENV{'SCRIPT_FILENAME'}, $0)>.
1069
1070 =item C<srcdump_system_dir($cgi,$verifier,$dir)>
1071
1072 Determines whether C<$dir> is a "system directory", in which any
1073 source code used by the application should nevertheless not be
1074 included in the source code dump.
1075
1076 Used by the default implementation of C<srcdump_item>.
1077
1078 The default implementation is as follows: Things in C</etc/> are
1079 system directories.  Things in C</usr/> are too, unless they are in
1080 C</usr/local/> or C</usr/lib/cgi*>.
1081
1082 =item C<srcdump_filter_cwd>
1083
1084 Boolean which controls the handling of C<.> if it appears in the
1085 return value from C<srcdump_listitems>.  Used only by the default
1086 implementation of C<srcdump_prepare>.
1087
1088 If set to false, C<.> is treated normally and no special action is
1089 taken.
1090
1091 However often the current directory may be C</>, or a data directory,
1092 or some other directory containing data which is confidential, or
1093 should not be included in the public source code distribution for
1094 other reasons.  And for historical reasons Perl has C<@INC> containing
1095 C<.> by default (which is arguably dangerous and wrong).
1096
1097 So the default this setting is true, which has the following effects:
1098
1099 C<.> is not searched for source code even if it appears in C<@INC>.
1100 C<.> is removed from C<@INC> and C<%INC> is checked to see if any
1101 modules appear to have already been loaded by virtue of C<.> appearing
1102 in C<@INC> and if they have it is treated as a fatal error.
1103
1104 Only the literal string C<.> is affected.  If the cwd is included by
1105 any other name it is not treated specially regardless of this setting.
1106
1107 =back
1108
1109 =head1 DATABASE TABLES
1110
1111 In a simple application, you do not need to worry about this.  But if
1112 your application runs on multiple frontend hosts with a shared
1113 database, you may need to create for yourself the tables and indices
1114 used by CGI::Auth::Flexible.
1115
1116 xxx document _db_setup_do
1117 xxx make _db_setup_do explicitly overrideable
1118
1119
1120 xxx divert spec
1121 xxx reqtype
1122 xxx settings
1123 xxx html generators
1124 xxx document cookie
1125
1126 xxx bugs wrong default random on Linux
1127 xxx bugs wrong default random on *BSD
1128 xxx bugs keys not shared should be in db
1129 xxx rename caf-assocs.db
1130 xxx rename caf_assocsecret default cookie name
1131 xxx mention relationship between login_timeout and cookies