Add check for pdf names in pdfa

DEVSIX-4048

Author: dzmitry.kachkou

pdfa/src/main/java/com/itextpdf/pdfa/PdfAConformanceException.java

@@ -50,8 +50,6 @@ This file is part of the iText (R) project.
  */
 public class PdfAConformanceException extends PdfException {
 
-    private static final long serialVersionUID = -5951503441486657717L;
-
     public static final String _0_ACTIONS_ARE_NOT_ALLOWED = "{0} actions are not allowed";
     public static final String A_CATALOG_DICTIONARY_SHALL_CONTAIN_METADATA_ENTRY = "A catalog dictionary shall contain metadata entry";
     public static final String A_CATALOG_DICTIONARY_SHALL_NOT_CONTAIN_AA_ENTRY = "A catalog dictionary shall not contain aa entry";
@@ -128,6 +126,7 @@ public class PdfAConformanceException extends PdfException {
     public static final String ORDER_ARRAY_SHALL_CONTAIN_REFERENCES_TO_ALL_OCGS = "Order array shall contain references to all ocgs";
     public static final String OUTPUT_INTENT_COLOR_SPACE_SHALL_BE_EITHER_GRAY_RGB_OR_CMYK = "Output intent color space shall be either gray rgb or cmyk";
     public static final String OVERPRINT_MODE_SHALL_NOT_BE_ONE_WHEN_AN_ICCBASED_CMYK_COLOUR_SPACE_IS_USED_AND_WHEN_OVERPRINTING_IS_SET_TO_TRUE = "Overprint mode shall not be one when an ICCBased CMYK colour space is used and when overprinting is set to true";
+    public static final String PDF_NAME_IS_TOO_LONG = "PdfName is too long";
     public static final String PDF_STRING_IS_TOO_LONG = "PdfString is too long";
     public static final String PROFILE_STREAM_OF_OUTPUTINTENT_SHALL_BE_OUTPUT_PROFILE_PRTR_OR_MONITOR_PROFILE_MNTR = "Profile stream of outputintent shall be output profile (prtr) or monitor profile (mntr)";
     public static final String REAL_NUMBER_IS_OUT_OF_RANGE = "Real number is out of range";
@@ -153,6 +152,8 @@ public class PdfAConformanceException extends PdfException {
     public static final String TRANSPARENCY_IS_NOT_ALLOWED_CA_SHALL_BE_EQUAL_TO_1 = "Transparency is not allowed. CA shall be equal to 1";
     public static final String VALUE_OF_NAME_ENTRY_SHALL_BE_UNIQUE_AMONG_ALL_OPTIONAL_CONTENT_CONFIGURATION_DICTIONARIES = "Value of name entry shall be unique among all optional content configuration dictionaries";
     public static final String WIDGET_ANNOTATION_DICTIONARY_OR_FIELD_DICTIONARY_SHALL_NOT_INCLUDE_A_OR_AA_ENTRY = "Widget annotation dictionary or field dictionary shall not include a or aa entry";
+
+    private static final long serialVersionUID = -5951503441486657717L;
 
     @Deprecated
     public static final String IF_THE_DOCUMENT_DOES_NOT_CONTAIN_A_PDFA_OUTPUTINTENT_TRANSPARENCY_IS_FORBIDDEN = "If the document does not contain a pdfa outputintent transparency is forbidden";

pdfa/src/main/java/com/itextpdf/pdfa/checker/PdfA1Checker.java

@@ -312,6 +312,9 @@ protected void checkContentStream(PdfStream contentStream) {
     protected void checkContentStreamObject(PdfObject object) {
         byte type = object.getType();
         switch (type) {
+            case PdfObject.NAME:
+                checkPdfName((PdfName) object);
+                break;
             case PdfObject.STRING:
                 checkPdfString((PdfString) object);
                 break;
@@ -328,7 +331,11 @@ protected void checkContentStreamObject(PdfObject object) {
             case PdfObject.DICTIONARY:
                 PdfDictionary dictionary = (PdfDictionary) object;
                 checkPdfDictionary(dictionary);
-                for (PdfObject obj : dictionary.values()) {
+                for (final PdfName name: dictionary.keySet()) {
+                    checkPdfName(name);
+                    checkPdfObject(dictionary.get(name, false));
+                }
+                for (final PdfObject obj : dictionary.values()) {
                     checkContentStreamObject(obj);
                 }
                 break;
@@ -524,6 +531,22 @@ protected void checkPdfStream(PdfStream stream) {
         }
     }
 
+    @Override
+    protected void checkPdfName(PdfName name) {
+        if (name.getValue().length() > getMaxNameLength()) {
+            throw new PdfAConformanceException(PdfAConformanceException.PDF_NAME_IS_TOO_LONG);
+        }
+    }
+
+    /**
+     * Retrieve maximum allowed length of the name object.
+     *
+     * @return maximum allowed length of the name
+     */
+    protected int getMaxNameLength() {
+        return 127;
+    }
+
     @Override
     protected void checkPdfString(PdfString string) {
         if (string.getValueBytes().length > getMaxStringLength()) {

pdfa/src/main/java/com/itextpdf/pdfa/checker/PdfAChecker.java

@@ -195,6 +195,9 @@ public void checkSinglePage(PdfPage page) {
      */
     public void checkPdfObject(PdfObject obj) {
         switch (obj.getType()) {
+            case PdfObject.NAME:
+                checkPdfName((PdfName) obj);
+                break;
             case PdfObject.NUMBER:
                 checkPdfNumber((PdfNumber) obj);
                 break;
@@ -420,6 +423,7 @@ protected void checkContentStreamObject(PdfObject object) {
     protected abstract void checkPageSize(PdfDictionary page);
     protected abstract void checkPdfArray(PdfArray array);
     protected abstract void checkPdfDictionary(PdfDictionary dictionary);
+    protected abstract void checkPdfName(PdfName name);
     protected abstract void checkPdfNumber(PdfNumber number);
     protected abstract void checkPdfStream(PdfStream stream);
     protected abstract void checkPdfString(PdfString string);
@@ -518,6 +522,7 @@ private void checkArrayRecursively(PdfArray array) {
 
     private void checkDictionaryRecursively(PdfDictionary dictionary) {
         for (PdfName name: dictionary.keySet()) {
+            checkPdfName(name);
             PdfObject object = dictionary.get(name, false);
             if (object != null && ! object.isIndirect()) {
                 checkPdfObject(object);

pdfa/src/test/java/com/itextpdf/pdfa/checker/PdfA1ImplementationLimitsCheckerTest.java

@@ -92,6 +92,7 @@ public void before() {
 
     @Test
     public void validObjectsTest() {
+        final int maxNameLength = pdfA1Checker.getMaxNameLength();
         final int maxStringLength = pdfA1Checker.getMaxStringLength();
         final int maxArrayCapacity = MAX_ARRAY_CAPACITY;
         final int maxDictionaryCapacity = MAX_DICTIONARY_CAPACITY;
@@ -100,7 +101,9 @@ public void validObjectsTest() {
         final double maxRealValue = pdfA1Checker.getMaxRealValue();
 
         Assert.assertEquals(65535, maxStringLength);
+        Assert.assertEquals(127, maxNameLength);
         PdfString longString = PdfACheckerTestUtils.getLongString(maxStringLength);
+        PdfName longName = PdfACheckerTestUtils.getLongName(maxNameLength);
 
         PdfArray longArray = PdfACheckerTestUtils.getLongArray(maxArrayCapacity);
         PdfDictionary longDictionary = PdfACheckerTestUtils.getLongDictionary(maxDictionaryCapacity);
@@ -113,7 +116,7 @@ public void validObjectsTest() {
         PdfNumber negativeInteger = new PdfNumber(minIntegerValue);
         PdfNumber largeReal = new PdfNumber(maxRealValue - 0.001);
 
-        PdfObject[] largeObjects = {longString, longArray, longDictionary,
+        PdfObject[] largeObjects = {longName, longString, longArray, longDictionary,
                 largeInteger, negativeInteger, largeReal};
         // No exceptions should not be thrown as all values match the
         // limitations provided in specification
@@ -152,6 +155,18 @@ public void independentLongStringTest() {
         pdfA1Checker.checkPdfObject(longString);
     }
 
+    @Test
+    public void independentLongNameTest() {
+        junitExpectedException.expect(PdfAConformanceException.class);
+        junitExpectedException.expectMessage(PdfAConformanceException.PDF_NAME_IS_TOO_LONG);
+
+        PdfName longName = buildLongName();
+
+        // An exception should be thrown as provided name is longer then
+        // it is allowed per specification
+        pdfA1Checker.checkPdfObject(longName);
+    }
+
     @Test
     public void independentLargeIntegerTest() {
         junitExpectedException.expect(PdfAConformanceException.class);
@@ -234,6 +249,23 @@ public void longStringInDictionaryTest() {
         checkInDictionary(longString);
     }
 
+    @Test
+    public void longNameAsKeyInDictionaryTest() {
+        junitExpectedException.expect(PdfAConformanceException.class);
+        junitExpectedException.expectMessage(PdfAConformanceException.PDF_NAME_IS_TOO_LONG);
+
+        PdfName longName = buildLongName();
+
+        PdfDictionary dict = new PdfDictionary();
+        dict.put(new PdfName("Key1"), new PdfString("value1"));
+        dict.put(new PdfName("Key2"), new PdfString("value2"));
+        dict.put(longName, new PdfString("value3"));
+
+        // An exception should be thrown as dictionary contains key which is longer then
+        // it is allowed per specification
+        pdfA1Checker.checkPdfObject(dict);
+    }
+
     @Test
     public void longStringInArrayTest() {
         junitExpectedException.expect(PdfAConformanceException.class);
@@ -257,6 +289,18 @@ public void longStringInContentStreamTest() {
         checkInContentStream(longString);
     }
 
+    @Test
+    public void longNameInContentStreamTest() {
+        junitExpectedException.expect(PdfAConformanceException.class);
+        junitExpectedException.expectMessage(PdfAConformanceException.PDF_NAME_IS_TOO_LONG);
+
+        PdfName longName = buildLongName();
+
+        // An exception should be thrown as content stream has a name which
+        // is longer then it is allowed per specification
+        checkInContentStream(longName);
+    }
+
     @Test
     public void largeIntegerInContentStreamTest() {
         junitExpectedException.expect(PdfAConformanceException.class);
@@ -367,6 +411,23 @@ public void longStringInDictionaryInContentStreamTest() {
         checkInDictionaryInContentStream(longString);
     }
 
+    @Test
+    public void longNameAsKeyInDictionaryInContentStreamTest() {
+        junitExpectedException.expect(PdfAConformanceException.class);
+        junitExpectedException.expectMessage(PdfAConformanceException.PDF_NAME_IS_TOO_LONG);
+
+        PdfName longName = buildLongName();
+
+        PdfDictionary dict = new PdfDictionary();
+        dict.put(new PdfName("Key1"), new PdfString("value1"));
+        dict.put(new PdfName("Key2"), new PdfString("value2"));
+        dict.put(longName, new PdfString("value3"));
+
+        // An exception should be thrown as content stream has a string which
+        // is longer then it is allowed per specification
+        checkInContentStream(dict);
+    }
+
     @Test
     public void longStringInComplexStructureTest() {
 
@@ -475,6 +536,15 @@ private PdfString buildLongString() {
         return PdfACheckerTestUtils.getLongString(testLength);
     }
 
+    private PdfName buildLongName() {
+
+        final int maxAllowedLength = pdfA1Checker.getMaxNameLength();
+        final int testLength = maxAllowedLength + 1;
+
+        Assert.assertEquals(128, testLength);
+
+        return PdfACheckerTestUtils.getLongName(testLength);
+    }
 
     private PdfArray buildLongArray() {
 

pdfa/src/test/java/com/itextpdf/pdfa/checker/PdfACheckerTestUtils.java

@@ -57,12 +57,11 @@ private PdfACheckerTestUtils() {
     }
 
     static PdfString getLongString(int length) {
-        final char charToFill = 'A';
-        char[] array = new char[length];
-        for (int i = 0; i < array.length; i++) {
-            array[i] = charToFill;
-        }
-        return new PdfString(new String(array));
+        return new PdfString(getLongPlainString(length));
+    }
+
+    static PdfName getLongName(int length) {
+        return new PdfName(getLongPlainString(length));
     }
 
     static PdfArray getLongArray(int length) {
@@ -101,4 +100,13 @@ static String getStreamWithValue(PdfObject object) {
                 + "ET\n"
                 + "Q";
     }
+
+    private static String getLongPlainString(int length) {
+        final char charToFill = 'A';
+        char[] array = new char[length];
+        for (int i = 0; i < array.length; i++) {
+            array[i] = charToFill;
+        }
+        return new String(array);
+    }
 }