API: ключ доступа X-API-Key и серверные лимиты входа

ApiKeyFilter — единственная граница доступа: сверяет X-API-Key со
свойством wordpdf.api-key (env WORDPDF_API_KEY, MessageDigest.isEqual);
пустое свойство = аутентификация выключена; /actuator/** открыт для
HEALTHCHECK; 401 отдаёт сам фильтр. Лимиты входа задаёт только
конфигурация сервера (wordpdf.max-bytes/max-pages, env
WORDPDF_MAX_BYTES/WORDPDF_MAX_PAGES, @Value с дефолтом-SpEL из констант
ядра; <=0 — падение на старте), параметрами запроса не переопределяются
(регрессии requestLimitParams_areIgnored, nonPositiveLimits_failStartup).
Конвертация — байты насквозь; опции рисования из запроса → ConvertOptions.
This commit is contained in:
Pjandro
2026-10-14 01:50:35 +00:00
parent 0a411a944b
commit 25ed56bf20
10 changed files with 443 additions and 76 deletions
@@ -9,6 +9,7 @@ import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.multipart.MaxUploadSizeExceededException;
import org.springframework.web.multipart.support.MissingServletRequestPartException;
import org.springframework.web.servlet.resource.NoResourceFoundException;
/**
* Единый перевод исключений в JSON {@code {"error": "..."}} с кодом по смыслу.
@@ -27,7 +28,7 @@ final class ApiExceptionHandler {
record ApiError(String error) {
}
/** Некорректный вход: пустой, не .docx, не zip, битый zip, > 5 MiB, > 100 страниц. */
/** Некорректный вход: пустой, не .docx, не zip, размер/страницы сверх лимитов запроса. */
@ExceptionHandler(ValidationException.class)
ResponseEntity<ApiError> validation(ValidationException e) {
return ResponseEntity.badRequest().body(new ApiError(e.getMessage()));
@@ -55,13 +56,15 @@ final class ApiExceptionHandler {
}
/**
* Контейнерный лимит multipart (6 МБ в application.properties) сработал
* раньше ядра: текст свой, смысл тот же, что у 400 от {@code WordPdfValidator}.
* Контейнерный потолок multipart (100 МБ в application.properties)
* сработал раньше ядра: срабатывает только на инфраструктурный лимит,
* авторитетный (свойство {@code wordpdf.max-bytes}/env {@code WORDPDF_MAX_BYTES})
* проверяет {@code WordPdfValidator} и отвечает 400 своим текстом.
*/
@ExceptionHandler(MaxUploadSizeExceededException.class)
ResponseEntity<ApiError> tooLarge(MaxUploadSizeExceededException e) {
return ResponseEntity.status(HttpStatus.PAYLOAD_TOO_LARGE)
.body(new ApiError("Файл больше 5 МБ"));
.body(new ApiError("Файл больше 100 МБ"));
}
/** Партита {@code file} нет в запросе — обе формы исключения возможны. */
@@ -72,6 +75,18 @@ final class ApiExceptionHandler {
.body(new ApiError("Файл не передан (multipart-поле «file» обязательно)"));
}
/**
* springdoc в проде выключен env'ом — запросы к {@code /v3/api-docs} и
* {@code /swagger-ui*} (с валидным ключом) доходят до обработчика
* статических ресурсов; без этого маппинга их ловил catch-all {@link #unexpected}
* и отвечал 500 вместо 404. Регрессия — ConvertControllerTest#unknownPath_notFound.
*/
@ExceptionHandler(NoResourceFoundException.class)
ResponseEntity<ApiError> notFound(NoResourceFoundException e) {
return ResponseEntity.status(HttpStatus.NOT_FOUND)
.body(new ApiError("Не найдено"));
}
/** Прочее — внутренняя ошибка; подробность только в лог, не в ответ. */
@ExceptionHandler(Exception.class)
ResponseEntity<ApiError> unexpected(Exception e) {
@@ -0,0 +1,57 @@
package ru.pjandro.wordpdf.app;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.OncePerRequestFilter;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
/**
* Единственная граница доступа: заголовок {@value #HEADER} обязан совпадать с
* {@code wordpdf.api-key}. Пустое свойство = фильтрация выключена (dev/тесты).
* {@code /actuator/**} открыт — им дышит Docker HEALTHCHECK. Ответ 401 пишется
* здесь же, {@link ApiExceptionHandler} ошибок фильтров не видит; форма тела —
* та же {@code {"error": …}}.
*
* <p>Регрессия — ApiKeyFilterTest.</p>
*/
@Component
final class ApiKeyFilter extends OncePerRequestFilter {
static final String HEADER = "X-API-Key";
/** null — аутентификация выключена. */
private final byte[] expected;
ApiKeyFilter(@Value("${wordpdf.api-key:}") String apiKey) {
String key = apiKey == null ? "" : apiKey.trim();
this.expected = key.isEmpty() ? null : key.getBytes(StandardCharsets.UTF_8);
}
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
FilterChain chain) throws ServletException, IOException {
if (expected == null || request.getRequestURI().startsWith("/actuator/")) {
chain.doFilter(request, response);
return;
}
String provided = request.getHeader(HEADER);
// MessageDigest.isEqual — сравнение за постоянное время (портал в интернете)
if (provided != null
&& MessageDigest.isEqual(expected, provided.getBytes(StandardCharsets.UTF_8))) {
chain.doFilter(request, response);
return;
}
response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
response.setContentType("application/json");
response.setCharacterEncoding("UTF-8");
response.getWriter().write(
"{\"error\":\"Ключ доступа не передан или неверен (заголовок X-API-Key)\"}");
}
}
@@ -3,13 +3,11 @@ package ru.pjandro.wordpdf.app;
import jakarta.annotation.PreDestroy;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import ru.pjandro.wordpdf.ConvertOptions;
import ru.pjandro.wordpdf.ConversionException;
import ru.pjandro.wordpdf.WordPdfConverter;
import ru.pjandro.wordpdf.WordPdfValidator;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.time.Duration;
import java.util.Locale;
import java.util.concurrent.ArrayBlockingQueue;
@@ -27,7 +25,7 @@ import java.util.concurrent.TimeoutException;
* случай»: каждая конвертация мутирует ГЛОБАЛЬНЫЙ реестр шрифтов docx4j
* ({@code new BundledFontMapper()} заново добавляет системные шрифты
* в {@code PhysicalFonts}, {@code BundledFonts.init()/restrictToBundled()}
* их вычищают — WordPdfConverter.java:125-130). Параллельные конвертации
* их вычищают — WordPdfConverter.convertToStream, шаг 1 пайплайна). Параллельные конвертации
* вырывают реестр друг у друга из-под рендера, ядро не потокобезопасно
* by design. Регрессия — ConvertControllerTest#concurrentRequests_bothSucceed.</p>
*
@@ -63,12 +61,16 @@ final class ConversionService {
* @throws ConversionFailedException ошибка ядра/рендера (500)
* @throws ConversionRejectedException очередь полна / прерывание (503)
* @throws ConversionTimeoutException конвертация дольше {@code wordpdf.convert-timeout} (504)
*
* <p>{@code options} — рисование и лимиты входа на этот вызов (лимиты
* задаёт конфигурация сервера, контроллер подставляет их из свойств);
* {@code null} не допускается (контроллер строит всегда).</p>
*/
byte[] convert(byte[] docxBytes, String originalFilename) {
validate(docxBytes);
byte[] convert(byte[] docxBytes, String originalFilename, ConvertOptions options) {
validate(docxBytes, options);
Future<byte[]> future;
try {
future = workers.submit(() -> doConvert(docxBytes, originalFilename));
future = workers.submit(() -> doConvert(docxBytes, originalFilename, options));
} catch (RejectedExecutionException e) {
throw new ConversionRejectedException();
}
@@ -106,7 +108,10 @@ final class ConversionService {
/**
* Валидация байтов переиспользует публичные byte-API ядра. Порядок значим:
* размер (дешёвая) → magic bytes → lightweight-разбор zip.
* размер (дешёвая) → magic bytes → lightweight-разбор zip. Лимиты
* размера/страниц берутся из {@code options} (контроллер подставляет их
* из конфигурации сервера: свойства {@code wordpdf.max-bytes}/
* {@code wordpdf.max-pages}, дефолт — константы ядра).
*
* <p>Проверка zip-подписи отдельным шагом обязательна:
* {@code ZipInputStream.getNextEntry()} на не-zip-потоке возвращает
@@ -114,9 +119,9 @@ final class ConversionService {
* такой вход не отверг бы (0 страниц). Регрессия —
* ConvertControllerTest#corruptNotAZip_rejected.</p>
*/
void validate(byte[] docxBytes) {
void validate(byte[] docxBytes, ConvertOptions options) {
try {
WordPdfValidator.checkInput(docxBytes);
WordPdfValidator.checkInput(docxBytes, options.maxBytes());
} catch (ConversionException e) {
throw new ValidationException(e.getMessage(), e);
}
@@ -125,47 +130,28 @@ final class ConversionService {
throw new ValidationException("Содержимое не похоже на .docx (не zip-архив)");
}
try {
WordPdfValidator.checkPageCountLightweight(docxBytes);
WordPdfValidator.checkPageCountLightweight(docxBytes, options.maxPages());
} catch (ConversionException e) {
throw new ValidationException(e.getMessage(), e);
}
}
/**
* Тело задачи воркера. Байтового API в ядре нет ({@code convertToStream}
* private и принимает {@code Path}), поэтому временные файлы; имя docx
* влияет на заголовок PDF (ядро берёт baseName файла), потому санитизировано.
* Тело задачи воркера. Ядро принимает байты — временные файлы не нужны;
* имя влияет только на заголовок PDF (параметр {@code title}), потому
* санитизировано.
*/
private static byte[] doConvert(byte[] docxBytes, String originalFilename) {
Path dir = null;
Path in = null;
Path out = null;
private static byte[] doConvert(byte[] docxBytes, String originalFilename, ConvertOptions options) {
try {
dir = Files.createTempDirectory("wordpdf-");
String docxName = safeDocxName(originalFilename);
in = dir.resolve(docxName);
out = dir.resolve(safeBaseName(originalFilename) + ".pdf");
Files.write(in, docxBytes);
WordPdfConverter.convert(in, out);
return Files.readAllBytes(out);
// заголовок PDF — санитизированный base исходного имени
return WordPdfConverter.convert(docxBytes, safeBaseName(originalFilename), options);
} catch (ConversionException e) {
// всё, что упало на рендер-стадии, — ошибка преобразования, 500
// всё, что упало на валидации/рендер-стадии ядра, — ошибка преобразования, 500
throw new ConversionFailedException("Не удалось конвертировать документ: "
+ e.getMessage(), e);
} catch (IOException e) {
throw new ConversionFailedException(e);
} finally {
deleteQuietly(out);
deleteQuietly(in);
deleteQuietly(dir);
}
}
/** Имя docx для временного файла: чистый base + обязательный суффикс .docx. */
static String safeDocxName(String original) {
return safeBaseName(original) + ".docx";
}
/**
* Санитизация имени (единый источник для имени файла и Content-Disposition):
* без каталога, только буквы/цифры/пробел/ {@code . _ -}, без суффикса
@@ -186,17 +172,6 @@ final class ConversionService {
return base.strip();
}
private static void deleteQuietly(Path p) {
if (p == null) {
return;
}
try {
Files.deleteIfExists(p);
} catch (IOException ignored) {
// вторичная ошибка очистки не должна затенять основной результат
}
}
@PreDestroy
void shutdown() {
workers.shutdownNow();
@@ -8,7 +8,10 @@ import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.multipart.MultipartFile;
import ru.pjandro.wordpdf.ConvertOptions;
import ru.pjandro.wordpdf.WordPdfSettings;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
@@ -21,29 +24,56 @@ import java.util.Locale;
* <p>Здесь только HTTP-слой: проверка presence/расширения и формирование
* {@code Content-Disposition}; проверка содержимого (zip, размер, страницы) —
* зона {@link ConversionService#validate}. Ошибки в JSON-ответ переводит
* {@link ApiExceptionHandler}.</p>
* {@link ApiExceptionHandler}. Лимиты входа — только конфигурация сервера
* (свойства {@code wordpdf.max-bytes}/{@code wordpdf.max-pages}, env
* {@code WORDPDF_MAX_BYTES}/{@code WORDPDF_MAX_PAGES}); параметрами запроса
* они не переопределяются.</p>
*/
@RestController
final class ConvertController {
private final ConversionService conversionService;
private final long maxBytes;
private final int maxPages;
ConvertController(ConversionService conversionService) {
/**
* Дефолт плейсхолдеров — константы ядра через SpEL: буквальное значение
* в свойствах не дублируется. Невалидное значение (<= 0) роняет
* приложение на старте (fail-fast): «сервис поднят, но весь вход
* отсекается» — худший исход, чем не поднявшийся сервис.
*/
ConvertController(ConversionService conversionService,
@Value("${wordpdf.max-bytes:#{T(ru.pjandro.wordpdf.WordPdfSettings).MAX_INPUT_BYTES}}") long maxBytes,
@Value("${wordpdf.max-pages:#{T(ru.pjandro.wordpdf.WordPdfSettings).MAX_PAGES}}") int maxPages) {
if (maxBytes <= 0) {
throw new IllegalStateException("wordpdf.max-bytes должен быть больше 0: " + maxBytes);
}
if (maxPages <= 0) {
throw new IllegalStateException("wordpdf.max-pages должен быть больше 0: " + maxPages);
}
this.conversionService = conversionService;
this.maxBytes = maxBytes;
this.maxPages = maxPages;
}
@Operation(summary = "Конвертировать .docx в PDF")
@Operation(summary = "Конвертировать .docx в PDF",
description = "renderCharts/renderSmartArt — факультативно, по умолчанию настройки ядра; "
+ "лимиты входа (размер/страницы) задаёт только конфигурация сервера "
+ "(свойства wordpdf.max-bytes/wordpdf.max-pages), параметрами запроса не переопределяются")
@PostMapping(
path = "/api/v1/convert",
consumes = MediaType.MULTIPART_FORM_DATA_VALUE,
produces = MediaType.APPLICATION_PDF_VALUE)
ResponseEntity<byte[]> convert(@RequestParam("file") MultipartFile file) {
ResponseEntity<byte[]> convert(
@RequestParam("file") MultipartFile file,
@RequestParam(name = "renderCharts", required = false) Boolean renderCharts,
@RequestParam(name = "renderSmartArt", required = false) Boolean renderSmartArt) {
if (file == null || file.isEmpty()) {
throw new ValidationException("Файл не передан (multipart-поле «file» обязательно)");
}
String name = file.getOriginalFilename();
if (name == null || !name.toLowerCase(Locale.ROOT).endsWith(".docx")) {
// та же формулировка, что у WordPdfValidator.checkInput(Path)
// расширение проверяется здесь: ядро с байтов его не видит
throw new ValidationException("Поддерживается только .docx (без .doc): " + name);
}
byte[] docxBytes;
@@ -52,7 +82,11 @@ final class ConvertController {
} catch (IOException e) {
throw new ValidationException("Не удалось прочитать загруженный файл", e);
}
byte[] pdf = conversionService.convert(docxBytes, name);
ConvertOptions options = new ConvertOptions(
renderCharts != null ? renderCharts : WordPdfSettings.RENDER_CHARTS,
renderSmartArt != null ? renderSmartArt : WordPdfSettings.RENDER_SMARTART,
maxBytes, maxPages);
byte[] pdf = conversionService.convert(docxBytes, name, options);
ContentDisposition disposition = ContentDisposition.attachment()
.filename(ConversionService.safeBaseName(name) + ".pdf", StandardCharsets.UTF_8)
.build();
@@ -1,8 +1,8 @@
package ru.pjandro.wordpdf.app;
/**
* Некорректный вход: пустой файл, не .docx, не zip-архив, размер больше
* {@code WordPdfValidator.MAX_INPUT_BYTES}, страниц больше ста.
* Некорректный вход: пустой файл, не .docx, не zip-архив, размер или число
* страниц сверх переданных в запросе (или дефолтных) лимитов.
*
* <p>Отличается от {@link ConversionFailedException} смыслом: запрос
* некорректен сам по себе, повтор его же ничего не изменит. Маппится в HTTP 400
@@ -1,10 +1,19 @@
spring.application.name=wordpdf-app
# 6MB, а не 5MB: авторитетный лимит — ядро (WordPdfValidator.MAX_INPUT_BYTES
# = 5 MiB = 5 242 880 Б). С multipart-лимитом «5MB» (5 000 000 Б) файлы
# 5.0–5.24 МБ отбивались бы контейнером с неверным текстом ошибки раньше ядра.
# file-size-threshold=6MB держит файл в памяти (ядро и так читает всё в RAM).
spring.servlet.multipart.max-file-size=6MB
spring.servlet.multipart.max-request-size=6MB
spring.servlet.multipart.file-size-threshold=6MB
# Потолок инфраструктуры — 100 МБ (совпадает с client_max_body_size в
# nginx-шлюзах): больше не пропустит ни шлюз, ни контейнер. Авторитетный
# лимит — свойство wordpdf.max-bytes (env WORDPDF_MAX_BYTES), по умолчанию
# WordPdfSettings.MAX_INPUT_BYTES = 20 MiB; здесь только потолок загрузки.
# Лимиты входа: env WORDPDF_MAX_BYTES (байты) / WORDPDF_MAX_PAGES (страницы),
# дефолты — константы ядра (20 MiB / 1000), задаются ConvertController.
# Значение <= 0 — падение на старте. Сами ключи здесь не объявлены:
# пустое значение затенит SpEL-дефолт @Value.
# file-size-threshold=100MB держит файл в памяти (ядро и так читает всё в RAM).
spring.servlet.multipart.max-file-size=100MB
spring.servlet.multipart.max-request-size=100MB
spring.servlet.multipart.file-size-threshold=100MB
# Таймаут одной конвертации (binding Duration в ConversionService)
wordpdf.convert-timeout=2m
# Ключ доступа (заголовок X-API-Key). Пусто = аутентификация выключена
# (dev: java -jar / тесты). В docker-compose задан ${WORDPDF_API_KEY:?} — fail-closed.
wordpdf.api-key=
@@ -0,0 +1,97 @@
package ru.pjandro.wordpdf.app;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.mock.web.MockMultipartFile;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.multipart;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
/**
* Граница доступа {@link ApiKeyFilter}: ключ включается только здесь
* (свойством в этом контексте — единственный способ включить auth в тестах;
* в основном контексте {@code ConvertControllerTest} ключ пуст, что и есть
* негативный кейс «аутентификация выключена»).
*/
@SpringBootTest(properties = "wordpdf.api-key=test-secret-key")
@AutoConfigureMockMvc
class ApiKeyFilterTest {
private static final MediaType DOCX =
MediaType.parseMediaType("application/vnd.openxmlformats-officedocument.wordprocessingml.document");
@Autowired
private MockMvc mockMvc;
/** Байты фикстуры из classpath (test-jar core: samples/…). */
private static byte[] bytes(String resource) throws IOException {
try (InputStream in = ApiKeyFilterTest.class.getResourceAsStream(resource)) {
assertNotNull(in, "Нет ресурса: " + resource);
return in.readAllBytes();
}
}
private static MockMultipartFile docx(String filename, byte[] content) {
return new MockMultipartFile("file", filename, DOCX.toString(), content);
}
@Test
void noKey_rejected() throws Exception {
mockMvc.perform(multipart("/api/v1/convert")
.file(docx("ru-plain.docx", bytes("/samples/ru-plain.docx"))))
.andExpect(status().isUnauthorized())
.andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("X-API-Key")));
}
@Test
void wrongKey_rejected() throws Exception {
mockMvc.perform(multipart("/api/v1/convert")
.file(docx("ru-plain.docx", bytes("/samples/ru-plain.docx")))
.header(ApiKeyFilter.HEADER, "wrong"))
.andExpect(status().isUnauthorized())
.andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("X-API-Key")));
}
@Test
void correctKey_converts() throws Exception {
MvcResult result = mockMvc.perform(multipart("/api/v1/convert")
.file(docx("ru-plain.docx", bytes("/samples/ru-plain.docx")))
.header(ApiKeyFilter.HEADER, "test-secret-key"))
.andExpect(status().isOk())
.andReturn();
byte[] pdf = result.getResponse().getContentAsByteArray();
assertTrue(new String(pdf, 0, 4, StandardCharsets.US_ASCII).equals("%PDF"),
"ответ не PDF");
}
@Test
void healthOpenWithoutKey() throws Exception {
// Docker HEALTHCHECK дышит /actuator/** без ключа — иначе контейнер
// никогда не станет healthy
mockMvc.perform(get("/actuator/health"))
.andExpect(status().isOk());
}
@Test
void openApiRequiresKey() throws Exception {
// в тестах springdoc включён; в проде выключен env'ом — фильтр
// накрывает документацию, когда она активна
mockMvc.perform(get("/v3/api-docs"))
.andExpect(status().isUnauthorized());
}
}
@@ -1,7 +1,10 @@
package ru.pjandro.wordpdf.app;
import org.apache.pdfbox.Loader;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDResources;
import org.apache.pdfbox.text.PDFTextStripper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
@@ -17,6 +20,7 @@ import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
@@ -24,8 +28,11 @@ import java.util.concurrent.Future;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.multipart;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header;
@@ -71,6 +78,22 @@ class ConvertControllerTest {
}
}
/** Количество Image XObject на всех страницах PDF-байтов. */
private static int imageCount(byte[] pdf) throws IOException {
int count = 0;
try (PDDocument doc = Loader.loadPDF(pdf)) {
for (PDPage page : doc.getPages()) {
PDResources res = page.getResources();
for (COSName name : res.getXObjectNames()) {
if (res.isImageXObject(name)) {
count++;
}
}
}
}
return count;
}
/** Валидный zip с одной мусорной записью (не OPC-пакет). */
private static byte[] zipWithGarbage() throws IOException {
ByteArrayOutputStream bos = new ByteArrayOutputStream();
@@ -100,6 +123,33 @@ class ConvertControllerTest {
"нет алфавита: " + text);
}
/**
* Выключенные renderCharts/renderSmartArt: 200, PDF без единого растра,
* текст вокруг рисунков сохраняется. Тот же запрос без параметров —
* дефолты ядра пробиваются сквозь HTTP: картинки на месте.
*/
@Test
void renderFlagsOff_convertsWithoutDrawings() throws Exception {
byte[] sample = bytes("/samples/charts-smartart.docx");
byte[] off = mockMvc.perform(multipart("/api/v1/convert")
.file(docx("charts-smartart.docx", sample))
.param("renderCharts", "false")
.param("renderSmartArt", "false"))
.andExpect(status().isOk())
.andExpect(content().contentType(MediaType.APPLICATION_PDF))
.andReturn().getResponse().getContentAsByteArray();
String offText = norm(pdfText(off));
assertTrue(offText.contains("Диаграммы"), "пропал текст вокруг диаграмм: " + offText);
assertEquals(0, imageCount(off), "выключенные drawing'и дали растры");
byte[] on = mockMvc.perform(multipart("/api/v1/convert")
.file(docx("charts-smartart.docx", sample)))
.andExpect(status().isOk())
.andReturn().getResponse().getContentAsByteArray();
assertTrue(imageCount(on) >= 4,
"дефолты ядра не пробиты сквозь HTTP: найдено растров " + imageCount(on));
}
@Test
void cyrillicAndPathInFilename_sanitizedResponseName() throws Exception {
byte[] sample = bytes("/samples/ru-plain.docx");
@@ -147,22 +197,42 @@ class ConvertControllerTest {
@Test
void oversizedOverCoreLimit_rejected() throws Exception {
// 5 MiB + 1 байт: проходит контейнерный multipart-лимит (6 MB)
// и отсекается валидацией ядра до очереди
byte[] big = new byte[5 * 1024 * 1024 + 1];
// 20 MiB + 1 байт: проходит контейнерный multipart-лимит (100 МБ)
// и отсекается валидацией ядра до очереди (дефолт ядра цел —
// лимит задаёт только конфигурация сервера)
byte[] big = new byte[20 * 1024 * 1024 + 1];
mockMvc.perform(multipart("/api/v1/convert").file(docx("big.docx", big)))
.andExpect(status().isBadRequest())
.andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("больше 5 МБ")));
org.hamcrest.Matchers.containsString("больше 20 МБ")));
}
/**
* Регрессия env-only: лимиты входа параметрами запроса не задаются.
* maxBytes/maxPages в multipart-форме игнорируются — маленький
* документ проходит на серверных лимитах (дефолты ядра).
*/
@Test
void tooManyPages_rejectedBeforeRender() throws Exception {
void requestLimitParams_areIgnored() throws Exception {
mockMvc.perform(multipart("/api/v1/convert")
.file(docx("too-many-pages.docx", bytes("/samples/too-many-pages.docx"))))
.andExpect(status().isBadRequest())
.andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("100")));
.file(docx("ru-plain.docx", bytes("/samples/ru-plain.docx")))
.param("maxBytes", "1000")
.param("maxPages", "1"))
.andExpect(status().isOk())
.andExpect(content().contentType(MediaType.APPLICATION_PDF));
}
/**
* Невалидные лимиты в конфигурации — падение на старте (fail-fast):
* «сервис поднят, но весь вход отсекается» хуже не поднявшегося.
* ConversionService в ctor не участвует (потоки ленивы, утечки нет).
*/
@Test
void nonPositiveLimits_failStartup() {
assertThrows(IllegalStateException.class, () -> new ConvertController(
new ConversionService(Duration.ofSeconds(5)), 0L, 1000));
assertThrows(IllegalStateException.class, () -> new ConvertController(
new ConversionService(Duration.ofSeconds(5)), 1L, 0));
}
@Test
@@ -221,4 +291,14 @@ class ConvertControllerTest {
.andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("Не удалось конвертировать")));
}
@Test
void unknownPath_notFound() throws Exception {
// в проде springdoc выключен — /v3/api-docs и /swagger-ui* попадают
// сюда же: 404 от отдельного хендлера, а не 500 от catch-all
mockMvc.perform(get("/no-such-path"))
.andExpect(status().isNotFound())
.andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("Не найдено")));
}
}
@@ -0,0 +1,94 @@
package ru.pjandro.wordpdf.app;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.mock.web.MockMultipartFile;
import org.springframework.test.context.TestPropertySource;
import org.springframework.test.web.servlet.MockMvc;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.Random;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.multipart;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
/**
* Лимиты входа из конфигурации сервера (свойства {@code wordpdf.max-bytes}/
* {@code wordpdf.max-pages}) применяются сквозь HTTP: отдельный контекст с
* {@code @TestPropertySource} доказывает, что {@code ConvertController}
* читает их из окружения Spring, а не живёт на константах ядра.
* Отдельный класс, а не {@code @Nested}: {@code @Nested} +
* {@code @TestPropertySource} не даёт отдельного контекста.
*
* <p>Пара свойств согласована с фикстурами: {@code max-bytes=20000} выше
* обеих (2612 и 2887 байт), так что page-отсечка на {@code max-pages=1}
* достижима; для byte-отсечки берётся файл заведомо больше 20000.</p>
*/
@SpringBootTest
@AutoConfigureMockMvc
@TestPropertySource(properties = {"wordpdf.max-bytes=20000", "wordpdf.max-pages=1"})
class ConvertLimitsTest {
private static final MediaType DOCX =
MediaType.parseMediaType("application/vnd.openxmlformats-officedocument.wordprocessingml.document");
@Autowired
private MockMvc mockMvc;
private static byte[] bytes(String resource) throws IOException {
try (InputStream in = ConvertLimitsTest.class.getResourceAsStream(resource)) {
assertNotNull(in, "Нет ресурса: " + resource);
return in.readAllBytes();
}
}
private static MockMultipartFile docx(String filename, byte[] content) {
return new MockMultipartFile("file", filename, DOCX.toString(), content);
}
/** Zip с ~40 КБ псевдослучайных байтов: больше лимита 20000, не жмётся. */
private static byte[] oversizedZip() throws IOException {
byte[] payload = new byte[40_000];
new Random(1).nextBytes(payload);
ByteArrayOutputStream bos = new ByteArrayOutputStream();
try (ZipOutputStream zout = new ZipOutputStream(bos)) {
zout.putNextEntry(new ZipEntry("garbage.bin"));
zout.write(payload);
zout.closeEntry();
}
return bos.toByteArray();
}
/** Свойство wordpdf.max-bytes отсекает файл до любой другой проверки. */
@Test
void configuredMaxBytes_applies() throws Exception {
mockMvc.perform(multipart("/api/v1/convert")
.file(docx("big.docx", oversizedZip())))
.andExpect(status().isBadRequest())
.andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("20000 байт")));
}
/**
* Свойство wordpdf.max-pages=1 отсекает фикстуру на 151 страницу на
* lightweight-проверке, до рендера (2887 байт — меньше лимита размера).
*/
@Test
void configuredMaxPages_appliesBeforeRender() throws Exception {
mockMvc.perform(multipart("/api/v1/convert")
.file(docx("too-many-pages.docx", bytes("/samples/too-many-pages.docx"))))
.andExpect(status().isBadRequest())
.andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("страниц")));
}
}