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