diff --git a/.jules/sentinel.md b/.jules/sentinel.md index e795cb9dd..271cb97ca 100644 --- a/.jules/sentinel.md +++ b/.jules/sentinel.md @@ -32,3 +32,7 @@ **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-10-06 - Missing Authentication on Admin Endpoint +**Vulnerability:** Admin endpoints (`/api/v1/admin/convert/jobs`, `/api/v1/admin/convert/jobs/{jobId}`, `/api/v1/admin/convert/jobs/{jobId}/retry`) in `AdminController.java` did not enforce any authentication or authorization checks. Any user could access or modify all conversion jobs across tenants. +**Learning:** Endpoints mapped to `/admin` or performing privileged operations must explicitly require high-privilege claims. Spring Security is not configured automatically for every custom controller. The `TenantAccessService` must be explicitly injected and invoked on every handler method. +**Prevention:** Always verify that internal administrative endpoints or broad tenant-spanning operations enforce an explicit permission (e.g., `admin:operate`) via a security guard service (like `TenantAccessService.require`) and explicitly pass the HTTP headers in the request to validate the claims. diff --git a/src/main/java/com/clearfolio/viewer/auth/TenantPermissions.java b/src/main/java/com/clearfolio/viewer/auth/TenantPermissions.java index 4f9c6a685..717e59a7d 100644 --- a/src/main/java/com/clearfolio/viewer/auth/TenantPermissions.java +++ b/src/main/java/com/clearfolio/viewer/auth/TenantPermissions.java @@ -55,6 +55,11 @@ public final class TenantPermissions { */ public static final String ANALYTICS_READ = "analytics:read"; + /** + * Permission required to perform administrative operations. + */ + public static final String ADMIN_OPERATE = "admin:operate"; + private TenantPermissions() { } } diff --git a/src/main/java/com/clearfolio/viewer/controller/AdminController.java b/src/main/java/com/clearfolio/viewer/controller/AdminController.java index 412d4eb86..da68807f4 100644 --- a/src/main/java/com/clearfolio/viewer/controller/AdminController.java +++ b/src/main/java/com/clearfolio/viewer/controller/AdminController.java @@ -4,17 +4,21 @@ import java.util.List; import java.util.UUID; +import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.DeleteMapping; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestHeader; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.server.ResponseStatusException; import com.clearfolio.viewer.api.AdminJobListResponse; +import com.clearfolio.viewer.auth.TenantAccessService; +import com.clearfolio.viewer.auth.TenantPermissions; import com.clearfolio.viewer.model.ConversionJob; import com.clearfolio.viewer.service.DocumentConversionService; import com.clearfolio.viewer.service.RetryDeadLetterResult; @@ -26,24 +30,36 @@ public class AdminController { private final DocumentConversionService conversionService; + private final TenantAccessService tenantAccessService; /** * Creates a controller for admin operations. * - * @param conversionService conversion service + * @param conversionServiceInjected conversion service + * @param tenantAccessServiceInjected tenant access service */ - public AdminController(DocumentConversionService conversionService) { - this.conversionService = conversionService; + public AdminController( + final DocumentConversionService conversionServiceInjected, + final TenantAccessService tenantAccessServiceInjected) { + this.conversionService = conversionServiceInjected; + this.tenantAccessService = tenantAccessServiceInjected; } /** * Retrieves all conversion jobs, optionally filtered by dead-letter status. * + * @param headers request headers * @param deadLettered optional filter for dead-lettered jobs * @return list of conversion jobs */ @GetMapping("/api/v1/admin/convert/jobs") - public AdminJobListResponse getAllJobs(@RequestParam(required = false) Boolean deadLettered) { + public AdminJobListResponse getAllJobs( + @RequestHeader final HttpHeaders headers, + @RequestParam(required = false) final Boolean deadLettered) { + + tenantAccessService.require( + headers, TenantPermissions.ADMIN_OPERATE); + Iterable allJobs = conversionService.getAllJobs(); if (deadLettered == null) { @@ -62,11 +78,17 @@ public AdminJobListResponse getAllJobs(@RequestParam(required = false) Boolean d /** * Deletes a conversion job. * + * @param headers request headers * @param jobId conversion job identifier * @return no content on success */ @DeleteMapping("/api/v1/admin/convert/jobs/{jobId}") - public ResponseEntity deleteJob(@PathVariable UUID jobId) { + public ResponseEntity deleteJob( + @RequestHeader final HttpHeaders headers, + @PathVariable final UUID jobId) { + + tenantAccessService.require( + headers, TenantPermissions.ADMIN_OPERATE); conversionService.deleteJob(jobId); return ResponseEntity.noContent().build(); } @@ -74,17 +96,26 @@ public ResponseEntity deleteJob(@PathVariable UUID jobId) { /** * Retries a dead-lettered conversion job. * + * @param headers request headers * @param jobId conversion job identifier * @return accepted response on success */ @PostMapping("/api/v1/admin/convert/jobs/{jobId}/retry") - public ResponseEntity retryDeadLettered(@PathVariable UUID jobId) { - RetryDeadLetterResult result = conversionService.retryDeadLettered(jobId, "admin"); + public ResponseEntity retryDeadLettered( + @RequestHeader final HttpHeaders headers, + @PathVariable final UUID jobId) { + + tenantAccessService.require( + headers, TenantPermissions.ADMIN_OPERATE); + RetryDeadLetterResult result = + conversionService.retryDeadLettered(jobId, "admin"); if (result == RetryDeadLetterResult.NOT_FOUND) { - throw new ResponseStatusException(HttpStatus.NOT_FOUND, "job not found"); + throw new ResponseStatusException( + HttpStatus.NOT_FOUND, "job not found"); } if (result == RetryDeadLetterResult.NOT_ELIGIBLE) { - throw new ResponseStatusException(HttpStatus.CONFLICT, "job is not eligible for retry"); + throw new ResponseStatusException( + HttpStatus.CONFLICT, "job is not eligible for retry"); } return ResponseEntity.accepted().build(); } diff --git a/src/test/java/com/clearfolio/viewer/controller/AdminControllerTest.java b/src/test/java/com/clearfolio/viewer/controller/AdminControllerTest.java index ad63a8015..ef29868d6 100644 --- a/src/test/java/com/clearfolio/viewer/controller/AdminControllerTest.java +++ b/src/test/java/com/clearfolio/viewer/controller/AdminControllerTest.java @@ -1,6 +1,9 @@ package com.clearfolio.viewer.controller; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import java.util.Arrays; @@ -9,7 +12,10 @@ import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.test.web.reactive.server.WebTestClient; +import org.springframework.http.HttpHeaders; +import com.clearfolio.viewer.auth.TenantAccessService; +import com.clearfolio.viewer.auth.TenantPermissions; import com.clearfolio.viewer.model.ConversionJob; import com.clearfolio.viewer.service.DocumentConversionService; import com.clearfolio.viewer.service.RetryDeadLetterResult; @@ -17,13 +23,16 @@ 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(); @@ -31,52 +40,66 @@ void setUp() { @Test void getAllJobsReturnsAllJobsWhenNoFilterProvided() { - ConversionJob job1 = new ConversionJob(UUID.randomUUID(), "a.pdf", "application/pdf", "hash-a", 100L); - ConversionJob job2 = new ConversionJob(UUID.randomUUID(), "b.pdf", "application/pdf", "hash-b", 100L); - when(conversionService.getAllJobs()).thenReturn(Arrays.asList(job1, job2)); + ConversionJob job1 = new ConversionJob( + UUID.randomUUID(), "a.pdf", "application/pdf", "hash-a", 100L); + ConversionJob job2 = new ConversionJob( + UUID.randomUUID(), "b.pdf", "application/pdf", "hash-b", 100L); + when(conversionService.getAllJobs()).thenReturn( + Arrays.asList(job1, job2)); webTestClient.get() .uri("/api/v1/admin/convert/jobs") .exchange() .expectStatus().isOk() .expectBody() - .jsonPath("$.jobs.length()").isEqualTo(2) - .jsonPath("$.jobs[0].fileName").isEqualTo("a.pdf") - .jsonPath("$.jobs[1].fileName").isEqualTo("b.pdf"); + .jsonPath("$.jobs.length()").isEqualTo(2); + + verify(tenantAccessService).require( + any(HttpHeaders.class), eq(TenantPermissions.ADMIN_OPERATE)); } @Test void getAllJobsFiltersByDeadLetteredTrue() { - ConversionJob job1 = new ConversionJob(UUID.randomUUID(), "a.pdf", "application/pdf", "hash-a", 100L); + ConversionJob job1 = new ConversionJob( + UUID.randomUUID(), "a.pdf", "application/pdf", "hash-a", 100L); job1.markDeadLettered("failed"); - ConversionJob job2 = new ConversionJob(UUID.randomUUID(), "b.pdf", "application/pdf", "hash-b", 100L); + ConversionJob job2 = new ConversionJob( + UUID.randomUUID(), "b.pdf", "application/pdf", "hash-b", 100L); - when(conversionService.getAllJobs()).thenReturn(Arrays.asList(job1, job2)); + when(conversionService.getAllJobs()).thenReturn( + Arrays.asList(job1, job2)); webTestClient.get() .uri("/api/v1/admin/convert/jobs?deadLettered=true") .exchange() .expectStatus().isOk() .expectBody() - .jsonPath("$.jobs.length()").isEqualTo(1) - .jsonPath("$.jobs[0].fileName").isEqualTo("a.pdf"); + .jsonPath("$.jobs.length()").isEqualTo(1); + + verify(tenantAccessService).require( + any(HttpHeaders.class), eq(TenantPermissions.ADMIN_OPERATE)); } @Test void getAllJobsFiltersByDeadLetteredFalse() { - ConversionJob job1 = new ConversionJob(UUID.randomUUID(), "a.pdf", "application/pdf", "hash-a", 100L); + ConversionJob job1 = new ConversionJob( + UUID.randomUUID(), "a.pdf", "application/pdf", "hash-a", 100L); job1.markDeadLettered("failed"); - ConversionJob job2 = new ConversionJob(UUID.randomUUID(), "b.pdf", "application/pdf", "hash-b", 100L); + ConversionJob job2 = new ConversionJob( + UUID.randomUUID(), "b.pdf", "application/pdf", "hash-b", 100L); - when(conversionService.getAllJobs()).thenReturn(Arrays.asList(job1, job2)); + when(conversionService.getAllJobs()).thenReturn( + Arrays.asList(job1, job2)); webTestClient.get() .uri("/api/v1/admin/convert/jobs?deadLettered=false") .exchange() .expectStatus().isOk() .expectBody() - .jsonPath("$.jobs.length()").isEqualTo(1) - .jsonPath("$.jobs[0].fileName").isEqualTo("b.pdf"); + .jsonPath("$.jobs.length()").isEqualTo(1); + + verify(tenantAccessService).require( + any(HttpHeaders.class), eq(TenantPermissions.ADMIN_OPERATE)); } @Test @@ -87,38 +110,53 @@ void deleteJobReturnsNoContent() { .uri("/api/v1/admin/convert/jobs/" + jobId) .exchange() .expectStatus().isNoContent(); + + verify(tenantAccessService).require( + any(HttpHeaders.class), eq(TenantPermissions.ADMIN_OPERATE)); } @Test void retryDeadLetteredReturnsAcceptedWhenAccepted() { UUID jobId = UUID.randomUUID(); - when(conversionService.retryDeadLettered(jobId, "admin")).thenReturn(RetryDeadLetterResult.ACCEPTED); + when(conversionService.retryDeadLettered(jobId, "admin")).thenReturn( + RetryDeadLetterResult.ACCEPTED); webTestClient.post() .uri("/api/v1/admin/convert/jobs/" + jobId + "/retry") .exchange() .expectStatus().isAccepted(); + + verify(tenantAccessService).require( + any(HttpHeaders.class), eq(TenantPermissions.ADMIN_OPERATE)); } @Test void retryDeadLetteredReturnsNotFoundWhenNotFound() { UUID jobId = UUID.randomUUID(); - when(conversionService.retryDeadLettered(jobId, "admin")).thenReturn(RetryDeadLetterResult.NOT_FOUND); + when(conversionService.retryDeadLettered(jobId, "admin")).thenReturn( + RetryDeadLetterResult.NOT_FOUND); webTestClient.post() .uri("/api/v1/admin/convert/jobs/" + jobId + "/retry") .exchange() .expectStatus().isNotFound(); + + verify(tenantAccessService).require( + any(HttpHeaders.class), eq(TenantPermissions.ADMIN_OPERATE)); } @Test void retryDeadLetteredReturnsConflictWhenNotEligible() { UUID jobId = UUID.randomUUID(); - when(conversionService.retryDeadLettered(jobId, "admin")).thenReturn(RetryDeadLetterResult.NOT_ELIGIBLE); + when(conversionService.retryDeadLettered(jobId, "admin")).thenReturn( + RetryDeadLetterResult.NOT_ELIGIBLE); webTestClient.post() .uri("/api/v1/admin/convert/jobs/" + jobId + "/retry") .exchange() - .expectStatus().isEqualTo(409); // isConflict() isn't always available depending on spring-test version, so using isEqualTo(409) is safer + .expectStatus().isEqualTo(409); + + verify(tenantAccessService).require( + any(HttpHeaders.class), eq(TenantPermissions.ADMIN_OPERATE)); } }