This patch makes it so that the expiry is not looked up in the underlying store when...
[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.28';
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     #
379     # since we're setting _session_expires directly, make load_session_expires
380     # actually use that value.
381     #
382     $c->_tried_loading_session_expires(1);
383     $c->_extended_session_expires( $exp );
384     $exp;
385 }
386
387 sub sessionid {
388     my $c = shift;
389
390     return $c->_sessionid || $c->_load_sessionid;
391 }
392
393 sub _load_sessionid {
394     my $c = shift;
395     return if $c->_tried_loading_session_id;
396     $c->_tried_loading_session_id(1);
397
398     if ( defined( my $sid = $c->get_session_id ) ) {
399         if ( $c->validate_session_id($sid) ) {
400             # temporarily set the inner key, so that validation will work
401             $c->_sessionid($sid);
402             return $sid;
403         } else {
404             my $err = "Tried to set invalid session ID '$sid'";
405             $c->log->error($err);
406             Catalyst::Exception->throw($err);
407         }
408     }
409
410     return;
411 }
412
413 sub session_is_valid {
414     my $c = shift;
415
416     # force a check for expiry, but also __address, etc
417     if ( $c->_load_session ) {
418         return 1;
419     } else {
420         return;
421     }
422 }
423
424 sub validate_session_id {
425     my ( $c, $sid ) = @_;
426
427     $sid and $sid =~ /^[a-f\d]+$/i;
428 }
429
430 sub session {
431     my $c = shift;
432
433     $c->_session || $c->_load_session || do {
434         $c->create_session_id_if_needed;
435         $c->initialize_session_data;
436     };
437 }
438
439 sub keep_flash {
440     my ( $c, @keys ) = @_;
441     my $href = $c->_flash_keep_keys || $c->_flash_keep_keys({});
442     (@{$href}{@keys}) = ((undef) x @keys);
443 }
444
445 sub _flash_data {
446     my $c = shift;
447     $c->_flash || $c->_load_flash || do {
448         $c->create_session_id_if_needed;
449         $c->_flash( {} );
450     };
451 }
452
453 sub _set_flash {
454     my $c = shift;
455     if (@_) {
456         my $items = @_ > 1 ? {@_} : $_[0];
457         croak('flash takes a hash or hashref') unless ref $items;
458         @{ $c->_flash }{ keys %$items } = values %$items;
459     }
460 }
461
462 sub flash {
463     my $c = shift;
464     $c->_flash_data;
465     $c->_set_flash(@_);
466     return $c->_flash;
467 }
468
469 sub clear_flash {
470     my $c = shift;
471
472     #$c->delete_session_data("flash:" . $c->sessionid); # should this be in here? or delayed till finalization?
473     $c->_flash_key_hashes({});
474     $c->_flash_keep_keys({});
475     $c->_flash({});
476 }
477
478 sub session_expire_key {
479     my ( $c, %keys ) = @_;
480
481     my $now = time;
482     @{ $c->session->{__expire_keys} }{ keys %keys } =
483       map { $now + $_ } values %keys;
484 }
485
486 sub initialize_session_data {
487     my $c = shift;
488
489     my $now = time;
490
491     return $c->_session(
492         {
493             __created => $now,
494             __updated => $now,
495
496             (
497                 $c->_session_plugin_config->{verify_address}
498                 ? ( __address => $c->request->address||'' )
499                 : ()
500             ),
501             (
502                 $c->_session_plugin_config->{verify_user_agent}
503                 ? ( __user_agent => $c->request->user_agent||'' )
504                 : ()
505             ),
506         }
507     );
508 }
509
510 sub generate_session_id {
511     my $c = shift;
512
513     my $digest = $c->_find_digest();
514     $digest->add( $c->session_hash_seed() );
515     return $digest->hexdigest;
516 }
517
518 sub create_session_id_if_needed {
519     my $c = shift;
520     $c->create_session_id unless $c->sessionid;
521 }
522
523 sub create_session_id {
524     my $c = shift;
525
526     my $sid = $c->generate_session_id;
527
528     $c->log->debug(qq/Created session "$sid"/) if $c->debug;
529
530     $c->_sessionid($sid);
531     $c->reset_session_expires;
532     $c->set_session_id($sid);
533
534     return $sid;
535 }
536
537 my $counter;
538
539 sub session_hash_seed {
540     my $c = shift;
541
542     return join( "", ++$counter, time, rand, $$, {}, overload::StrVal($c), );
543 }
544
545 my $usable;
546
547 sub _find_digest () {
548     unless ($usable) {
549         foreach my $alg (qw/SHA-1 SHA-256 MD5/) {
550             if ( eval { Digest->new($alg) } ) {
551                 $usable = $alg;
552                 last;
553             }
554         }
555         Catalyst::Exception->throw(
556                 "Could not find a suitable Digest module. Please install "
557               . "Digest::SHA1, Digest::SHA, or Digest::MD5" )
558           unless $usable;
559     }
560
561     return Digest->new($usable);
562 }
563
564 sub dump_these {
565     my $c = shift;
566
567     (
568         $c->maybe::next::method(),
569
570         $c->sessionid
571         ? ( [ "Session ID" => $c->sessionid ], [ Session => $c->session ], )
572         : ()
573     );
574 }
575
576
577 sub get_session_id { shift->maybe::next::method(@_) }
578 sub set_session_id { shift->maybe::next::method(@_) }
579 sub delete_session_id { shift->maybe::next::method(@_) }
580 sub extend_session_id { shift->maybe::next::method(@_) }
581
582 __PACKAGE__;
583
584 __END__
585
586 =pod
587
588 =head1 NAME
589
590 Catalyst::Plugin::Session - Generic Session plugin - ties together server side storage and client side state required to maintain session data.
591
592 =head1 SYNOPSIS
593
594     # To get sessions to "just work", all you need to do is use these plugins:
595
596     use Catalyst qw/
597       Session
598       Session::Store::FastMmap
599       Session::State::Cookie
600       /;
601
602     # you can replace Store::FastMmap with Store::File - both have sensible
603     # default configurations (see their docs for details)
604
605     # more complicated backends are available for other scenarios (DBI storage,
606     # etc)
607
608
609     # after you've loaded the plugins you can save session data
610     # For example, if you are writing a shopping cart, it could be implemented
611     # like this:
612
613     sub add_item : Local {
614         my ( $self, $c ) = @_;
615
616         my $item_id = $c->req->param("item");
617
618         # $c->session is a hash ref, a bit like $c->stash
619         # the difference is that it' preserved across requests
620
621         push @{ $c->session->{items} }, $item_id;
622
623         $c->forward("MyView");
624     }
625
626     sub display_items : Local {
627         my ( $self, $c ) = @_;
628
629         # values in $c->session are restored
630         $c->stash->{items_to_display} =
631           [ map { MyModel->retrieve($_) } @{ $c->session->{items} } ];
632
633         $c->forward("MyView");
634     }
635
636 =head1 DESCRIPTION
637
638 The Session plugin is the base of two related parts of functionality required
639 for session management in web applications.
640
641 The first part, the State, is getting the browser to repeat back a session key,
642 so that the web application can identify the client and logically string
643 several requests together into a session.
644
645 The second part, the Store, deals with the actual storage of information about
646 the client. This data is stored so that the it may be revived for every request
647 made by the same client.
648
649 This plugin links the two pieces together.
650
651 =head1 RECOMENDED BACKENDS
652
653 =over 4
654
655 =item Session::State::Cookie
656
657 The only really sane way to do state is using cookies.
658
659 =item Session::Store::File
660
661 A portable backend, based on Cache::File.
662
663 =item Session::Store::FastMmap
664
665 A fast and flexible backend, based on Cache::FastMmap.
666
667 =back
668
669 =head1 METHODS
670
671 =over 4
672
673 =item sessionid
674
675 An accessor for the session ID value.
676
677 =item session
678
679 Returns a hash reference that might contain unserialized values from previous
680 requests in the same session, and whose modified value will be saved for future
681 requests.
682
683 This method will automatically create a new session and session ID if none
684 exists.
685
686 =item session_expires
687
688 =item session_expires $reset
689
690 This method returns the time when the current session will expire, or 0 if
691 there is no current session. If there is a session and it already expired, it
692 will delete the session and return 0 as well.
693
694 If the C<$reset> parameter is true, and there is a session ID the expiry time
695 will be reset to the current time plus the time to live (see
696 L</CONFIGURATION>). This is used when creating a new session.
697
698 =item flash
699
700 This is like Ruby on Rails' flash data structure. Think of it as a stash that
701 lasts for longer than one request, letting you redirect instead of forward.
702
703 The flash data will be cleaned up only on requests on which actually use
704 $c->flash (thus allowing multiple redirections), and the policy is to delete
705 all the keys which haven't changed since the flash data was loaded at the end
706 of every request.
707
708     sub moose : Local {
709         my ( $self, $c ) = @_;
710
711         $c->flash->{beans} = 10;
712         $c->response->redirect( $c->uri_for("foo") );
713     }
714
715     sub foo : Local {
716         my ( $self, $c ) = @_;
717
718         my $value = $c->flash->{beans};
719
720         # ...
721
722         $c->response->redirect( $c->uri_for("bar") );
723     }
724
725     sub bar : Local {
726         my ( $self, $c ) = @_;
727
728         if ( exists $c->flash->{beans} ) { # false
729
730         }
731     }
732
733 =item clear_flash
734
735 Zap all the keys in the flash regardless of their current state.
736
737 =item keep_flash @keys
738
739 If you want to keep a flash key for the next request too, even if it hasn't
740 changed, call C<keep_flash> and pass in the keys as arguments.
741
742 =item delete_session REASON
743
744 This method is used to invalidate a session. It takes an optional parameter
745 which will be saved in C<session_delete_reason> if provided.
746
747 NOTE: This method will B<also> delete your flash data.
748
749 =item session_delete_reason
750
751 This accessor contains a string with the reason a session was deleted. Possible
752 values include:
753
754 =over 4
755
756 =item *
757
758 C<address mismatch>
759
760 =item *
761
762 C<session expired>
763
764 =back
765
766 =item session_expire_key $key, $ttl
767
768 Mark a key to expire at a certain time (only useful when shorter than the
769 expiry time for the whole session).
770
771 For example:
772
773     __PACKAGE__->config('Plugin::Session' => { expires => 1000000000000 }); # forever
774
775     # later
776
777     $c->session_expire_key( __user => 3600 );
778
779 Will make the session data survive, but the user will still be logged out after
780 an hour.
781
782 Note that these values are not auto extended.
783
784 =item change_session_id
785
786 By calling this method you can force a session id change while keeping all
787 session data. This method might come handy when you are paranoid about some
788 advanced variations of session fixation attack.
789
790 If you want to prevent this session fixation scenario:
791
792     0) let us have WebApp with anonymous and authenticated parts
793     1) a hacker goes to vulnerable WebApp and gets a real sessionid,
794        just by browsing anonymous part of WebApp
795     2) the hacker inserts (somehow) this values into a cookie in victim's browser
796     3) after the victim logs into WebApp the hacker can enter his/her session
797
798 you should call change_session_id in your login controller like this:
799
800       if ($c->authenticate( { username => $user, password => $pass } )) {
801         # login OK
802         $c->change_session_id;
803         ...
804       } else {
805         # login FAILED
806         ...
807       }
808
809 =back
810
811 =head1 INTERNAL METHODS
812
813 =over 4
814
815 =item setup
816
817 This method is extended to also make calls to
818 C<check_session_plugin_requirements> and C<setup_session>.
819
820 =item check_session_plugin_requirements
821
822 This method ensures that a State and a Store plugin are also in use by the
823 application.
824
825 =item setup_session
826
827 This method populates C<< $c->config('Plugin::Session') >> with the default values
828 listed in L</CONFIGURATION>.
829
830 =item prepare_action
831
832 This method is extended.
833
834 Its only effect is if the (off by default) C<flash_to_stash> configuration
835 parameter is on - then it will copy the contents of the flash to the stash at
836 prepare time.
837
838 =item finalize_headers
839
840 This method is extended and will extend the expiry time before sending
841 the response.
842
843 =item finalize_body
844
845 This method is extended and will call finalize_session before the other
846 finalize_body methods run.  Here we persist the session data if a session exists.
847
848 =item initialize_session_data
849
850 This method will initialize the internal structure of the session, and is
851 called by the C<session> method if appropriate.
852
853 =item create_session_id
854
855 Creates a new session ID using C<generate_session_id> if there is no session ID
856 yet.
857
858 =item validate_session_id SID
859
860 Make sure a session ID is of the right format.
861
862 This currently ensures that the session ID string is any amount of case
863 insensitive hexadecimal characters.
864
865 =item generate_session_id
866
867 This method will return a string that can be used as a session ID. It is
868 supposed to be a reasonably random string with enough bits to prevent
869 collision. It basically takes C<session_hash_seed> and hashes it using SHA-1,
870 MD5 or SHA-256, depending on the availability of these modules.
871
872 =item session_hash_seed
873
874 This method is actually rather internal to generate_session_id, but should be
875 overridable in case you want to provide more random data.
876
877 Currently it returns a concatenated string which contains:
878
879 =over 4
880
881 =item * A counter
882
883 =item * The current time
884
885 =item * One value from C<rand>.
886
887 =item * The stringified value of a newly allocated hash reference
888
889 =item * The stringified value of the Catalyst context object
890
891 =back
892
893 in the hopes that those combined values are entropic enough for most uses. If
894 this is not the case you can replace C<session_hash_seed> with e.g.
895
896     sub session_hash_seed {
897         open my $fh, "<", "/dev/random";
898         read $fh, my $bytes, 20;
899         close $fh;
900         return $bytes;
901     }
902
903 Or even more directly, replace C<generate_session_id>:
904
905     sub generate_session_id {
906         open my $fh, "<", "/dev/random";
907         read $fh, my $bytes, 20;
908         close $fh;
909         return unpack("H*", $bytes);
910     }
911
912 Also have a look at L<Crypt::Random> and the various openssl bindings - these
913 modules provide APIs for cryptographically secure random data.
914
915 =item finalize_session
916
917 Clean up the session during C<finalize>.
918
919 This clears the various accessors after saving to the store.
920
921 =item dump_these
922
923 See L<Catalyst/dump_these> - ammends the session data structure to the list of
924 dumped objects if session ID is defined.
925
926
927 =item calculate_extended_session_expires
928
929 =item calculate_initial_session_expires
930
931 =item create_session_id_if_needed
932
933 =item delete_session_id
934
935 =item extend_session_expires
936
937 =item extend_session_id
938
939 =item get_session_id
940
941 =item reset_session_expires
942
943 =item session_is_valid
944
945 =item set_session_id
946
947 =back
948
949 =head1 USING SESSIONS DURING PREPARE
950
951 The earliest point in time at which you may use the session data is after
952 L<Catalyst::Plugin::Session>'s C<prepare_action> has finished.
953
954 State plugins must set $c->session ID before C<prepare_action>, and during
955 C<prepare_action> L<Catalyst::Plugin::Session> will actually load the data from
956 the store.
957
958     sub prepare_action {
959         my $c = shift;
960
961         # don't touch $c->session yet!
962
963         $c->NEXT::prepare_action( @_ );
964
965         $c->session;  # this is OK
966         $c->sessionid; # this is also OK
967     }
968
969 =head1 CONFIGURATION
970
971     $c->config('Plugin::Session' => {
972         expires => 1234,
973     });
974
975 All configuation parameters are provided in a hash reference under the
976 C<Plugin::Session> key in the configuration hash.
977
978 =over 4
979
980 =item expires
981
982 The time-to-live of each session, expressed in seconds. Defaults to 7200 (two
983 hours).
984
985 =item verify_address
986
987 When true, C<<$c->request->address>> will be checked at prepare time. If it is
988 not the same as the address that initiated the session, the session is deleted.
989
990 Defaults to false.
991
992 =item verify_user_agent
993
994 When true, C<<$c->request->user_agent>> will be checked at prepare time. If it
995 is not the same as the user agent that initiated the session, the session is
996 deleted.
997
998 Defaults to false.
999
1000 =item flash_to_stash
1001
1002 This option makes it easier to have actions behave the same whether they were
1003 forwarded to or redirected to. On prepare time it copies the contents of
1004 C<flash> (if any) to the stash.
1005
1006 =back
1007
1008 =head1 SPECIAL KEYS
1009
1010 The hash reference returned by C<< $c->session >> contains several keys which
1011 are automatically set:
1012
1013 =over 4
1014
1015 =item __expires
1016
1017 This key no longer exists. Use C<session_expires> instead.
1018
1019 =item __updated
1020
1021 The last time a session was saved to the store.
1022
1023 =item __created
1024
1025 The time when the session was first created.
1026
1027 =item __address
1028
1029 The value of C<< $c->request->address >> at the time the session was created.
1030 This value is only populated if C<verify_address> is true in the configuration.
1031
1032 =item __user_agent
1033
1034 The value of C<< $c->request->user_agent >> at the time the session was created.
1035 This value is only populated if C<verify_user_agent> is true in the configuration.
1036
1037 =back
1038
1039 =head1 CAVEATS
1040
1041 =head2 Round the Robin Proxies
1042
1043 C<verify_address> could make your site inaccessible to users who are behind
1044 load balanced proxies. Some ISPs may give a different IP to each request by the
1045 same client due to this type of proxying. If addresses are verified these
1046 users' sessions cannot persist.
1047
1048 To let these users access your site you can either disable address verification
1049 as a whole, or provide a checkbox in the login dialog that tells the server
1050 that it's OK for the address of the client to change. When the server sees that
1051 this box is checked it should delete the C<__address> special key from the
1052 session hash when the hash is first created.
1053
1054 =head2 Race Conditions
1055
1056 In this day and age where cleaning detergents and Dutch football (not the
1057 American kind) teams roam the plains in great numbers, requests may happen
1058 simultaneously. This means that there is some risk of session data being
1059 overwritten, like this:
1060
1061 =over 4
1062
1063 =item 1.
1064
1065 request a starts, request b starts, with the same session ID
1066
1067 =item 2.
1068
1069 session data is loaded in request a
1070
1071 =item 3.
1072
1073 session data is loaded in request b
1074
1075 =item 4.
1076
1077 session data is changed in request a
1078
1079 =item 5.
1080
1081 request a finishes, session data is updated and written to store
1082
1083 =item 6.
1084
1085 request b finishes, session data is updated and written to store, overwriting
1086 changes by request a
1087
1088 =back
1089
1090 If this is a concern in your application, a soon-to-be-developed locking
1091 solution is the only safe way to go. This will have a bigger overhead.
1092
1093 For applications where any given user is only making one request at a time this
1094 plugin should be safe enough.
1095
1096 =head1 AUTHORS
1097
1098 Andy Grundman
1099
1100 Christian Hansen
1101
1102 Yuval Kogman, C<nothingmuch@woobling.org>
1103
1104 Sebastian Riedel
1105
1106 Tomas Doran (t0m) C<bobtfish@bobtfish.net> (current maintainer)
1107
1108 Sergio Salvi
1109
1110 kmx C<kmx@volny.cz>
1111
1112 Florian Ragwitz (rafl) C<rafl@debian.org>
1113
1114 Kent Fredric (kentnl)
1115
1116 And countless other contributers from #catalyst. Thanks guys!
1117
1118 =head1 COPYRIGHT & LICENSE
1119
1120     Copyright (c) 2005 the aforementioned authors. All rights
1121     reserved. This program is free software; you can redistribute
1122     it and/or modify it under the same terms as Perl itself.
1123
1124 =cut
1125
1126