Type:
Module

Makes it dead easy to do HTTP Basic authentication.

Simple Basic example

1
2
3
4
5
6
7
8
9
10
11
class PostsController < ApplicationController
   http_basic_authenticate_with name: "dhh", password: "secret", 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
end

Advanced Basic example

Here is a more advanced Basic example where only Atom feeds and the XML API is protected by HTTP authentication, the regular HTML interface is protected by a session approach:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
class ApplicationController < ActionController::Base
  before_action :set_account, :authenticate
 
  protected
    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_basic { |u, p| @account.users.authenticate(u, p) }
          @current_user = user
        else
          request_http_basic_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

In your integration tests, you can do something like this:

1
2
3
4
5
6
7
8
def test_access_granted_from_xml
  get(
    "/notes/1.xml", nil,
    'HTTP_AUTHORIZATION' => ActionController::HttpAuthentication::Basic.encode_credentials(users(:dhh).name, users(:dhh).password)
  )
 
  assert_equal 200, status
end
user_name_and_password
  • References/Ruby on Rails/Rails/Classes/ActionController/ActionController::HttpAuthentication/ActionController::HttpAuthentication::Basic

user_name_and_password(request) Instance Public methods

2025-01-10 15:47:30
encode_credentials
  • References/Ruby on Rails/Rails/Classes/ActionController/ActionController::HttpAuthentication/ActionController::HttpAuthentication::Basic

encode_credentials(user_name, password) Instance Public methods

2025-01-10 15:47:30
http_basic_authenticate_with
  • References/Ruby on Rails/Rails/Classes/ActionController/ActionController::HttpAuthentication/ActionController::HttpAuthentication::Basic/ActionController::HttpAuthentication::Basic::ControllerMethods/ActionController::HttpAuthentication::Basic::ControllerMethods::ClassMethods

http_basic_authenticate_with(options = {}) Instance Public methods

2025-01-10 15:47:30
authentication_request
  • References/Ruby on Rails/Rails/Classes/ActionController/ActionController::HttpAuthentication/ActionController::HttpAuthentication::Basic

authentication_request(controller, realm) Instance Public methods

2025-01-10 15:47:30
authenticate
  • References/Ruby on Rails/Rails/Classes/ActionController/ActionController::HttpAuthentication/ActionController::HttpAuthentication::Basic

authenticate(request, &login_procedure) Instance Public methods

2025-01-10 15:47:30
auth_scheme
  • References/Ruby on Rails/Rails/Classes/ActionController/ActionController::HttpAuthentication/ActionController::HttpAuthentication::Basic

auth_scheme(request) Instance Public methods

2025-01-10 15:47:30
request_http_basic_authentication
  • References/Ruby on Rails/Rails/Classes/ActionController/ActionController::HttpAuthentication/ActionController::HttpAuthentication::Basic/ActionController::HttpAuthentication::Basic::ControllerMethods

request_http_basic_authentication(realm = "Application") Instance Public methods

2025-01-10 15:47:30
has_basic_credentials?
  • References/Ruby on Rails/Rails/Classes/ActionController/ActionController::HttpAuthentication/ActionController::HttpAuthentication::Basic

has_basic_credentials?(request) Instance Public methods

2025-01-10 15:47:30
auth_param
  • References/Ruby on Rails/Rails/Classes/ActionController/ActionController::HttpAuthentication/ActionController::HttpAuthentication::Basic

auth_param(request) Instance Public methods

2025-01-10 15:47:30
decode_credentials
  • References/Ruby on Rails/Rails/Classes/ActionController/ActionController::HttpAuthentication/ActionController::HttpAuthentication::Basic

decode_credentials(request) Instance Public methods

2025-01-10 15:47:30