jro_apps/redmine Commit - r3105:e07e9d8bfed4

Added support for HTTP Basic access to the API. (#3920)...

Eric Davis -

r3105:e07e9d8bfed4

parent child

Context file:

r3105:e07e9d8bfed4

Collapse all files

test/integration/http_basic_login_test.rb created 644 +78 0

@@ -0,0 +1,78
	1	require "#{File.dirname(__FILE__)}/../test_helper"
	2
	3	class HttpBasicLoginTest < ActionController::IntegrationTest
	4	fixtures :all
	5
	6	def setup
	7	Setting.login_required = '1'
	8	end
	9
	10	def teardown
	11	Setting.login_required = '0'
	12	end
	13
	14	# Using the NewsController because it's a simple API.
	15	context "get /news" do
	16
	17	context "in :xml format" do
	18	context "with a valid HTTP authentication" do
	19	setup do
	20	@user = User.generate_with_protected!(:password => 'my_password', :password_confirmation => 'my_password')
	21	@authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@user.login, 'my_password')
	22	get "/news.xml", nil, :authorization => @authorization
	23	end
	24
	25	should_respond_with :success
	26	should_respond_with_content_type :xml
	27	should "login as the user" do
	28	assert_equal @user, User.current
	29	end
	30	end
	31
	32	context "with an invalid HTTP authentication" do
	33	setup do
	34	@user = User.generate_with_protected!
	35	@authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@user.login, 'wrong_password')
	36	get "/news.xml", nil, :authorization => @authorization
	37	end
	38
	39	should_respond_with :unauthorized
	40	should_respond_with_content_type :xml
	41	should "not login as the user" do
	42	assert_equal User.anonymous, User.current
	43	end
	44	end
	45	end
	46
	47	context "in :json format" do
	48	context "with a valid HTTP authentication" do
	49	setup do
	50	@user = User.generate_with_protected!(:password => 'my_password', :password_confirmation => 'my_password')
	51	@authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@user.login, 'my_password')
	52	get "/news.json", nil, :authorization => @authorization
	53	end
	54
	55	should_respond_with :success
	56	should_respond_with_content_type :json
	57	should "login as the user" do
	58	assert_equal @user, User.current
	59	end
	60	end
	61
	62	context "with an invalid HTTP authentication" do
	63	setup do
	64	@user = User.generate_with_protected!
	65	@authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@user.login, 'wrong_password')
	66	get "/news.json", nil, :authorization => @authorization
	67	end
	68
	69	should_respond_with :unauthorized
	70	should_respond_with_content_type :json
	71	should "not login as the user" do
	72	assert_equal User.anonymous, User.current
	73	end
	74	end
	75	end
	76
	77	end
	78	end

test/integration/http_basic_login_with_api_token_test.rb created 644 +82 0

