Deprecate iharder implementation of Base64 in favor JDK implementation

Author: introfog

commons/src/main/java/com/itextpdf/commons/actions/processors/DefaultITextProductEventProcessor.java

@@ -24,7 +24,7 @@ This file is part of the iText (R) project.
 
 import com.itextpdf.commons.actions.AbstractProductProcessITextEvent;
 import com.itextpdf.commons.actions.confirmations.ConfirmEvent;
-import com.itextpdf.commons.utils.Base64;
+import com.itextpdf.commons.utils.EncodingUtil;
 
 import java.nio.charset.StandardCharsets;
 import java.util.concurrent.atomic.AtomicLong;
@@ -36,8 +36,8 @@ This file is part of the iText (R) project.
  */
 public class DefaultITextProductEventProcessor extends AbstractITextProductEventProcessor {
 
-    static final byte[] MESSAGE_FOR_LOGGING = Base64
-            .decode("WW91IGFyZSB1c2luZyBpVGV4dCB1bmRlciB0aGUgQUdQTC4KCklmIHRoaXMgaXMgeW9" +
+    static final byte[] MESSAGE_FOR_LOGGING = EncodingUtil.fromBase64(
+            "WW91IGFyZSB1c2luZyBpVGV4dCB1bmRlciB0aGUgQUdQTC4KCklmIHRoaXMgaXMgeW9" +
                        "1ciBpbnRlbnRpb24sIHlvdSBoYXZlIHB1Ymxpc2hlZCB5b3VyIG93biBzb3VyY2UgY2" +
                        "9kZSBhcyBBR1BMIHNvZnR3YXJlIHRvby4KUGxlYXNlIGxldCB1cyBrbm93IHdoZXJlI" +
                        "HRvIGZpbmQgeW91ciBzb3VyY2UgY29kZSBieSBzZW5kaW5nIGEgbWFpbCB0byBhZ3Bs" +

commons/src/main/java/com/itextpdf/commons/utils/Base64.java

@@ -68,7 +68,11 @@
  * @author Robert Harder
  * @author [email protected]
  * @version 2.2.1
+ *
+ * @deprecated in favour of {@link EncodingUtil#toBase64(byte[])} and {@link EncodingUtil#fromBase64(String)}
  */
+@Deprecated
+// After removing the class, update commons/NOTICE.txt
 public class Base64 {
 
     /* ********  P U B L I C   F I E L D S  ******** */

commons/src/main/java/com/itextpdf/commons/utils/EncodingUtil.java

@@ -29,6 +29,7 @@ This file is part of the iText (R) project.
 import java.nio.charset.Charset;
 import java.nio.charset.CharsetEncoder;
 import java.nio.charset.CodingErrorAction;
+import java.util.Base64;
 
 /**
  * This file is a helper class for internal usage only.
@@ -85,4 +86,24 @@ public static String convertToString(byte[] bytes, String encoding) throws Unsup
         }
         return new String(bytes, encoding);
     }
+
+    /**
+     * Decodes base64 string into byte array with tolerance to new lines and spaces.
+     *
+     * @param base64 base64 string to decode
+     * @return decode string as byte array
+     */
+    public static byte[] fromBase64(String base64) {
+        return Base64.getDecoder().decode(base64.replaceAll("\\s", ""));
+    }
+
+    /**
+     * Encodes byte array to base64 string.
+     *
+     * @param bytes the byte array to encode
+     * @return encoded base64 string
+     */
+    public static String toBase64(byte[] bytes) {
+        return Base64.getEncoder().encodeToString(bytes);
+    }
 }

commons/src/sharpenconfig/java/com/itextpdf/commons/SharpenConfigMapping.java

@@ -117,8 +117,8 @@ public void applyMappingConfiguration(MappingConfigurator configurator) {
         configurator.mapMethod("java.util.AbstractSet.hashCode", "iText.Commons.Utils.JavaUtil.SetHashCode", false);
         configurator.mapMethodParametersOrder("com.itextpdf.commons.utils.JsonUtil.deserializeFromString", "1");
         configurator.mapMethodParametersOrder("com.itextpdf.commons.utils.JsonUtil.deserializeFromStream", "1");
-        configurator.mapMethod("com.itextpdf.commons.utils.Base64.decode", "System.Convert.FromBase64String", false);
-        configurator.mapMethod("com.itextpdf.commons.utils.Base64.encodeBytes", "System.Convert.ToBase64String", false);
+        configurator.mapMethod("com.itextpdf.commons.utils.EncodingUtil.fromBase64", "System.Convert.FromBase64String", false);
+        configurator.mapMethod("com.itextpdf.commons.utils.EncodingUtil.toBase64", "System.Convert.ToBase64String", false);
         configurator.mapType("com.itextpdf.commons.utils.ThrowingSupplier<>", "System.Func");
         configurator.mapType("com.itextpdf.commons.utils.Action", "System.Action");
         configurator.mapType("com.itextpdf.commons.utils.ThrowingAction", "System.Action");

forms/src/main/java/com/itextpdf/forms/fields/PdfButtonFormField.java

@@ -22,7 +22,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.forms.fields;
 
-import com.itextpdf.commons.utils.Base64;
+import com.itextpdf.commons.utils.EncodingUtil;
 import com.itextpdf.commons.utils.FileUtil;
 import com.itextpdf.forms.logs.FormsLogMessageConstants;
 import com.itextpdf.io.util.StreamUtil;
@@ -210,7 +210,7 @@ public PdfButtonFormField setRadiosInUnison(boolean radiosInUnison) {
      */
     public PdfButtonFormField setImage(String image) throws IOException {
         InputStream is = FileUtil.getInputStreamForFile(image);
-        String str = Base64.encodeBytes(StreamUtil.inputStreamToArray(is));
+        String str = EncodingUtil.toBase64(StreamUtil.inputStreamToArray(is));
         return (PdfButtonFormField) setValue(str);
     }
 

forms/src/main/java/com/itextpdf/forms/fields/PdfFormField.java

@@ -23,7 +23,7 @@ This file is part of the iText (R) project.
 package com.itextpdf.forms.fields;
 
 import com.itextpdf.commons.datastructures.NullableContainer;
-import com.itextpdf.commons.utils.Base64;
+import com.itextpdf.commons.utils.EncodingUtil;
 import com.itextpdf.commons.utils.MessageFormatUtil;
 import com.itextpdf.forms.PdfAcroForm;
 import com.itextpdf.forms.fields.properties.CheckBoxType;
@@ -1393,7 +1393,7 @@ private PdfFormField setFieldValue(String value, boolean generateAppearance) {
         if (PdfName.Btn.equals(formType)) {
             if (getFieldFlag(PdfButtonFormField.FF_PUSH_BUTTON)) {
                 try {
-                    img = ImageDataFactory.create(Base64.decode(value));
+                    img = ImageDataFactory.create(EncodingUtil.fromBase64(value));
                 } catch (Exception e) {
                     if (generateAppearance) {
                         // Display value.

kernel/src/test/java/com/itextpdf/kernel/crypto/PdfDecryptingTest.java

@@ -23,7 +23,7 @@ This file is part of the iText (R) project.
 package com.itextpdf.kernel.crypto;
 
 import com.itextpdf.bouncycastleconnector.BouncyCastleFactoryCreator;
-import com.itextpdf.commons.utils.Base64;
+import com.itextpdf.commons.utils.EncodingUtil;
 import com.itextpdf.commons.utils.FileUtil;
 import com.itextpdf.io.util.StreamUtil;
 import com.itextpdf.kernel.logs.KernelLogMessageConstant;
@@ -298,7 +298,7 @@ private PrivateKey readPrivateKey(String privateKeyName, String algorithm)
             int startPos = pemContent.indexOf(start);
             int endPos = pemContent.indexOf(end);
             pemContent = pemContent.substring(startPos + start.length(), endPos);
-            byte[] encoded = Base64.decode(pemContent);
+            byte[] encoded = EncodingUtil.fromBase64(pemContent);
 
             PKCS8EncodedKeySpec keySpec = new PKCS8EncodedKeySpec(encoded);
             return KeyFactory.getInstance(algorithm, BouncyCastleFactoryCreator.getFactory().getProviderName())

kernel/src/test/java/com/itextpdf/kernel/crypto/PdfEncryptingTest.java

@@ -24,7 +24,7 @@ This file is part of the iText (R) project.
 
 import com.itextpdf.bouncycastleconnector.BouncyCastleFactoryCreator;
 import com.itextpdf.commons.bouncycastle.crypto.fips.AbstractFipsUnapprovedOperationError;
-import com.itextpdf.commons.utils.Base64;
+import com.itextpdf.commons.utils.EncodingUtil;
 import com.itextpdf.commons.utils.FileUtil;
 import com.itextpdf.commons.utils.MessageFormatUtil;
 import com.itextpdf.io.font.constants.StandardFonts;
@@ -200,7 +200,7 @@ private PrivateKey readPrivateKey(String privateKeyName, String algorithm)
             int startPos = pemContent.indexOf(start);
             int endPos = pemContent.indexOf(end);
             pemContent = pemContent.substring(startPos + start.length(), endPos);
-            byte[] encoded = Base64.decode(pemContent);
+            byte[] encoded = EncodingUtil.fromBase64(pemContent);
 
             PKCS8EncodedKeySpec keySpec = new PKCS8EncodedKeySpec(encoded);
             return KeyFactory.getInstance(algorithm, BouncyCastleFactoryCreator.getFactory().getProviderName())

sign/src/main/java/com/itextpdf/signatures/SignUtils.java

@@ -41,7 +41,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.commons.bouncycastle.operator.AbstractOperatorCreationException;
 import com.itextpdf.commons.bouncycastle.tsp.AbstractTSPException;
 import com.itextpdf.commons.bouncycastle.tsp.ITimeStampToken;
-import com.itextpdf.commons.utils.Base64;
+import com.itextpdf.commons.utils.EncodingUtil;
 import com.itextpdf.kernel.exceptions.PdfException;
 import com.itextpdf.kernel.pdf.PdfEncryption;
 import com.itextpdf.signatures.exceptions.SignExceptionMessageConstant;
@@ -285,7 +285,7 @@ static TsaResponse getTsaResponseForUserRequest(String tsaUrl, byte[] requestByt
         if ((tsaUsername != null) && !tsaUsername.equals("")) {
             String userPassword = tsaUsername + ":" + tsaPassword;
             tsaConnection.setRequestProperty("Authorization", "Basic " +
-                    Base64.encodeBytes(userPassword.getBytes(StandardCharsets.UTF_8), Base64.DONT_BREAK_LINES));
+                    EncodingUtil.toBase64(userPassword.getBytes(StandardCharsets.UTF_8)));
         }
         OutputStream out = tsaConnection.getOutputStream();
         out.write(requestBytes);

sign/src/main/java/com/itextpdf/signatures/SignaturePolicyInfo.java

@@ -29,7 +29,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.commons.bouncycastle.asn1.esf.ISigPolicyQualifierInfo;
 import com.itextpdf.commons.bouncycastle.asn1.esf.ISignaturePolicyId;
 import com.itextpdf.commons.bouncycastle.asn1.esf.ISignaturePolicyIdentifier;
-import com.itextpdf.commons.utils.Base64;
+import com.itextpdf.commons.utils.EncodingUtil;
 import com.itextpdf.kernel.crypto.DigestAlgorithms;
 
 /**
@@ -87,7 +87,7 @@ public SignaturePolicyInfo(String policyIdentifier, byte[] policyHash, String po
      */
     public SignaturePolicyInfo(String policyIdentifier, String policyHashBase64, String policyDigestAlgorithm,
             String policyUri) {
-        this(policyIdentifier, policyHashBase64 != null ? Base64.decode(policyHashBase64) : null,
+        this(policyIdentifier, policyHashBase64 != null ? EncodingUtil.fromBase64(policyHashBase64) : null,
                 policyDigestAlgorithm, policyUri);
     }