X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FSession.pm;h=470fd113affb26155dcef9e0b3fec647689ab001;hb=refs%2Fremotes%2Fmirror%2Fpeople%2Fdhoss%2Ffix-rt-71142;hp=3b8d60fde528589c44fdd8fe02d08250f82ba348;hpb=340449a2298791740760b77b9837439226563e72;p=catagits%2FCatalyst-Plugin-Session.git diff --git a/lib/Catalyst/Plugin/Session.pm b/lib/Catalyst/Plugin/Session.pm index 3b8d60f..470fd11 100644 --- a/lib/Catalyst/Plugin/Session.pm +++ b/lib/Catalyst/Plugin/Session.pm @@ -1,27 +1,30 @@ #!/usr/bin/perl package Catalyst::Plugin::Session; -use base qw/Class::Accessor::Fast/; -use strict; -use warnings; - -use NEXT; +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.07"; +our $VERSION = '0.33'; +$VERSION = eval $VERSION; my @session_data_accessors; # used in delete_session -BEGIN { - __PACKAGE__->mk_accessors( + +__PACKAGE__->mk_accessors( "_session_delete_reason", @session_data_accessors = qw/ _sessionid _session _session_expires + _extended_session_expires _session_data_sig _flash _flash_keep_keys @@ -31,13 +34,21 @@ BEGIN { _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->NEXT::setup(@_); + $c->maybe::next::method(@_); $c->check_session_plugin_requirements; $c->setup_session; @@ -63,54 +74,81 @@ sub check_session_plugin_requirements { sub setup_session { my $c = shift; - my $cfg = ( $c->config->{session} ||= {} ); + my $cfg = $c->_session_plugin_config; %$cfg = ( expires => 7200, - verify_address => 1, + verify_address => 0, + verify_user_agent => 0, %$cfg, ); - $c->NEXT::setup_session(); + $c->maybe::next::method(); } sub prepare_action { my $c = shift; - if ( $c->config->{session}{flash_to_stash} + $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; + + # Force extension of session_expires before finalizing headers, so a possible cookie will be + # up to date. First call to session_expires will extend the expiry, subsequent calls will + # just return the previously extended value. + $c->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; - $c->NEXT::prepare_action(@_); + return $c->maybe::next::method(@_); } -sub finalize { +sub finalize_session { my $c = shift; + $c->maybe::next::method(@_); + $c->_save_session_expires; + $c->_save_session_id; $c->_save_session; $c->_save_flash; - $c->_save_session_id; - $c->NEXT::finalize(@_); + $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(my $expires = $c->_session_expires) ) { + if ( defined($c->_session_expires) ) { + my $expires = $c->session_expires; # force extension + my $sid = $c->sessionid; $c->store_session_data( "expires:$sid" => $expires ); - - $c->_session_expires(undef); - $c->_tried_loading_session_expires(undef); } } @@ -127,9 +165,6 @@ sub _save_session { my $sid = $c->sessionid; $c->store_session_data( "session:$sid" => $session_data ); } - - $c->_session(undef); - $c->_tried_loading_session_data(undef); } } @@ -145,18 +180,18 @@ sub _save_flash { delete $flash_data->{$key}; } } - + my $sid = $c->sessionid; + my $session_data = $c->_session; if (%$flash_data) { - $c->store_session_data( "flash:$sid", $flash_data ); + $session_data->{__flash} = $flash_data; } else { - $c->delete_session_data("flash:$sid"); + delete $session_data->{__flash}; } - - $c->_flash(undef); - $c->_tried_loading_flash_data(undef); + $c->_session($session_data); + $c->_save_session; } } @@ -169,7 +204,8 @@ sub _load_session_expires { my $expires = $c->get_session_data("expires:$sid") || 0; if ( $expires >= time() ) { - return $c->extend_session_expires( $expires ); + $c->_session_expires( $expires ); + return $expires; } else { $c->delete_session( "session expired" ); return 0; @@ -185,13 +221,14 @@ sub _load_session { $c->_tried_loading_session_data(1); if ( my $sid = $c->sessionid ) { - if ( $c->session_expires ) { # > 0 + 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->config->{session}{verify_address} + if ( $c->_session_plugin_config->{verify_address} + && exists $session_data->{__address} && $session_data->{__address} ne $c->request->address ) { $c->log->warn( @@ -202,6 +239,17 @@ sub _load_session { $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; @@ -220,11 +268,14 @@ sub _load_flash { $c->_tried_loading_flash_data(1); if ( my $sid = $c->sessionid ) { - if ( my $flash_data = $c->_flash - || $c->_flash( $c->get_session_data("flash:$sid") ) ) + + 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; } } @@ -244,10 +295,34 @@ sub _expire_session_keys { } } +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") if $c->debug; + $c->log->debug("Deleting session" . ( defined($msg) ? "($msg)" : '(no reason given)') ) if $c->debug; # delete the session data if ( my $sid = $c->sessionid ) { @@ -257,7 +332,7 @@ sub delete_session { # reset the values in the context object # see the BEGIN block - $c->$_(undef) for @session_data_accessors; + $c->_clear_session_instance_data; $c->_session_delete_reason($msg); } @@ -273,11 +348,10 @@ sub session_delete_reason { sub session_expires { my $c = shift; - if ( defined( my $expires = $c->_session_expires ) ) { + if ( defined( my $expires = $c->_extended_session_expires ) ) { return $expires; } elsif ( defined( $expires = $c->_load_session_expires ) ) { - $c->_session_expires($expires); - return $expires; + return $c->extend_session_expires( $expires ); } else { return 0; } @@ -285,14 +359,14 @@ sub session_expires { sub extend_session_expires { my ( $c, $expires ) = @_; - $c->_session_expires( my $updated = $c->calculate_extended_session_expires( $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->config->{session}{expires} ); + return ( time() + $c->_session_plugin_config->{expires} ); } sub calculate_extended_session_expires { @@ -302,13 +376,21 @@ sub calculate_extended_session_expires { sub reset_session_expires { my ( $c, $sid ) = @_; - $c->_session_expires( my $exp = $c->calculate_initial_session_expires ); + + 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; } @@ -319,7 +401,8 @@ sub _load_sessionid { if ( defined( my $sid = $c->get_session_id ) ) { if ( $c->validate_session_id($sid) ) { - $c->_sessionid( $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'"; @@ -351,10 +434,21 @@ sub validate_session_id { sub session { my $c = shift; - $c->_session || $c->_load_session || do { + 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 { @@ -363,14 +457,39 @@ sub keep_flash { (@{$href}{@keys}) = ((undef) x @keys); } -sub flash { +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 ) = @_; @@ -390,8 +509,13 @@ sub initialize_session_data { __updated => $now, ( - $c->config->{session}{verify_address} - ? ( __address => $c->request->address ) + $c->_session_plugin_config->{verify_address} + ? ( __address => $c->request->address||'' ) + : () + ), + ( + $c->_session_plugin_config->{verify_user_agent} + ? ( __user_agent => $c->request->user_agent||'' ) : () ), } @@ -413,7 +537,7 @@ sub create_session_id_if_needed { sub create_session_id { my $c = shift; - + my $sid = $c->generate_session_id; $c->log->debug(qq/Created session "$sid"/) if $c->debug; @@ -456,19 +580,19 @@ sub dump_these { my $c = shift; ( - $c->NEXT::dump_these(), + $c->maybe::next::method(), - $c->sessionid + $c->_sessionid ? ( [ "Session ID" => $c->sessionid ], [ Session => $c->session ], ) : () ); } -sub get_session_id { shift->NEXT::get_session_id(@_) } -sub set_session_id { shift->NEXT::set_session_id(@_) } -sub delete_session_id { shift->NEXT::delete_session_id(@_) } -sub extend_session_id { shift->NEXT::extend_session_id(@_) } +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__; @@ -478,8 +602,7 @@ __END__ =head1 NAME -Catalyst::Plugin::Session - Generic Session plugin - ties together server side -storage and client side state required to maintain session data. +Catalyst::Plugin::Session - Generic Session plugin - ties together server side storage and client side state required to maintain session data. =head1 SYNOPSIS @@ -491,11 +614,11 @@ storage and client side state required to maintain session data. Session::State::Cookie /; - # you can replace Store::FastMmap with Store::File - both have sensible - # default configurations (see their docs for details) + # 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) + # more complicated backends are available for other scenarios (DBI storage, + # etc) # after you've loaded the plugins you can save session data @@ -540,7 +663,7 @@ made by the same client. This plugin links the two pieces together. -=head1 RECCOMENDED BACKENDS +=head1 RECOMENDED BACKENDS =over 4 @@ -575,6 +698,13 @@ 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 @@ -597,6 +727,15 @@ $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. +Note that use of the flash is an easy way to get data across requests, but +it's also strongly disrecommended, due it it being inherently plagued with +race conditions. This means that it's unlikely to work well if your +users have multiple tabs open at once, or if your site does a lot of AJAX +requests. + +L is the recommended alternative solution, +as this doesn't suffer from these issues. + sub moose : Local { my ( $self, $c ) = @_; @@ -618,13 +757,17 @@ of every request. 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 wawnt to keep a flash key for the next request too, even if it hasn't +If you want to keep a flash key for the next request too, even if it hasn't changed, call C and pass in the keys as arguments. =item delete_session REASON @@ -632,6 +775,8 @@ changed, call C and pass in the keys as arguments. This method is used to invalidate a session. It takes an optional parameter which will be saved in C if provided. +NOTE: This method will B delete your flash data. + =item session_delete_reason This accessor contains a string with the reason a session was deleted. Possible @@ -656,7 +801,8 @@ expiry time for the whole session). For example: - __PACKAGE__->config->{session}{expires} = 1000000000000; # forever + __PACKAGE__->config('Plugin::Session' => { expires => 10000000000 }); # "forever" + (NB If this number is too large, Y2K38 breakage could result.) # later @@ -667,6 +813,31 @@ 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 @@ -685,21 +856,26 @@ application. =item setup_session -This method populates C<< $c->config->{session} >> with the default values +This method populates C<< $c->config('Plugin::Session') >> with the default values listed in L. =item prepare_action -This methoid is extended. +This method is extended. -It's only effect is if the (off by default) C configuration +Its only effect is if the (off by default) C configuration parameter is on - then it will copy the contents of the flash to the stash at prepare time. -=item finalize +=item finalize_headers + +This method is extended and will extend the expiry time before sending +the response. -This method is extended and will extend the expiry time, as well as persist the -session data if a session exists. +=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 @@ -708,7 +884,7 @@ called by the C method if appropriate. =item create_session_id -Creates a new session id using C if there is no session ID +Creates a new session ID using C if there is no session ID yet. =item validate_session_id SID @@ -723,7 +899,7 @@ insensitive hexadecimal characters. 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 and hashes it using SHA-1, -MD5 or SHA-256, depending on the availibility of these modules. +MD5 or SHA-256, depending on the availability of these modules. =item session_hash_seed @@ -734,29 +910,19 @@ Currently it returns a concatenated string which contains: =over 4 -=item * - -A counter - -=item * - -The current time +=item * A counter -=item * - -One value from C. +=item * The current time -=item * +=item * One value from C. -The stringified value of a newly allocated hash reference +=item * The stringified value of a newly allocated hash reference -=item * - -The stringified value of the Catalyst context object +=item * The stringified value of the Catalyst context object =back -In the hopes that those combined values are entropic enough for most uses. If +in the hopes that those combined values are entropic enough for most uses. If this is not the case you can replace C with e.g. sub session_hash_seed { @@ -778,11 +944,38 @@ Or even more directly, replace C: Also have a look at L and the various openssl bindings - these modules provide APIs for cryptographically secure random data. +=item finalize_session + +Clean up the session during C. + +This clears the various accessors after saving to the store. + =item dump_these See L - 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 @@ -794,25 +987,25 @@ State plugins must set $c->session ID before C, and during C L will actually load the data from the store. - sub prepare_action { - my $c = shift; + sub prepare_action { + my $c = shift; - # don't touch $c->session yet! + # don't touch $c->session yet! - $c->NEXT::prepare_action( @_ ); + $c->NEXT::prepare_action( @_ ); - $c->session; # this is OK - $c->sessionid; # this is also OK - } + $c->session; # this is OK + $c->sessionid; # this is also OK + } =head1 CONFIGURATION - $c->config->{session} = { + $c->config('Plugin::Session' => { expires => 1234, - }; + }); All configuation parameters are provided in a hash reference under the -C key in the configuration hash. +C key in the configuration hash. =over 4 @@ -826,6 +1019,16 @@ hours). 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 @@ -858,6 +1061,11 @@ The time when the session was first created. The value of C<< $c->request->address >> at the time the session was created. This value is only populated if C 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 is true in the configuration. + =back =head1 CAVEATS @@ -872,13 +1080,13 @@ 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> sepcial key from the +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 +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: @@ -886,7 +1094,7 @@ overwritten, like this: =item 1. -request a starts, request b starts, with the same session id +request a starts, request b starts, with the same session ID =item 2. @@ -911,33 +1119,40 @@ changes by request a =back -If this is a concern in your application, a soon to be developed locking -solution is the only safe way to go. This will have a bigger overhead. - -For applications where any given user is only making one request at a time this -plugin should be safe enough. +For applications where any given user's session is only making one request +at a time this plugin should be safe enough. =head1 AUTHORS -=over 4 +Andy Grundman -=item Andy Grundman +Christian Hansen -=item Christian Hansen +Yuval Kogman, C -=item Yuval Kogman, C (current maintainer) +Sebastian Riedel -=item Sebastian Riedel +Tomas Doran (t0m) C (current maintainer) -=back +Sergio Salvi + +kmx C + +Florian Ragwitz (rafl) C + +Kent Fredric (kentnl) And countless other contributers from #catalyst. Thanks guys! +=head1 Contributors + +Devin Austin (dhoss) + =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. + 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