@@ -0,0 +1,82
	1	require "#{File.dirname(__FILE__)}/../test_helper"
	2
	3	class HttpBasicLoginWithApiTokenTest < ActionController::IntegrationTest
	4	fixtures :all
	5
	6	def setup
	7	Setting.login_required = '1'
	8	end
	9
	10	def teardown
	11	Setting.login_required = '0'
	12	end
	13
	14	# Using the NewsController because it's a simple API.
	15	context "get /news" do
	16
	17	context "in :xml format" do
	18	context "with a valid HTTP authentication using the API token" do
	19	setup do
	20	@user = User.generate_with_protected!
	21	@token = Token.generate!(:user => @user, :action => 'api')
	22	@authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@token.value, 'X')
	23	get "/news.xml", nil, :authorization => @authorization
	24	end
	25
	26	should_respond_with :success
	27	should_respond_with_content_type :xml
	28	should "login as the user" do
	29	assert_equal @user, User.current
	30	end
	31	end
	32
	33	context "with an invalid HTTP authentication" do
	34	setup do
	35	@user = User.generate_with_protected!
	36	@token = Token.generate!(:user => @user, :action => 'feeds')
	37	@authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@token.value, 'X')
	38	get "/news.xml", nil, :authorization => @authorization
	39	end
	40
	41	should_respond_with :unauthorized
	42	should_respond_with_content_type :xml
	43	should "not login as the user" do
	44	assert_equal User.anonymous, User.current
	45	end
	46	end
	47	end
	48
	49	context "in :json format" do
	50	context "with a valid HTTP authentication" do
	51	setup do
	52	@user = User.generate_with_protected!
	53	@token = Token.generate!(:user => @user, :action => 'api')
	54	@authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@token.value, 'DoesNotMatter')
	55	get "/news.json", nil, :authorization => @authorization
	56	end
	57
	58	should_respond_with :success
	59	should_respond_with_content_type :json
	60	should "login as the user" do
	61	assert_equal @user, User.current
	62	end
	63	end
	64
	65	context "with an invalid HTTP authentication" do
	66	setup do
	67	@user = User.generate_with_protected!
	68	@token = Token.generate!(:user => @user, :action => 'feeds')
	69	@authorization = ActionController::HttpAuthentication::Basic.encode_credentials(@token.value, 'DoesNotMatter')
	70	get "/news.json", nil, :authorization => @authorization
	71	end
	72
	73	should_respond_with :unauthorized
	74	should_respond_with_content_type :json
	75	should "not login as the user" do
	76	assert_equal User.anonymous, User.current
	77	end
	78	end
	79	end
	80
	81	end
	82	end

app/controllers/application_controller.rb +10 -1

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'uri'
             require 'cgi'
             class ApplicationController < ActionController::Base
               include Redmine::I18n
               layout 'base'
               # Remove broken cookie after upgrade from 0.8.x (#4292)
               # See https://rails.lighthouseapp.com/projects/8994/tickets/3360
               # TODO: remove it when Rails is fixed
               before_filter :delete_broken_cookies
               def delete_broken_cookies
                 if cookies['_redmine_session'] && cookies['_redmine_session'] !~ /--/
                   cookies.delete '_redmine_session'
                   redirect_to home_path
                   return false
                 end
               end
               before_filter :user_setup, :check_if_login_required, :set_localization
               filter_parameter_logging :password
               protect_from_forgery
               rescue_from ActionController::InvalidAuthenticityToken, :with => :invalid_authenticity_token
               include Redmine::Search::Controller
               include Redmine::MenuManager::MenuController
               helper Redmine::MenuManager::MenuHelper
               REDMINE_SUPPORTED_SCM.each do |scm|
                 require_dependency "repository/#{scm.underscore}"
               end
               def user_setup
                 # Check the settings cache for each request
                 Setting.check_cache
                 # Find the current user
                 User.current = find_current_user
               end
               # Returns the current user or nil if no user is logged in
               # and starts a session if needed
               def find_current_user
                 if session[:user_id]
                   # existing session
                   (User.active.find(session[:user_id]) rescue nil)
                 elsif cookies[:autologin] && Setting.autologin?
                   # auto-login feature starts a new session
                   user = User.try_to_autologin(cookies[:autologin])
                   session[:user_id] = user.id if user
                   user
                 elsif params[:format] == 'atom' && params[:key] && accept_key_auth_actions.include?(params[:action])
                   # RSS key authentication does not start a session
                   User.find_by_rss_key(params[:key])
-                elsif ['xml', 'json'].include?(params[:format]) && params[:key] && accept_key_auth_actions.include?(params[:action])
+                elsif ['xml', 'json'].include?(params[:format]) && accept_key_auth_actions.include?(params[:action])
+                  if params[:key].present?
+                    # Use API key
                     User.find_by_api_key(params[:key])
