1 package Catalyst::Plugin::Session::State::Cookie;
3 use namespace::autoclean;
5 extends 'Catalyst::Plugin::Session::State';
8 use Catalyst::Utils ();
10 our $VERSION = "0.17";
12 has _deleted_session_id => ( is => 'rw' );
17 $c->maybe::next::method(@_);
19 $c->_session_plugin_config->{cookie_name}
20 ||= Catalyst::Utils::appprefix($c) . '_session';
23 sub extend_session_id {
24 my ( $c, $sid, $expires ) = @_;
26 if ( my $cookie = $c->get_session_cookie ) {
27 $c->update_session_cookie( $c->make_session_cookie( $sid ) );
30 $c->maybe::next::method( $sid, $expires );
36 $c->update_session_cookie( $c->make_session_cookie( $sid ) );
38 return $c->maybe::next::method($sid);
41 sub update_session_cookie {
42 my ( $c, $updated ) = @_;
44 unless ( $c->cookie_is_rejecting( $updated ) ) {
45 my $cookie_name = $c->_session_plugin_config->{cookie_name};
46 $c->response->cookies->{$cookie_name} = $updated;
50 sub cookie_is_rejecting {
51 my ( $c, $cookie ) = @_;
53 if ( $cookie->{path} ) {
54 return 1 if index '/'.$c->request->path, $cookie->{path};
60 sub make_session_cookie {
61 my ( $c, $sid, %attrs ) = @_;
63 my $cfg = $c->_session_plugin_config;
66 ( $cfg->{cookie_domain} ? ( domain => $cfg->{cookie_domain} ) : () ),
67 ( $cfg->{cookie_path} ? ( path => $cfg->{cookie_path} ) : () ),
71 unless ( exists $cookie->{expires} ) {
72 $cookie->{expires} = $c->calculate_session_cookie_expires();
75 #beware: we have to accept also the old syntax "cookie_secure = true"
76 my $sec = $cfg->{cookie_secure} || 0; # default = 0 (not set)
77 $cookie->{secure} = 1 unless ( ($sec==0) || ($sec==2) );
78 $cookie->{secure} = 1 if ( ($sec==2) && $c->req->secure );
80 $cookie->{httponly} = $cfg->{cookie_httponly};
81 $cookie->{httponly} = 1
82 unless defined $cookie->{httponly}; # default = 1 (set httponly)
84 $cookie->{samesite} = $cfg->{cookie_samesite};
85 $cookie->{samesite} = "Lax"
86 unless defined $cookie->{ samesite}; # default = Lax
91 sub calc_expiry { # compat
93 $c->maybe::next::method( @_ ) || $c->calculate_session_cookie_expires( @_ );
96 sub calculate_session_cookie_expires {
98 my $cfg = $c->_session_plugin_config;
100 my $value = $c->maybe::next::method(@_);
101 return $value if $value;
103 if ( exists $cfg->{cookie_expires} ) {
104 if ( $cfg->{cookie_expires} > 0 ) {
105 return time() + $cfg->{cookie_expires};
112 return $c->session_expires;
116 sub get_session_cookie {
119 my $cookie_name = $c->_session_plugin_config->{cookie_name};
121 return $c->request->cookies->{$cookie_name};
127 if ( !$c->_deleted_session_id and my $cookie = $c->get_session_cookie ) {
128 my $sid = $cookie->value;
129 $c->log->debug(qq/Found sessionid "$sid" in cookie/) if $c->debug;
133 $c->maybe::next::method(@_);
136 sub delete_session_id {
137 my ( $c, $sid ) = @_;
139 $c->_deleted_session_id(1); # to prevent get_session_id from returning it
141 $c->update_session_cookie( $c->make_session_cookie( $sid, expires => 0 ) );
143 $c->maybe::next::method($sid);
151 Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies.
155 use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/;
159 In order for L<Catalyst::Plugin::Session> to work the session ID needs to be
160 stored on the client, and the session data needs to be stored on the server.
162 This plugin stores the session ID on the client using the cookie mechanism.
168 =item make_session_cookie
170 Returns a hash reference with the default values for new cookies.
172 =item update_session_cookie $hash_ref
174 Sets the cookie based on C<cookie_name> in the response object.
178 =item calculate_session_cookie_expires
180 =item cookie_is_rejecting
182 =item delete_session_id
184 =item extend_session_id
186 =item get_session_cookie
194 =head1 EXTENDED METHODS
198 =item prepare_cookies
200 Will restore if an appropriate cookie is found.
202 =item finalize_cookies
204 Will set a cookie called C<session> if it doesn't exist or if its value is not
205 the current session id.
209 Will set the C<cookie_name> parameter to its default value if it isn't set.
219 The name of the cookie to store (defaults to C<Catalyst::Utils::apprefix($c) . '_session'>).
223 The name of the domain to store in the cookie (defaults to current host)
227 Number of seconds from now you want to elapse before cookie will expire.
228 Set to 0 to create a session cookie, ie one which will die when the
229 user's browser is shut down.
233 If this attribute B<set to 0> the cookie will not have the secure flag.
235 If this attribute B<set to 1> (or true for backward compatibility) - the cookie
236 sent by the server to the client will get the secure flag that tells the browser
237 to send this cookie back to the server only via HTTPS.
239 If this attribute B<set to 2> then the cookie will get the secure flag only if
240 the request that caused cookie generation was sent over https (this option is
241 not good if you are mixing https and http in your application).
245 =item cookie_httponly
247 If this attribute B<set to 0>, the cookie will not have HTTPOnly flag.
249 If this attribute B<set to 1>, the cookie will got HTTPOnly flag that should
250 prevent client side Javascript accessing the cookie value - this makes some
251 sort of session hijacking attacks significantly harder. Unfortunately not all
252 browsers support this flag (MSIE 6 SP1+, Firefox 3.0.0.6+, Opera 9.5+); if
253 a browser is not aware of HTTPOnly the flag will be ignored.
257 Note1: Many people are confused by the name "HTTPOnly" - it B<does not mean>
258 that this cookie works only over HTTP and not over HTTPS.
260 Note2: This parameter requires Catalyst::Runtime 5.80005 otherwise is skipped.
262 =item cookie_samesite
264 This attribute configures the value of the
265 L<SameSite|https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite>
268 If set to None, the cookie will be sent when making cross origin requests,
269 including following links from other origins. This requires the
270 L</cookie_secure> flag to be set.
272 If set to Lax, the cookie will not be included when embedded in or fetched from
273 other origins, but will be included when following cross origin links.
275 If set to Strict, the cookie will not be included for any cross origin requests,
276 including links from different origins.
278 Default value is C<Lax>. This is the default modern browsers use.
280 Note: This parameter requires Catalyst::Runtime 5.90125 otherwise is skipped.
284 The path of the request url where cookie should be baked.
288 For example, you could stick this in MyApp.pm:
290 __PACKAGE__->config( 'Plugin::Session' => {
291 cookie_domain => '.mydomain.com',
296 Sessions have to be created before the first write to be saved. For example:
299 my ( $self, $c ) = @_;
300 $c->res->write("foo");
305 Will cause a session ID to not be set, because by the time a session is
306 actually created the headers have already been sent to the client.
310 L<Catalyst>, L<Catalyst::Plugin::Session>.
314 Yuval Kogman <nothingmuch@woobling.org>
318 This module is derived from L<Catalyst::Plugin::Session::FastMmap> code, and
319 has been heavily modified since.
329 Jonathan Rockway <jrockway@cpan.org>
337 Copyright (c) 2005 - 2009
338 the Catalyst::Plugin::Session::State::Cookie L</AUTHORS> and L</CONTRIBUTORS>
343 This program is free software, you can redistribute it and/or modify it
344 under the same terms as Perl itself.