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