+                  else
+                    # HTTP Basic, either username/password or API key/random
+                    authenticate_with_http_basic do |username, password|
+                      User.try_to_login(username, password) || User.find_by_api_key(username)
+                    end
+                  end
                 end
               end
               # Sets the logged in user
               def logged_user=(user)
                 reset_session
                 if user && user.is_a?(User)
                   User.current = user
                   session[:user_id] = user.id
                 else
                   User.current = User.anonymous
                 end
               end
               # check if login is globally required to access the application
               def check_if_login_required
                 # no check needed if user is already logged in
                 return true if User.current.logged?
                 require_login if Setting.login_required?
               end
               def set_localization
                 lang = nil
                 if User.current.logged?
                   lang = find_language(User.current.language)
                 end
                 if lang.nil? && request.env['HTTP_ACCEPT_LANGUAGE']
                   accept_lang = parse_qvalues(request.env['HTTP_ACCEPT_LANGUAGE']).first.downcase
                   if !accept_lang.blank?
                     lang = find_language(accept_lang) || find_language(accept_lang.split('-').first)
                   end
                 end
                 lang ||= Setting.default_language
                 set_language_if_valid(lang)
               end
               def require_login
                 if !User.current.logged?
                   # Extract only the basic url parameters on non-GET requests
                   if request.get?
                     url = url_for(params)
                   else
                     url = url_for(:controller => params[:controller], :action => params[:action], :id => params[:id], :project_id => params[:project_id])
                   end
                   respond_to do |format|
                     format.html { redirect_to :controller => "account", :action => "login", :back_url => url }
+                    format.atom { redirect_to :controller => "account", :action => "login", :back_url => url }
                     format.xml { head :unauthorized }
                     format.json { head :unauthorized }
                   end
                   return false
                 end
                 true
               end
               def require_admin
                 return unless require_login
                 if !User.current.admin?
                   render_403
                   return false
                 end
                 true
               end
               def deny_access
                 User.current.logged? ? render_403 : require_login
               end
               # Authorize the user for the requested action
               def authorize(ctrl = params[:controller], action = params[:action], global = false)
                 allowed = User.current.allowed_to?({:controller => ctrl, :action => action}, @project, :global => global)
                 allowed ? true : deny_access
               end
               # Authorize the user for the requested action outside a project
               def authorize_global(ctrl = params[:controller], action = params[:action], global = true)
                 authorize(ctrl, action, global)
               end
               # make sure that the user is a member of the project (or admin) if project is private
               # used as a before_filter for actions that do not require any particular permission on the project
               def check_project_privacy
                 if @project && @project.active?
                   if @project.is_public? || User.current.member_of?(@project) || User.current.admin?
                     true
                   else
                     User.current.logged? ? render_403 : require_login
                   end
                 else
                   @project = nil
                   render_404
                   false
                 end
               end
               def redirect_back_or_default(default)
                 back_url = CGI.unescape(params[:back_url].to_s)
                 if !back_url.blank?
                   begin
                     uri = URI.parse(back_url)
                     # do not redirect user to another host or to the login or register page
                     if (uri.relative? || (uri.host == request.host)) && !uri.path.match(%r{/(login|account/register)})
                       redirect_to(back_url)
                       return
                     end
                   rescue URI::InvalidURIError
                     # redirect to default
                   end
                 end
                 redirect_to default
               end
               def render_403
                 @project = nil
                 render :template => "common/403", :layout => (request.xhr? ? false : 'base'), :status => 403
                 return false
               end
               def render_404
                 render :template => "common/404", :layout => !request.xhr?, :status => 404
                 return false
               end
               def render_error(msg)
                 flash.now[:error] = msg
                 render :text => '', :layout => !request.xhr?, :status => 500
               end
               def invalid_authenticity_token
                 render_error "Invalid form authenticity token."
               end
               def render_feed(items, options={})
                 @items = items || []
                 @items.sort! {|x,y| y.event_datetime <=> x.event_datetime }
                 @items = @items.slice(0, Setting.feeds_limit.to_i)
                 @title = options[:title] || Setting.app_title
                 render :template => "common/feed.atom.rxml", :layout => false, :content_type => 'application/atom+xml'
               end
               def self.accept_key_auth(*actions)
                 actions = actions.flatten.map(&:to_s)
                 write_inheritable_attribute('accept_key_auth_actions', actions)
               end
               def accept_key_auth_actions
                 self.class.read_inheritable_attribute('accept_key_auth_actions') || []
               end
               # TODO: move to model
               def attach_files(obj, attachments)
                 attached = []
                 unsaved = []
                 if attachments && attachments.is_a?(Hash)
                   attachments.each_value do |attachment|
                     file = attachment['file']
                     next unless file && file.size > 0
                     a = Attachment.create(:container => obj,
                                           :file => file,
                                           :description => attachment['description'].to_s.strip,
                                           :author => User.current)
                     a.new_record? ? (unsaved << a) : (attached << a)
                   end
                   if unsaved.any?
                     flash[:warning] = l(:warning_attachments_not_saved, unsaved.size)
                   end
                 end
                 attached
               end
               # Returns the number of objects that should be displayed
               # on the paginated list
               def per_page_option
                 per_page = nil
                 if params[:per_page] && Setting.per_page_options_array.include?(params[:per_page].to_s.to_i)
                   per_page = params[:per_page].to_s.to_i
                   session[:per_page] = per_page
                 elsif session[:per_page]
                   per_page = session[:per_page]
                 else
                   per_page = Setting.per_page_options_array.first || 25
                 end
                 per_page
               end
               # qvalues http header parser
               # code taken from webrick
               def parse_qvalues(value)
                 tmp = []
                 if value
                   parts = value.split(/,\s*/)
                   parts.each {|part|
                     if m = %r{^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$}.match(part)
                       val = m[1]
                       q = (m[2] or 1).to_f
                       tmp.push([val, q])
                     end
                   }
                   tmp = tmp.sort_by{|val, q| -q}
                   tmp.collect!{|val, q| val}
                 end
                 return tmp
               rescue
                 nil
               end
               # Returns a string that can be used as filename value in Content-Disposition header
               def filename_for_content_disposition(name)
                 request.env['HTTP_USER_AGENT'] =~ %r{MSIE} ? ERB::Util.url_encode(name) : name
               end
             end

