jro_apps/redmine Commit - r3087:cf9bb2699fa1

Adds on optional API key to repositories management controller and reposman.rb....

Jean-Philippe Lang -

r3087:cf9bb2699fa1

parent child

Context file:

r3087:cf9bb2699fa1

Collapse all files

app/controllers/sys_controller.rb +2 -2

               def check_enabled
                 User.current = nil
-                unless Setting.sys_api_enabled?
+                unless Setting.sys_api_enabled? && params[:key].to_s == Setting.sys_api_key
-                  render :nothing => 'Access denied. Repository management WS is disabled.', :status => 403
+                  render :text => 'Access denied. Repository management WS is disabled or key is invalid.', :status => 403
                   return false
                 end
               end

app/views/settings/_repositories.rhtml +9 -1

@@ -3,7 +3,15
3	<div class="box tabular settings">	3	<div class="box tabular settings">
4	<p><%= setting_check_box :autofetch_changesets %></p>	4	<p><%= setting_check_box :autofetch_changesets %></p>
5		5
6	<p><%= setting_check_box :sys_api_enabled %></p>	6	<p><%= setting_check_box :sys_api_enabled,
		7	:onclick => "if (this.checked) { Form.Element.enable('settings_sys_api_key'); } else { Form.Element.disable('settings_sys_api_key'); }" %></p>
		8
		9	<p><%= setting_text_field :sys_api_key, :size => 30,
		10	:id => 'settings_sys_api_key',
		11	:disabled => !Setting.sys_api_enabled?,
		12	:label => :setting_mail_handler_api_key %>
		13	<%= link_to_function l(:label_generate_key), "if ($('settings_sys_api_key').disabled == false) { $('settings_sys_api_key').value = randomKey(20) }" %>
		14	</p>
7		15
8	<p><%= setting_multiselect(:enabled_scm, REDMINE_SUPPORTED_SCM) %></p>	16	<p><%= setting_multiselect(:enabled_scm, REDMINE_SUPPORTED_SCM) %></p>
9		17

config/settings.yml +2 0

               default: 1
             sys_api_enabled:
               default: 0
+            sys_api_key:
+              default: ''
             commit_ref_keywords:
               default: 'refs,references,IssueID'
             commit_fix_keywords:

extra/svn/reposman.rb +17 -10

             #                             -r redmine.example.net
             #                             -r http://redmine.example.net
             #                             -r https://example.net/redmine
+            #   -k, --key=KEY             use KEY as the Redmine API key
             #
             # == Options
             #
             #   -o, --owner=OWNER         owner of the repository. using the rails login
             #                             allow user to browse the repository within
-            #                             Redmine even for private project. If you want to share repositories
+            #                             Redmine even for private project. If you want to
-            #                             through Redmine.pm, you need to use the apache owner.
+            #                             share repositories through Redmine.pm, you need
+            #                             to use the apache owner.
             #   -g, --group=GROUP         group of the repository. (default: root)
-            #   --scm=SCM                 the kind of SCM repository you want to create (and register) in
+            #   --scm=SCM                 the kind of SCM repository you want to create (and
-            #                             Redmine (default: Subversion). reposman is able to create Git
+            #                             register) in Redmine (default: Subversion).
-            #                             and Subversion repositories. For all other kind (Bazaar,
+            #                             reposman is able to create Git and Subversion
-            #                             Darcs, Filesystem, Mercurial) you must specify a --command option
+            #                             repositories. For all other kind, you must specify
+            #                             a --command option
             #   -u, --url=URL             the base url Redmine will use to access your
             #                             repositories. This option is used to automatically
             #                             register the repositories in Redmine. The project
             #                             the repositories in Redmine
             #   -c, --command=COMMAND     use this command instead of "svnadmin create" to
             #                             create a repository. This option can be used to
-            #                             create repositories other than subversion and git kind.
+            #                             create repositories other than subversion and git
-            #                             This command override the default creation for git and subversion.
+            #                             kind.
+            #                             This command override the default creation for git
+            #                             and subversion.
             #   -f, --force               force repository creation even if the project
             #                             repository is already declared in Redmine
             #   -t, --test                only show what should be done
             opts = GetoptLong.new(
                                   ['--svn-dir',      '-s', GetoptLong::REQUIRED_ARGUMENT],
                                   ['--redmine-host', '-r', GetoptLong::REQUIRED_ARGUMENT],
+                                  ['--key',          '-k', GetoptLong::REQUIRED_ARGUMENT],
                                   ['--owner',        '-o', GetoptLong::REQUIRED_ARGUMENT],
                                   ['--group',        '-g', GetoptLong::REQUIRED_ARGUMENT],
                                   ['--url',          '-u', GetoptLong::REQUIRED_ARGUMENT],
                 case opt
                 when '--svn-dir';        $repos_base   = arg.dup
                 when '--redmine-host';   $redmine_host = arg.dup
+                when '--key';            $api_key      = arg.dup
                 when '--owner';          $svn_owner    = arg.dup; $use_groupid = false;
                 when '--group';          $svn_group    = arg.dup; $use_groupid = false;
                 when '--url';            $svn_url      = arg.dup
             begin
               # Get all active projects that have the Repository module enabled
-              projects = Project.find(:all)
+              projects = Project.find(:all, :params => {:key => $api_key})
             rescue => e
               log("Unable to connect to #{Project.site}: #{e}", :exit => true)
             end
                 if $svn_url
                   begin
-                    project.post(:repository, :vendor => $scm, :repository => {:url => "#{$svn_url}#{project.identifier}"})
+                    project.post(:repository, :vendor => $scm, :repository => {:url => "#{$svn_url}#{project.identifier}"}, :key => $api_key)
                     log("\trepository #{repos_path} registered in Redmine with url #{$svn_url}#{project.identifier}");
                   rescue => e
                     log("\trepository #{repos_path} not registered in Redmine: #{e.message}");

test/functional/sys_controller_test.rb +21 0

@@ -68,4 +68,25 class SysControllerTest < ActionController::TestCase
68	get :fetch_changesets, :id => 'unknown'	68	get :fetch_changesets, :id => 'unknown'
69	assert_response 404	69	assert_response 404
70	end	70	end
		71
		72	def test_disabled_ws_should_respond_with_403_error
		73	with_settings :sys_api_enabled => '0' do
		74	get :projects
		75	assert_response 403
		76	end
		77	end
		78
		79	def test_api_key
		80	with_settings :sys_api_key => 'my_secret_key' do
		81	get :projects, :key => 'my_secret_key'
		82	assert_response :success
		83	end
		84	end
		85
		86	def test_wrong_key_should_respond_with_403_error
		87	with_settings :sys_api_enabled => 'my_secret_key' do
		88	get :projects, :key => 'wrong_key'
		89	assert_response 403
		90	end
		91	end
71	end	92	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