Skip to content

🛡️ Sentinel: [CRITICAL] Add authentication to admin endpoints #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
seonghobae wants to merge 1 commit into from
Closed

🛡️ Sentinel: [CRITICAL] Add authentication to admin endpoints #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .jules/sentinel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,8 @@
**Vulnerability:** The document hashing routine in `DefaultDocumentConversionService` processed file streams without enforcing any maximum size limit on the bytes read. An attacker could exploit this by uploading a maliciously large stream (or exploiting a compression bomb if unzipping), exhausting system memory, CPU, or disk space (DoS).
**Learning:** Checking the declared file size (e.g., `file.getSize()`) in initial validation is not always sufficient if the input stream itself can be spoofed or dynamically expanded during reading. The actual bytes read must be verified against bounds continuously.
**Prevention:** Always enforce a strict, configurable size limit (e.g., `ConversionProperties.maxUploadSizeBytes`) within the `while` loop that reads from untrusted input streams. Track `totalRead` and throw an exception immediately if the limit is exceeded.

## 2026-07-29 - Missing Authentication on Admin Endpoints
**Vulnerability:** The endpoints in `AdminController.java` (`/api/v1/admin/convert/jobs`, `DELETE /api/v1/admin/convert/jobs/{jobId}`, `POST /api/v1/admin/convert/jobs/{jobId}/retry`) were not enforcing any authentication or authorization checks.
**Learning:** Any endpoint, especially those performing sensitive administrative actions or accessing broad sets of data, must strictly enforce authentication and authorization. Relying on network segmentation or obscurity is insufficient.
**Prevention:** Always inject `TenantAccessService` and use `tenantAccessService.require(headers, TenantPermissions.[SPECIFIC_PERMISSION])` in all endpoints to ensure they are secured.
10 changes: 10 additions & 0 deletions src/main/java/com/clearfolio/viewer/auth/TenantPermissions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ public final class TenantPermissions {
*/
public static final String ANALYTICS_READ = "analytics:read";

/**
* Permission required to read admin endpoints.
*/
public static final String ADMIN_READ = "admin:read";

/**
* Permission required to execute admin write endpoints.
*/
public static final String ADMIN_WRITE = "admin:write";

private TenantPermissions() {
}
}
25 changes: 21 additions & 4 deletions src/main/java/com/clearfolio/viewer/controller/AdminController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.server.ResponseStatusException;

import org.springframework.http.HttpHeaders;
import org.springframework.web.bind.annotation.RequestHeader;

import com.clearfolio.viewer.auth.TenantAccessService;
import com.clearfolio.viewer.auth.TenantPermissions;

