Redmine

The attached patch series implements full OAuth2 provider support for Redmine.

Background¶

OAuth2 is a widely adopted protocol for granting access to API client applications. More information can be found here:

• https://oauth.net/2/
• https://aaronparecki.com/2012/07/29/2/oauth2-simplified

Screenshots¶

Here are a few screenshots that show how it looks like:

Admins are able to create/modify/delete OAuth2 client apps from the user interface.

OAuth2 App credentials are generated and can then be used in API clients.

In order for an App to gain access to Redmine, it must ask the user for permission.

Regular users are able to see which apps currently have access to their data from their My Account area.

Regular users are able to revoke access to individual apps.

Live Demo¶

We are providing a live demo server and client via these links:

https://server.redmine-oauth.planio.org¶

Username/Password is admin:oauth2. The content on this server will be reset every 60 minutes. Feel free to create your own OAuth2 applications via the Admin section, but please don't modify/delete the "Sinatra Client App".

https://client.redmine-oauth.planio.org¶

You can use this app to try out the authentication/authorization flow. Feel free to create your own user accounts on the Redmine server for this.

The /issues API will only work if the view_issues scope is requested. If only the standard scopes are requested, you will see an error here (on purpose).

Feel free to download the client app code from our Planio repository to try out everything locally.

The patch series¶

• 0001 changes the base layout to use named routes. The old hash-style routes (e.g. {controller => 'search', :action => 'index'}) would get namespaced when the layout is used in a namespaced controller in a plugin or engine which is the case with the Doorkeeper gem introduced later.
• 0002 changes the MenuManager in a similar way and prevents the rendered menu links from getting namespaced in the above scenario.
• 0003 adds the Doorkeeper Gem and integrates it with Redmine in the relevant places. You could apply patches 0001-0003 only to get functioning OAuth2 provider support already. In detail, what happens is:
  • Gemfile - Gem is added in
  • app/controllers/application_controller.rb - Doorkeeper is used as a new optional authentication mechanism that is tried when regular Redmine API auth fails
  • app/views/my/account.html.erb - Link to Doorkeeper's views for managing a user's authorized apps
  • config/initializers/doorkeeper.rb - Configure Doorkeeper so that it ties in with Redmine's user and admin authentication
  • config/routes.rb - Add Doorkeeper specific routes and root_url which is needed by it
  • db/migrate/20170107092155_create_doorkeeper_tables.rb - Migrations to add Doorkeeper tables
  • lib/redmine.rb - Link to Doorkeeper's views for managing available apps within the admin section
  • public/stylesheets/application.css - Icon for Apps
  • test/unit/lib/redmine/i18n_test.rb - Fix locale counting in tests because doorkeeper-i18n introduces languages unknown to Redmine
• 0004 - integrates Doorkeeper further by overriding all views with Redmine compatible markup and makes use of Redmine's deny_access and require_login methods which become available once the Doorkeeper controllers are set to inherit from Redmine's ApplicationController
• 0005 - changes Role#allowed_to? so that it can accept an optional scope parameter which can be an array of permission symbols that will be used as a logical AND filter.
• 0006 - Allows OAuth2 client apps to use Redmine permissions as Scopes in the sense of OAuth2. This way, admins and application developers can limit the abilities of client apps. An app will generally have at most the permissions defined by the App definition or as reqested by the app during the auhtorization step. Of course, the app will never have more permissions than the user is has requested authorization for would have in a normal interactive scenario.

Considerations¶

Why use Doorkeeper?¶

Implementing OAuth2 "by hand" seemed like re-inventing the wheel. Building and maintaining such security-critical code is both error-prone and non-trivial. The Doorkeeper Gem is the de-facto standard solution for implementing an OAuth2 provider in Rails. It's tried and tested, well-maintained and used by many high profile apps and services.

Integrating it with Redmine required only minor changes to Redmine's code base itself which should hopefully make maintenance of this functionality quite easy.

Why can only admins create apps?¶

The decision that only Redmine admins can add new API client applications is debatable, but it felt like the easiest solution for this first version. Allowing regular users to create apps would have required more overridden Doorkeeper controllers, new Redmine permissions (e.g. add_apps, view_apps, destroy_apps, etc.)

In addition to that, enabling/diasbling things like the REST API, JSONP support, etc. is currently also only available to admins, so I thought it would be consistent.

Some translations are missing! Where are the I18n keys?¶

