bc9eb24fd2621717014db9e8f5141b93d1b1c60a
[catagits/Catalyst-Plugin-Session.git] / lib / Catalyst / Plugin / Session.pm
1 #!/usr/bin/perl
2
3 package Catalyst::Plugin::Session;
4
5 use Moose;
6 with 'MooseX::Emulate::Class::Accessor::Fast';
7 use MRO::Compat;
8 use Catalyst::Exception ();
9 use Digest              ();
10 use overload            ();
11 use Object::Signature   ();
12 use Carp;
13
14 use namespace::clean -except => 'meta';
15
16 our $VERSION = '0.27';
17 $VERSION = eval $VERSION;
18
19 my @session_data_accessors; # used in delete_session
20
21 __PACKAGE__->mk_accessors(
22         "_session_delete_reason",
23         @session_data_accessors = qw/
24           _sessionid
25           _session
26           _session_expires
27           _extended_session_expires
28           _session_data_sig
29           _flash
30           _flash_keep_keys
31           _flash_key_hashes
32           _tried_loading_session_id
33           _tried_loading_session_data
34           _tried_loading_session_expires
35           _tried_loading_flash_data
36           /
37 );
38
39 sub _session_plugin_config {
40     my $c = shift;
41     # FIXME - Start warning once all the state/store modules have also been updated.
42     #$c->log->warn("Deprecated 'session' config key used, please use the key 'Plugin::Session' instead")
43     #    if exists $c->config->{session}
44     #$c->config->{'Plugin::Session'} ||= delete($c->config->{session}) || {};
45     $c->config->{'Plugin::Session'} ||= $c->config->{session} || {};
46 }
47
48 sub setup {
49     my $c = shift;
50
51     $c->maybe::next::method(@_);
52
53     $c->check_session_plugin_requirements;
54     $c->setup_session;
55
56     return $c;
57 }
58
59 sub check_session_plugin_requirements {
60     my $c = shift;
61
62     unless ( $c->isa("Catalyst::Plugin::Session::State")
63         && $c->isa("Catalyst::Plugin::Session::Store") )
64     {
65         my $err =
66           (     "The Session plugin requires both Session::State "
67               . "and Session::Store plugins to be used as well." );
68
69         $c->log->fatal($err);
70         Catalyst::Exception->throw($err);
71     }
72 }
73
74 sub setup_session {
75     my $c = shift;
76
77     my $cfg = $c->_session_plugin_config;
78
79     %$cfg = (
80         expires        => 7200,
81         verify_address => 0,
82         verify_user_agent => 0,
83         %$cfg,
84     );
85
86     $c->maybe::next::method();
87 }
88
89 sub prepare_action {
90     my $c = shift;
91
92     $c->maybe::next::method(@_);
93
94     if (    $c->_session_plugin_config->{flash_to_stash}
95         and $c->sessionid
96         and my $flash_data = $c->flash )
97     {
98         @{ $c->stash }{ keys %$flash_data } = values %$flash_data;
99     }
100 }
101
102 sub finalize_headers {
103     my $c = shift;
104
105     # fix cookie before we send headers
106     $c->_save_session_expires;
107
108     return $c->maybe::next::method(@_);
109 }
110
111 sub finalize_body {
112     my $c = shift;
113
114     # We have to finalize our session *before* $c->engine->finalize_xxx is called,
115     # because we do not want to send the HTTP response before the session is stored/committed to
116     # the session database (or whatever Session::Store you use).
117     $c->finalize_session;
118
119     return $c->maybe::next::method(@_);
120 }
121
122 sub finalize_session {
123     my $c = shift;
124
125     $c->maybe::next::method(@_);
126
127     $c->_save_session_id;
128     $c->_save_session;
129     $c->_save_flash;
130
131     $c->_clear_session_instance_data;
132 }
133
134 sub _save_session_id {
135     my $c = shift;
136
137     # we already called set when allocating
138     # no need to tell the state plugins anything new
139 }
140
141 sub _save_session_expires {
142     my $c = shift;
143
144     if ( defined($c->_session_expires) ) {
145         my $expires = $c->session_expires; # force extension
146
147         my $sid = $c->sessionid;
148         $c->store_session_data( "expires:$sid" => $expires );
149     }
150 }
151
152 sub _save_session {
153     my $c = shift;
154
155     if ( my $session_data = $c->_session ) {
156
157         no warnings 'uninitialized';
158         if ( Object::Signature::signature($session_data) ne
159             $c->_session_data_sig )
160         {
161             $session_data->{__updated} = time();
162             my $sid = $c->sessionid;
163             $c->store_session_data( "session:$sid" => $session_data );
164         }
165     }
166 }
167
168 sub _save_flash {
169     my $c = shift;
170
171     if ( my $flash_data = $c->_flash ) {
172
173         my $hashes = $c->_flash_key_hashes || {};
174         my $keep = $c->_flash_keep_keys || {};
175         foreach my $key ( keys %$hashes ) {
176             if ( !exists $keep->{$key} and Object::Signature::signature( \$flash_data->{$key} ) eq $hashes->{$key} ) {
177                 delete $flash_data->{$key};
178             }
179         }
180
181         my $sid = $c->sessionid;
182
183         my $session_data = $c->_session;
184         if (%$flash_data) {
185             $session_data->{__flash} = $flash_data;
186         }
187         else {
188             delete $session_data->{__flash};
189         }
190         $c->_session($session_data);
191         $c->_save_session;
192     }
193 }
194
195 sub _load_session_expires {
196     my $c = shift;
197     return $c->_session_expires if $c->_tried_loading_session_expires;
198     $c->_tried_loading_session_expires(1);
199
200     if ( my $sid = $c->sessionid ) {
201         my $expires = $c->get_session_data("expires:$sid") || 0;
202
203         if ( $expires >= time() ) {
204             $c->_session_expires( $expires );
205             return $expires;
206         } else {
207             $c->delete_session( "session expired" );
208             return 0;
209         }
210     }
211
212     return;
213 }
214
215 sub _load_session {
216     my $c = shift;
217     return $c->_session if $c->_tried_loading_session_data;
218     $c->_tried_loading_session_data(1);
219
220     if ( my $sid = $c->sessionid ) {
221         if ( $c->_load_session_expires ) {    # > 0
222
223             my $session_data = $c->get_session_data("session:$sid") || return;
224             $c->_session($session_data);
225
226             no warnings 'uninitialized';    # ne __address
227             if (   $c->_session_plugin_config->{verify_address}
228                 && $session_data->{__address} ne $c->request->address )
229             {
230                 $c->log->warn(
231                         "Deleting session $sid due to address mismatch ("
232                       . $session_data->{__address} . " != "
233                       . $c->request->address . ")"
234                 );
235                 $c->delete_session("address mismatch");
236                 return;
237             }
238             if (   $c->_session_plugin_config->{verify_user_agent}
239                 && $session_data->{__user_agent} ne $c->request->user_agent )
240             {
241                 $c->log->warn(
242                         "Deleting session $sid due to user agent mismatch ("
243                       . $session_data->{__user_agent} . " != "
244                       . $c->request->user_agent . ")"
245                 );
246                 $c->delete_session("user agent mismatch");
247                 return;
248             }
249
250             $c->log->debug(qq/Restored session "$sid"/) if $c->debug;
251             $c->_session_data_sig( Object::Signature::signature($session_data) ) if $session_data;
252             $c->_expire_session_keys;
253
254             return $session_data;
255         }
256     }
257
258     return;
259 }
260
261 sub _load_flash {
262     my $c = shift;
263     return $c->_flash if $c->_tried_loading_flash_data;
264     $c->_tried_loading_flash_data(1);
265
266     if ( my $sid = $c->sessionid ) {
267
268         my $session_data = $c->session;
269         $c->_flash($session_data->{__flash});
270
271         if ( my $flash_data = $c->_flash )
272         {
273             $c->_flash_key_hashes({ map { $_ => Object::Signature::signature( \$flash_data->{$_} ) } keys %$flash_data });
274
275             return $flash_data;
276         }
277     }
278
279     return;
280 }
281
282 sub _expire_session_keys {
283     my ( $c, $data ) = @_;
284
285     my $now = time;
286
287     my $expire_times = ( $data || $c->_session || {} )->{__expire_keys} || {};
288     foreach my $key ( grep { $expire_times->{$_} < $now } keys %$expire_times ) {
289         delete $c->_session->{$key};
290         delete $expire_times->{$key};
291     }
292 }
293
294 sub _clear_session_instance_data {
295     my $c = shift;
296     $c->$_(undef) for @session_data_accessors;
297     $c->maybe::next::method(@_); # allow other plugins to hook in on this
298 }
299
300 sub change_session_id {
301     my $c = shift;
302
303     my $sessiondata = $c->session;
304     my $oldsid = $c->sessionid;
305     my $newsid = $c->create_session_id;
306
307     if ($oldsid) {
308         $c->log->debug(qq/change_sessid: deleting session data from "$oldsid"/) if $c->debug;
309         $c->delete_session_data("${_}:${oldsid}") for qw/session expires flash/;
310     }
311
312     $c->log->debug(qq/change_sessid: storing session data to "$newsid"/) if $c->debug;
313     $c->store_session_data( "session:$newsid" => $sessiondata );
314
315     return $newsid;
316 }
317
318 sub delete_session {
319     my ( $c, $msg ) = @_;
320
321     $c->log->debug("Deleting session" . ( defined($msg) ? "($msg)" : '(no reason given)') ) if $c->debug;
322
323     # delete the session data
324     if ( my $sid = $c->sessionid ) {
325         $c->delete_session_data("${_}:${sid}") for qw/session expires flash/;
326         $c->delete_session_id($sid);
327     }
328
329     # reset the values in the context object
330     # see the BEGIN block
331     $c->_clear_session_instance_data;
332
333     $c->_session_delete_reason($msg);
334 }
335
336 sub session_delete_reason {
337     my $c = shift;
338
339     $c->session_is_valid; # check that it was loaded
340
341     $c->_session_delete_reason(@_);
342 }
343
344 sub session_expires {
345     my $c = shift;
346
347     if ( defined( my $expires = $c->_extended_session_expires ) ) {
348         return $expires;
349     } elsif ( defined( $expires = $c->_load_session_expires ) ) {
350         return $c->extend_session_expires( $expires );
351     } else {
352         return 0;
353     }
354 }
355
356 sub extend_session_expires {
357     my ( $c, $expires ) = @_;
358     $c->_extended_session_expires( my $updated = $c->calculate_extended_session_expires( $expires ) );
359     $c->extend_session_id( $c->sessionid, $updated );
360     return $updated;
361 }
362
363 sub calculate_initial_session_expires {
364     my $c = shift;
365     return ( time() + $c->_session_plugin_config->{expires} );
366 }
367
368 sub calculate_extended_session_expires {
369     my ( $c, $prev ) = @_;
370     $c->calculate_initial_session_expires;
371 }
372
373 sub reset_session_expires {
374     my ( $c, $sid ) = @_;
375
376     my $exp = $c->calculate_initial_session_expires;
377     $c->_session_expires( $exp );
378     $c->_extended_session_expires( $exp );
379     $exp;
380 }
381
382 sub sessionid {
383     my $c = shift;
384
385     return $c->_sessionid || $c->_load_sessionid;
386 }
387
388 sub _load_sessionid {
389     my $c = shift;
390     return if $c->_tried_loading_session_id;
391     $c->_tried_loading_session_id(1);
392
393     if ( defined( my $sid = $c->get_session_id ) ) {
394         if ( $c->validate_session_id($sid) ) {
395             # temporarily set the inner key, so that validation will work
396             $c->_sessionid($sid);
397             return $sid;
398         } else {
399             my $err = "Tried to set invalid session ID '$sid'";
400             $c->log->error($err);
401             Catalyst::Exception->throw($err);
402         }
403     }
404
405     return;
406 }
407
408 sub session_is_valid {
409     my $c = shift;
410
411     # force a check for expiry, but also __address, etc
412     if ( $c->_load_session ) {
413         return 1;
414     } else {
415         return;
416     }
417 }
418
419 sub validate_session_id {
420     my ( $c, $sid ) = @_;
421
422     $sid and $sid =~ /^[a-f\d]+$/i;
423 }
424
425 sub session {
426     my $c = shift;
427
428     $c->_session || $c->_load_session || do {
429         $c->create_session_id_if_needed;
430         $c->initialize_session_data;
431     };
432 }
433
434 sub keep_flash {
435     my ( $c, @keys ) = @_;
436     my $href = $c->_flash_keep_keys || $c->_flash_keep_keys({});
437     (@{$href}{@keys}) = ((undef) x @keys);
438 }
439
440 sub _flash_data {
441     my $c = shift;
442     $c->_flash || $c->_load_flash || do {
443         $c->create_session_id_if_needed;
444         $c->_flash( {} );
445     };
446 }
447
448 sub _set_flash {
449     my $c = shift;
450     if (@_) {
451         my $items = @_ > 1 ? {@_} : $_[0];
452         croak('flash takes a hash or hashref') unless ref $items;
453         @{ $c->_flash }{ keys %$items } = values %$items;
454     }
455 }
456
457 sub flash {
458     my $c = shift;
459     $c->_flash_data;
460     $c->_set_flash(@_);
461     return $c->_flash;
462 }
463
464 sub clear_flash {
465     my $c = shift;
466
467     #$c->delete_session_data("flash:" . $c->sessionid); # should this be in here? or delayed till finalization?
468     $c->_flash_key_hashes({});
469     $c->_flash_keep_keys({});
470     $c->_flash({});
471 }
472
473 sub session_expire_key {
474     my ( $c, %keys ) = @_;
475
476     my $now = time;
477     @{ $c->session->{__expire_keys} }{ keys %keys } =
478       map { $now + $_ } values %keys;
479 }
480
481 sub initialize_session_data {
482     my $c = shift;
483
484     my $now = time;
485
486     return $c->_session(
487         {
488             __created => $now,
489             __updated => $now,
490
491             (
492                 $c->_session_plugin_config->{verify_address}
493                 ? ( __address => $c->request->address||'' )
494                 : ()
495             ),
496             (
497                 $c->_session_plugin_config->{verify_user_agent}
498                 ? ( __user_agent => $c->request->user_agent||'' )
499                 : ()
500             ),
501         }
502     );
503 }
504
505 sub generate_session_id {
506     my $c = shift;
507
508     my $digest = $c->_find_digest();
509     $digest->add( $c->session_hash_seed() );
510     return $digest->hexdigest;
511 }
512
513 sub create_session_id_if_needed {
514     my $c = shift;
515     $c->create_session_id unless $c->sessionid;
516 }
517
518 sub create_session_id {
519     my $c = shift;
520
521     my $sid = $c->generate_session_id;
522
523     $c->log->debug(qq/Created session "$sid"/) if $c->debug;
524
525     $c->_sessionid($sid);
526     $c->reset_session_expires;
527     $c->set_session_id($sid);
528
529     return $sid;
530 }
531
532 my $counter;
533
534 sub session_hash_seed {
535     my $c = shift;
536
537     return join( "", ++$counter, time, rand, $$, {}, overload::StrVal($c), );
538 }
539
540 my $usable;
541
542 sub _find_digest () {
543     unless ($usable) {
544         foreach my $alg (qw/SHA-1 SHA-256 MD5/) {
545             if ( eval { Digest->new($alg) } ) {
546                 $usable = $alg;
547                 last;
548             }
549         }
550         Catalyst::Exception->throw(
551                 "Could not find a suitable Digest module. Please install "
552               . "Digest::SHA1, Digest::SHA, or Digest::MD5" )
553           unless $usable;
554     }
555
556     return Digest->new($usable);
557 }
558
559 sub dump_these {
560     my $c = shift;
561
562     (
563         $c->maybe::next::method(),
564
565         $c->sessionid
566         ? ( [ "Session ID" => $c->sessionid ], [ Session => $c->session ], )
567         : ()
568     );
569 }
570
571
572 sub get_session_id { shift->maybe::next::method(@_) }
573 sub set_session_id { shift->maybe::next::method(@_) }
574 sub delete_session_id { shift->maybe::next::method(@_) }
575 sub extend_session_id { shift->maybe::next::method(@_) }
576
577 __PACKAGE__;
578
579 __END__
580
581 =pod
582
583 =head1 NAME
584
585 Catalyst::Plugin::Session - Generic Session plugin - ties together server side storage and client side state required to maintain session data.
586
587 =head1 SYNOPSIS
588
589     # To get sessions to "just work", all you need to do is use these plugins:
590
591     use Catalyst qw/
592       Session
593       Session::Store::FastMmap
594       Session::State::Cookie
595       /;
596
597     # you can replace Store::FastMmap with Store::File - both have sensible
598     # default configurations (see their docs for details)
599
600     # more complicated backends are available for other scenarios (DBI storage,
601     # etc)
602
603
604     # after you've loaded the plugins you can save session data
605     # For example, if you are writing a shopping cart, it could be implemented
606     # like this:
607
608     sub add_item : Local {
609         my ( $self, $c ) = @_;
610
611         my $item_id = $c->req->param("item");
612
613         # $c->session is a hash ref, a bit like $c->stash
614         # the difference is that it' preserved across requests
615
616         push @{ $c->session->{items} }, $item_id;
617
618         $c->forward("MyView");
619     }
620
621     sub display_items : Local {
622         my ( $self, $c ) = @_;
623
624         # values in $c->session are restored
625         $c->stash->{items_to_display} =
626           [ map { MyModel->retrieve($_) } @{ $c->session->{items} } ];
627
628         $c->forward("MyView");
629     }
630
631 =head1 DESCRIPTION
632
633 The Session plugin is the base of two related parts of functionality required
634 for session management in web applications.
635
636 The first part, the State, is getting the browser to repeat back a session key,
637 so that the web application can identify the client and logically string
638 several requests together into a session.
639
640 The second part, the Store, deals with the actual storage of information about
641 the client. This data is stored so that the it may be revived for every request
642 made by the same client.
643
644 This plugin links the two pieces together.
645
646 =head1 RECOMENDED BACKENDS
647
648 =over 4
649
650 =item Session::State::Cookie
651
652 The only really sane way to do state is using cookies.
653
654 =item Session::Store::File
655
656 A portable backend, based on Cache::File.
657
658 =item Session::Store::FastMmap
659
660 A fast and flexible backend, based on Cache::FastMmap.
661
662 =back
663
664 =head1 METHODS
665
666 =over 4
667
668 =item sessionid
669
670 An accessor for the session ID value.
671
672 =item session
673
674 Returns a hash reference that might contain unserialized values from previous
675 requests in the same session, and whose modified value will be saved for future
676 requests.
677
678 This method will automatically create a new session and session ID if none
679 exists.
680
681 =item session_expires
682
683 =item session_expires $reset
684
685 This method returns the time when the current session will expire, or 0 if
686 there is no current session. If there is a session and it already expired, it
687 will delete the session and return 0 as well.
688
689 If the C<$reset> parameter is true, and there is a session ID the expiry time
690 will be reset to the current time plus the time to live (see
691 L</CONFIGURATION>). This is used when creating a new session.
692
693 =item flash
694
695 This is like Ruby on Rails' flash data structure. Think of it as a stash that
696 lasts for longer than one request, letting you redirect instead of forward.
697
698 The flash data will be cleaned up only on requests on which actually use
699 $c->flash (thus allowing multiple redirections), and the policy is to delete
700 all the keys which haven't changed since the flash data was loaded at the end
701 of every request.
702
703     sub moose : Local {
704         my ( $self, $c ) = @_;
705
706         $c->flash->{beans} = 10;
707         $c->response->redirect( $c->uri_for("foo") );
708     }
709
710     sub foo : Local {
711         my ( $self, $c ) = @_;
712
713         my $value = $c->flash->{beans};
714
715         # ...
716
717         $c->response->redirect( $c->uri_for("bar") );
718     }
719
720     sub bar : Local {
721         my ( $self, $c ) = @_;
722
723         if ( exists $c->flash->{beans} ) { # false
724
725         }
726     }
727
728 =item clear_flash
729
730 Zap all the keys in the flash regardless of their current state.
731
732 =item keep_flash @keys
733
734 If you want to keep a flash key for the next request too, even if it hasn't
735 changed, call C<keep_flash> and pass in the keys as arguments.
736
737 =item delete_session REASON
738
739 This method is used to invalidate a session. It takes an optional parameter
740 which will be saved in C<session_delete_reason> if provided.
741
742 NOTE: This method will B<also> delete your flash data.
743
744 =item session_delete_reason
745
746 This accessor contains a string with the reason a session was deleted. Possible
747 values include:
748
749 =over 4
750
751 =item *
752
753 C<address mismatch>
754
755 =item *
756
757 C<session expired>
758
759 =back
760
761 =item session_expire_key $key, $ttl
762
763 Mark a key to expire at a certain time (only useful when shorter than the
764 expiry time for the whole session).
765
766 For example:
767
768     __PACKAGE__->config('Plugin::Session' => { expires => 1000000000000 }); # forever
769
770     # later
771
772     $c->session_expire_key( __user => 3600 );
773
774 Will make the session data survive, but the user will still be logged out after
775 an hour.
776
777 Note that these values are not auto extended.
778
779 =item change_session_id
780
781 By calling this method you can force a session id change while keeping all
782 session data. This method might come handy when you are paranoid about some
783 advanced variations of session fixation attack.
784
785 If you want to prevent this session fixation scenario:
786
787     0) let us have WebApp with anonymous and authenticated parts
788     1) a hacker goes to vulnerable WebApp and gets a real sessionid,
789        just by browsing anonymous part of WebApp
790     2) the hacker inserts (somehow) this values into a cookie in victim's browser
791     3) after the victim logs into WebApp the hacker can enter his/her session
792
793 you should call change_session_id in your login controller like this:
794
795       if ($c->authenticate( { username => $user, password => $pass } )) {
796         # login OK
797         $c->change_session_id;
798         ...
799       } else {
800         # login FAILED
801         ...
802       }
803
804 =back
805
806 =head1 INTERNAL METHODS
807
808 =over 4
809
810 =item setup
811
812 This method is extended to also make calls to
813 C<check_session_plugin_requirements> and C<setup_session>.
814
815 =item check_session_plugin_requirements
816
817 This method ensures that a State and a Store plugin are also in use by the
818 application.
819
820 =item setup_session
821
822 This method populates C<< $c->config('Plugin::Session') >> with the default values
823 listed in L</CONFIGURATION>.
824
825 =item prepare_action
826
827 This method is extended.
828
829 Its only effect is if the (off by default) C<flash_to_stash> configuration
830 parameter is on - then it will copy the contents of the flash to the stash at
831 prepare time.
832
833 =item finalize_headers
834
835 This method is extended and will extend the expiry time before sending
836 the response.
837
838 =item finalize_body
839
840 This method is extended and will call finalize_session before the other
841 finalize_body methods run.  Here we persist the session data if a session exists.
842
843 =item initialize_session_data
844
845 This method will initialize the internal structure of the session, and is
846 called by the C<session> method if appropriate.
847
848 =item create_session_id
849
850 Creates a new session ID using C<generate_session_id> if there is no session ID
851 yet.
852
853 =item validate_session_id SID
854
855 Make sure a session ID is of the right format.
856
857 This currently ensures that the session ID string is any amount of case
858 insensitive hexadecimal characters.
859
860 =item generate_session_id
861
862 This method will return a string that can be used as a session ID. It is
863 supposed to be a reasonably random string with enough bits to prevent
864 collision. It basically takes C<session_hash_seed> and hashes it using SHA-1,
865 MD5 or SHA-256, depending on the availability of these modules.
866
867 =item session_hash_seed
868
869 This method is actually rather internal to generate_session_id, but should be
870 overridable in case you want to provide more random data.
871
872 Currently it returns a concatenated string which contains:
873
874 =over 4
875
876 =item * A counter
877
878 =item * The current time
879
880 =item * One value from C<rand>.
881
882 =item * The stringified value of a newly allocated hash reference
883
884 =item * The stringified value of the Catalyst context object
885
886 =back
887
888 in the hopes that those combined values are entropic enough for most uses. If
889 this is not the case you can replace C<session_hash_seed> with e.g.
890
891     sub session_hash_seed {
892         open my $fh, "<", "/dev/random";
893         read $fh, my $bytes, 20;
894         close $fh;
895         return $bytes;
896     }
897
898 Or even more directly, replace C<generate_session_id>:
899
900     sub generate_session_id {
901         open my $fh, "<", "/dev/random";
902         read $fh, my $bytes, 20;
903         close $fh;
904         return unpack("H*", $bytes);
905     }
906
907 Also have a look at L<Crypt::Random> and the various openssl bindings - these
908 modules provide APIs for cryptographically secure random data.
909
910 =item finalize_session
911
912 Clean up the session during C<finalize>.
913
914 This clears the various accessors after saving to the store.
915
916 =item dump_these
917
918 See L<Catalyst/dump_these> - ammends the session data structure to the list of
919 dumped objects if session ID is defined.
920
921
922 =item calculate_extended_session_expires
923
924 =item calculate_initial_session_expires
925
926 =item create_session_id_if_needed
927
928 =item delete_session_id
929
930 =item extend_session_expires
931
932 =item extend_session_id
933
934 =item get_session_id
935
936 =item reset_session_expires
937
938 =item session_is_valid
939
940 =item set_session_id
941
942 =back
943
944 =head1 USING SESSIONS DURING PREPARE
945
946 The earliest point in time at which you may use the session data is after
947 L<Catalyst::Plugin::Session>'s C<prepare_action> has finished.
948
949 State plugins must set $c->session ID before C<prepare_action>, and during
950 C<prepare_action> L<Catalyst::Plugin::Session> will actually load the data from
951 the store.
952
953     sub prepare_action {
954         my $c = shift;
955
956         # don't touch $c->session yet!
957
958         $c->NEXT::prepare_action( @_ );
959
960         $c->session;  # this is OK
961         $c->sessionid; # this is also OK
962     }
963
964 =head1 CONFIGURATION
965
966     $c->config('Plugin::Session' => {
967         expires => 1234,
968     });
969
970 All configuation parameters are provided in a hash reference under the
971 C<Plugin::Session> key in the configuration hash.
972
973 =over 4
974
975 =item expires
976
977 The time-to-live of each session, expressed in seconds. Defaults to 7200 (two
978 hours).
979
980 =item verify_address
981
982 When true, C<<$c->request->address>> will be checked at prepare time. If it is
983 not the same as the address that initiated the session, the session is deleted.
984
985 Defaults to false.
986
987 =item verify_user_agent
988
989 When true, C<<$c->request->user_agent>> will be checked at prepare time. If it
990 is not the same as the user agent that initiated the session, the session is
991 deleted.
992
993 Defaults to false.
994
995 =item flash_to_stash
996
997 This option makes it easier to have actions behave the same whether they were
998 forwarded to or redirected to. On prepare time it copies the contents of
999 C<flash> (if any) to the stash.
1000
1001 =back
1002
1003 =head1 SPECIAL KEYS
1004
1005 The hash reference returned by C<< $c->session >> contains several keys which
1006 are automatically set:
1007
1008 =over 4
1009
1010 =item __expires
1011
1012 This key no longer exists. Use C<session_expires> instead.
1013
1014 =item __updated
1015
1016 The last time a session was saved to the store.
1017
1018 =item __created
1019
1020 The time when the session was first created.
1021
1022 =item __address
1023
1024 The value of C<< $c->request->address >> at the time the session was created.
1025 This value is only populated if C<verify_address> is true in the configuration.
1026
1027 =item __user_agent
1028
1029 The value of C<< $c->request->user_agent >> at the time the session was created.
1030 This value is only populated if C<verify_user_agent> is true in the configuration.
1031
1032 =back
1033
1034 =head1 CAVEATS
1035
1036 =head2 Round the Robin Proxies
1037
1038 C<verify_address> could make your site inaccessible to users who are behind
1039 load balanced proxies. Some ISPs may give a different IP to each request by the
1040 same client due to this type of proxying. If addresses are verified these
1041 users' sessions cannot persist.
1042
1043 To let these users access your site you can either disable address verification
1044 as a whole, or provide a checkbox in the login dialog that tells the server
1045 that it's OK for the address of the client to change. When the server sees that
1046 this box is checked it should delete the C<__address> special key from the
1047 session hash when the hash is first created.
1048
1049 =head2 Race Conditions
1050
1051 In this day and age where cleaning detergents and Dutch football (not the
1052 American kind) teams roam the plains in great numbers, requests may happen
1053 simultaneously. This means that there is some risk of session data being
1054 overwritten, like this:
1055
1056 =over 4
1057
1058 =item 1.
1059
1060 request a starts, request b starts, with the same session ID
1061
1062 =item 2.
1063
1064 session data is loaded in request a
1065
1066 =item 3.
1067
1068 session data is loaded in request b
1069
1070 =item 4.
1071
1072 session data is changed in request a
1073
1074 =item 5.
1075
1076 request a finishes, session data is updated and written to store
1077
1078 =item 6.
1079
1080 request b finishes, session data is updated and written to store, overwriting
1081 changes by request a
1082
1083 =back
1084
1085 If this is a concern in your application, a soon-to-be-developed locking
1086 solution is the only safe way to go. This will have a bigger overhead.
1087
1088 For applications where any given user is only making one request at a time this
1089 plugin should be safe enough.
1090
1091 =head1 AUTHORS
1092
1093 Andy Grundman
1094
1095 Christian Hansen
1096
1097 Yuval Kogman, C<nothingmuch@woobling.org>
1098
1099 Sebastian Riedel
1100
1101 Tomas Doran (t0m) C<bobtfish@bobtfish.net> (current maintainer)
1102
1103 Sergio Salvi
1104
1105 kmx C<kmx@volny.cz>
1106
1107 And countless other contributers from #catalyst. Thanks guys!
1108
1109 =head1 COPYRIGHT & LICENSE
1110
1111     Copyright (c) 2005 the aforementioned authors. All rights
1112     reserved. This program is free software; you can redistribute
1113     it and/or modify it under the same terms as Perl itself.
1114
1115 =cut
1116
1117