import com.clearfolio.viewer.api.AdminJobListResponse;
import com.clearfolio.viewer.model.ConversionJob;
import com.clearfolio.viewer.service.DocumentConversionService;
Expand All @@ -26,14 +32,16 @@
public class AdminController {

private final DocumentConversionService conversionService;
private final TenantAccessService tenantAccessService;

/**
* Creates a controller for admin operations.
*
* @param conversionService conversion service
*/
public AdminController(DocumentConversionService conversionService) {
public AdminController(DocumentConversionService conversionService, TenantAccessService tenantAccessService) {
this.conversionService = conversionService;
this.tenantAccessService = tenantAccessService;
}

/**
Expand All @@ -43,7 +51,10 @@ public AdminController(DocumentConversionService conversionService) {
* @return list of conversion jobs
*/
@GetMapping("/api/v1/admin/convert/jobs")
public AdminJobListResponse getAllJobs(@RequestParam(required = false) Boolean deadLettered) {
public AdminJobListResponse getAllJobs(
@RequestParam(required = false) Boolean deadLettered,
@RequestHeader HttpHeaders headers) {
tenantAccessService.require(headers, TenantPermissions.ADMIN_READ);
Iterable<ConversionJob> allJobs = conversionService.getAllJobs();

if (deadLettered == null) {
Expand All @@ -66,7 +77,10 @@ public AdminJobListResponse getAllJobs(@RequestParam(required = false) Boolean d
* @return no content on success
*/
@DeleteMapping("/api/v1/admin/convert/jobs/{jobId}")
public ResponseEntity<Void> deleteJob(@PathVariable UUID jobId) {
public ResponseEntity<Void> deleteJob(
@PathVariable UUID jobId,
@RequestHeader HttpHeaders headers) {
tenantAccessService.require(headers, TenantPermissions.ADMIN_WRITE);
conversionService.deleteJob(jobId);
return ResponseEntity.noContent().build();
}
Expand All @@ -78,7 +92,10 @@ public ResponseEntity<Void> deleteJob(@PathVariable UUID jobId) {
* @return accepted response on success
*/
@PostMapping("/api/v1/admin/convert/jobs/{jobId}/retry")
public ResponseEntity<Void> retryDeadLettered(@PathVariable UUID jobId) {
public ResponseEntity<Void> retryDeadLettered(
@PathVariable UUID jobId,
@RequestHeader HttpHeaders headers) {
tenantAccessService.require(headers, TenantPermissions.ADMIN_WRITE);
RetryDeadLetterResult result = conversionService.retryDeadLettered(jobId, "admin");
if (result == RetryDeadLetterResult.NOT_FOUND) {
throw new ResponseStatusException(HttpStatus.NOT_FOUND, "job not found");
Expand Down
27 changes: 26 additions & 1 deletion src/test/java/com/clearfolio/viewer/controller/AdminControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,24 @@
import org.junit.jupiter.api.Test;
import org.springframework.test.web.reactive.server.WebTestClient;

import com.clearfolio.viewer.auth.TenantAccessService;

import com.clearfolio.viewer.model.ConversionJob;
import com.clearfolio.viewer.service.DocumentConversionService;
import com.clearfolio.viewer.service.RetryDeadLetterResult;

class AdminControllerTest {

private DocumentConversionService conversionService;
private TenantAccessService tenantAccessService;
private WebTestClient webTestClient;
private AdminController controller;

@BeforeEach
void setUp() {
conversionService = mock(DocumentConversionService.class);
controller = new AdminController(conversionService);
tenantAccessService = mock(TenantAccessService.class);
controller = new AdminController(conversionService, tenantAccessService);
webTestClient = WebTestClient.bindToController(controller)
.controllerAdvice(new ApiExceptionHandler())
.build();
Expand All @@ -37,6 +41,9 @@ void getAllJobsReturnsAllJobsWhenNoFilterProvided() {

webTestClient.get()
.uri("/api/v1/admin/convert/jobs")
.header("X-Clearfolio-Tenant-Id", "admin")
.header("X-Clearfolio-Subject-Id", "admin-user")
.header("X-Clearfolio-Permissions", "admin:read")
.exchange()
.expectStatus().isOk()
.expectBody()
Expand All @@ -55,6 +62,9 @@ void getAllJobsFiltersByDeadLetteredTrue() {

webTestClient.get()
.uri("/api/v1/admin/convert/jobs?deadLettered=true")
.header("X-Clearfolio-Tenant-Id", "admin")
.header("X-Clearfolio-Subject-Id", "admin-user")
.header("X-Clearfolio-Permissions", "admin:read")
.exchange()
.expectStatus().isOk()
.expectBody()
Expand All @@ -72,6 +82,9 @@ void getAllJobsFiltersByDeadLetteredFalse() {

webTestClient.get()
.uri("/api/v1/admin/convert/jobs?deadLettered=false")
.header("X-Clearfolio-Tenant-Id", "admin")
.header("X-Clearfolio-Subject-Id", "admin-user")
.header("X-Clearfolio-Permissions", "admin:read")
.exchange()
.expectStatus().isOk()
.expectBody()
Expand All @@ -85,6 +98,9 @@ void deleteJobReturnsNoContent() {

webTestClient.delete()
.uri("/api/v1/admin/convert/jobs/" + jobId)
.header("X-Clearfolio-Tenant-Id", "admin")
.header("X-Clearfolio-Subject-Id", "admin-user")
.header("X-Clearfolio-Permissions", "admin:write")
.exchange()
.expectStatus().isNoContent();
}
Expand All @@ -96,6 +112,9 @@ void retryDeadLetteredReturnsAcceptedWhenAccepted() {

webTestClient.post()
.uri("/api/v1/admin/convert/jobs/" + jobId + "/retry")
.header("X-Clearfolio-Tenant-Id", "admin")
.header("X-Clearfolio-Subject-Id", "admin-user")
.header("X-Clearfolio-Permissions", "admin:write")
.exchange()
.expectStatus().isAccepted();
}
Expand All @@ -107,6 +126,9 @@ void retryDeadLetteredReturnsNotFoundWhenNotFound() {

webTestClient.post()
.uri("/api/v1/admin/convert/jobs/" + jobId + "/retry")
.header("X-Clearfolio-Tenant-Id", "admin")
.header("X-Clearfolio-Subject-Id", "admin-user")
.header("X-Clearfolio-Permissions", "admin:write")
.exchange()
.expectStatus().isNotFound();
}
Expand All @@ -118,6 +140,9 @@ void retryDeadLetteredReturnsConflictWhenNotEligible() {

webTestClient.post()
.uri("/api/v1/admin/convert/jobs/" + jobId + "/retry")
.header("X-Clearfolio-Tenant-Id", "admin")
.header("X-Clearfolio-Subject-Id", "admin-user")
.header("X-Clearfolio-Permissions", "admin:write")
.exchange()
.expectStatus().isEqualTo(409); // isConflict() isn't always available depending on spring-test version, so using isEqualTo(409) is safer
}
Expand Down
Loading