Plack:...ession(3pm)

✨ NAME ✨

Plack::Middleware::Session β€” middleware for session management πŸ‘‘ (yes bestie, it's a perl 3pm page, we're doing this)


🌸 SYNOPSIS 🌸

use Plack::Builder;

my $app = sub {
    my $env = shift;
    my $session = $env->{'psgix.session'};
    return [
        200,
        [ 'Content-Type' => 'text/plain' ],
        [ "Hello, you've been here for ", $session->{counter}++, "th time!" ],
    ];
};

builder {
    enable 'Session';
    $app;
};

# Or, use the File store backend (great if you use multiprocess server)
# For more options, see perldoc Plack::Session::Store::File
builder {
    enable 'Session', store => 'File';
    $app;
};

πŸ’… DESCRIPTION πŸ’…

okay so this is a Plack middleware component for session management, periodt. By default it's gonna use cookies to keep session state, and it stores the actual data in memory. This distribution also ships with other state and store solutions, so go check the perldoc for those backends to see how to use them πŸ‘€

One thing to note (and it's important, bestie): the current session gets stored as a hash reference in the psgix.session key inside the $env, and that's where you can grab it whenever you need it 🫢

NOTE: As of version 0.04 the session is stored in psgix.session instead of plack.session. glow up, honestly ✨

πŸ¦‹ State πŸ¦‹

  • Plack::Session::State β€” this one maintains 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. no autopilot here, queen πŸ’…
  • Plack::Session::State::Cookie β€” this one maintains session state using browser cookies πŸ“

πŸŽ€ Store πŸŽ€

  • Plack::Session::Store β€” this is your basic in-memory session data store. It is volatile storage and not recommended for multiprocessing environments. However, it is very useful for development and testing πŸ™ˆ
  • Plack::Session::Store::File β€” this will persist session data in a file. By default it uses Storable, but it can be configured to have a custom serializer and deserializer ✨
  • Plack::Session::Store::Cache β€” this will persist session data using the Cache interface.
  • Plack::Session::Store::Null β€” sometimes you just don't care about storing session data, and honestly? valid. In that case you can use this noop module πŸ’€

⭐ OPTIONS ⭐

The following are options that can be passed to this module:

  • state β€” this is expected to be an instance of Plack::Session::State, or an object that implements the same interface. If no option is provided, the default Plack::Session::State::Cookie will be used πŸ’–
  • store β€” this is expected to be an instance of Plack::Session::Store, or an object that implements the same interface. If no option is provided, the default Plack::Session::Store will be used.
It should be noted that this default is an in-memory volatile store, and it is only suitable for development (or single process servers). For a more robust solution, see Plack::Session::Store::File or Plack::Session::Store::Cache πŸ‘‘

🌈 PLACK REQUEST OPTIONS 🌈

On top of handing you a psgix.session key in $env for persistent session info, this module also provides a psgix.session.options key which you can use to control the behavior of the module per-request. The following sub-keys exist:

  • change_id β€” if set to a true value, forces the session identifier to change (rotate). This should always be done after logging in, to prevent session fixation attacks from subdomains; see <http://en.wikipedia.org/wiki/Session_fixation#Attacks_using_cross-subdomain_cooking> πŸ”₯ (do it, bestie, it's giving safety)
  • expire β€” if set to a true value, expunges the session from the store, and clears the state in the client. bye bye πŸ‘‹
  • no_store β€” if set to a true value, no changes made to the session in this request will be saved to the store. Either expire and change_id take precedence over this, as both need to update the session store πŸ’…
  • late_store β€” if set to a true value, the session will be saved at the end of the request, after all data has been sent to the client β€” this may be required if streaming responses attempt to alter the session after the header has already been sent to the client. Note, however, that it introduces a possible race condition, where the server attempts to store the updated session before the client makes the next request. For redirects, or other responses on which the client needs do minimal processing before making a second request, this race is quite possible to win β€” causing the second request to obtain stale session data 😭 (so, like, lowkey risky)
  • id β€” this key contains the session identifier of the session. It should be considered read-only; to generate a new identifier, use change_id ⭐

πŸ’€ BUGS πŸ’€

All complex software has bugs lurking in it, and this module is no exception (ngl, that's just the vibe of complex software). If you find a bug please either email me, or add the bug to cpan-RT πŸ›


🫢 AUTHOR 🫢

Tatsuhiko Miyagawa

Stevan Little <stevan.little@iinteractive.com>


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.


and that's the whole page, bestie πŸ’– this was perl v5.40.1, dated 2025-08-10, serving up Plack:...ession(3pm) β€” no cap, you ate that πŸŽ€βœ¨

πŸ“¦ where this page comes from