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