C::P::Session::State::Cookie - changes in option cookie_secure + new option cookie_ht...
[catagits/Catalyst-Plugin-Session-State-Cookie.git] / lib / Catalyst / Plugin / Session / State / Cookie.pm
index 144442c..aae5332 100644 (file)
@@ -4,17 +4,17 @@ 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.10";
+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';
@@ -27,7 +27,7 @@ sub extend_session_id {
         $c->update_session_cookie( $c->make_session_cookie( $sid ) );
     }
 
-    $c->NEXT::extend_session_id( $sid, $expires );
+    $c->maybe::next::method( $sid, $expires );
 }
 
 sub set_session_id {
@@ -35,7 +35,7 @@ sub set_session_id {
 
     $c->update_session_cookie( $c->make_session_cookie( $sid ) );
 
-    return $c->NEXT::set_session_id($sid);
+    return $c->maybe::next::method($sid);
 }
 
 sub update_session_cookie {
@@ -72,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} ) {
@@ -119,7 +125,7 @@ sub get_session_id {
         return $sid if $sid;
     }
 
-    $c->NEXT::get_session_id(@_);
+    $c->maybe::next::method(@_);
 }
 
 sub delete_session_id {
@@ -129,7 +135,7 @@ sub delete_session_id {
 
     $c->update_session_cookie( $c->make_session_cookie( $sid, expires => 0 ) );
 
-    $c->NEXT::delete_session_id($sid);
+    $c->maybe::next::method($sid);
 }
 
 __PACKAGE__
@@ -222,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<set to 0> the cookie will not have the secure flag.
+
+If this attribute B<set to 1> (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<set to 2> 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<set to 0>, the cookie will not have HTTPOnly flag.
+
+If this attribute B<set to 1>, 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<does not mean>
+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