jro_apps/redmine Commit - r3104:baa1ad42560f

Allow authenticating with an API token via XML or JSON. (#3920)...

Eric Davis -

r3104:baa1ad42560f

parent child

Context file:

r3104:baa1ad42560f

Collapse all files

test/integration/api_token_login_test.rb created 644 +73 0

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

app/controllers/application_controller.rb +7 -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])
+                  User.find_by_api_key(params[:key])
                 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
-                  redirect_to :controller => "account", :action => "login", :back_url => url
+                  respond_to do |format|
+                    format.html { 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

app/controllers/news_controller.rb +2 0

             # redMine - project management software
             # Copyright (C) 2006  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.
             class NewsController < ApplicationController
               default_search_scope :news
               before_filter :find_news, :except => [:new, :index, :preview]
               before_filter :find_project, :only => [:new, :preview]
               before_filter :authorize, :except => [:index, :preview]
               before_filter :find_optional_project, :only => :index
               accept_key_auth :index
               def index
                 @news_pages, @newss = paginate :news,
                                                :per_page => 10,
                                                :conditions => Project.allowed_to_condition(User.current, :view_news, :project => @project),
                                                :include => [:author, :project],
                                                :order => "#{News.table_name}.created_on DESC"
                 respond_to do |format|
                   format.html { render :layout => false if request.xhr? }
+                  format.xml { render :xml => @newss.to_xml }
+                  format.json { render :json => @newss.to_json }
                   format.atom { render_feed(@newss, :title => (@project ? @project.name : Setting.app_title) + ": #{l(:label_news_plural)}") }
                 end
               end
               def show
                 @comments = @news.comments
                 @comments.reverse! if User.current.wants_comments_in_reverse_order?
               end
               def new
                 @news = News.new(:project => @project, :author => User.current)
                 if request.post?
                   @news.attributes = params[:news]
                   if @news.save
                     flash[:notice] = l(:notice_successful_create)
                     redirect_to :controller => 'news', :action => 'index', :project_id => @project
                   end
                 end
               end
               def edit
                 if request.post? and @news.update_attributes(params[:news])
                   flash[:notice] = l(:notice_successful_update)
                   redirect_to :action => 'show', :id => @news
                 end
               end
               def add_comment
                 @comment = Comment.new(params[:comment])
                 @comment.author = User.current
                 if @news.comments << @comment
                   flash[:notice] = l(:label_comment_added)
                   redirect_to :action => 'show', :id => @news
                 else
                   show
                   render :action => 'show'
                 end
               end
               def destroy_comment
                 @news.comments.find(params[:comment_id]).destroy
                 redirect_to :action => 'show', :id => @news
               end
               def destroy
                 @news.destroy
                 redirect_to :action => 'index', :project_id => @project
               end
               def preview
                 @text = (params[:news] ? params[:news][:description] : nil)
                 render :partial => 'common/preview'
               end
             private
               def find_news
                 @news = News.find(params[:id])
                 @project = @news.project
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               def find_project
                 @project = Project.find(params[:project_id])
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               def find_optional_project
                 return true unless params[:project_id]
                 @project = Project.find(params[:project_id])
                 authorize
               rescue ActiveRecord::RecordNotFound
                 render_404
               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