test/integration/api_token_login_test.rb +11 -6

             require "#{File.dirname(__FILE__)}/../test_helper"
             class ApiTokenLoginTest < ActionController::IntegrationTest
               fixtures :all
+              def setup
+                Setting.login_required = '1'
+              end
+              def teardown
+                Setting.login_required = '0'
+              end
               # Using the NewsController because it's a simple API.
-              context "get /news.xml" do
+              context "get /news" do
                 context "in :xml format" do
                   context "with a valid api token" do
                     setup do
                       @user = User.generate_with_protected!
                       @token = Token.generate!(:user => @user, :action => 'api')
                       get "/news.xml?key=#{@token.value}"
                     end
                     should_respond_with :success
                     should_respond_with_content_type :xml
                     should "login as the user" do
                       assert_equal @user, User.current
                     end
                   end
-                  context "with an invalid api token (on a protected site)" do
+                  context "with an invalid api token" do
                     setup do
-                      Setting.login_required = '1'
                       @user = User.generate_with_protected!
                       @token = Token.generate!(:user => @user, :action => 'feeds')
                       get "/news.xml?key=#{@token.value}"
                     end
                     should_respond_with :unauthorized
                     should_respond_with_content_type :xml
                     should "not login as the user" do
                       assert_equal User.anonymous, User.current
                     end
                   end
                 end
                 context "in :json format" do
                   context "with a valid api token" do
                     setup do
                       @user = User.generate_with_protected!
                       @token = Token.generate!(:user => @user, :action => 'api')
                       get "/news.json?key=#{@token.value}"
                     end
                     should_respond_with :success
                     should_respond_with_content_type :json
                     should "login as the user" do
                       assert_equal @user, User.current
                     end
                   end
-                  context "with an invalid api token (on a protected site)" do
+                  context "with an invalid api token" do
                     setup do
-                      Setting.login_required = '1'
                       @user = User.generate_with_protected!
                       @token = Token.generate!(:user => @user, :action => 'feeds')
                       get "/news.json?key=#{@token.value}"
                     end
                     should_respond_with :unauthorized
                     should_respond_with_content_type :json
                     should "not login as the user" do
                       assert_equal User.anonymous, User.current
                     end
                   end
                 end
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages