BrotliFilterTest.java
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2026 Apryse Group NV
Authors: Apryse Software.
This program is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://itextpdf.com/sales. For AGPL licensing, see below.
AGPL licensing:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.itextpdf.kernel.pdf.filters;
import com.itextpdf.io.exceptions.IOException;
import com.itextpdf.kernel.exceptions.MemoryLimitsAwareException;
import com.itextpdf.kernel.pdf.MemoryLimitsAwareHandler;
import com.itextpdf.kernel.pdf.PdfArray;
import com.itextpdf.kernel.pdf.PdfDictionary;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfName;
import com.itextpdf.kernel.pdf.PdfReader;
import com.itextpdf.kernel.pdf.PdfStream;
import com.itextpdf.kernel.pdf.PdfVersion;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.kernel.pdf.ReaderProperties;
import com.itextpdf.test.AssertUtil;
import com.itextpdf.test.ExtendedITextTest;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
/**
* Unit tests for {@link BrotliFilter}.
*/
@Tag("UnitTest")
public class BrotliFilterTest extends ExtendedITextTest {
@Test
public void testEmpty() throws IOException {
decompressValues("", "\u0006", null);
}
@Test
public void testX() throws IOException {
decompressValues("X", "\u000B\u0000\u0080X\u0003", null);
}
@Test
public void testX10Y10() throws IOException {
decompressValues(
"XXXXXXXXXXYYYYYYYYYY",
"\u001B\u0013\u0000\u0000\u00A4\u00B0\u00B2\u00EA\u0081G\u0002\u008A", null);
}
@Test
public void testX64() throws IOException {
decompressValues(
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"\u001B?\u0000\u0000$\u00B0\u00E2\u0099\u0080\u0012", null);
}
@Test
public void testUkkonooa() throws IOException {
decompressValues(
"ukko nooa, ukko nooa oli kunnon mies, kun han meni saunaan, "
+ "pisti laukun naulaan, ukko nooa, ukko nooa oli kunnon mies.",
"\u001Bv\u0000\u0000\u0014J\u00AC\u009Bz\u00BD\u00E1\u0097\u009D\u007F\u008E\u00C2\u0082"
+ "6\u000E\u009C\u00E0\u0090\u0003\u00F7\u008B\u009E8\u00E6\u00B6\u0000\u00AB\u00C3\u00CA"
+ "\u00A0\u00C2\u00DAf6\u00DC\u00CD\u0080\u008D.!\u00D7n\u00E3\u00EAL\u00B8\u00F0\u00D2"
+ "\u00B8\u00C7\u00C2pM:\u00F0i~\u00A1\u00B8Es\u00AB\u00C4W\u001E", null);
}
@Test
public void testMonkey() throws IOException {
decompressValues(
"znxcvnmz,xvnm.,zxcnv.,xcn.z,vn.zvn.zxcvn.,zxcn.vn.v,znm.,vnzx.,vnzxc.vn.z,vnz.,nv.z,nvmz"
+ "xc,nvzxcvcnm.,vczxvnzxcnvmxc.zmcnvzm.,nvmc,nzxmc,vn.mnnmzxc,vnxcnmv,znvzxcnmv,.xcnvm,zxc"
+ "nzxv.zx,qweryweurqioweupropqwutioweupqrioweutiopweuriopweuriopqwurioputiopqwuriowuqeriou"
+ "pqweropuweropqwurweuqriopuropqwuriopuqwriopuqweopruioqweurqweuriouqweopruioupqiytioqtyio"
+ "wtyqptypryoqweutioioqtweqruowqeytiowquiourowetyoqwupiotweuqiorweuqroipituqwiorqwtioweuri"
+ "ouytuioerytuioweryuitoweytuiweyuityeruirtyuqriqweuropqweiruioqweurioqwuerioqwyuituierwot"
+ "ueryuiotweyrtuiwertyioweryrueioqptyioruyiopqwtjkasdfhlafhlasdhfjklashjkfhasjklfhklasjdfh"
+ "klasdhfjkalsdhfklasdhjkflahsjdkfhklasfhjkasdfhasfjkasdhfklsdhalghhaf;hdklasfhjklashjklfa"
+ "sdhfasdjklfhsdjklafsd;hkldadfjjklasdhfjasddfjklfhakjklasdjfkl;asdjfasfljasdfhjklasdfhjka"
+ "ghjkashf;djfklasdjfkljasdklfjklasdjfkljasdfkljaklfj",
"\u001BJ\u0003\u0000\u008C\u0094n\u00DE\u00B4\u00D7\u0096\u00B1x\u0086\u00F2-\u00E1\u001A"
+ "\u00BC\u000B\u001C\u00BA\u00A9\u00C7\u00F7\u00CCn\u00B2B4QD\u008BN\u0013\b\u00A0\u00CDn"
+ "\u00E8,\u00A5S\u00A1\u009C],\u001D#\u001A\u00D2V\u00BE\u00DB\u00EB&\u00BA\u0003e|\u0096j"
+ "\u00A2v\u00EC\u00EF\u0087G3\u00D6\'\u000Ec\u0095\u00E2\u001D\u008D,\u00C5\u00D1(\u009F`"
+ "\u0094o\u0002\u008B\u00DD\u00AAd\u0094,\u001E;e|\u0007EZ\u00B2\u00E2\u00FCI\u0081,\u009F"
+ "@\u00AE\u00EFh\u0081\u00AC\u0016z\u000F\u00F5;m\u001C\u00B9\u001E-_\u00D5\u00C8\u00AF^"
+ "\u0085\u00AA\u0005\u00BESu\u00C2\u00B0\"\u008A\u0015\u00C6\u00A3\u00B1\u00E6B\u0014"
+ "\u00F4\u0084TS\u0019_\u00BE\u00C3\u00F2\u001D\u00D1\u00B7\u00E5\u00DD\u00B6\u00D9#\u00C6"
+ "\u00F6\u009F\u009E\u00F6Me0\u00FB\u00C0qE\u0004\u00AD\u0003\u00B5\u00BE\u00C9\u00CB\u00FD"
+ "\u00E2PZFt\u0004\r"
+ "\u00FF \u0004w\u00B2m\'\u00BFG\u00A9\u009D\u001B\u0096,b\u0090#"
+ "\u008B\u00E0\u00F8\u001D\u00CF\u00AF\u001D=\u00EE\u008A\u00C8u#f\u00DD\u00DE\u00D6m\u00E3"
+ "*\u0082\u008Ax\u008A\u00DB\u00E6"
+ " L\u00B7\\c\u00BA0\u00E3?\u00B6\u00EE\u008C\"\u00A2*\u00B0\"\n"
+ "\u0099\u00FF=bQ\u00EE\b\u00F6=J\u00E4\u00CC\u00EF\"\u0087\u0011\u00E2"
+ "\u0083(\u00E4\u00F5\u008F5\u0019c[\u00E1Z\u0092s\u00DD\u00A1P\u009D8\\\u00EB\u00B5\u0003jd"
+ "\u0090\u0094\u00C8\u008D\u00FB/\u008A\u0086\"\u00CC\u001D\u0087\u00E0H\n"
+ "\u0096w\u00909\u00C6##H\u00FB\u0011GV\u00CA"
+ " \u00E3B\u0081\u00F7w2\u00C1\u00A5\\@!e\u0017@)\u0017\u0017lV2\u00988\u0006\u00DC\u0099M3)"
+ "\u00BB\u0002\u00DFL&\u0093l\u0017\u0082\u0086"
+ " \u00D7"
+ "\u0003y}\u009A\u0000\u00D7\u0087\u0000\u00E7\u000Bf\u00E3Lfqg\b2\u00F9\b>\u00813\u00CD"
+ "\u0017r1\u00F0\u00B8\u0094RK\u00901\u008Eh\u00C1\u00EF\u0090\u00C9\u00E5\u00F2a"
+ "\tr%\u00AD\u00EC\u00C5b\u00C0\u000B\u0012\u0005\u00F7\u0091u\r"
+ "\u00EEa..\u0019\t\u00C2\u0003", null);
}
@Test
public void testFox() throws IOException {
decompressValues(
"The quick brown fox jumps over the lazy dog",
"\u001B*\u0000\u0000\u0004\u0004\u00BAF:\u0085\u0003\u00E9\u00FA\f\u0091\u0002H\u0011,"
+ "\u00F3\u008A:\u00A3V\u007F\u001A\u00AE\u00BF\u00A4\u00AB\u008EM\u00BF\u00ED\u00E2\u0004K"
+ "\u0091\u00FF\u0087\u00E9\u001E", null);
}
@Test
public void testFoxFox() {
decompressValues(
"The quick brown fox jumps over the lazy dog",
"\u001B*\u0000\u0000 \u0000\u00C2\u0098\u00B0\u00CA\u0001",
"The quick brown fox jumps over the lazy dog");
}
@Test
public void testWithSomeRandomValues() {
byte[] bytes = convertUnicodeStringToBytes("\u000B\u0000\u0080X\u0003");
BrotliFilter filter = new BrotliFilter();
try (PdfDocument pdf = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()))) {
PdfStream stream = new PdfStream(bytes);
stream.makeIndirect(pdf);
AssertUtil.doesNotThrow(() -> {
filter.decode(bytes, PdfName.BrotliDecode, new PdfName("slkdjf"), stream);
});
}
}
@Test
public void testWithMemoryAwareFilterHandler() throws java.io.IOException {
byte[] bytes = convertUnicodeStringToBytes(
"\u001B*\u0000\u0000\u0004\u0004\u00BAF:\u0085\u0003\u00E9\u00FA\f\u0091\u0002H\u0011,"
+ "\u00F3\u008A:\u00A3V\u007F\u001A\u00AE\u00BF\u00A4\u00AB\u008EM\u00BF\u00ED\u00E2\u0004K"
+ "\u0091\u00FF\u0087\u00E9\u001E");
try (PdfDocument pdf = new PdfDocument(new NoOpPdfReader(),
new PdfWriter(new ByteArrayOutputStream())) {
final MemoryLimitsAwareHandler handler = new MemoryLimitsAwareHandler() {
@Override
public boolean isMemoryLimitsAwarenessRequiredOnDecompression(PdfArray filters) {
return true;
}
};
@Override
public MemoryLimitsAwareHandler getMemoryLimitsAwareHandler() {
handler.setMaxSizeOfSingleDecompressedPdfStream(1);
return handler;
}
@Override
public void close() {
}
@Override
protected void open(PdfVersion newPdfVersion) {
// No need to open the pdf for this test
}
}) {
PdfStream stream = new PdfStream(bytes);
stream.put(PdfName.Filter, PdfName.BrotliDecode);
stream.makeIndirect(pdf);
Map<PdfName, IFilterHandler> handlers = new HashMap<>();
BrotliFilter filter = new BrotliFilter();
handlers.put(PdfName.BrotliDecode, filter);
Assertions.assertThrows(MemoryLimitsAwareException.class, () -> {
PdfReader.decodeBytes(bytes, stream, handlers);
});
}
}
private void decompressValues(String expected, String compressed, String dictionary) {
BrotliFilter filter = new BrotliFilter();
byte[] expectedBytes = convertUnicodeStringToBytes(expected);
byte[] compressedBytes = convertUnicodeStringToBytes(compressed);
PdfDictionary decodeParams = new PdfDictionary();
if (dictionary != null) {
PdfStream dictStream = new PdfStream(convertUnicodeStringToBytes(dictionary));
decodeParams.put(PdfName.D, dictStream);
}
try (PdfDocument pdf = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()))) {
PdfStream stream = new PdfStream(compressedBytes);
stream.makeIndirect(pdf);
byte[] actual = filter.decode(compressedBytes, PdfName.BrotliDecode, decodeParams, stream);
Assertions.assertArrayEquals(expectedBytes, actual);
}
}
private static byte[] convertUnicodeStringToBytes(String unicodeString) {
byte[] result = new byte[unicodeString.length()];
for (int i = 0; i < result.length; ++i) {
result[i] = (byte) unicodeString.charAt(i);
}
return result;
}
private static class NoOpPdfReader extends PdfReader {
NoOpPdfReader() throws java.io.IOException {
super(new ByteArrayInputStream(
("%PDF-1.7\n%��������\n1 0 obj\n<< /Type /Catalog >>\nendobj\ntrailer\n<< /Root 1 0 R "
+ ">>\n%%EOF").getBytes(StandardCharsets.UTF_8)),
new ReaderProperties());
}
}
}