5 CGI::Auth::Flexible - web authentication optionally using cookies
9 my $verifier = CGI::Auth::Flexible->new_verifier(setting => value,...);
10 my $authreq = $verifier->new_request($cgi);
13 $authreq->check_ok() or return;
15 # sophisticated applications
16 my $divert_kind = $authreq->check_divert();
17 if ($divert_kind) { ... print diversion page and quit ... }
19 # while handling the request
20 $user = $authreq->get_username();
21 $authreq->check_mutate();
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.
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.
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.
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.
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
57 Call C<new_verifier> (once at application startup)
61 Call C<new_request> (once per request)
65 B<SECURITY>: Call C<check_ok> or C<check_divert> on every request, and
66 honour the return value.
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>.
76 Provide the setting C<dir> (or provide absolute paths for all the
77 other relevant settings).
81 Call C<get_username> when you need to know who's logged in.
85 B<SECURITY>: Call C<check_mutate> or C<mutate_ok>, if you specified
86 C<promise_check_mutate>.
90 B<SECURITY>: Call C<check_nonpage> for every request which is not a page load
91 (if your application has any of those).
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).
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.
107 Set up HTTPS on your webserver, or set the C<encrypted_only> setting
112 These points will now be covered in more detail.
114 =head2 INITIALISATION
116 Your application should, on startup (eg, when it is loaded by
118 C<< $verifier = CGI::Auth::Flexible->new_verifier(settings...) >>.
119 This call can be expensive and is best amortised.
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) >>.
127 =head2 CHECKING AND RESPONSE GENERATION
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
134 =head3 Simple applications
136 The simplest 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 process that request
140 any further. If the user is logged in it will return true.
142 Various hooks are provided to customise the responses generated by
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 You may also need to call C<check_mutate> and/or C<check_nonpage>
151 =head3 Sophisticated applications
153 If you want to handle the control flow and to generate login forms,
154 redirections, etc., yourself, you can say
155 C<< $divert = $request->check_divert >>. This returns undef if
156 the user is logged in, or a I<divert spec> if some kind of login
157 page or diversion should be generated. See L</DIVERT SPEC> below for
158 details of how to deal with the return value.
160 =head2 MUTATING OPERATIONS AND EXTERNAL LINKS
162 =head3 Mutation-ignorant applications
164 By default CGI::Auth::Flexible does not permit external deep links
166 All GET requests give a "click to continue" page which
167 submits a form which loads your app's main page. In this
168 configuration all your application's forms and AJAX requests should
171 Such applications are also not able to provide user-specific CSS
172 stylesheets, javascript, favicons, etc.
174 This restriction arises from complicated deficiencies
175 in the web's security architecture.
177 =head3 Mutation-aware applications
179 The alternative is for your application to always make a special check
180 when the incoming request is going to do some kind of action (such as
181 modifying the user's setup, purchasing goods, or whatever) rather than
182 just retrieve and/or display information. We term such requests
185 Then non-mutating pages can be linked to from other, untrustworthy,
188 To support external links, and C<GET> requests, pass
189 C<< promise_check_mutate => 1 >> in I<settings>, and then call
190 C<< $authreq->check_mutate() >> before taking any actions. If the
191 incoming request is not suitable then C<< $authreq->check_mutate() >>
194 There have to be no mutating C<GET> requests in your application (but
195 you shouldn't have any of those anyway); if there are, they won't
196 work. (CGI::Auth::Flexible will spot them and cause them to fail,
197 rather than allow them to be insecure.)
199 =head2 GENERATING URLS, FORMS AND AJAX QUERIES
201 When you generate a URL, C<POST> form or AJAX request you may need to
202 include a secret hidden form parameter for the benefit of
203 CGI::Auth::Generic. This form parameter will be checked by
204 C<check_ok>/C<check_divert> and should be ignored by your application.
206 By default the hidden parameter is called C<caf__assochash>.
208 After calling C<check_ok> or C<check_divert> the value to put in your
209 form can be obtained from C<secret_hidden_val>; C<secret_hidden_html>
210 will generate the whole HTML C<< <input...> >> element.
212 =head3 Mutation-ignorant applications
214 For mutation-ignorant applications (see above), all forms etc. should
215 include the hidden parameter (and as discussed, they must all use
216 POST rather than GET).
218 =head3 Mutation-aware applications
220 For mutation-aware applications, whether to include the secret
221 parameter depends on the kind of request. CGI::Auth::Flexible knows
222 when it is necessary. You should find out by calling
225 If it is inconvenient to call C<need_add_hidden> at runtime, you can
226 rely instead on the following promises: All POST requests (which
227 includes all mutating requests) need the parameter. The return value
228 of need_add_hidden depends only on the $method and $reqtype
229 parameters, so you can query it once and remember the answer.
230 HTML page load GETs do not need the parameter. It is better to
231 err on the side of including the parameter.
233 If you really must, you can call C<need_add_hidden> "on the bench"
234 during development and bake the answer into your application code
235 structure. However, if you do that and a new vulnerability was
236 discovered which is fixed by changing the answer, updating
237 CGI::Auth::Flexible wouldn't be sufficient to fix it.
239 =head3 Mutation-aware applications - non-page requests
241 If your mutation-aware application supports non-page resources (AJAX
242 and JSON requests, stylesheets, favicons, etc.) it must inform
243 CGI::Auth::Flexible when it is handling such a request, by calling
246 Normally C<check_nonpage> will simply return (and you can ignore the
247 return value). However, if there is an attack (or, perhaps, a bug) it
248 will die, stopping the attack.
250 (You do not need to call C<check_nonpage> for POST requests, but it is
253 =head3 Mutation-aware applications - novel kinds of request
255 If you want to support a kind of request perhaps not yet known about
256 by CGI::Auth::Flexible, you can provide information about that new
257 request kind using C<update_get_need_add_hidden>.
261 CGI::Auth::Flexible needs to store various information in plain files;
262 it does this in the directory specified by the C<dir> parameter.
264 =head1 SOURCE CODE DOWNLOAD
266 By default, CGI::Auth::Flexible provides a facility for users to
267 download the source code for the running version of your web
270 This facility makes a number of important assumptions which you need
271 to check. Note that if the provided facility is not sufficient
272 because your application is more sophisticated than it copes with (or
273 if you disable the builtin facility), you may need to implement a
274 functioning alternative to avoid violating the AGPLv3 licence.
276 Here are the most important (default) assumptions:
282 Your app's source code is available by looking at @INC, $0 and
283 S<$ENV{'SCRIPT_FILENAME'}> (the B<source items>). See
284 C<srcdump_listitems>. Where these point to files or directories under
285 revision control, the source item is the whole containing vcs tree.
289 Specifically, there are no compiled or autogenerated Perl
290 files, Javascript resources, etc., which are not contained in one of
291 the source item directories. (Files which came with your operating
292 system install don't need to be shipped as they fall under the system
297 You have not installed any modified versions of system
298 libraries (including system-supplied Perl modules) in C</usr> outside
299 C</usr/local>. See C<srcdump_system_dir>.
303 For each source item in a dvcs, the entire dvcs history does
304 not contain anything confidential (or libellous). Also, all files which
305 contain secrets are in the dvcs's I<.ignore> file. See
306 C<srcdump_vcsscript_git> et al.
310 For each source item NOT in a dvcs, there are no confidential
311 files with the world-readable bit set (being in a world-inaccessible
312 directory is not sufficient). See C<srcdump_excludes>.
316 You have none of your app's source code in C</etc>.
320 You don't regard pathnames on your server as secret.
324 You don't intentionally load Perl code by virtue of C<.>
325 being in C<@INC> by default. (See C<srcdump_filter_cwd>.)
329 =head1 MAIN FUNCTIONS AND METHODS
333 =item C<< CGI::Auth::Flexible->new_verifier(setting => value, ...) >>
335 Initialises an instance and returns a verifier object.
336 The arguments are setting pairs like a hash initialiser.
337 See L</SETTINGS> below.
339 =item C<< $verifier->new_request($cgi) >>
341 Prepares to process a request. I<$cgi> should normally
342 be the query object from L<CGI(3perl)>. Most of the default
343 hook methods assume that it is; however if you replace enough of
344 the hook methods then you can pass any value you like and it
345 will be passed to your hooks.
347 The return value is the authentication request object (I<$authreq>)
348 which is used to check the incoming request and will contain
349 information about its credentials.
351 =item C<< $authreq->check_divert() >>
353 Checks whether the user is logged in. Returns undef if the user is
354 logged in and we should service the request. Otherwise returns a
355 divert spec (see L</DIVERT SPEC>) saying what should happen instead.
357 This method may die if it doesn't like the request, in which case
358 the request needs to be rejected.
360 =item C<< $authreq->check_ok() >>
362 Checks whether the user is logged in. Returns true if the user is
363 logged in and we should service the request.
365 Otherwise it handles the request itself, generating any appropriate
366 redirect, login form, or continuation page. It then returns false and
367 the application should not process the request further.
369 =item C<< $verifier->disconnect() >>
371 Discards the resources (open files, etc.) in the verifier object.
375 =head1 REQUEST-RELATED FUNCTIONS AND METHODS
377 All of these are only valid after C<check_divert> or C<check_ok> has
378 been called. (In the case of C<check_ok> it won't normally be sensible
379 to call these functions unless C<check_ok> returned true.)
383 =item C<< $authreq->get_divert() >>
385 Returns the value previously returned by C<check_divert>.
387 =item C<< $authreq->get_username() >>
389 Returns the name of the logged-in user. If the user was not logged
390 in (or their session had timed out, or something), returns undef.
392 =item C<< $authreq->check_mutate() >>
394 Declares to CGI::Auth::Generic that the request being handled will
395 "mutate". That is, it will modify some server-side state (eg, adding
396 items to shopping baskets, posting messages to blogs, sending emails,
399 If you have set the setting C<promise_check_mutate> you must call
400 C<check_mutate> whenever appropriate. If you haven't then it's
401 irrelevant. See L<MUTATING OPERATIONS AND EXTERNAL LINKS>.
403 C<check_mutate> will either return successfully, indicating that all
404 is well and the request should proceed, or it will die. If it dies
405 that means that the request was improper, which can only result from a
406 bug or an attack. So an "internal server error" is a suitable
409 =item C<< $authreq->check_nonpage($method, $reqtype) >>
411 Declares to CGI::Auth::Generic that the request is not a page request,
412 but rather a request of type I<$reqtype>.
414 If your application has set the setting C<promise_check_mutate>,
415 whenever it is handling anything except an HTML page loads, it must
416 call this function. See L</REQUEST TYPES>, and
417 L<GENERATING URLS, FORMS AND AJAX QUERIES>.
419 C<check_nonpage> will either return successfully, indicating that all
420 is well and the request should proceed, or it will die, like
425 =head1 RESPONSE-RELATED FUNCTIONS AND METHODS
429 =item C<< $authreq->url_with_query_params($params, [$nonpagetype]) >>
431 Convenience function which returns a url for a GET request to this
434 I<$params> is a hashref specifying the parameters and the PATH_INFO
435 (not including any parameters related to CGI::Auth::Flexible).
436 The keys are the parameter names, and the values are array refs with
437 the parameter value(s) (as strings, as yet unquoted). (They are array
438 refs because it is possible to pass multiple values for the same
439 parameter in a single request; normally each arrayref would be a
442 The request path will be the path to the application. If a parameter
443 with name C<< '' >> is supplied, it is taken as the PATH_INFO - its
444 value will be appended to the application path. (It should normally
445 start with C<< / >>, and only one value should be supplied.)
447 =item C<< something->need_add_hidden($method, $reqtype) >>
449 Enquires whether a request of type I<$reqtype> using HTTP method
450 I<$method> needs the hidden form parameter. See L</REQUEST TYPES>.
452 =item C<< something->secret_hidden_val() >>
454 Returns the value of the hidden form parameter. This should be
455 included in all POST requests to your application (and thus be a
456 hidden form parameter in all forms).
458 It should also be in some (maybe all) GET requests. If your
459 application is mutation-ignorant, it should be in all GET requests.
460 If you are mutation-aware, you need to consult C<need_add_hidden>.
462 The name of the hidden parameter is the setting C<assoc_param_name>,
463 C<caf_hassochash> by default. xxx rename param and setting
465 =item C<< something->secret_hidden_html() >>
467 Returns the HTML for an C<INPUT> element specifying the hidden form
470 =item C<< something->secret_cookie_val() >>
472 Returns the value of the secret cookie. CGI::Auth::Flexible sets this
473 cookie in the forms generated by C<check_ok>. You may also set it
474 yourself (and indeed you must do so if you use C<check_divert>).
476 =item C<< $authreq->_chain_params() >>
478 Returns a hash of the "relevant" parameters to this request, in a form
479 suitable for C<url_with_query_params>. This is all of the query
480 parameters which are not related to CGI::Auth::Flexible. The
481 PATH_INFO from the request is returned as the parameter C<< '' >>.
485 =head1 OTHER FUNCTIONS AND METHODS
489 =item C<< $verifier_or_authreq->hash($data) >>
491 Hashes the supplied data using the hash function specified by the
492 C<hash_algorithm> setting, and converts the result to a string of hex
495 =item C<< something->update_get_need_add_hidden($reqtype, $value, [$force]) >>
497 Updates CGI::Auth::Generic's knowledge about the various kinds of
498 request, and whether they need the hidden form parameter. This
499 function applies only to GET requests - POST requests always use the
502 I<$reqtype> is the request type (the value which will be passed to
503 C<check_nonpage> and C<need_add_hidden>. If you are supporting a new
504 I<$reqtype> you shouuld coordinate with CGI::Auth::Flexible upstream,
505 or other users, to assign a unique request type name.
507 This method may be called on an authreq or a verifier, in which case
508 it will affect all authreqs using the same verifier. Or it may be
509 called on the class as a whole, in which case it will affect the
510 global default list for all verifiers.
512 If I<$force> is supplied and true, this will override
513 CGI::Auth::Flexible's existing knowledge. Otherwise this new setting
514 will be ignored if CGI::Auth::Flexible already knows about the request
515 type. (When called on a verifier or authreq, it will ignore the
516 update in favour of existing knowledge recorded both globally in the
517 class or due to previous requests on the same verifier.)
519 See L</REQUEST TYPES>.
521 =item C<< CGI::Auth::Flexible::srcdump_dir_cpio($cgi,$verifier,$dumpdir,$dir,$outfn,$how,$script) >>
523 Helper function for implementing the C<srcdump_process_item> hook.
524 Generates a tarball using cpio and includes it in the prepared source
527 The arguments are mostly the same as for that hook. C<$dir> is the
528 root directory at which to start the archive. C<$how> is a short text
529 string which will be mentioned in the log.
531 C<$script> is a shell script fragment which must output a
532 nul-separated list of filenames (e.g. the output of C<find -print0>).
533 It is textually surrounded by C<( )> and will be executed with C<set -e>
534 in force. Its cwd will be C<$dir>.
536 =item C<< $verifier_or_authreq->($data) | CGI::Auth::Flexible-> >>
538 Hashes the supplied data using the hash function specified by the
539 C<hash_algorithm> setting, and converts the result to a string of hex
546 The C<$reqtype> values understood by C<check_nonpage> are strings.
553 A top-level HTML page load. May contain confidential information for
554 the benefit of the logged-in user.
558 An HTML frame. May contain confidential information for
559 the benefit of the logged-in user.
563 An HTML iframe. May contain confidential information for
564 the benefit of the logged-in user.
568 Source dump request, whether for the licence or actual source code
569 tarball; returned value is not secret.
573 CSS stylesheet. B<MUST NOT> contain any confidential data. If the
574 stylesheet depends on the user, then attackers may be able to
575 determine what stylesheet the user is using. Hopefully this is not a
580 "Favicon" - icon for display in the browser's url bar etc. We aren't
581 currently aware of a way that attackers can get a copy of this.
585 C<robots.txt>. Should not contain any confidential data (obviously).
589 Inline image, for an C<< <img src=...> >> element.
591 Unfortunately it is not possible to sensibly show top-level
592 confidential images (that is, have the user's browser directly visit a
593 url which resolves to an image rather than an HTML page with an inline
594 image). This is because images need to have a per-session hidden form
595 parameter to avoid cross-site scripting, which breaks bookmarks etc.
599 JavaScript for a C<< <script> >> element. (Possibly confidential for
604 C<< XMLHttpRequest >> returning XML data. (Possibly
605 confidential for the user.)
609 C<< XMLHttpRequest >> returning JSON data. (Possibly
610 confidential for the user.)
614 C<< XMLHttpRequest >> returning data of some other kind. (Possibly
615 confidential for the user.)
621 The return value from C<check_divert> indicates how the request should
622 be handled. It is C<undef> if all is well and the user is logged in.
624 Otherwise the return value is a hash ref with the following keys:
630 Scalar string indicating the kind of diversion required.
634 Scalar string for display to the user in relation to the diversion.
635 Has already been translated. In HTML but normally does not contain
638 =item C<CookieSecret>
640 The login cookie which should be set along with whatever response is
641 sent to the client. The value in the hash is the actual value
642 of the cookie as a string. C<undef> means no cookie setting header
643 should be sent; C<''> means the cookie should be cleared.
647 Provided with diversion kinds which involve
648 generating a redirection or indirection,
649 perhaps via a login form.
651 The extra hidden form parameters (and the C<PATH_INFO>) which should
652 be set when the subsequent request bounces back from the client, in
653 the form used by C<url_with_query_params>.
655 The contents of this hashref does not include the CAF-specific
656 parameters such as the secret cookie, those which follow from the kind
657 of diversion requested, etc.
659 It is correct to always include the contents of C<Params> as hidden
660 parameters in the urls for all redirections, and as hidden input
661 fields in all generated forms. The specific cases where C<Params> is
662 currently relevant are also mentioned in the text for each divert
667 The values of C<Kind> are:
671 =item C<SRCDUMP->I<item>
673 We should respond by sending our application source code. I<item>
674 (which will contain only word characters, and no lower case) is the
675 specific item to send, normally C<SOURCE> or C<LICENCE>.
677 =item C<REDIRECT-HTTPS>
679 We should respond with an HTTP redirect to the HTTPS instance of our
682 =item C<REDIRECT-LOGGEDOUT>
684 We should redirect to a page showing that the user has been logged
685 out. (Ie, to a url with one of the the C<loggedout_param_names> set.)
687 =item C<SMALLPAGE-LOGGEDOUT>
689 We should generate a page showing that the user has been logged out.
690 There can be a link on the page pointing to the login page so that the
691 user can log back in.
693 =item C<SMALLPAGE-NOCOOKIE>
695 We should generate a page reporting that the user does not have
696 cookies enabled. It should probably contain a link pointing to the
697 login page with additionally all the parameters in C<Params>. When
698 this divert spec is generated, C<Message> will explain the problem
699 with cookies so there is no need to do that again in the page body if
700 you include the contents of C<Message>.
704 The user's session was stale (this is described in C<Message>). We
705 should generate a login form.
709 The user supplied bad login credentials. The details are in
710 C<Message>. We should generate a login form (with additionally the
711 parameters from C<Params> as hidden fields).
713 =item C<LOGIN-INCOMINGLINK>
715 We should generate a login form (with the specified parameters); the
716 user is entering the site via a cross-site link but is not yet logged
721 We should generate a login form. The user is not yet logged in.
723 =item C<REDIRECT-LOGGEDIN>
725 We should redirect to our actual application, with the specified
726 parameters. (The user has just logged in.)
728 =item C<MAINPAGEONLY>
730 We should generate our main page but B<ignoring all form parameters>
731 and B<ignoring the path_info>. Most applications will find this
732 difficult to implement.
734 An alternative is to generate a small page with a form or link which
735 submits our own main page without any parameters.
737 (Applications which set C<promise_check_mutate> do not see this divert
744 C<new_verifier> and C<new_request> each take a list of settings, as
745 a list of pairs C<< key => value >> (like a Perl hash assignment).
747 The settings supplied to C<new_verifier> are stored in the verifier
748 and will apply to all authreqs made from it unless overridden in the
749 call to C<new_request>
751 When a setting is described as a hook function, it should be a
752 coderef. The first argument will be the query object from
753 L<CGI(3perl)> (strictly, it will be whatever value was passed to
754 C<new_request>). The second argument will be the authreq object (the
755 return value from C<new_request>).
756 Ie, C<< sub some_hook ($$...) { my ($cgi,$authreq,@stuff) = @_ ... >>
758 In bullet point headings, the hook functions are shown in the form
759 C<< some_hook($cgi,$authreq,@stuff) >> even though this would not be
760 legal syntax. This should be read to mean that the
761 %implicit_settings_hash{'some_hook'}($cgi,$authreq,@stuff)
762 would be a legal call. (However, the settings hash is not exposed.)
764 When a hook's default implementation is mentioned and named, that
765 function won't also be described in the section on the module's
768 =head2 GENERAL SETTINGS
774 The directory CGI::Auth::Generic should use for its data storage.
775 This is actually just a default absolute path used when the other
776 path settings are relative values.
778 Must be an absolute filename.
782 CGI::Auth::Flexible needs a database for recording users' login
783 session. This database needs to be shared across all instances of the
784 web application, so in a multi-node cluster it needs to be your actual
787 CGI::Auth::Flexible will create the table and index it needs if they
788 don't already exist, and will manage their contents. You do not need
789 to integrate them into the rest of your webapp's data storage. (In
790 particular, there is no need for transactional integrity across
791 changes made by CAF and your own application.)
793 By default, CAF uses a sqlite3 database stored on local disk in the
794 file named by C<db_path>. This will be suitable for all
795 applications which run on a single host.
797 This value, if supplied, should be a DBI handle for the database.
801 This is the DSN to pass to C<< DBI->connect >>. Used only if
802 C<db_dbh> is not supplied.
806 Path to the sqlite3 database used for CAF's session storage. The
807 default is C<caf.db>.
809 Used only if neither C<db_dbh> or C<db_dsn> are supplied.
811 If this is a relative path, it is in C<dir>.
815 Prefix for the SQL tables and indices to use (and to create, if
818 See L</DATABASE TABLES>.
822 Path to the keys file used by CAF. This arrangement will change in
823 the future. See L</BUGS>.
825 =item C<random_source>
827 Special file to read random numbers from. Should return
828 cryptographically secure (pseudo)-random bytes, unpredictable to
829 adversaries (even ones on the same machine).
831 On Linux, there is no device which is properly suitable. This is a
832 bug in Linux. You can use C</dev/random> which can block
833 unnecessarily even though the kernel PRNG has been properly seeded and
834 is fine, or C</dev/urandom> which might return values which attackers
835 can predict if the kernel PRNG has not been properly seeded.
837 The default is C</dev/urandom>.
841 Length of the assoc secret. Defaults to 128.
843 =item C<hash_algorithm>
845 Must be a string suitable for use with C<new Digest>.
846 Defaults to C<SHA-256>.
848 =item C<login_timeout>
850 A user will be logged out this many seconds after they first logged
851 in. Default: 86400 (one day).
853 =item C<login_form_timeout>
855 A login form becomes invalid this many seconds after it has been sent.
856 Default: 3600 seconds (one hour).
858 =item C<key_rollover>
860 The key used for generating assoc secrets is rolled over approximately
861 this often (in seconds). Default: 86400.
863 =item C<assoc_param_name>
865 Name of the hidden form parameter. Default: C<caf_assochash>.
869 Name of the cookie used for login sessions. Default:
872 =item C<password_param_name>
874 Name of the password field in the login form. Default: C<password>.
876 Used by C<login_ok_password> (the default C<login_ok> hook),
877 C<gen_plain_login_form> and the default C<is_login> hook.
879 =item C<username_param_names>
881 Arrayref of name(s) of username form parameters.
883 The first entry is used by C<login_ok_password> (the default
884 C<login_ok> hook) to pass to the C<username_password_error> hook and
885 used as the username if all is well.
887 All the entries are used by C<gen_plain_login_fork> (the default
888 C<gen_login_form> hook for C<check_ok>) to generate form entry fields.
890 The default is C<['username']>.
892 =item C<logout_param_names>
894 Arrayref of name(s) of form parameters indicating that the request is
897 Used by the default C<is_logout> hook.
899 If you want users to be able to explicitly log out, you need to
900 provide a logout button, something like
901 C<< <input type="submit" name="caf_logout" ... >>
903 The default is C<['caf_logout']>
905 =item C<logged_param_names>
907 Arrayref of name(s) of form parameters indicating that user has just
908 logged out. (During the logout process, the actual logout action is a
909 POST request, whose response redirects to the "you have been logged
910 out" page; these form parameters are for this second page.)
912 Used by the default C<is_loggedout> hook.
914 The first entry is used by C<check_ok> to generate the redirection.
916 The default is C<['caf_loggedout']>
918 =item C<promise_check_mutate>
920 Boolean. If true, is a declaration by the application that it is
921 mutatin-aware. See L</MUTATING OPERATIONS AND EXTERNAL LINKS>.
925 =item C<encrypted_only>
927 Boolean. If true, CAF will insist that all transactions be done over
928 an encrypted http connection. It will redirect unencrypted requests
929 to the https instance of the applicattion, and will set the encrypted
930 only flag on its cookie.
934 =item C<< get_url($cgi,$authreq) >>
936 Hook which returns the URL of this web application. By default, we
937 call C<< $cgi->url() >> for each request, but you can fix this if you
940 =item C<< is_login,is_logout,is_loggedout($cgi,$authreq) >>
942 Hook which returns a boolean indicating whether the request was,
943 respectively: a login form submission (ie, username and password); a
944 logout request (submission resulting from the user pressing the
945 "logout" button); "logged out" page (redirection from the logout
948 The default is to check whether any of the corresponding request
949 parameters (C<< login_param_names >> etc.) was supplied, using the
954 =head2 SETTINGS (HOOKS) RELATED TO THE CGI REQUEST OBJECT
958 =item C<< get_param($cgi,$authreq,$param) >>
960 Returns the value of a single-valued form parameter.
961 The default is to call C<< $cgi->param($param) >>.
962 The semantics are the same as that of C<CGI::param>.
964 =item C<< get_params($cgi,$authreq) >>
966 Returns a hash of the parameters. The return value is a hashref whose
967 keys are the parameter names and whose values are arrayrefs, one entry
968 in the arrayref for each value.
970 The default is to call C<< $cgi->Vars() >>, expect the
971 results to look like those from C<CGI::Vars>, and massage them into
972 the required form with split.
974 =item C<< get_path_info($cgi,$authreq) >>
976 Returns the PATH_INFO of the request. The default is to
977 call C<< $cgi->path_info() >>.
979 =item C<< get_cookie($cgi,$authreq) >>
981 Returns the value of the CAF cookie sent with the request, or undef if
982 none was supplied. The default is to call C<<
983 $cgi->cookie($cookie_name) >> (where C<$cookie_name> is from the
984 setting of the same name). The return value should be the scalar
987 =item C<< get_method($cgi,$authreq) >>
989 Returns the HTTP method as a string. The default is to call
990 C<< $cgi->request_method() >>.
992 =item C<< is_https($cgi,$authreq) >>
994 Returns a boolean indicating whether the request was over an encrypted
995 channel. The default is C<< !!$cgi->https() >>. See C<encrypted_only>.
999 =head2 SETTINGS RELATED TO HTML GENERATION
1001 These are only used if you call C<check_ok> (or other functions
1002 mentioned in this section).
1004 Settings whose names are of the form C<gen_...> are hooks which each
1005 return an array of strings, normally HTML strings, for use by
1006 C<check_ok> (or, in turn, other hooks, or your application). These
1007 are often documented simply by showing the output produced. In many
1008 cases parts of the output are in turn obtained from other hooks. In
1009 some cases the default implementations have been given names for
1010 convenient use by your application. They will be called in array
1013 We'll write C<gettext(something)> even though actually there is a hook
1014 to control the translation function used.
1018 =item C<handle_divert>($cgi,$authreq,$divert))
1020 C<check_ok> calls this hook before producing output of its own. If
1021 you want to handle some but not all diversions yourself, you may set
1022 this hook. The hook should either do nothing and return false, or
1023 return true if it has handled the request (or arrange for the request
1024 to be handled). If the hook returns true then C<check_ok> simply
1027 =item C<gen_login_form>($cgi,$authreq,$divert))
1029 Default: a table (used mostly for layout) containing input fields for
1030 a login form. Must be within a C<< <form> >> element, but doesn't
1031 generate it. Has text fields for every entry in
1032 C<username_param_names> (in each case associated with a description
1033 C<< gettext(ucfirst $parameter_name) >>, a password field (with
1034 description C<gettext("Password")>, and a login submit button (with
1035 description C<gettext("Login")>.
1037 Default is available as the module function C<gen_plain_login_form>.
1039 =item C<gen_login_link>($cgi,$authreq))
1043 <a href="http:...">gettext(Log in again to continue.)</a>
1045 Default is available as the module function C<gen_plain_login_link>.
1047 =item C<gen_postmainpage_form>($cgi,$authreq,$params))
1049 Default: form contents (but not the C<< <form> >> element):
1051 C<$params> (in the form returned by the C<get_params> hook) as hidden
1054 <input type="submit" ... value=getext('Continue')>
1056 Default is available as the module function C<gen_postmainpage_form>.
1058 =item C<gen_start_html>($cgi,$authreq,$title)
1060 Default: C<$cgi->start_html($title)>
1062 =item C<gen_end_html>($cgi,$authreq,$title)
1064 Default: C<$cgi->end_html($title)>
1066 =item C<gen_footer_html>($cgi,$authreq)>
1071 Powered by Free / Libre / Open Source Software
1072 according to the [gen_licence_link_html].
1073 [gen_source_link_html].
1076 Default is available as the module function C<gen_plain_footer_html>.
1078 =item C<gen_licence_link_html>($cgi,$authreq)>
1080 Default: uses C<url_with_query_params> to generate a URL for
1081 downloading the licence, and returns:
1082 <a href="...">GNU Affero GPL</a>
1084 Default is available as the module function C<gen_plain_licence_link_html>.
1086 =item C<gen_source_link_html>($cgi,$authreq)>
1088 Default: uses C<url_with_query_params> to generate a URL for
1089 downloading the source, and returns:
1090 <a href="...">Source available</a>
1092 Default is available as the module function C<gen_plain_source_link_html>.
1094 =item C<form_entry_size>
1096 Size of generated text entry fields. Default is 60.
1098 =item C<dummy_param_name_prefix>
1100 Some of CAF's HTML-generating functions need to invent form parameter
1101 names. They will all start with this string. Default: C<caf__>.
1105 =head2 SETTINGS FOR SOURCE CODE DOWNLOAD FACILITY
1109 =item C<srcdump_param_name>
1111 Form parameter name used to indicate that this is a source download
1112 request. If this parameter is supplied, C<check_ok> and
1113 C<check_divert> will arrange for the applicaton source code to be
1114 delivered as the response (in C<check_ok>'s case by doing it itself
1115 and in C<check_divert>'s case by asking your application to do so.
1117 Default is C<caf_srcdump>.
1119 =item C<srcdump_path>
1121 Path to the directory used for storing pre-prepared source downloads.
1122 Defaults to C<caf-srcdump>.
1124 If this is a relative path, it is in C<dir>.
1126 =item C<srcdump_dump($cgi,$authreq,$srcobj)>
1128 Dump the source code (C<$srcobj='source'> or licence data
1129 (C<$srcobj='licence'>). The default implementation checks that
1130 C<$srcobj> has reasonable syntax and uses the files C<$srcobj.data>
1131 and C<$srcobj.ctype> with the C<dump> hook.
1133 =item C<dump($cgi,$authreq,$contenttype,$datafilehandle)>
1135 Responds to the request by sending the contents of $datafilehandle
1136 (which should just have been opened) and specifying a content type of
1139 The default implmentation uses the C<print> hook, and also calls
1140 C<$cgi->header('-type' => $contenttype>, and is available as the
1141 module function C<dump_plain>.
1143 =item C<srcdump_prepare($cgi,$verifier)>
1145 Prepares the source code for download when requested. Invoked by
1146 C<new_verifier>, always, immediately before it returns the
1147 just-created verifier object.
1149 The default implementation is the module function
1150 C<srcdump_dirscan_prepare>, which prepares a manifest, licence file
1151 and source code tarball of tarballs, as follows:
1153 It processes each entry in the return value from C<srcdump_listitems>.
1154 These are the software's include directories and any other directories
1155 containing source code. It handles C<.> specially (see
1156 C<srcdump_filter_cwd>).
1158 For each entry it looks, relative to that, for the licence as a file
1159 with a name mentioned in C<srcdump_licence_files>. The first such
1160 file found is considered to be the licence. It then calls the hook
1161 C<srcdump_process_item> for the entry.
1163 The licence, a manifest file, and all the outputs generated by the
1164 calls to C<srcdump_process_item>, are tarred up and compressed as a
1165 single source tarball.
1167 It uses the directory named by C<srcdump_path> as its directory for
1168 working and output files. It uses the filename patterns
1169 C<generate.*>, C<licence.*>, C<s.[a-z][a-z][a-z].*>, C<manifest.*>,
1170 C<source.*> in that directory.
1172 =item C<srcdump_process_item>($cgi,$verifier,$dumpdir,$item,\&outfn,\$needlicence,\%dirsdone)>
1174 Processes a single include directory or software entry, so as to
1175 include the source code found there. Called only by the default
1176 implementation of C<srcdump_prepare>.
1178 C<$dumpdir> is the directory for working and output files. C<$item>
1179 is the real (no symlinks) absolute path to the item.
1181 C<\$needlicence> is a ref to a scalar: this scalar is undef if we have
1182 already found the licence file; otherwise it is the filename to which
1183 the licence should be copied. If the referent is undef on entry,
1184 C<srcdump_process_item> needs to see if it finds the licence; if it
1185 does it should copy it to the named file and then set the scalar to
1188 C<\%dirsdone> is a ref to the hash used by C<srcdump_prepare> to avoid
1189 including a single directory more than once. If
1190 C<srcdump_process_item> decides to process a directory other than
1191 C<$item> it should check this hash with the real absolute path of the
1192 other directoy as a key: if the hash entry is true, it has already
1193 been done and should be skipped; otherwise the hash entry should be set.
1195 C<\&outfn> is a coderef which C<srcdump_process_item> should call each
1196 time it wants to generate a file which should be included as part of
1197 the source code. It should be called using one of these patterns:
1198 $outfn->("message for manifest");
1199 $outfile = $outfn->("message for manifest", "extension");
1200 The former simply prints the message into the manifest in the form
1201 none: message for manifest
1202 The latter generates and returns a filename which should then
1203 be created and filled with some appropriate data. C<"extension">
1204 should be a string for the file extension, eg C<"txt">. The output
1205 can be written directly to the named file: there is no need to
1206 write to a temporary file and rename. C<$outfn> writes the filename
1207 and the message to the manifest, in the form
1208 filename leaf: message
1209 In neither case is the actual name of C<$dir> on the system
1210 disclosed per se although of course some of the contents of some of
1211 the files in the source code dump may mention it.
1213 The default implementation is the module function
1214 C<srcdump_process_item>.
1216 It skips directories for which C<srcdump_system_dir> returns true.
1218 It then searches the item and its parent
1219 directories for a vcs metadata directory (one of the names in
1220 C<srcdump_vcs_dirs>); if found, it calls the C<srcdump_byvcs> hook
1221 (after checking and updaeing C<%dirsdone>).
1222 Otherwise it calls the C<srcdump_novcs> hook.
1224 =item C<srcdump_novcs($cgi,$verifier,$dumpdir,$item,$outfn)>
1226 Called by the default implementation of C<srcdump_process_item>, with
1227 the same arguments, if it doesn't find vcs metadata.
1229 The default implementation is the module function C<srcdump_novcs>.
1231 If C<$item> is a directory, it uses C<srcdump_dir_cpio> to prepare a
1232 tarball of all the files under C<$item> which have the world read bit
1233 set. Directories are not included (and their permissions are
1234 disregarded). The contents of C<srcdump_excludes> are excluded.
1236 If it's a plain file it uses C<srcdump_file> to include the file.
1238 =item C<srcdump_byvcs($cgi,$verifier,$dumpdir,$item,$outfn,$vcs)>
1240 Called by the default implementation of C<srcdump_process_item>, with
1241 the same arguments, if it finds vcs metadata. The additional argument
1242 C<$vcs> is derived from the entry of C<srcump_vcs_dirs> which was
1243 used: it's the first sequence of word characters, lowercased.
1245 The default implementation is the module function C<srcdump_byvcs>.
1246 It simply calls C<srcdump_dir_cpio> with a script from the setting
1247 C<srcdump_vcsscript>.
1249 =item C<srcdump_vcs_dirs>
1251 Array ref of leaf names of vcs metadata directories. Used by the
1252 default implementation of C<srcdump_process_item>. The default value
1253 is C<['.git','.hg','.bzr','.svn']>.
1255 =item C<srcdump_vcs_script>
1257 Hash ref of scripts for generating vcs metadata. Used by the default
1258 implementation of C<srcdump_byvcs>. The keys are values of C<$vcs>
1259 (see C<srcdump_byvcs>); the values are scripts as for
1260 C<srcdump_dir_cpio>.
1262 The default has an entry only for C<git>:
1264 git ls-files -z --others --exclude-from=.gitignore
1267 =item C<srcdump_excludes>
1269 Array ref of exclude glob patterns, used by the default implementation
1270 of C<srcdump_novcs>. The default value is C<['*~','*.bak','*.tmp','#*#']>.
1272 Entries must not contain C<'> or C<\>.
1274 =item C<srcdump_listitems($cgi,$verifier)>
1276 Returns an array of directories which might contain source code of the
1277 web application and which should be therefore be considered for
1278 including in the source code delivery.
1280 Used by the default implementation of C<srcdump_prepare>.
1282 Entries must be directories, plain files, or nonexistent; they may
1283 also be symlinks which resolve to one of those.
1285 If C<.> is included it may be treated specially - see
1286 C<srcdump_filter_cwd>.
1288 The default implementation returns
1289 C<(@INC, $ENV{'SCRIPT_FILENAME'}, $0)>.
1291 =item C<srcdump_system_dir($cgi,$verifier,$dir)>
1293 Determines whether C<$dir> is a "system directory", in which any
1294 source code used by the application should nevertheless not be
1295 included in the source code dump.
1297 Used by the default implementation of C<srcdump_item>.
1299 The default implementation is as follows: Things in C</etc/> are
1300 system directories. Things in C</usr/> are too, unless they are in
1301 C</usr/local/> or C</usr/lib/cgi*>.
1303 =item C<srcdump_filter_cwd>
1305 Boolean which controls the handling of C<.> if it appears in the
1306 return value from C<srcdump_listitems>. Used only by the default
1307 implementation of C<srcdump_prepare>.
1309 If set to false, C<.> is treated normally and no special action is
1312 However often the current directory may be C</>, or a data directory,
1313 or some other directory containing data which is confidential, or
1314 should not be included in the public source code distribution for
1315 other reasons. And for historical reasons Perl has C<@INC> containing
1316 C<.> by default (which is arguably dangerous and wrong).
1318 So the default this setting is true, which has the following effects:
1320 C<.> is not searched for source code even if it appears in C<@INC>.
1321 C<.> is removed from C<@INC> and C<%INC> is checked to see if any
1322 modules appear to have already been loaded by virtue of C<.> appearing
1323 in C<@INC> and if they have it is treated as a fatal error.
1325 Only the literal string C<.> is affected. If the cwd is included by
1326 any other name it is not treated specially regardless of this setting.
1330 =head1 DATABASE TABLES
1332 In a simple application, you do not need to worry about this. But if
1333 your application runs on multiple frontend hosts with a shared
1334 database, you may need to create for yourself the tables and indices
1335 used by CGI::Auth::Flexible.
1337 By default, every time CAF starts up, it attempts to execute certain
1338 fixed database statements to create the tables and indices it needs.
1339 These are run with C<$dbh->{PrintError}> set to 0. The effect with
1340 sqlite (the default database) is that the tables and indices are
1341 created iff they do not already exist, and that no spurious errors are
1344 If you use a different database, or just prefer to do things
1345 differently, you can set up the tables yourself and/or disable or
1346 modify the default setup statements, via the C<db_setup_stmts>
1349 The tables needed are:
1352 xxx document _db_setup_do
1353 xxx make _db_setup_do explicitly overrideable
1356 xxx remaining settings
1358 username_password_error
1365 xxx document cookie usage
1366 xxx document construct_cookie fn
1368 xxx document @default_db_setup_statements
1370 xxx bugs wrong default random on Linux
1372 xxx bugs wrong default random on *BSD
1374 xxx bugs keys not shared should be in db
1376 xxx rename caf_assocsecret default cookie name
1378 xxx mention relationship between login_timeout and cookies