Class: Rack::Session::Cookie

### Home Classes Methods

### In Files

- lib/rack/session/cookie.rb

### Parent

Rack::Session::Abstract::ID

### Namespace

- CLASS Rack::Session::Cookie::Base64
- CLASS Rack::Session::Cookie::Identity
- CLASS Rack::Session::Cookie::Reverse

### Methods

- ::new

### Files

- KNOWN-ISSUES

### Class/Module Index

Quicksearch

- Rack
- Rack::Auth
- Rack::Auth::AbstractHandler
- Rack::Auth::AbstractRequest
- Rack::Auth::Basic
- Rack::Auth::Basic::Request
- Rack::Auth::Digest
- Rack::Auth::Digest::MD5
- Rack::Auth::Digest::Nonce
- Rack::Auth::Digest::Params
- Rack::Auth::Digest::Request
- Rack::BodyProxy
- Rack::Builder
- Rack::Cascade
- Rack::Chunked
- Rack::Chunked::Body
- Rack::CommonLogger
- Rack::ConditionalGet
- Rack::Config
- Rack::ContentLength
- Rack::ContentType
- Rack::Deflater
- Rack::Deflater::DeflateStream
- Rack::Deflater::GzipStream
- Rack::Directory
- Rack::ETag
- Rack::File
- Rack::ForwardRequest
- Rack::Handler
- Rack::Handler::CGI
- Rack::Handler::EventedMongrel
- Rack::Handler::FastCGI
- Rack::Handler::LSWS
- Rack::Handler::Mongrel
- Rack::Handler::SCGI
- Rack::Handler::SwiftipliedMongrel
- Rack::Handler::Thin
- Rack::Handler::WEBrick
- Rack::Head
- Rack::Lint
- Rack::Lobster
- Rack::Lock
- Rack::Logger
- Rack::MethodOverride
- Rack::Mime
- Rack::MockRequest
- Rack::MockRequest::FatalWarner
- Rack::MockRequest::FatalWarning
- Rack::MockResponse
- Rack::Multipart
- Rack::Multipart::Generator
- Rack::Multipart::Parser
- Rack::Multipart::UploadedFile
- Rack::NullLogger
- Rack::Recursive
- Rack::Reloader
- Rack::Reloader::Stat
- Rack::Request
- Rack::Response
- Rack::Response::Helpers
- Rack::RewindableInput
- Rack::RewindableInput::Tempfile
- Rack::Runtime
- Rack::Sendfile
- Rack::Server
- Rack::Server::Options
- Rack::Session
- Rack::Session::Abstract
- Rack::Session::Abstract::ID
- Rack::Session::Abstract::SessionHash
- Rack::Session::Cookie
- Rack::Session::Cookie::Base64
- Rack::Session::Cookie::Base64::JSON
- Rack::Session::Cookie::Base64::Marshal
- Rack::Session::Cookie::Identity
- Rack::Session::Cookie::Reverse
- Rack::Session::Memcache
- Rack::Session::Pool
- Rack::ShowExceptions
- Rack::ShowStatus
- Rack::Static
- Rack::URLMap
- Rack::Utils
- Rack::Utils::Context
- Rack::Utils::HeaderHash
- Rack::Utils::KeySpaceConstrainedParams
- Rack::Utils::Multipart
- Rack::Utils::OkJson
- Rack::Utils::OkJson::Error
- Rack::Utils::OkJson::Utf8Error
- FCGI
- FCGI::Stream
- Object

No matching classes.

# Rack::Session::Cookie

Rack::Session::Cookie provides simple cookie based session management. By default, the session is a Ruby Hash stored as base64 encoded marshalled data set to :key (default: rack.session). The object that encodes the session data is configurable and must respond to `encode` and `decode`. Both methods must take a string and return a string.

When the secret key is set, cookie data is checked for data integrity. The old secret key is also accepted and allows graceful secret rotation.

Example:

    use Rack::Session::Cookie, :key => 'rack.session',
                               :domain => 'foo.com',
                               :path => '/',
                               :expire_after => 2592000,
                               :secret => 'change_me',
                               :old_secret => 'also_change_me'

    All parameters are optional.

Example of a cookie with no encoding:

    Rack::Session::Cookie.new(application, {
      :coder => Rack::Session::Cookie::Identity.new
    })

Example of a cookie with custom encoding:

    Rack::Session::Cookie.new(application, {
      :coder => Class.new {
        def encode(str); str.reverse; end
        def decode(str); str.reverse; end
      }.new
    })

### Attributes

coder[R]

### Public Class Methods

new(app, options={}) click to toggle source

    # File lib/rack/session/cookie.rb, line 97
    def initialize(app, options={})
      @secrets = options.values_at(:secret, :old_secret).compact
      warn         SECURITY WARNING: No secret option provided to Rack::Session::Cookie.        This poses a security threat. It is strongly recommended that you        provide a secret to prevent exploits that may be possible from crafted        cookies. This will not be supported in future versions of Rack, and        future versions will even invalidate your existing user cookies.        Called from: #{caller[0]}. unless @secrets.size >= 1
      @coder  = options[:coder] ||= Base64::Marshal.new
      super(app, options.merge!(:cookie_only => true))
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.