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.18';
13 has _deleted_session_id => ( is => 'rw' );
18 $c->maybe::next::method(@_);
20 $c->_session_plugin_config->{cookie_name}
21 ||= Catalyst::Utils::appprefix($c) . '_session';
24 sub extend_session_id {
25 my ( $c, $sid, $expires ) = @_;
27 if ( my $cookie = $c->get_session_cookie ) {
28 $c->update_session_cookie( $c->make_session_cookie( $sid ) );
31 $c->maybe::next::method( $sid, $expires );
37 $c->update_session_cookie( $c->make_session_cookie( $sid ) );
39 return $c->maybe::next::method($sid);
42 sub update_session_cookie {
43 my ( $c, $updated ) = @_;
45 unless ( $c->cookie_is_rejecting( $updated ) ) {
46 my $cookie_name = $c->_session_plugin_config->{cookie_name};
47 $c->response->cookies->{$cookie_name} = $updated;
51 sub cookie_is_rejecting {
52 my ( $c, $cookie ) = @_;
54 if ( $cookie->{path} ) {
55 return 1 if index '/'.$c->request->path, $cookie->{path};
61 sub make_session_cookie {
62 my ( $c, $sid, %attrs ) = @_;
64 my $cfg = $c->_session_plugin_config;
67 ( $cfg->{cookie_domain} ? ( domain => $cfg->{cookie_domain} ) : () ),
68 ( $cfg->{cookie_path} ? ( path => $cfg->{cookie_path} ) : () ),
72 unless ( exists $cookie->{expires} ) {
73 $cookie->{expires} = $c->calculate_session_cookie_expires();
76 #beware: we have to accept also the old syntax "cookie_secure = true"
77 my $sec = $cfg->{cookie_secure} || 0; # default = 0 (not set)
78 $cookie->{secure} = 1 unless ( ($sec==0) || ($sec==2) );
79 $cookie->{secure} = 1 if ( ($sec==2) && $c->req->secure );
81 $cookie->{httponly} = $cfg->{cookie_httponly};
82 $cookie->{httponly} = 1
83 unless defined $cookie->{httponly}; # default = 1 (set httponly)
85 $cookie->{samesite} = $cfg->{cookie_samesite};
86 $cookie->{samesite} = "Lax"
87 unless defined $cookie->{ samesite}; # default = Lax
92 sub calc_expiry { # compat
94 $c->maybe::next::method( @_ ) || $c->calculate_session_cookie_expires( @_ );
97 sub calculate_session_cookie_expires {
99 my $cfg = $c->_session_plugin_config;
101 my $value = $c->maybe::next::method(@_);
102 return $value if $value;
104 if ( exists $cfg->{cookie_expires} ) {
105 if ( $cfg->{cookie_expires} > 0 ) {
106 return time() + $cfg->{cookie_expires};
113 return $c->session_expires;
117 sub get_session_cookie {
120 my $cookie_name = $c->_session_plugin_config->{cookie_name};
122 return $c->request->cookies->{$cookie_name};
128 if ( !$c->_deleted_session_id and my $cookie = $c->get_session_cookie ) {
129 my $sid = $cookie->value;
130 $c->log->debug(qq/Found sessionid "$sid" in cookie/) if $c->debug;
134 $c->maybe::next::method(@_);
137 sub delete_session_id {
138 my ( $c, $sid ) = @_;
140 $c->_deleted_session_id(1); # to prevent get_session_id from returning it
142 $c->update_session_cookie( $c->make_session_cookie( $sid, expires => 0 ) );
144 $c->maybe::next::method($sid);
152 Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies.
156 use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/;
160 In order for L<Catalyst::Plugin::Session> to work the session ID needs to be
161 stored on the client, and the session data needs to be stored on the server.
163 This plugin stores the session ID on the client using the cookie mechanism.
169 =item make_session_cookie
171 Returns a hash reference with the default values for new cookies.
173 =item update_session_cookie $hash_ref
175 Sets the cookie based on C<cookie_name> in the response object.
179 =item calculate_session_cookie_expires
181 =item cookie_is_rejecting
183 =item delete_session_id
185 =item extend_session_id
187 =item get_session_cookie
195 =head1 EXTENDED METHODS
199 =item prepare_cookies
201 Will restore if an appropriate cookie is found.
203 =item finalize_cookies
205 Will set a cookie called C<session> if it doesn't exist or if its value is not
206 the current session id.
210 Will set the C<cookie_name> parameter to its default value if it isn't set.
220 The name of the cookie to store (defaults to C<Catalyst::Utils::apprefix($c) . '_session'>).
224 The name of the domain to store in the cookie (defaults to current host)
228 Number of seconds from now you want to elapse before cookie will expire.
229 Set to 0 to create a session cookie, ie one which will die when the
230 user's browser is shut down.
234 If this attribute B<set to 0> the cookie will not have the secure flag.
236 If this attribute B<set to 1> (or true for backward compatibility) - the cookie
237 sent by the server to the client will get the secure flag that tells the browser
238 to send this cookie back to the server only via HTTPS.
240 If this attribute B<set to 2> then the cookie will get the secure flag only if
241 the request that caused cookie generation was sent over https (this option is
242 not good if you are mixing https and http in your application).
246 =item cookie_httponly
248 If this attribute B<set to 0>, the cookie will not have HTTPOnly flag.
250 If this attribute B<set to 1>, the cookie will got HTTPOnly flag that should
251 prevent client side Javascript accessing the cookie value - this makes some
252 sort of session hijacking attacks significantly harder. Unfortunately not all
253 browsers support this flag (MSIE 6 SP1+, Firefox 3.0.0.6+, Opera 9.5+); if
254 a browser is not aware of HTTPOnly the flag will be ignored.
258 Note1: Many people are confused by the name "HTTPOnly" - it B<does not mean>
259 that this cookie works only over HTTP and not over HTTPS.
261 Note2: This parameter requires Catalyst::Runtime 5.80005 otherwise is skipped.
263 =item cookie_samesite
265 This attribute configures the value of the
266 L<SameSite|https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite>
269 If set to None, the cookie will be sent when making cross origin requests,
270 including following links from other origins. This requires the
271 L</cookie_secure> flag to be set.
273 If set to Lax, the cookie will not be included when embedded in or fetched from
274 other origins, but will be included when following cross origin links.
276 If set to Strict, the cookie will not be included for any cross origin requests,
277 including links from different origins.
279 Default value is C<Lax>. This is the default modern browsers use.
281 Note: This parameter requires Catalyst::Runtime 5.90125 otherwise is skipped.
285 The path of the request url where cookie should be baked.
289 For example, you could stick this in MyApp.pm:
291 __PACKAGE__->config( 'Plugin::Session' => {
292 cookie_domain => '.mydomain.com',
297 Sessions have to be created before the first write to be saved. For example:
300 my ( $self, $c ) = @_;
301 $c->res->write("foo");
306 Will cause a session ID to not be set, because by the time a session is
307 actually created the headers have already been sent to the client.
311 L<Catalyst>, L<Catalyst::Plugin::Session>.
315 Yuval Kogman <nothingmuch@woobling.org>
319 This module is derived from L<Catalyst::Plugin::Session::FastMmap> code, and
320 has been heavily modified since.
330 Jonathan Rockway <jrockway@cpan.org>
338 Copyright (c) 2005 - 2009
339 the Catalyst::Plugin::Session::State::Cookie L</AUTHORS> and L</CONTRIBUTORS>
344 This program is free software, you can redistribute it and/or modify it
345 under the same terms as Perl itself.