NAME¶
Plack::Session::State - Basic parameter-based session state
SYNOPSIS¶
use Plack::Builder;
use Plack::Middleware::Session;
use Plack::Session::State;
my $app = sub {
return [ 200, [ 'Content-Type' => 'text/plain' ], [ 'Hello Foo' ] ];
};
builder {
enable 'Session',
state => Plack::Session::State->new;
$app;
};
DESCRIPTION¶
This will maintain session state by passing the session through the request
params. It does not do this automatically though, you are responsible for
passing the session param.
This should be considered the state "base" class (although subclassing
is not a requirement) and defines the spec for all
Plack::Session::State::* modules. You will only need to override a
couple methods if you do subclass. See Plack::Session::State::Cookie for an
example of this.
WARNING: parameter based session ID management makes session fixation
really easy, and that makes your website vulnerable. You should really avoid
using this state in the production environment except when you have to deal
with legacy HTTP clients that do not support cookies.
In the future this parameter based state handling will be removed from this base
class and will be moved to its own State class.
METHODS¶
- new ( %params )
- The %params can include session_key,
sid_generator and sid_checker however in both cases a
default will be provided for you.
- session_key
- This is the name of the session key, it defaults to
'plack_session'.
- sid_generator
- This is a CODE ref used to generate unique session ids, by
default it will generate a SHA1 using fairly sufficient entropy. If you
are concerned or interested, just read the source.
- sid_validator
- This is a regex used to validate requested session id.
Session ID Managment¶
- get_session_id ( $env )
- This is the method used to extract the session id from a
$env. Subclasses will often only need to override this method and the
"finalize" method.
- validate_session_id ( $session_id
)
- This will use the "sid_validator" regex and
confirm that the $session_id is valid.
- extract ( $env )
- This will attempt to extract the session from a $env by
looking for the "session_key" in the request params. It will
then check to see if the session is valid and that it has not expired. It
will return the session id if everything is good or undef otherwise.
- generate ( $request )
- This will generate a new session id using the
"sid_generator" callback. The $request argument is not used by
this method but is there for use by subclasses. The $request is expected
to be a Plack::Request instance or an object with an equivalent
interface.
- finalize ( $session_id,
$response )
- Given a $session_id and a $response this will perform any
finalization necessary to preserve state. This method is called by the
Plack::Session "finalize" method. The $response is expected to
be a Plack::Response instance or an object with an equivalent
interface.
Session Expiration Handling¶
- expire_session_id ( $id,
$response )
- This will mark the session for $id as expired. This method
is called by the Plack::Session "expire" method.
BUGS¶
All complex software has bugs lurking in it, and this module is no exception. If
you find a bug please either email me, or add the bug to cpan-RT.
AUTHOR¶
Stevan Little <stevan.little@iinteractive.com>
COPYRIGHT AND LICENSE¶
Copyright 2009, 2010 Infinity Interactive, Inc.
<
http://www.iinteractive.com>
This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.