Project

General

Profile

Actions

Feature #35001

closed

Disable API authentication with username and password when two-factor authentication is enabled for the user

Added by Go MAEDA over 3 years ago. Updated almost 3 years ago.

Status:
Closed
Priority:
Normal
Category:
Accounts / authentication
Target version:
Start date:
Due date:
% Done:

0%

Estimated time:
Resolution:
Fixed

Description

In Redmine 4.2, two-factor authentication has been introduced.

When two-factor authentication is enabled, it becomes difficult for an attacker to log in to Redmine even if he knows the username and password.

However, API authentication is not covered by two-factor authentication. Currently, there are three methods of API authentication:

1. send the user's API key via X-Redmine-API-Key header
2. basic authentication with the user's API key ( username is the API key and password is a random string)
3. basic authentication with user name and password

If you have two-factor authentication enabled, I think the third method will be problematic. This is because even though the web UI can prevent an attacker from logging in with an illegally obtained username and password, they can still use that username and password to access the data via the API.

To address this risk, I suggest disabling basic authentication with username and password for users who have two-factor authentication enabled.


Files

35001.patch (1.88 KB) 35001.patch Go MAEDA, 2022-01-16 08:58

Related issues

Related to Redmine - Feature #1237: Add support for two-factor authenticationClosedGo MAEDA2008-05-14

Actions
Related to Redmine - Defect #41220: API Access does not require second factorClosed

Actions
Actions #1

Updated by Go MAEDA over 3 years ago

The following code is a sample implementation.

diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
index b5644e89d..ec64e74cf 100644
--- a/app/controllers/application_controller.rb
+++ b/app/controllers/application_controller.rb
@@ -129,7 +129,11 @@ class ApplicationController < ActionController::Base
       elsif /\ABasic /i.match?(request.authorization.to_s)
         # HTTP Basic, either username/password or API key/random
         authenticate_with_http_basic do |username, password|
-          user = User.try_to_login(username, password) || User.find_by_api_key(username)
+          user = User.try_to_login(username, password)
+          # Don't allow using username/password when two-factor auth is active
+          user = nil if user&.twofa_active?
+
+          user ||= User.find_by_api_key(username)
         end
         if user && user.must_change_password?
           render_error :message => 'You must change your password', :status => 403
Actions #2

Updated by Marius BĂLTEANU over 3 years ago

  • Related to Feature #1237: Add support for two-factor authentication added
Actions #3

Updated by Go MAEDA almost 3 years ago

  • File 35001.patch added

Attaching a patch.

Actions #4

Updated by Go MAEDA almost 3 years ago

  • File deleted (35001.patch)
Actions #5

Updated by Go MAEDA almost 3 years ago

Actions #6

Updated by Go MAEDA almost 3 years ago

  • Target version set to 5.0.0

Setting the target version to 5.0.0.

Actions #7

Updated by Marius BĂLTEANU almost 3 years ago

  • Status changed from New to Resolved
  • Assignee set to Marius BĂLTEANU
  • Resolution set to Fixed

Patch committed, thanks!

Actions #8

Updated by Marius BĂLTEANU almost 3 years ago

  • Status changed from Resolved to Closed
Actions #9

Updated by Holger Just 4 months ago

  • Related to Defect #41220: API Access does not require second factor added
Actions

Also available in: Atom PDF