/usr/share/perl5/Catalyst/Plugin/Session/State/Cookie.pm is in libcatalyst-plugin-session-state-cookie-perl 0.17-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 | package Catalyst::Plugin::Session::State::Cookie;
use Moose;
use namespace::autoclean;
extends 'Catalyst::Plugin::Session::State';
use MRO::Compat;
use Catalyst::Utils ();
our $VERSION = "0.17";
has _deleted_session_id => ( is => 'rw' );
sub setup_session {
my $c = shift;
$c->maybe::next::method(@_);
$c->_session_plugin_config->{cookie_name}
||= Catalyst::Utils::appprefix($c) . '_session';
}
sub extend_session_id {
my ( $c, $sid, $expires ) = @_;
if ( my $cookie = $c->get_session_cookie ) {
$c->update_session_cookie( $c->make_session_cookie( $sid ) );
}
$c->maybe::next::method( $sid, $expires );
}
sub set_session_id {
my ( $c, $sid ) = @_;
$c->update_session_cookie( $c->make_session_cookie( $sid ) );
return $c->maybe::next::method($sid);
}
sub update_session_cookie {
my ( $c, $updated ) = @_;
unless ( $c->cookie_is_rejecting( $updated ) ) {
my $cookie_name = $c->_session_plugin_config->{cookie_name};
$c->response->cookies->{$cookie_name} = $updated;
}
}
sub cookie_is_rejecting {
my ( $c, $cookie ) = @_;
if ( $cookie->{path} ) {
return 1 if index '/'.$c->request->path, $cookie->{path};
}
return 0;
}
sub make_session_cookie {
my ( $c, $sid, %attrs ) = @_;
my $cfg = $c->_session_plugin_config;
my $cookie = {
value => $sid,
( $cfg->{cookie_domain} ? ( domain => $cfg->{cookie_domain} ) : () ),
( $cfg->{cookie_path} ? ( path => $cfg->{cookie_path} ) : () ),
%attrs,
};
unless ( exists $cookie->{expires} ) {
$cookie->{expires} = $c->calculate_session_cookie_expires();
}
#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 );
$cookie->{httponly} = $cfg->{cookie_httponly};
$cookie->{httponly} = 1
unless defined $cookie->{httponly}; # default = 1 (set httponly)
return $cookie;
}
sub calc_expiry { # compat
my $c = shift;
$c->maybe::next::method( @_ ) || $c->calculate_session_cookie_expires( @_ );
}
sub calculate_session_cookie_expires {
my $c = shift;
my $cfg = $c->_session_plugin_config;
my $value = $c->maybe::next::method(@_);
return $value if $value;
if ( exists $cfg->{cookie_expires} ) {
if ( $cfg->{cookie_expires} > 0 ) {
return time() + $cfg->{cookie_expires};
}
else {
return undef;
}
}
else {
return $c->session_expires;
}
}
sub get_session_cookie {
my $c = shift;
my $cookie_name = $c->_session_plugin_config->{cookie_name};
return $c->request->cookies->{$cookie_name};
}
sub get_session_id {
my $c = shift;
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->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->maybe::next::method($sid);
}
__PACKAGE__
__END__
=pod
=head1 NAME
Catalyst::Plugin::Session::State::Cookie - Maintain session IDs using cookies.
=head1 SYNOPSIS
use Catalyst qw/Session Session::State::Cookie Session::Store::Foo/;
=head1 DESCRIPTION
In order for L<Catalyst::Plugin::Session> to work the session ID needs to be
stored on the client, and the session data needs to be stored on the server.
This plugin stores the session ID on the client using the cookie mechanism.
=head1 METHODS
=over 4
=item make_session_cookie
Returns a hash reference with the default values for new cookies.
=item update_session_cookie $hash_ref
Sets the cookie based on C<cookie_name> 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
=over 4
=item prepare_cookies
Will restore if an appropriate cookie is found.
=item finalize_cookies
Will set a cookie called C<session> if it doesn't exist or if its value is not
the current session id.
=item setup_session
Will set the C<cookie_name> parameter to its default value if it isn't set.
=back
=head1 CONFIGURATION
=over 4
=item cookie_name
The name of the cookie to store (defaults to C<Catalyst::Utils::apprefix($c) . '_session'>).
=item cookie_domain
The name of the domain to store in the cookie (defaults to current host)
=item cookie_expires
Number of seconds from now you want to elapse before cookie will expire.
Set to 0 to create a session cookie, ie one which will die when the
user's browser is shut down.
=item cookie_secure
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 parameter requires Catalyst::Runtime 5.80005 otherwise is skipped.
=item cookie_path
The path of the request url where cookie should be baked.
=back
For example, you could stick this in MyApp.pm:
__PACKAGE__->config( 'Plugin::Session' => {
cookie_domain => '.mydomain.com',
});
=head1 CAVEATS
Sessions have to be created before the first write to be saved. For example:
sub action : Local {
my ( $self, $c ) = @_;
$c->res->write("foo");
$c->session( ... );
...
}
Will cause a session ID to not be set, because by the time a session is
actually created the headers have already been sent to the client.
=head1 SEE ALSO
L<Catalyst>, L<Catalyst::Plugin::Session>.
=head1 AUTHORS
Yuval Kogman E<lt>nothingmuch@woobling.orgE<gt>
=head1 CONTRIBUTORS
This module is derived from L<Catalyst::Plugin::Session::FastMmap> code, and
has been heavily modified since.
Andrew Ford
Andy Grundman
Christian Hansen
Marcus Ramberg
Jonathan Rockway E<lt>jrockway@cpan.orgE<gt>
Sebastian Riedel
Florian Ragwitz
=head1 COPYRIGHT
Copyright (c) 2005 - 2009
the Catalyst::Plugin::Session::State::Cookie L</AUTHORS> and L</CONTRIBUTORS>
as listed above.
=head1 LICENSE
This program is free software, you can redistribute it and/or modify it
under the same terms as Perl itself.
=cut
1;
|