actionpack 2.3.2 → 2.3.3

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of actionpack might be problematic. Click here for more details.

Files changed (117) hide show
  1. data/CHANGELOG +5 -0
  2. data/Rakefile +10 -9
  3. data/lib/action_controller.rb +2 -7
  4. data/lib/action_controller/assertions/response_assertions.rb +11 -3
  5. data/lib/action_controller/base.rb +7 -2
  6. data/lib/action_controller/caching.rb +1 -1
  7. data/lib/action_controller/caching/actions.rb +9 -1
  8. data/lib/action_controller/caching/sweeper.rb +45 -0
  9. data/lib/action_controller/caching/sweeping.rb +0 -42
  10. data/lib/action_controller/failsafe.rb +40 -6
  11. data/lib/action_controller/flash.rb +11 -3
  12. data/lib/action_controller/http_authentication.rb +5 -2
  13. data/lib/action_controller/integration.rb +5 -12
  14. data/lib/action_controller/middlewares.rb +0 -1
  15. data/lib/action_controller/reloader.rb +34 -3
  16. data/lib/action_controller/request.rb +6 -2
  17. data/lib/action_controller/response.rb +2 -2
  18. data/lib/action_controller/routing/route_set.rb +2 -1
  19. data/lib/action_controller/streaming.rb +1 -1
  20. data/lib/action_controller/test_process.rb +9 -1
  21. data/lib/action_pack/version.rb +1 -1
  22. data/lib/action_view/helpers.rb +1 -1
  23. data/lib/action_view/helpers/asset_tag_helper.rb +21 -9
  24. data/lib/action_view/helpers/date_helper.rb +2 -2
  25. data/lib/action_view/helpers/form_helper.rb +25 -12
  26. data/lib/action_view/helpers/form_options_helper.rb +2 -0
  27. data/lib/action_view/helpers/form_tag_helper.rb +10 -4
  28. data/lib/action_view/helpers/number_helper.rb +1 -1
  29. data/lib/action_view/helpers/prototype_helper.rb +7 -7
  30. data/lib/action_view/helpers/scriptaculous_helper.rb +5 -5
  31. data/lib/action_view/helpers/text_helper.rb +3 -3
  32. data/lib/action_view/helpers/url_helper.rb +1 -1
  33. data/lib/action_view/paths.rb +1 -1
  34. data/lib/action_view/template.rb +22 -33
  35. data/test/abstract_unit.rb +1 -1
  36. data/test/activerecord/active_record_store_test.rb +3 -3
  37. data/test/controller/action_pack_assertions_test.rb +27 -0
  38. data/test/controller/caching_test.rb +39 -0
  39. data/test/controller/cookie_test.rb +10 -0
  40. data/test/controller/dispatcher_test.rb +9 -7
  41. data/test/controller/failsafe_test.rb +60 -0
  42. data/test/controller/filter_params_test.rb +2 -1
  43. data/test/controller/flash_test.rb +6 -1
  44. data/test/controller/http_digest_authentication_test.rb +34 -3
  45. data/test/controller/integration_test.rb +31 -3
  46. data/test/controller/redirect_test.rb +4 -1
  47. data/test/controller/reloader_test.rb +97 -0
  48. data/test/controller/render_test.rb +19 -9
  49. data/test/controller/request/multipart_params_parsing_test.rb +1 -62
  50. data/test/controller/request/test_request_test.rb +35 -0
  51. data/test/controller/request/url_encoded_params_parsing_test.rb +0 -38
  52. data/test/controller/request_test.rb +218 -230
  53. data/test/controller/resources_test.rb +8 -0
  54. data/test/controller/routing_test.rb +21 -0
  55. data/test/controller/send_file_test.rb +1 -1
  56. data/test/controller/session/cookie_store_test.rb +9 -32
  57. data/test/controller/test_test.rb +8 -0
  58. data/test/fixtures/failsafe/500.html +1 -0
  59. data/test/template/active_record_helper_test.rb +1 -1
  60. data/test/template/asset_tag_helper_test.rb +46 -0
  61. data/test/template/form_helper_test.rb +117 -6
  62. data/test/template/form_options_helper_test.rb +22 -0
  63. data/test/template/form_tag_helper_test.rb +23 -6
  64. data/test/template/prototype_helper_test.rb +11 -11
  65. data/test/template/template_test.rb +32 -0
  66. metadata +20 -63
  67. data/lib/action_controller/rewindable_input.rb +0 -28
  68. data/lib/action_controller/vendor/rack-1.0/rack.rb +0 -89
  69. data/lib/action_controller/vendor/rack-1.0/rack/adapter/camping.rb +0 -22
  70. data/lib/action_controller/vendor/rack-1.0/rack/auth/abstract/handler.rb +0 -37
  71. data/lib/action_controller/vendor/rack-1.0/rack/auth/abstract/request.rb +0 -37
  72. data/lib/action_controller/vendor/rack-1.0/rack/auth/basic.rb +0 -58
  73. data/lib/action_controller/vendor/rack-1.0/rack/auth/digest/md5.rb +0 -124
  74. data/lib/action_controller/vendor/rack-1.0/rack/auth/digest/nonce.rb +0 -51
  75. data/lib/action_controller/vendor/rack-1.0/rack/auth/digest/params.rb +0 -55
  76. data/lib/action_controller/vendor/rack-1.0/rack/auth/digest/request.rb +0 -40
  77. data/lib/action_controller/vendor/rack-1.0/rack/auth/openid.rb +0 -480
  78. data/lib/action_controller/vendor/rack-1.0/rack/builder.rb +0 -63
  79. data/lib/action_controller/vendor/rack-1.0/rack/cascade.rb +0 -36
  80. data/lib/action_controller/vendor/rack-1.0/rack/chunked.rb +0 -49
  81. data/lib/action_controller/vendor/rack-1.0/rack/commonlogger.rb +0 -61
  82. data/lib/action_controller/vendor/rack-1.0/rack/conditionalget.rb +0 -45
  83. data/lib/action_controller/vendor/rack-1.0/rack/content_length.rb +0 -29
  84. data/lib/action_controller/vendor/rack-1.0/rack/content_type.rb +0 -23
  85. data/lib/action_controller/vendor/rack-1.0/rack/deflater.rb +0 -85
  86. data/lib/action_controller/vendor/rack-1.0/rack/directory.rb +0 -153
  87. data/lib/action_controller/vendor/rack-1.0/rack/file.rb +0 -88
  88. data/lib/action_controller/vendor/rack-1.0/rack/handler.rb +0 -48
  89. data/lib/action_controller/vendor/rack-1.0/rack/handler/cgi.rb +0 -61
  90. data/lib/action_controller/vendor/rack-1.0/rack/handler/evented_mongrel.rb +0 -8
  91. data/lib/action_controller/vendor/rack-1.0/rack/handler/fastcgi.rb +0 -89
  92. data/lib/action_controller/vendor/rack-1.0/rack/handler/lsws.rb +0 -55
  93. data/lib/action_controller/vendor/rack-1.0/rack/handler/mongrel.rb +0 -84
  94. data/lib/action_controller/vendor/rack-1.0/rack/handler/scgi.rb +0 -59
  95. data/lib/action_controller/vendor/rack-1.0/rack/handler/swiftiplied_mongrel.rb +0 -8
  96. data/lib/action_controller/vendor/rack-1.0/rack/handler/thin.rb +0 -18
  97. data/lib/action_controller/vendor/rack-1.0/rack/handler/webrick.rb +0 -67
  98. data/lib/action_controller/vendor/rack-1.0/rack/head.rb +0 -19
  99. data/lib/action_controller/vendor/rack-1.0/rack/lint.rb +0 -462
  100. data/lib/action_controller/vendor/rack-1.0/rack/lobster.rb +0 -65
  101. data/lib/action_controller/vendor/rack-1.0/rack/lock.rb +0 -16
  102. data/lib/action_controller/vendor/rack-1.0/rack/methodoverride.rb +0 -27
  103. data/lib/action_controller/vendor/rack-1.0/rack/mime.rb +0 -204
  104. data/lib/action_controller/vendor/rack-1.0/rack/mock.rb +0 -160
  105. data/lib/action_controller/vendor/rack-1.0/rack/recursive.rb +0 -57
  106. data/lib/action_controller/vendor/rack-1.0/rack/reloader.rb +0 -64
  107. data/lib/action_controller/vendor/rack-1.0/rack/request.rb +0 -241
  108. data/lib/action_controller/vendor/rack-1.0/rack/response.rb +0 -179
  109. data/lib/action_controller/vendor/rack-1.0/rack/session/abstract/id.rb +0 -142
  110. data/lib/action_controller/vendor/rack-1.0/rack/session/cookie.rb +0 -91
  111. data/lib/action_controller/vendor/rack-1.0/rack/session/memcache.rb +0 -109
  112. data/lib/action_controller/vendor/rack-1.0/rack/session/pool.rb +0 -100
  113. data/lib/action_controller/vendor/rack-1.0/rack/showexceptions.rb +0 -349
  114. data/lib/action_controller/vendor/rack-1.0/rack/showstatus.rb +0 -106
  115. data/lib/action_controller/vendor/rack-1.0/rack/static.rb +0 -38
  116. data/lib/action_controller/vendor/rack-1.0/rack/urlmap.rb +0 -55
  117. data/lib/action_controller/vendor/rack-1.0/rack/utils.rb +0 -392
