Class

CookieStore

Extends:

This cookie-based session store is the Rails default. Sessions typically contain at most a user_id and flash message; both fit within the 4K cookie size limit. Cookie-based sessions are dramatically faster than the alternatives.

If you have more than 4K of session data or don’t want your data to be visible to the user, pick another session store.

CookieOverflow is raised if you attempt to store more than 4K of data. TamperedWithCookie is raised if the data integrity check fails.

A message digest is included with the cookie to ensure data integrity: a user cannot alter his user_id without knowing the secret key included in the hash. New apps are generated with a pregenerated secret in config/environment.rb. Set your own for old apps you’re upgrading.

Session options:

:secret   An application-wide key string or block returning a string
          called per generated digest. The block is called with the
          CGI::Session instance as an argument. It's important that the
          secret is not vulnerable to a dictionary attack. Therefore,
          you should choose a secret consisting of random numbers and
          letters and more than 30 characters.

          Example:  :secret => '449fe2e7daee471bffae2fd8dc02313d'
                    :secret => Proc.new { User.current_user.secret_key }

:digest   The message digest algorithm used to verify session integrity
          defaults to 'SHA1' but may be any digest provided by OpenSSL,
          such as 'MD5', 'RIPEMD160', 'SHA256', etc.

To generate a secret key for an existing application, run `rake secret` and set the key in config/environment.rb

Note that changing digest or secret invalidates all existing sessions!

Classes
CookieOverflow Raised when storing more than 4K of session data.
TamperedWithCookie Raised when the cookie fails its integrity check.
Constants
MAX Cookies can typically store 4096 bytes.
SECRET_MIN_LENGTH
Public Methods
close Write the session data cookie if it was loaded and has changed.
delete Delete the session data by setting an expired cookie with no data.
ensure_secret_secure To prevent users from using something insecure like "Password" we make sure that the secret they’ve provided is at least 30 characters in length.
generate_digest Generate the HMAC keyed message digest. Uses SHA1 by default.
new Called from CGI::Session only.
restore Restore session data from the cookie.
update Wait until close to write the session data cookie.
Private Methods
clear_old_cookie_value Clear cookie value so subsequent new_session doesn’t reload old data.
marshal Marshal a session hash into safe cookie data. Include an integrity hash.
read_cookie Read the session data cookie.
unmarshal Unmarshal cookie data to a hash and verify its integrity.
write_cookie CGI likes to make you hack.
Comments

Have your say
Please use Textile formatting (click here for a cheat sheet). Use <code/> and <pre/> for code samples.
Click here to login with OpenID to to post comments.