kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Document Bearer prefix for Authorization header [ci skip]

Browse source
This commit is contained in:
Eliot Sykes 2015-09-23 18:00:41 +01:00
parent f860ab3f14
commit 619481559d
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
actionpack/lib/action_controller/metal/http_authentication.rb
View file

@ -436,15 +436,17 @@ module ActionController
end end
end end
# Parses the token and options out of the token authorization header. If # Parses the token and options out of the token authorization header.
# the header looks like this: # The value for the Authorization header is expected to have the prefix
# <tt>"Token"</tt> or <tt>"Bearer"</tt>. If the header looks like this:
# Authorization: Token token="abc", nonce="def" # Authorization: Token token="abc", nonce="def"
# Then the returned token is "abc", and the options is {nonce: "def"} # Then the returned token is <tt>"abc"</tt>, and the options are
# <tt>{nonce: "def"}</tt>
# #
# request - ActionDispatch::Request instance with the current headers. # request - ActionDispatch::Request instance with the current headers.
# #
# Returns an Array of [String, Hash] if a token is present. # Returns an +Array+ of <tt>[String, Hash]</tt> if a token is present.
# Returns nil if no token is found. # Returns +nil+ if no token is found.
def token_and_options(request) def token_and_options(request)
authorization_request = request.authorization.to_s authorization_request = request.authorization.to_s
if authorization_request[TOKEN_REGEX] if authorization_request[TOKEN_REGEX]