feat: admin-only /api/users/twoFactor audit endpoints [DHIS2-20097]

dhis-2/dhis-services/dhis-service-administration/src/main/java/org/hisp/dhis/security/twofa/audit/TwoFactorAuditQueryService.java

@@ -0,0 +1,215 @@
+/*
+ * Copyright (c) 2004-2026, University of Oslo
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors 
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package org.hisp.dhis.security.twofa.audit;
+
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.EnumMap;
+import java.util.List;
+import java.util.Map;
+import javax.annotation.CheckForNull;
+import lombok.RequiredArgsConstructor;
+import org.hisp.dhis.security.twofa.TwoFactorType;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.stereotype.Service;
+
+/**
+ * Native-SQL backed provider for the 2FA enrolment audit endpoints. Aggregates counts and lists
+ * users directly against the {@code userinfo} / {@code userrolemembers} / {@code
+ * userroleauthorities} tables, avoiding full-graph hydration of {@code User} entities and their
+ * lazy {@code userRoles} collections.
+ *
+ * @author Morten Svanaes
+ */
+@Service
+@RequiredArgsConstructor
+public class TwoFactorAuditQueryService {
+
+  public enum TwoFactorAuditStatus {
+    ALL,
+    ENABLED,
+    DISABLED
+  }
+
+  private static final String ENABLED_TYPES_SQL_LIST = "('TOTP_ENABLED','EMAIL_ENABLED')";
+
+  private static final String EFFECTIVE_TYPE_SQL = "COALESCE(twofactortype, 'NOT_ENABLED')";
+
+  // Only count accounts that can actually log in.
+  private static final String ACTIVE_ACCOUNT_FILTER =
+      " AND disabled = false AND invitation = false";
+
+  private final JdbcTemplate jdbcTemplate;
+
+  /** Returns the row count of active users grouped by {@code twofactortype}. */
+  public Map<TwoFactorType, Long> countByType() {
+    Map<TwoFactorType, Long> result = new EnumMap<>(TwoFactorType.class);
+    for (TwoFactorType type : TwoFactorType.values()) {
+      result.put(type, 0L);
+    }
+    jdbcTemplate.query(
+        "SELECT "
+            + EFFECTIVE_TYPE_SQL
+            + " AS effective_type, COUNT(*) FROM userinfo WHERE 1=1"
+            + ACTIVE_ACCOUNT_FILTER
+            + " GROUP BY "
+            + EFFECTIVE_TYPE_SQL,
+        rs -> {
+          String raw = rs.getString(1);
+          if (raw != null) {
+            try {
+              result.put(TwoFactorType.valueOf(raw), rs.getLong(2));
+            } catch (IllegalArgumentException ignore) {
+              // Out-of-enum value in the column.
+            }
+          }
+        });
+    return result;
+  }
+
+  /**
+   * Returns the count of active users holding the {@code ALL} authority and how many of them have
+   * no active 2FA.
+   */
+  public PrivilegedCounts countPrivileged() {
+    String sql =
+        "SELECT COUNT(DISTINCT urm.userid) AS with_all,"
+            + " COUNT(DISTINCT urm.userid) FILTER ("
+            + "   WHERE COALESCE(u.twofactortype, 'NOT_ENABLED') NOT IN "
+            + ENABLED_TYPES_SQL_LIST
+            + " ) AS with_all_missing"
+            + " FROM userrolemembers urm"
+            + " JOIN userroleauthorities ura ON ura.userroleid = urm.userroleid"
+            + " JOIN userinfo u ON u.userinfoid = urm.userid"
+            + " WHERE ura.authority = 'ALL'"
+            + " AND u.disabled = false AND u.invitation = false";
+    PrivilegedCounts counts =
+        jdbcTemplate.queryForObject(
+            sql, (rs, n) -> new PrivilegedCounts(rs.getLong(1), rs.getLong(2)));
+    return counts == null ? new PrivilegedCounts(0L, 0L) : counts;
+  }
+
+  /** Returns the number of active users matching the given filter. */
+  public int count(TwoFactorAuditStatus status, @CheckForNull List<TwoFactorType> types) {
+    StringBuilder sql = new StringBuilder("SELECT COUNT(*) FROM userinfo WHERE 1=1");
+    sql.append(ACTIVE_ACCOUNT_FILTER);
+    List<Object> params = new ArrayList<>();
+    appendStatusClause(sql, status);
+    appendTypeClause(sql, params, types);
+    Integer count = jdbcTemplate.queryForObject(sql.toString(), Integer.class, params.toArray());
+    return count == null ? 0 : count;
+  }
+
+  /**
+   * Returns the matching active user rows projected to the audit-row shape. {@code offset}/{@code
+   * limit} are applied DB-side via {@code OFFSET} / {@code LIMIT}; pass {@code limit < 0} to return
+   * all matches.
+   */
+  public List<UserAuditRow> list(
+      TwoFactorAuditStatus status, @CheckForNull List<TwoFactorType> types, int offset, int limit) {
+    StringBuilder sql =
+        new StringBuilder(
+            "SELECT uid, username, name, twofactortype, lastlogin,"
+                + " email, disabled, invitation FROM userinfo WHERE 1=1");
+    sql.append(ACTIVE_ACCOUNT_FILTER);
+    List<Object> params = new ArrayList<>();
+    appendStatusClause(sql, status);
+    appendTypeClause(sql, params, types);
+    sql.append(" ORDER BY username");
+    if (limit >= 0) {
+      sql.append(" LIMIT ? OFFSET ?");
+      params.add(limit);
+      params.add(Math.max(0, offset));
+    }
+    return jdbcTemplate.query(
+        sql.toString(),
+        params.toArray(),
+        (rs, n) ->
+            new UserAuditRow(
+                rs.getString("uid"),
+                rs.getString("username"),
+                rs.getString("name"),
+                parseType(rs.getString("twofactortype")),
+                rs.getTimestamp("lastlogin"),
+                rs.getString("email"),
+                rs.getBoolean("disabled"),
+                rs.getBoolean("invitation")));
+  }
+
+  private static void appendStatusClause(StringBuilder sql, TwoFactorAuditStatus status) {
+    switch (status) {
+      case ENABLED ->
+          sql.append(" AND ")
+              .append(EFFECTIVE_TYPE_SQL)
+              .append(" IN ")
+              .append(ENABLED_TYPES_SQL_LIST);
+      case DISABLED ->
+          sql.append(" AND ")
+              .append(EFFECTIVE_TYPE_SQL)
+              .append(" NOT IN ")
+              .append(ENABLED_TYPES_SQL_LIST);
+      case ALL -> {
+        // no-op
+      }
+    }
+  }
+
+  private static void appendTypeClause(
+      StringBuilder sql, List<Object> params, @CheckForNull List<TwoFactorType> types) {
+    if (types == null || types.isEmpty()) return;
+    sql.append(" AND ").append(EFFECTIVE_TYPE_SQL).append(" IN (");
+    for (int i = 0; i < types.size(); i++) {
+      sql.append(i == 0 ? "?" : ",?");
+      params.add(types.get(i).name());
+    }
+    sql.append(")");
+  }
+
+  private static TwoFactorType parseType(@CheckForNull String raw) {
+    if (raw == null) return TwoFactorType.NOT_ENABLED;
+    try {
+      return TwoFactorType.valueOf(raw);
+    } catch (IllegalArgumentException e) {
+      return TwoFactorType.NOT_ENABLED;
+    }
+  }
+
+  public record PrivilegedCounts(long withAllAuthority, long withAllAuthorityMissing2FA) {}
+
+  public record UserAuditRow(
+      String uid,
+      String username,
+      String name,
+      TwoFactorType twoFactorType,
+      Date lastLogin,
+      String email,
+      boolean disabled,
+      boolean invitation) {}
+}