NAME
Mojolicious::Sessions - Signed cookie based sessions
SYNOPSIS
use Mojolicious::Sessions;
my $sessions = Mojolicious::Sessions->new;
$sessions->cookie_name('myapp');
DESCRIPTION
Mojolicious::Sessions is a very simple signed cookie based session implementation. All data gets serialized with Mojo::JSON and stored on the client-side, but is protected from unwanted changes with a signature.
ATTRIBUTES
Mojolicious::Sessions implements the following attributes.
cookie_domain
my $domain = $sessions->cookie_domain;
$sessions = $sessions->cookie_domain('.example.com');
Domain for session cookie, not defined by default.
cookie_name
my $name = $sessions->cookie_name;
$sessions = $sessions->cookie_name('session');
Name of the signed cookie used to store session data, defaults to mojolicious
.
cookie_path
my $path = $sessions->cookie_path;
$sessions = $sessions->cookie_path('/foo');
Path for session cookie, defaults to /
.
default_expiration
my $time = $sessions->default_expiration;
$sessions = $sessions->default_expiration(3600);
Time for the session to expire in seconds from now, defaults to 3600
. The expiration timeout gets refreshed for every request. Setting the value to 0
will allow sessions to persist until the browser window is closed, this can have security implications though. For more control you can also use the expires
session value to set the expiration date to a specific time in epoch seconds.
# Expire a week from now
$c->session(expires => time + 604800);
# Expire a long long time ago
$c->session(expires => 1);
secure
my $secure = $sessions->secure;
$sessions = $sessions->secure(1);
Set the secure flag on all session cookies, so that browsers send them only over HTTPS connections.
METHODS
Mojolicious::Sessions inherits all methods from Mojo::Base and implements the following ones.
load
$sessions->load(Mojolicious::Controller->new);
Load session data from signed cookie.
store
$sessions->store(Mojolicious::Controller->new);
Store session data in signed cookie.