2007-12-21 08:48:59 +01:00
|
|
|
require 'action_controller/cgi_ext'
|
|
|
|
require 'action_controller/session/cookie_store'
|
2007-01-22 14:43:50 +01:00
|
|
|
|
|
|
|
module ActionController #:nodoc:
|
|
|
|
class Base
|
2008-05-18 06:22:34 +02:00
|
|
|
# Process a request extracted from a CGI object and return a response. Pass false as <tt>session_options</tt> to disable
|
2007-01-22 14:43:50 +01:00
|
|
|
# sessions (large performance increase if sessions are not needed). The <tt>session_options</tt> are the same as for CGI::Session:
|
|
|
|
#
|
|
|
|
# * <tt>:database_manager</tt> - standard options are CGI::Session::FileStore, CGI::Session::MemoryStore, and CGI::Session::PStore
|
2007-02-09 09:04:31 +01:00
|
|
|
# (default). Additionally, there is CGI::Session::DRbStore and CGI::Session::ActiveRecordStore. Read more about these in
|
2007-01-22 14:43:50 +01:00
|
|
|
# lib/action_controller/session.
|
|
|
|
# * <tt>:session_key</tt> - the parameter name used for the session id. Defaults to '_session_id'.
|
2007-10-15 19:16:54 +02:00
|
|
|
# * <tt>:session_id</tt> - the session id to use. If not provided, then it is retrieved from the +session_key+ cookie, or
|
|
|
|
# automatically generated for a new session.
|
2007-01-22 14:43:50 +01:00
|
|
|
# * <tt>:new_session</tt> - if true, force creation of a new session. If not set, a new session is only created if none currently
|
2007-02-09 09:04:31 +01:00
|
|
|
# exists. If false, a new session is never created, and if none currently exists and the +session_id+ option is not set,
|
2007-01-22 14:43:50 +01:00
|
|
|
# an ArgumentError is raised.
|
2008-06-02 08:35:38 +02:00
|
|
|
# * <tt>:session_expires</tt> - the time the current session expires, as a Time object. If not set, the session will continue
|
2007-01-22 14:43:50 +01:00
|
|
|
# indefinitely.
|
2008-05-18 06:22:34 +02:00
|
|
|
# * <tt>:session_domain</tt> - the hostname domain for which this session is valid. If not set, defaults to the hostname of the
|
2007-01-22 14:43:50 +01:00
|
|
|
# server.
|
|
|
|
# * <tt>:session_secure</tt> - if +true+, this session will only work over HTTPS.
|
|
|
|
# * <tt>:session_path</tt> - the path for which this session applies. Defaults to the directory of the CGI script.
|
2007-10-15 19:16:54 +02:00
|
|
|
# * <tt>:cookie_only</tt> - if +true+ (the default), session IDs will only be accepted from cookies and not from
|
|
|
|
# the query string or POST parameters. This protects against session fixation attacks.
|
2007-02-09 09:04:31 +01:00
|
|
|
def self.process_cgi(cgi = CGI.new, session_options = {})
|
2007-01-22 14:43:50 +01:00
|
|
|
new.process_cgi(cgi, session_options)
|
|
|
|
end
|
2007-02-09 09:04:31 +01:00
|
|
|
|
2007-01-22 14:43:50 +01:00
|
|
|
def process_cgi(cgi, session_options = {}) #:nodoc:
|
|
|
|
process(CgiRequest.new(cgi, session_options), CgiResponse.new(cgi)).out
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
class CgiRequest < AbstractRequest #:nodoc:
|
2007-12-21 08:48:59 +01:00
|
|
|
attr_accessor :cgi, :session_options
|
2008-05-18 06:22:34 +02:00
|
|
|
class SessionFixationAttempt < StandardError #:nodoc:
|
|
|
|
end
|
2007-01-22 14:43:50 +01:00
|
|
|
|
|
|
|
DEFAULT_SESSION_OPTIONS = {
|
2007-12-21 08:48:59 +01:00
|
|
|
:database_manager => CGI::Session::CookieStore, # store data in cookie
|
|
|
|
:prefix => "ruby_sess.", # prefix session file names
|
|
|
|
:session_path => "/", # available to all paths in app
|
|
|
|
:session_key => "_session_id",
|
2008-10-27 07:47:01 +01:00
|
|
|
:cookie_only => true,
|
|
|
|
:session_http_only=> true
|
|
|
|
}
|
2007-01-22 14:43:50 +01:00
|
|
|
|
|
|
|
def initialize(cgi, session_options = {})
|
|
|
|
@cgi = cgi
|
|
|
|
@session_options = session_options
|
2008-10-27 07:47:01 +01:00
|
|
|
@env = @cgi.__send__(:env_table)
|
2007-01-22 14:43:50 +01:00
|
|
|
super()
|
|
|
|
end
|
|
|
|
|
|
|
|
def query_string
|
2007-12-21 08:48:59 +01:00
|
|
|
qs = @cgi.query_string if @cgi.respond_to?(:query_string)
|
|
|
|
if !qs.blank?
|
2007-01-22 14:43:50 +01:00
|
|
|
qs
|
|
|
|
else
|
2007-12-21 08:48:59 +01:00
|
|
|
super
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2008-10-27 07:47:01 +01:00
|
|
|
def body_stream #:nodoc:
|
|
|
|
@cgi.stdinput
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
2007-02-09 09:04:31 +01:00
|
|
|
|
2007-01-22 14:43:50 +01:00
|
|
|
def cookies
|
|
|
|
@cgi.cookies.freeze
|
|
|
|
end
|
|
|
|
|
|
|
|
def session
|
2007-02-09 09:04:31 +01:00
|
|
|
unless defined?(@session)
|
2007-01-22 14:43:50 +01:00
|
|
|
if @session_options == false
|
|
|
|
@session = Hash.new
|
|
|
|
else
|
|
|
|
stale_session_check! do
|
2007-12-21 08:48:59 +01:00
|
|
|
if cookie_only? && query_parameters[session_options_with_string_keys['session_key']]
|
2007-10-15 19:16:54 +02:00
|
|
|
raise SessionFixationAttempt
|
|
|
|
end
|
2007-02-09 09:04:31 +01:00
|
|
|
case value = session_options_with_string_keys['new_session']
|
|
|
|
when true
|
|
|
|
@session = new_session
|
|
|
|
when false
|
|
|
|
begin
|
|
|
|
@session = CGI::Session.new(@cgi, session_options_with_string_keys)
|
|
|
|
# CGI::Session raises ArgumentError if 'new_session' == false
|
|
|
|
# and no session cookie or query param is present.
|
|
|
|
rescue ArgumentError
|
|
|
|
@session = Hash.new
|
|
|
|
end
|
|
|
|
when nil
|
|
|
|
@session = CGI::Session.new(@cgi, session_options_with_string_keys)
|
|
|
|
else
|
|
|
|
raise ArgumentError, "Invalid new_session option: #{value}"
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
@session['__valid_session']
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
@session
|
|
|
|
end
|
|
|
|
|
|
|
|
def reset_session
|
2007-02-09 09:04:31 +01:00
|
|
|
@session.delete if defined?(@session) && @session.is_a?(CGI::Session)
|
2007-01-22 14:43:50 +01:00
|
|
|
@session = new_session
|
|
|
|
end
|
|
|
|
|
|
|
|
def method_missing(method_id, *arguments)
|
2008-10-27 07:47:01 +01:00
|
|
|
@cgi.__send__(method_id, *arguments) rescue super
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
# Delete an old session if it exists then create a new one.
|
|
|
|
def new_session
|
|
|
|
if @session_options == false
|
|
|
|
Hash.new
|
|
|
|
else
|
|
|
|
CGI::Session.new(@cgi, session_options_with_string_keys.merge("new_session" => false)).delete rescue nil
|
|
|
|
CGI::Session.new(@cgi, session_options_with_string_keys.merge("new_session" => true))
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2007-12-21 08:48:59 +01:00
|
|
|
def cookie_only?
|
|
|
|
session_options_with_string_keys['cookie_only']
|
|
|
|
end
|
|
|
|
|
2007-01-22 14:43:50 +01:00
|
|
|
def stale_session_check!
|
|
|
|
yield
|
|
|
|
rescue ArgumentError => argument_error
|
2007-12-21 08:48:59 +01:00
|
|
|
if argument_error.message =~ %r{undefined class/module ([\w:]*\w)}
|
2007-01-22 14:43:50 +01:00
|
|
|
begin
|
2007-12-21 08:48:59 +01:00
|
|
|
# Note that the regexp does not allow $1 to end with a ':'
|
|
|
|
$1.constantize
|
2007-01-22 14:43:50 +01:00
|
|
|
rescue LoadError, NameError => const_error
|
2007-02-09 09:04:31 +01:00
|
|
|
raise ActionController::SessionRestoreError, <<-end_msg
|
2007-01-22 14:43:50 +01:00
|
|
|
Session contains objects whose class definition isn\'t available.
|
|
|
|
Remember to require the classes for all objects kept in the session.
|
|
|
|
(Original exception: #{const_error.message} [#{const_error.class}])
|
|
|
|
end_msg
|
|
|
|
end
|
|
|
|
|
|
|
|
retry
|
|
|
|
else
|
|
|
|
raise
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def session_options_with_string_keys
|
2007-02-09 09:04:31 +01:00
|
|
|
@session_options_with_string_keys ||= DEFAULT_SESSION_OPTIONS.merge(@session_options).stringify_keys
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
class CgiResponse < AbstractResponse #:nodoc:
|
|
|
|
def initialize(cgi)
|
|
|
|
@cgi = cgi
|
|
|
|
super()
|
|
|
|
end
|
|
|
|
|
|
|
|
def out(output = $stdout)
|
|
|
|
output.binmode if output.respond_to?(:binmode)
|
|
|
|
output.sync = false if output.respond_to?(:sync=)
|
2007-02-09 09:04:31 +01:00
|
|
|
|
2007-01-22 14:43:50 +01:00
|
|
|
begin
|
|
|
|
output.write(@cgi.header(@headers))
|
|
|
|
|
2008-10-27 07:47:01 +01:00
|
|
|
if @cgi.__send__(:env_table)['REQUEST_METHOD'] == 'HEAD'
|
2007-01-22 14:43:50 +01:00
|
|
|
return
|
|
|
|
elsif @body.respond_to?(:call)
|
2007-02-09 09:04:31 +01:00
|
|
|
# Flush the output now in case the @body Proc uses
|
|
|
|
# #syswrite.
|
|
|
|
output.flush if output.respond_to?(:flush)
|
2007-01-22 14:43:50 +01:00
|
|
|
@body.call(self, output)
|
|
|
|
else
|
|
|
|
output.write(@body)
|
|
|
|
end
|
|
|
|
|
|
|
|
output.flush if output.respond_to?(:flush)
|
2007-02-09 09:04:31 +01:00
|
|
|
rescue Errno::EPIPE, Errno::ECONNRESET
|
|
|
|
# lost connection to parent process, ignore output
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|