At the moment, I've included them via the doorkeeper-i18n Gem. Technically, we could pull the locales in to Redmine's code base. However, – in the spirit of open source – I'd advcate in favor of keeping them in the external Gem and working with the Doorkeeper maintainers to improve them if needed. I've fixed two issues with the locales already via pull requests and they were accepted rather quickly.

That's it for now. I am looking forward to your feedback!

Slightly updated version of 0003, using wider columns for scopes

And another fix.

I'm setting the status to New then, as requested. Ideally, we could get some more feedback from other contributors if the feature is desired and if yes, I'd be happy to rebase the patches on current trunk.

I rebased this patch on current master and added a brief system test that covers application creation, authorization and usage with an actual oauth2 client.

I'd also like to add that, since a few weeks, we're using this feature successfully at Planio for authenticating the native Planio Storage client apps.

Thanks Jens. I would really enjoy seeing this making its way into a future Redmine release and I believe it will help Redmine get more third party apps and integrations!

Another update to this patch. Notable changes are:

• updated to Doorkeeper 5.4, which allowed for the following improvements:
  • secrets (tokens, application secret) are now stored as hashes
  • support for PKCE (most relevant for non-confidential clients)
• introduced an admin scope which allows Administrators to grant admin permissions to client applications
• fixed a stored CSRF vulnerability that was present in one of the original Doorkeeper templates. It was only exploitable by Administrators but if you're using an older version of this patch, at least update your views according to this doorkeeper commit

We also just released the omniauth-redmine-oauth2 gem (source code at Planio and Github). We also built a small Rails app to demonstrate usage of the gem .

Currently this patch makes two I18n tests fail. This is due to the inclusion of the doorkeeper-i18n gem, which introduces 4 locales that aren't present in Redmine. In general, we would need to decide if we want to include these 3rd party translation at all (they do not cover all of Redmine's locales by a large margin) or if we incorporate them into Redmine. As of now the patch just overrides a few strings to make the wording more Redmine-like.

Due to the Doorkeeper upgrade I was more or less forced to squash the last 4 commits of the previous patch series, so it's down to 4 commits now.

Jens, I've started to look to the provided patches and to test this feature. For now, I've committed all 4 patches to the Gitlab instance in order to get the tests results. Besides the I18n test fails, there are some Rubocop warnings that should be fixed.

Am I wrong if I say that patches 0001 and 0002 can be extracted from this issue and delivered as separated ticket? In this way, we will down this feature to 2 patches and it will be easier to maintain/rebase it.

I've assigning this to the next major release version because the changes are too huge for a minor version.

here are the remaining two patches, updated to the most recent doorkeeper release (5.5.1), rebased on current master, and hopefully with a lot less rubocop warnings.

The patches need some changes to work with Rails 6 and zeitwerk autoloader.

• apply cleanly on the current trunk
• replace the legacy icons with SVG icons
• fix all Rubocop warnings

The tests pass with a quick workaround for the I18n tests.

• Decide what to do with the 4 extra languages added by doorkeeper-i18n gem ([:be, :nb, :"zh-CN", :"zh-HK"]
• Update doorkeeper gem to the latest version
• Replace WEBrick with Puma in the system tests

I will try to handle all these points in the following weeks, but any help is appreciated!

I've updated the patches in order to fix all Rubocop warnings, update doorkeeper gem to the latest version and to replace Webrick with Puma. Everything looks good and we can I added it to the core, except the extra languages.

Go MAEDA wrote in #note-32:

[..]

I don't think Redmine needs to do anything about 'be' (Belarusian), 'nb' (Norwegian Bokmål), and 'zh-HK' (Chinese - Hong Kong). Adding those languages to Redmine's config/locales would add languages that are not well maintained.

I agree, but removing as I did in the second patch is not the most elegant solution.

Jens Krämer, Holger Just, do you have any better approach?

Now that the issue with locales added by 3rd parties is now fixed, I've finally commit this feature to the core. I will generate the locales and I will replace the webrick with puma in the following days.

Special thanks to Jens and Holger from Plan.io for providing this nice feature!

• the system test passes now on Github CI
• webrick was replaced by puma

I've attached a minimal patch that fixes the issue described in #note-44.
It ensures that Redmine::PluginLoader.load is executed before Doorkeeper.configure.

All tests have passed, as confirmed in the following:
https://github.com/hidakatsuya/redmine/actions/runs/15747468431