@@ -1,37 +0,0 @@
1
- module Rack
2
- module Auth
3
- class AbstractRequest
4
-
5
- def initialize(env)
6
- @env = env
7
- end
8
-
9
- def provided?
10
- !authorization_key.nil?
11
- end
12
-
13
- def parts
14
- @parts ||= @env[authorization_key].split(' ', 2)
15
- end
16
-
17
- def scheme
18
- @scheme ||= parts.first.downcase.to_sym
19
- end
20
-
21
- def params
22
- @params ||= parts.last
23
- end
24
-
25
-
26
- private
27
-
28
- AUTHORIZATION_KEYS = ['HTTP_AUTHORIZATION', 'X-HTTP_AUTHORIZATION', 'X_HTTP_AUTHORIZATION']
29
-
30
- def authorization_key
31
- @authorization_key ||= AUTHORIZATION_KEYS.detect { |key| @env.has_key?(key) }
32
- end
33
-
34
- end
35
-
36
- end
37
- end
@@ -1,58 +0,0 @@
1
- require 'rack/auth/abstract/handler'
2
- require 'rack/auth/abstract/request'
3
-
4
- module Rack
5
- module Auth
6
- # Rack::Auth::Basic implements HTTP Basic Authentication, as per RFC 2617.
7
- #
8
- # Initialize with the Rack application that you want protecting,
9
- # and a block that checks if a username and password pair are valid.
10
- #
11
- # See also: <tt>example/protectedlobster.rb</tt>
12
-
13
- class Basic < AbstractHandler
14
-
15
- def call(env)
16
- auth = Basic::Request.new(env)
17
-
18
- return unauthorized unless auth.provided?
19
-
20
- return bad_request unless auth.basic?
21
-
22
- if valid?(auth)
23
- env['REMOTE_USER'] = auth.username
24
-
25
- return @app.call(env)
26
- end
27
-
28
- unauthorized
29
- end
30
-
31
-
32
- private
33
-
34
- def challenge
35
- 'Basic realm="%s"' % realm
36
- end
37
-
38
- def valid?(auth)
39
- @authenticator.call(*auth.credentials)
40
- end
41
-
42
- class Request < Auth::AbstractRequest
43
- def basic?
44
- :basic == scheme
45
- end
46
-
47
- def credentials
48
- @credentials ||= params.unpack("m*").first.split(/:/, 2)
49
- end
50
-
51
- def username
52
- credentials.first
53
- end
54
- end
55
-
56
- end
57
- end
58
- end
@@ -1,124 +0,0 @@
1
- require 'rack/auth/abstract/handler'
2
- require 'rack/auth/digest/request'
3
- require 'rack/auth/digest/params'
4
- require 'rack/auth/digest/nonce'
5
- require 'digest/md5'
6
-
7
- module Rack
8
- module Auth
9
- module Digest
10
- # Rack::Auth::Digest::MD5 implements the MD5 algorithm version of
11
- # HTTP Digest Authentication, as per RFC 2617.
12
- #
13
- # Initialize with the [Rack] application that you want protecting,
14
- # and a block that looks up a plaintext password for a given username.
15
- #
16
- # +opaque+ needs to be set to a constant base64/hexadecimal string.
17
- #
18
- class MD5 < AbstractHandler
19
-
20
- attr_accessor :opaque
21
-
22
- attr_writer :passwords_hashed
23
-
24
- def initialize(*args)
25
- super
26
- @passwords_hashed = nil
27
- end
28
-
29
- def passwords_hashed?
30
- !!@passwords_hashed
31
- end
32
-
33
- def call(env)
34
- auth = Request.new(env)
35
-
36
- unless auth.provided?
37
- return unauthorized
38
- end
39
-
40
- if !auth.digest? || !auth.correct_uri? || !valid_qop?(auth)
41
- return bad_request
42
- end
43
-
44
- if valid?(auth)
45
- if auth.nonce.stale?
46
- return unauthorized(challenge(:stale => true))
47
- else
48
- env['REMOTE_USER'] = auth.username
49
-
50
- return @app.call(env)
51
- end
52
- end
53
-
54
- unauthorized
55
- end
56
-
57
-
58
- private
59
-
60
- QOP = 'auth'.freeze
61
-
62
- def params(hash = {})
63
- Params.new do |params|
64
- params['realm'] = realm
65
- params['nonce'] = Nonce.new.to_s
66
- params['opaque'] = H(opaque)
67
- params['qop'] = QOP
68
-
69
- hash.each { |k, v| params[k] = v }
70
- end
71
- end
72
-
73
- def challenge(hash = {})
74
- "Digest #{params(hash)}"
75
- end
76
-
77
- def valid?(auth)
78
- valid_opaque?(auth) && valid_nonce?(auth) && valid_digest?(auth)
79
- end
80
-
81
- def valid_qop?(auth)
82
- QOP == auth.qop
83
- end
84
-
85
- def valid_opaque?(auth)
86
- H(opaque) == auth.opaque
87
- end
88
-
89
- def valid_nonce?(auth)
90
- auth.nonce.valid?
91
- end
92
-
93
- def valid_digest?(auth)
94
- digest(auth, @authenticator.call(auth.username)) == auth.response
95
- end
96
-
97
- def md5(data)
98
- ::Digest::MD5.hexdigest(data)
99
- end
100
-
101
- alias :H :md5
102
-
103
- def KD(secret, data)
104
- H([secret, data] * ':')
105
- end
106
-
107
- def A1(auth, password)
108
- [ auth.username, auth.realm, password ] * ':'
109
- end
110
-
111
- def A2(auth)
112
- [ auth.method, auth.uri ] * ':'
113
- end
114
-
115
- def digest(auth, password)
116
- password_hash = passwords_hashed? ? password : H(A1(auth, password))
117
-
118
- KD(password_hash, [ auth.nonce, auth.nc, auth.cnonce, QOP, H(A2(auth)) ] * ':')
119
- end
120
-
121
- end
122
- end
123
- end
124
- end
@@ -1,51 +0,0 @@
1
- require 'digest/md5'
2
-
3
- module Rack
4
- module Auth
5
- module Digest
6
- # Rack::Auth::Digest::Nonce is the default nonce generator for the
7
- # Rack::Auth::Digest::MD5 authentication handler.
8
- #
9
- # +private_key+ needs to set to a constant string.
10
- #
11
- # +time_limit+ can be optionally set to an integer (number of seconds),
12
- # to limit the validity of the generated nonces.
13
-
14
- class Nonce
15
-
16
- class << self
17
- attr_accessor :private_key, :time_limit
18
- end
19
-
20
- def self.parse(string)
21
- new(*string.unpack("m*").first.split(' ', 2))
22
- end
23
-
24
- def initialize(timestamp = Time.now, given_digest = nil)
25
- @timestamp, @given_digest = timestamp.to_i, given_digest
26
- end
27
-
28
- def to_s
29
- [([ @timestamp, digest ] * ' ')].pack("m*").strip
30
- end
31
-
32
- def digest
33
- ::Digest::MD5.hexdigest([ @timestamp, self.class.private_key ] * ':')
34
- end
35
-
36
- def valid?
37
- digest == @given_digest
38
- end
39
-
40
- def stale?
41
- !self.class.time_limit.nil? && (@timestamp - Time.now.to_i) < self.class.time_limit
42
- end
43
-
44
- def fresh?
45
- !stale?
46
- end
47
-
48
- end
49
- end
50
- end
51
- end
@@ -1,55 +0,0 @@
1
- module Rack
2
- module Auth
3
- module Digest
4
- class Params < Hash
5
-
6
- def self.parse(str)
7
- split_header_value(str).inject(new) do |header, param|
8
- k, v = param.split('=', 2)
9
- header[k] = dequote(v)
10
- header
11
- end
12
- end
13
-
14
- def self.dequote(str) # From WEBrick::HTTPUtils
15
- ret = (/\A"(.*)"\Z/ =~ str) ? $1 : str.dup
16
- ret.gsub!(/\\(.)/, "\\1")
17
- ret
18
- end
19
-
20
- def self.split_header_value(str)
21
- str.scan( /(\w+\=(?:"[^\"]+"|[^,]+))/n ).collect{ |v| v[0] }
22
- end
23
-
24
- def initialize
25
- super
26
-
27
- yield self if block_given?
28
- end
29
-
30
- def [](k)
31
- super k.to_s
32
- end
33
-
34
- def []=(k, v)
35
- super k.to_s, v.to_s
36
- end
37
-
38
- UNQUOTED = ['qop', 'nc', 'stale']
39
-
40
- def to_s
41
- inject([]) do |parts, (k, v)|
42
- parts << "#{k}=" + (UNQUOTED.include?(k) ? v.to_s : quote(v))
43
- parts
44
- end.join(', ')
45
- end
46
-
47
- def quote(str) # From WEBrick::HTTPUtils
48
- '"' << str.gsub(/[\\\"]/o, "\\\1") << '"'
49
- end
50
-
51
- end
52
- end
53
- end
54
- end
55
-
@@ -1,40 +0,0 @@
1
- require 'rack/auth/abstract/request'
2
- require 'rack/auth/digest/params'
3
- require 'rack/auth/digest/nonce'
4
-
5
- module Rack
6
- module Auth
7
- module Digest
8
- class Request < Auth::AbstractRequest
9
-
10
- def method
11
- @env['rack.methodoverride.original_method'] || @env['REQUEST_METHOD']
12
- end
13
-
14
- def digest?
15
- :digest == scheme
16
- end
17
-
18
- def correct_uri?
19
- (@env['SCRIPT_NAME'].to_s + @env['PATH_INFO'].to_s) == uri
20
- end
21
-
22
- def nonce
23
- @nonce ||= Nonce.parse(params['nonce'])
24
- end
25
-
26
- def params
27
- @params ||= Params.parse(parts.last)
28
- end
29
-
30
- def method_missing(sym)
31
- if params.has_key? key = sym.to_s
32
- return params[key]
33
- end
34
- super
35
- end
36
-
37
- end
38
- end
39
- end
40
- end
@@ -1,480 +0,0 @@
1
- # AUTHOR: blink <blinketje@gmail.com>; blink#ruby-lang@irc.freenode.net
2
-
3
- gem 'ruby-openid', '~> 2' if defined? Gem
4
- require 'rack/request'
5
- require 'rack/utils'
6
- require 'rack/auth/abstract/handler'
7
- require 'uri'
8
- require 'openid' #gem
9
- require 'openid/extension' #gem
10
- require 'openid/store/memory' #gem
11
-
12
- module Rack
13
- class Request
14
- def openid_request
15
- @env['rack.auth.openid.request']
16
- end
17
-
18
- def openid_response
19
- @env['rack.auth.openid.response']
20
- end
21
- end
22
-
23
- module Auth
24
-
25
- # Rack::Auth::OpenID provides a simple method for setting up an OpenID
26
- # Consumer. It requires the ruby-openid library from janrain to operate,
27
- # as well as a rack method of session management.
28
- #
29
- # The ruby-openid home page is at http://openidenabled.com/ruby-openid/.
30
- #
31
- # The OpenID specifications can be found at
32
- # http://openid.net/specs/openid-authentication-1_1.html
33
- # and
34
- # http://openid.net/specs/openid-authentication-2_0.html. Documentation
35
- # for published OpenID extensions and related topics can be found at
36
- # http://openid.net/developers/specs/.
37
- #
38
- # It is recommended to read through the OpenID spec, as well as
39
- # ruby-openid's documentation, to understand what exactly goes on. However
40
- # a setup as simple as the presented examples is enough to provide
41
- # Consumer functionality.
42
- #
43
- # This library strongly intends to utilize the OpenID 2.0 features of the
44
- # ruby-openid library, which provides OpenID 1.0 compatiblity.
45
- #
46
- # NOTE: Due to the amount of data that this library stores in the
47
- # session, Rack::Session::Cookie may fault.
48
-
49
- class OpenID
50
-
51
- class NoSession < RuntimeError; end
52
- class BadExtension < RuntimeError; end
53
- # Required for ruby-openid
54
- ValidStatus = [:success, :setup_needed, :cancel, :failure]
55
-
56
- # = Arguments
57
- #
58
- # The first argument is the realm, identifying the site they are trusting
59
- # with their identity. This is required, also treated as the trust_root
60
- # in OpenID 1.x exchanges.
61
- #
62
- # The optional second argument is a hash of options.
63
- #
64
- # == Options
65
- #
66
- # <tt>:return_to</tt> defines the url to return to after the client
67
- # authenticates with the openid service provider. This url should point
68
- # to where Rack::Auth::OpenID is mounted. If <tt>:return_to</tt> is not
69
- # provided, return_to will be the current url which allows flexibility
70
- # with caveats.
71
- #
72
- # <tt>:session_key</tt> defines the key to the session hash in the env.
73
- # It defaults to 'rack.session'.
74
- #
75
- # <tt>:openid_param</tt> defines at what key in the request parameters to
76
- # find the identifier to resolve. As per the 2.0 spec, the default is
77
- # 'openid_identifier'.
78
- #
79
- # <tt>:store</tt> defined what OpenID Store to use for persistant
80
- # information. By default a Store::Memory will be used.
81
- #
82
- # <tt>:immediate</tt> as true will make initial requests to be of an
83
- # immediate type. This is false by default. See OpenID specification
84
- # documentation.
85
- #
86
- # <tt>:extensions</tt> should be a hash of openid extension
87
- # implementations. The key should be the extension main module, the value
88
- # should be an array of arguments for extension::Request.new.
89
- # The hash is iterated over and passed to #add_extension for processing.
90
- # Please see #add_extension for further documentation.
91
- #
92
- # == Examples
93
- #
94
- # simple_oid = OpenID.new('http://mysite.com/')
95
- #
96
- # return_oid = OpenID.new('http://mysite.com/', {
97
- # :return_to => 'http://mysite.com/openid'
98
- # })
99
- #
100
- # complex_oid = OpenID.new('http://mysite.com/',
101
- # :immediate => true,
102
- # :extensions => {
103
- # ::OpenID::SReg => [['email'],['nickname']]
104
- # }
105
- # )
106
- #
107
- # = Advanced
108
- #
109
- # Most of the functionality of this library is encapsulated such that
110
- # expansion and overriding functions isn't difficult nor tricky.
111
- # Alternately, to avoid opening up singleton objects or subclassing, a
112
- # wrapper rack middleware can be composed to act upon Auth::OpenID's
113
- # responses. See #check and #finish for locations of pertinent data.
114
- #
115
- # == Responses
116
- #
117
- # To change the responses that Auth::OpenID returns, override the methods
118
- # #redirect, #bad_request, #unauthorized, #access_denied, and
119
- # #foreign_server_failure.
120
- #
121
- # Additionally #confirm_post_params is used when the URI would exceed
122
- # length limits on a GET request when doing the initial verification
123
- # request.
124
- #
125
- # == Processing
126
- #
127
- # To change methods of processing completed transactions, override the
128
- # methods #success, #setup_needed, #cancel, and #failure. Please ensure
129
- # the returned object is a rack compatible response.
130
- #
131
- # The first argument is an OpenID::Response, the second is a
132
- # Rack::Request of the current request, the last is the hash used in
133
- # ruby-openid handling, which can be found manually at
134
- # env['rack.session'][:openid].
135
- #
136
- # This is useful if you wanted to expand the processing done, such as
137
- # setting up user accounts.
138
- #
139
- # oid_app = Rack::Auth::OpenID.new realm, :return_to => return_to
140
- # def oid_app.success oid, request, session
141
- # user = Models::User[oid.identity_url]
142
- # user ||= Models::User.create_from_openid oid
143
- # request['rack.session'][:user] = user.id
144
- # redirect MyApp.site_home
145
- # end
146
- #
147
- # site_map['/openid'] = oid_app
148
- # map = Rack::URLMap.new site_map
149
- # ...
150
-
151
- def initialize(realm, options={})
152
- realm = URI(realm)
153
- raise ArgumentError, "Invalid realm: #{realm}" \
154
- unless realm.absolute? \
155
- and realm.fragment.nil? \
156
- and realm.scheme =~ /^https?$/ \
157
- and realm.host =~ /^(\*\.)?#{URI::REGEXP::PATTERN::URIC_NO_SLASH}+/
158
- realm.path = '/' if realm.path.empty?
159
- @realm = realm.to_s
160
-
161
- if ruri = options[:return_to]
162
- ruri = URI(ruri)
163
- raise ArgumentError, "Invalid return_to: #{ruri}" \
164
- unless ruri.absolute? \
165
- and ruri.scheme =~ /^https?$/ \
166
- and ruri.fragment.nil?
167
- raise ArgumentError, "return_to #{ruri} not within realm #{realm}" \
168
- unless self.within_realm?(ruri)
169
- @return_to = ruri.to_s
170
- end
171
-
172
- @session_key = options[:session_key] || 'rack.session'
173
- @openid_param = options[:openid_param] || 'openid_identifier'
174
- @store = options[:store] || ::OpenID::Store::Memory.new
175
- @immediate = !!options[:immediate]
176
-
177
- @extensions = {}
178
- if extensions = options.delete(:extensions)
179
- extensions.each do |ext, args|
180
- add_extension ext, *args
181
- end
182
- end
183
-
184
- # Undocumented, semi-experimental
185
- @anonymous = !!options[:anonymous]
186
- end
187
-
188
- attr_reader :realm, :return_to, :session_key, :openid_param, :store,
189
- :immediate, :extensions
190
-
191
- # Sets up and uses session data at <tt>:openid</tt> within the session.
192
- # Errors in this setup will raise a NoSession exception.
193
- #
194
- # If the parameter 'openid.mode' is set, which implies a followup from
195
- # the openid server, processing is passed to #finish and the result is
196
- # returned. However, if there is no appropriate openid information in the
197
- # session, a 400 error is returned.
198
- #
199
- # If the parameter specified by <tt>options[:openid_param]</tt> is
200
- # present, processing is passed to #check and the result is returned.
201
- #
202
- # If neither of these conditions are met, #unauthorized is called.
203
-
204
- def call(env)
205
- env['rack.auth.openid'] = self
206
- env_session = env[@session_key]
207
- unless env_session and env_session.is_a?(Hash)
208
- raise NoSession, 'No compatible session'
209
- end
210
- # let us work in our own namespace...
211
- session = (env_session[:openid] ||= {})
212
- unless session and session.is_a?(Hash)
213
- raise NoSession, 'Incompatible openid session'
214
- end
215
-
216
- request = Rack::Request.new(env)
217
- consumer = ::OpenID::Consumer.new(session, @store)
218
-
219
- if mode = request.GET['openid.mode']
220
- if session.key?(:openid_param)
221
- finish(consumer, session, request)
222
- else
223
- bad_request
224
- end
225
- elsif request.GET[@openid_param]
226
- check(consumer, session, request)
227
- else
228
- unauthorized
229
- end
230
- end
231
-
232
- # As the first part of OpenID consumer action, #check retrieves the data
233
- # required for completion.
234
- #
235
- # If all parameters fit within the max length of a URI, a 303 redirect
236
- # will be returned. Otherwise #confirm_post_params will be called.
237
- #
238
- # Any messages from OpenID's request are logged to env['rack.errors']
239
- #
240
- # <tt>env['rack.auth.openid.request']</tt> is the openid checkid request
241
- # instance.
242
- #
243
- # <tt>session[:openid_param]</tt> is set to the openid identifier
244
- # provided by the user.
245
- #
246
- # <tt>session[:return_to]</tt> is set to the return_to uri given to the
247
- # identity provider.
248
-
249
- def check(consumer, session, req)
250
- oid = consumer.begin(req.GET[@openid_param], @anonymous)
251
- req.env['rack.auth.openid.request'] = oid
252
- req.env['rack.errors'].puts(oid.message)
253
- p oid if $DEBUG
254
-
255
- ## Extension support
256
- extensions.each do |ext,args|
257
- oid.add_extension(ext::Request.new(*args))
258
- end
259
-
260
- session[:openid_param] = req.GET[openid_param]
261
- return_to_uri = return_to ? return_to : req.url
262
- session[:return_to] = return_to_uri
263
- immediate = session.key?(:setup_needed) ? false : immediate
264
-
265
- if oid.send_redirect?(realm, return_to_uri, immediate)
266
- uri = oid.redirect_url(realm, return_to_uri, immediate)
267
- redirect(uri)
268
- else
269
- confirm_post_params(oid, realm, return_to_uri, immediate)
270
- end
271
- rescue ::OpenID::DiscoveryFailure => e
272
- # thrown from inside OpenID::Consumer#begin by yadis stuff
273
- req.env['rack.errors'].puts([e.message, *e.backtrace]*"\n")
274
- return foreign_server_failure
275
- end
276
-
277
- # This is the final portion of authentication.
278
- # If successful, a redirect to the realm is be returned.
279
- # Data gathered from extensions are stored in session[:openid] with the
280
- # extension's namespace uri as the key.
281
- #
282
- # Any messages from OpenID's response are logged to env['rack.errors']
283
- #
284
- # <tt>env['rack.auth.openid.response']</tt> will contain the openid
285
- # response.
286
-
287
- def finish(consumer, session, req)
288
- oid = consumer.complete(req.GET, req.url)
289
- req.env['rack.auth.openid.response'] = oid
290
- req.env['rack.errors'].puts(oid.message)
291
- p oid if $DEBUG
292
-
293
- raise unless ValidStatus.include?(oid.status)
294
- __send__(oid.status, oid, req, session)
295
- end
296
-
297
- # The first argument should be the main extension module.
298
- # The extension module should contain the constants:
299
- # * class Request, should have OpenID::Extension as an ancestor
300
- # * class Response, should have OpenID::Extension as an ancestor
301
- # * string NS_URI, which defining the namespace of the extension
302
- #
303
- # All trailing arguments will be passed to extension::Request.new in
304
- # #check.
305
- # The openid response will be passed to
306
- # extension::Response#from_success_response, #get_extension_args will be
307
- # called on the result to attain the gathered data.
308
- #
309
- # This method returns the key at which the response data will be found in
310
- # the session, which is the namespace uri by default.
311
-
312
- def add_extension(ext, *args)
313
- raise BadExtension unless valid_extension?(ext)
314
- extensions[ext] = args
315
- return ext::NS_URI
316
- end
317
-
318
- # Checks the validitity, in the context of usage, of a submitted
319
- # extension.
320
-
321
- def valid_extension?(ext)
322
- if not %w[NS_URI Request Response].all?{|c| ext.const_defined?(c) }
323
- raise ArgumentError, 'Extension is missing constants.'
324
- elsif not ext::Response.respond_to?(:from_success_response)
325
- raise ArgumentError, 'Response is missing required method.'
326
- end
327
- return true
328
- rescue
329
- return false
330
- end
331
-
332
- # Checks the provided uri to ensure it'd be considered within the realm.
333
- # is currently not compatible with wildcard realms.
334
-
335
- def within_realm? uri
336
- uri = URI.parse(uri.to_s)
337
- realm = URI.parse(self.realm)
338
- return false unless uri.absolute?
339
- return false unless uri.path[0, realm.path.size] == realm.path
340
- return false unless uri.host == realm.host or realm.host[/^\*\./]
341
- # for wildcard support, is awkward with URI limitations
342
- realm_match = Regexp.escape(realm.host).
343
- sub(/^\*\./,"^#{URI::REGEXP::PATTERN::URIC_NO_SLASH}+.")+'$'
344
- return false unless uri.host.match(realm_match)
345
- return true
346
- end
347
- alias_method :include?, :within_realm?
348
-
349
- protected
350
-
351
- ### These methods define some of the boilerplate responses.
352
-
353
- # Returns an html form page for posting to an Identity Provider if the
354
- # GET request would exceed the upper URI length limit.
355
-
356
- def confirm_post_params(oid, realm, return_to, immediate)
357
- Rack::Response.new.finish do |r|
358
- r.write '<html><head><title>Confirm...</title></head><body>'
359
- r.write oid.form_markup(realm, return_to, immediate)
360
- r.write '</body></html>'
361
- end
362
- end
363
-
364
- # Returns a 303 redirect with the destination of that provided by the
365
- # argument.
366
-
367
- def redirect(uri)
368
- [ 303, {'Content-Length'=>'0', 'Content-Type'=>'text/plain',
369
- 'Location' => uri},
370
- [] ]
371
- end
372
-
373
- # Returns an empty 400 response.
374
-
375
- def bad_request
376
- [ 400, {'Content-Type'=>'text/plain', 'Content-Length'=>'0'},
377
- [''] ]
378
- end
379
-
380
- # Returns a basic unauthorized 401 response.
381
-
382
- def unauthorized
383
- [ 401, {'Content-Type' => 'text/plain', 'Content-Length' => '13'},
384
- ['Unauthorized.'] ]
385
- end
386
-
387
- # Returns a basic access denied 403 response.
388
-
389
- def access_denied
390
- [ 403, {'Content-Type' => 'text/plain', 'Content-Length' => '14'},
391
- ['Access denied.'] ]
392
- end
393
-
394
- # Returns a 503 response to be used if communication with the remote
395
- # OpenID server fails.
396
-
397
- def foreign_server_failure
398
- [ 503, {'Content-Type'=>'text/plain', 'Content-Length' => '23'},
399
- ['Foreign server failure.'] ]
400
- end
401
-
402
- private
403
-
404
- ### These methods are called after a transaction is completed, depending
405
- # on its outcome. These should all return a rack compatible response.
406
- # You'd want to override these to provide additional functionality.
407
-
408
- # Called to complete processing on a successful transaction.
409
- # Within the openid session, :openid_identity and :openid_identifier are
410
- # set to the user friendly and the standard representation of the
411
- # validated identity. All other data in the openid session is cleared.
412
-
413
- def success(oid, request, session)
414
- session.clear
415
- session[:openid_identity] = oid.display_identifier
416
- session[:openid_identifier] = oid.identity_url
417
- extensions.keys.each do |ext|
418
- label = ext.name[/[^:]+$/].downcase
419
- response = ext::Response.from_success_response(oid)
420
- session[label] = response.data
421
- end
422
- redirect(realm)
423
- end
424
-
425
- # Called if the Identity Provider indicates further setup by the user is
426
- # required.
427
- # The identifier is retrived from the openid session at :openid_param.
428
- # And :setup_needed is set to true to prevent looping.
429
-
430
- def setup_needed(oid, request, session)
431
- identifier = session[:openid_param]
432
- session[:setup_needed] = true
433
- redirect req.script_name + '?' + openid_param + '=' + identifier
434
- end
435
-
436
- # Called if the user indicates they wish to cancel identification.
437
- # Data within openid session is cleared.
438
-
439
- def cancel(oid, request, session)
440
- session.clear
441
- access_denied
442
- end
443
-
444
- # Called if the Identity Provider indicates the user is unable to confirm
445
- # their identity. Data within the openid session is left alone, in case
446
- # of swarm auth attacks.
447
-
448
- def failure(oid, request, session)
449
- unauthorized
450
- end
451
- end
452
-
453
- # A class developed out of the request to use OpenID as an authentication
454
- # middleware. The request will be sent to the OpenID instance unless the
455
- # block evaluates to true. For example in rackup, you can use it as such:
456
- #
457
- # use Rack::Session::Pool
458
- # use Rack::Auth::OpenIDAuth, realm, openid_options do |env|
459
- # env['rack.session'][:authkey] == a_string
460
- # end
461
- # run RackApp
462
- #
463
- # Or simply:
464
- #
465
- # app = Rack::Auth::OpenIDAuth.new app, realm, openid_options, &auth
466
-
467
- class OpenIDAuth < Rack::Auth::AbstractHandler
468
- attr_reader :oid
469
- def initialize(app, realm, options={}, &auth)
470
- @oid = OpenID.new(realm, options)
471
- super(app, &auth)
472
- end
473
-
474
- def call(env)
475
- to = auth.call(env) ? @app : @oid
476
- to.call env
477
- end
478
- end
479
- end
480
- end