Makes it dead easy to do HTTP Basic authentication.
Simple Basic example:
class PostsController < ApplicationController
USER_NAME, PASSWORD = "dhh", "secret"
before_filter :authenticate, :except => [ :index ]
def index
render :text => "Everyone can see me!"
end
def edit
render :text => "I'm only accessible if you know the password"
end
private
def authenticate
authenticate_or_request_with_http_basic do |user_name, password|
user_name == USER_NAME && password == PASSWORD
end
end
end
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:
class ApplicationController < ActionController::Base
before_filter :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:
def test_access_granted_from_xml
get(
"/notes/1.xml", nil,
:authorization => ActionController::HttpAuthentication::Basic.encode_credentials(users(:dhh).name, users(:dhh).password)
)
assert_equal 200, status
end
On shared hosts, Apache sometimes doesn‘t pass authentication headers to FCGI instances. If your environment matches this description and you cannot authenticate, try this rule in your Apache setup:
RewriteRule ^(.*)$ dispatch.fcgi [E=X-HTTP_AUTHORIZATION:%{HTTP:Authorization},QSA,L]
Methods
- authenticate
- authentication_request
- authorization
- decode_credentials
- encode_credentials
- user_name_and_password
Classes and Modules
Module ActionController::HttpAuthentication::Basic::ControllerMethodsPublic Instance methods
[ show source ]
# File actionpack/lib/action_controller/http_authentication.rb, line 93
93: def authenticate(controller, &login_procedure)
94: unless authorization(controller.request).blank?
95: login_procedure.call(*user_name_and_password(controller.request))
96: end
97: end
[ show source ]
# File actionpack/lib/action_controller/http_authentication.rb, line 118
118: def authentication_request(controller, realm)
119: controller.headers["WWW-Authenticate"] = %(Basic realm="#{realm.gsub(/"/, "")}")
120: controller.send! :render, :text => "HTTP Basic: Access denied.\n", :status => :unauthorized
121: end
[ show source ]
# File actionpack/lib/action_controller/http_authentication.rb, line 103
103: def authorization(request)
104: request.env['HTTP_AUTHORIZATION'] ||
105: request.env['X-HTTP_AUTHORIZATION'] ||
106: request.env['X_HTTP_AUTHORIZATION'] ||
107: request.env['REDIRECT_X_HTTP_AUTHORIZATION']
108: end
[ show source ]
# File actionpack/lib/action_controller/http_authentication.rb, line 110
110: def decode_credentials(request)
111: ActiveSupport::Base64.decode64(authorization(request).split.last || '')
112: end
[ show source ]
# File actionpack/lib/action_controller/http_authentication.rb, line 114
114: def encode_credentials(user_name, password)
115: "Basic #{ActiveSupport::Base64.encode64("#{user_name}:#{password}")}"
116: end
[ show source ]
# File actionpack/lib/action_controller/http_authentication.rb, line 99
99: def user_name_and_password(request)
100: decode_credentials(request).split(/:/, 2)
101: end