модуль ActionController::HttpAuthentication::Token

Делает HTTP токен аутентификацию очень простой.

Простой пример токена:

class PostsController < ApplicationController
  TOKEN = "secret"

  before_action :authenticate, except: [ :index ]

  def index
    render plain: "Everyone can see me!"
  end

  def edit
    render plain: "I'm only accessible if you know the password"
  end

  private
    def authenticate
      authenticate_or_request_with_http_token do |token, options|
        # Compare the tokens in a time-constant manner, to mitigate
        # timing attacks.
        ActiveSupport::SecurityUtils.secure_compare(token, TOKEN)
      end
    end
end

Вот более сложный пример токена, где только Atom-ленты и XML API защищены HTTP-аутентификацией токенов, обычный HTML-интерфейс защищен подходом сессий:

class ApplicationController < ActionController::Base
  before_action :set_account, :authenticate

  private
    def set_account
      @account = Account.find_by(url_name: request.subdomains.first)
    end

    def authenticate
      case request.format
      when Mime[:xml], Mime[:atom]
        if user = authenticate_with_http_token { |t, o| @account.users.authenticate(t, o) }
          @current_user = user
        else
          request_http_token_authentication
        end
      else
        if session_authenticated?
          @current_user = @account.users.find(session[:authenticated][:user_id])
        else
          redirect_to(login_url) and return false
        end
      end
    end
end

В своих интеграционных тестах вы можете сделать что-то подобное:

def test_access_granted_from_xml
  get(
    "/notes/1.xml", nil,
    'HTTP_AUTHORIZATION' => ActionController::HttpAuthentication::Token.encode_credentials(users(:dhh).token)
  )

  assert_equal 200, status
end

На совместных хостингах Apache иногда не передает заголовки аутентификации в экземпляры FCGI. Если ваша среда соответствует этому описанию и вы не можете пройти аутентификацию, попробуйте использовать данное правило в своей настройке Apache:

RewriteRule ^(.*)$ dispatch.fcgi [E=X-HTTP_AUTHORIZATION:%{HTTP:Authorization},QSA,L]

Константы

AUTHN_PAIR_DELIMITERS
TOKEN_KEY
TOKEN_REGEX

Публичные методы экземпляров

authenticate(controller, &login_procedure) Показать исходный код

# File actionpack/lib/action_controller/metal/http_authentication.rb, line 440
def authenticate(controller, &login_procedure)
  token, options = token_and_options(controller.request)
  unless token.blank?
    login_procedure.call(token, options)
  end
end

Если заголовок Authorization с токеном присутствует, вызовите процедуру входа с текущим токеном и опциями.

controller

Экземпляр ActionController::Base для текущего запроса.

login_procedure

Процедура, которая будет вызвана, если токен присутствует. Процедура должна принимать два аргумента:

authenticate(controller) { |token, options| ... }

Возвращает значение, возвращаемое login_procedure если токен найден. Возвращает nil если токен не найден.

authentication_request(controller, realm, message = nil) Показать исходный код

# File actionpack/lib/action_controller/metal/http_authentication.rb, line 512
def authentication_request(controller, realm, message = nil)
  message ||= "HTTP Token: Access denied.\n"
  controller.headers["WWW-Authenticate"] = %(Token realm="#{realm.tr('"'.freeze, "".freeze)}")
  controller.__send__ :render, plain: message, status: :unauthorized
end

Устанавливает заголовок WWW-Authenticate, чтобы клиент знал, что требуется токен.

controller - экземпляр ActionController::Base для исходящего ответа. realm - строка области для использования в заголовке.

Не возвращает ничего.

encode_credentials(token, options = {}) Показать исходный код

# File actionpack/lib/action_controller/metal/http_authentication.rb, line 499
def encode_credentials(token, options = {})
  values = ["#{TOKEN_KEY}#{token.to_s.inspect}"] + options.map do |key, value|
    "#{key}=#{value.to_s.inspect}"
  end
  "Token #{values * ", "}"
end

Кодирует заданный токен и опции в значение заголовка Authorization.

token - строка токен. options - необязательный хеш опций.

Возвращает строку.

params_array_from(raw_params) Показать исходный код

# File actionpack/lib/action_controller/metal/http_authentication.rb, line 471
def params_array_from(raw_params)
  raw_params.map { |param| param.split %r/=(.+)?/ }
end

Преобразует #raw_params в массив параметров

raw_params(auth) Показать исходный код

# File actionpack/lib/action_controller/metal/http_authentication.rb, line 483
def raw_params(auth)
  _raw_params = auth.sub(TOKEN_REGEX, "").split(/\s*#{AUTHN_PAIR_DELIMITERS}\s*/)

  if !(_raw_params.first =~ %r{\A#{TOKEN_KEY}})
    _raw_params[0] = "#{TOKEN_KEY}#{_raw_params.first}"
  end

  _raw_params
end

Этот метод принимает тело авторизации и разбивает пары ключ-значение с использованием стандартных разделителей :, ;, или \t, определённых в AUTHN_PAIR_DELIMITERS.

rewrite_param_values(array_params) Показать исходный код

# File actionpack/lib/action_controller/metal/http_authentication.rb, line 476
def rewrite_param_values(array_params)
  array_params.each { |param| (param[1] || "".dup).gsub! %r/^"|"$/, "" }
end

Удаляет символы " вокруг значения.

token_and_options(request) Показать исходный код

# File actionpack/lib/action_controller/metal/http_authentication.rb, line 458
def token_and_options(request)
  authorization_request = request.authorization.to_s
  if authorization_request[TOKEN_REGEX]
    params = token_params_from authorization_request
    [params.shift[1], Hash[params].with_indifferent_access]
  end
end

Разбирает токен и опции из заголовка Authorization с токеном. Ожидается, что значение заголовка Authorization будет иметь префикс "Token" или "Bearer". Если заголовок выглядит так:

Authorization: Token token="abc", nonce="def"

Тогда возвращаемый токен это "abc", а опции {nonce: "def"}

request - экземпляр ActionDispatch::Request с текущими заголовками.

Возвращает Array содержащий [String, Hash] если токен присутствует. Возвращает nil если токен не найден.

token_params_from(auth) Показать исходный код

# File actionpack/lib/action_controller/metal/http_authentication.rb, line 466
def token_params_from(auth)
  rewrite_param_values params_array_from raw_params auth
end