X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Plugin-Session-State-Cookie.git;a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FSession%2FState%2FCookie.pm;h=aae53326c48ca9fc6adc650b11adc65dbdd230ac;hp=a87ccc892602cd8c20989e48036f5b39c564620c;hb=d2cf2047cb7892e69e434b621321d1b3d410e0f1;hpb=8bdcbb468aedff34275a7fb30b18ea8be066255b diff --git a/lib/Catalyst/Plugin/Session/State/Cookie.pm b/lib/Catalyst/Plugin/Session/State/Cookie.pm index a87ccc8..aae5332 100644 --- a/lib/Catalyst/Plugin/Session/State/Cookie.pm +++ b/lib/Catalyst/Plugin/Session/State/Cookie.pm @@ -1,18 +1,20 @@ package Catalyst::Plugin::Session::State::Cookie; -use base qw/Catalyst::Plugin::Session::State/; +use base qw/Catalyst::Plugin::Session::State Class::Accessor::Fast/; use strict; use warnings; -use NEXT; +use MRO::Compat; use Catalyst::Utils (); -our $VERSION = "0.05"; +our $VERSION = "0.11"; + +BEGIN { __PACKAGE__->mk_accessors(qw/_deleted_session_id/) } sub setup_session { my $c = shift; - $c->NEXT::setup_session(@_); + $c->maybe::next::method(@_); $c->config->{session}{cookie_name} ||= Catalyst::Utils::appprefix($c) . '_session'; @@ -25,7 +27,7 @@ sub extend_session_id { $c->update_session_cookie( $c->make_session_cookie( $sid ) ); } - $c->NEXT::extend_session_id( @_ ); + $c->maybe::next::method( $sid, $expires ); } sub set_session_id { @@ -33,7 +35,7 @@ sub set_session_id { $c->update_session_cookie( $c->make_session_cookie( $sid ) ); - return $c->NEXT::set_session_id(@_); + return $c->maybe::next::method($sid); } sub update_session_cookie { @@ -49,7 +51,7 @@ sub cookie_is_rejecting { my ( $c, $cookie ) = @_; if ( $cookie->{path} ) { - return 1 if index $c->request->path, $cookie->{path}; + return 1 if index '/'.$c->request->path, $cookie->{path}; } return 0; @@ -70,21 +72,27 @@ sub make_session_cookie { $cookie->{expires} = $c->calculate_session_cookie_expires(); } - $cookie->{secure} = 1 if $cfg->{cookie_secure}; + #beware: we have to accept also the old syntax "cookie_secure = true" + my $sec = $cfg->{cookie_secure} || 0; # default = 0 (not set) + $cookie->{secure} = 1 unless ( ($sec==0) || ($sec==2) ); + $cookie->{secure} = 1 if ( ($sec==2) && $c->req->secure ); + + my $hto = $cookie->{httponly} || 1; # default = 1 (set httponly) + $cookie->{httponly} = 1 unless ($hto==0); return $cookie; } sub calc_expiry { # compat my $c = shift; - $c->NEXT::calc_expiry( @_ ) || $c->calculate_session_cookie_expires( @_ ); + $c->maybe::next::method( @_ ) || $c->calculate_session_cookie_expires( @_ ); } sub calculate_session_cookie_expires { my $c = shift; my $cfg = $c->config->{session}; - my $value = $c->NEXT::calculate_session_cookie_expires(@_); + my $value = $c->maybe::next::method(@_); return $value if $value; if ( exists $cfg->{cookie_expires} ) { @@ -111,21 +119,23 @@ sub get_session_cookie { sub get_session_id { my $c = shift; - if ( my $cookie = $c->get_session_cookie ) { + if ( !$c->_deleted_session_id and my $cookie = $c->get_session_cookie ) { my $sid = $cookie->value; $c->log->debug(qq/Found sessionid "$sid" in cookie/) if $c->debug; return $sid if $sid; } - $c->NEXT::get_session_id(@_); + $c->maybe::next::method(@_); } sub delete_session_id { my ( $c, $sid ) = @_; + + $c->_deleted_session_id(1); # to prevent get_session_id from returning it $c->update_session_cookie( $c->make_session_cookie( $sid, expires => 0 ) ); - $c->NEXT::delete_session_id($sid); + $c->maybe::next::method($sid); } __PACKAGE__ @@ -161,6 +171,22 @@ Returns a hash reference with the default values for new cookies. Sets the cookie based on C in the response object. +=item calc_expiry + +=item calculate_session_cookie_expires + +=item cookie_is_rejecting + +=item delete_session_id + +=item extend_session_id + +=item get_session_cookie + +=item get_session_id + +=item set_session_id + =back =head1 EXTENDED METHODS @@ -173,12 +199,12 @@ Will restore if an appropriate cookie is found. =item finalize_cookies -Will set a cookie called C if it doesn't exist or if it's value is not +Will set a cookie called C if it doesn't exist or if its value is not the current session id. =item setup_session -Will set the C parameter to it's default value if it isn't set. +Will set the C parameter to its default value if it isn't set. =back @@ -202,7 +228,34 @@ user's browser is shut down. =item cookie_secure -If this attribute set true, the cookie will only be sent via HTTPS. +If this attribute B the cookie will not have the secure flag. + +If this attribute B (or true for backward compatibility) - the cookie +send by the server to the client will got the secure flag that tells the browser +to send this cookies back to the server only via HTTPS. + +If this attribute B then the cookie will got the secure flag only if +the request that caused cookie generation was sent over https (this option is +not good if you are mixing https and http in you application). + +Default vaule is 0. + +=item cookie_httponly + +If this attribute B, the cookie will not have HTTPOnly flag. + +If this attribute B, the cookie will got HTTPOnly flag that should +prevent client side Javascript accessing the cookie value - this makes some +sort of session hijacking attacks significantly harder. Unfortunately not all +browsers support this flag (MSIE 6 SP1+, Firefox 3.0.0.6+, Opera 9.5+); if +a browser is not aware of HTTPOnly the flag will be ignored. + +Default value is 1. + +Note1: Many peole are confused by the name "HTTPOnly" - it B +that this cookie works only over HTTP and not over HTTPS. + +Note2: This paramater requires Catalyst::Runtime 5.80005 otherwise is skipped. =item cookie_path @@ -210,6 +263,12 @@ The path of the request url where cookie should be baked. =back +For example, you could stick this in MyApp.pm: + + __PACKAGE__->config( session => { + cookie_domain => '.mydomain.com', + }); + =head1 CAVEATS Sessions have to be created before the first write to be saved. For example: @@ -230,15 +289,19 @@ L, L. =head1 AUTHORS +Yuval Kogman Enothingmuch@woobling.orgE + +=head1 CONTRIBUTORS + This module is derived from L code, and has been heavily modified since. -Andrew Ford -Andy Grundman -Christian Hansen -Yuval Kogman, C -Marcus Ramberg -Sebastian Riedel + Andrew Ford + Andy Grundman + Christian Hansen + Marcus Ramberg + Jonathan Rockway Ejrockway@cpan.orgE + Sebastian Riedel =head1 COPYRIGHT