JAVA-2507: Replace use of javax.xml.bind.DatatypeConverter for Base64 encoding and decoding with org.bson.internal.Base64

jyemin · jyemin · commit 96440b5ed760 · 2017-05-16T09:07:21.000-04:00
diff --git a/bson/src/main/org/bson/internal/Base64.java b/bson/src/main/org/bson/internal/Base64.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008-2014 MongoDB, Inc.
+ * Copyright 2014-2017 MongoDB, Inc.
  * Copyright 1999,2005 The Apache Software Foundation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -8,27 +8,26 @@
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
  */
 
-package com.mongodb.connection;
-
-import com.mongodb.MongoException;
-
-import java.io.UnsupportedEncodingException;
+package org.bson.internal;
 
 /**
  * <p>Provides Base64 encoding and decoding.</p>
  * <p>This class implements Base64 encoding</p>
  * <p>Thanks to Apache Commons project. This class refactored from org.apache.commons.codec.binary</p>
  * <p>Original Thanks to <a href="http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/">commons</a> project in
  * ws.apache.org for this code. </p>
+ *
+ * @since 3.5
  */
-class Base64Codec {
+public final class Base64 {
     private static final int BYTES_PER_UNENCODED_BLOCK = 3;
     private static final int BYTES_PER_ENCODED_BLOCK = 4;
 
@@ -61,7 +60,13 @@ class Base64Codec {
         }
     }
 
-    public byte[] decode(final String s) {
+    /**
+     * Decodes the given Base64-encoded string.
+     *
+     * @param s the Base64-encoded string
+     * @return the decoded byte array
+     */
+    public static byte[] decode(final String s) {
         int delta = s.endsWith("==") ? 2 : s.endsWith("=") ? 1 : 0;
         byte[] buffer = new byte[s.length() * BYTES_PER_UNENCODED_BLOCK / BYTES_PER_ENCODED_BLOCK - delta];
         int mask = 0xFF;
@@ -84,7 +89,14 @@ public byte[] decode(final String s) {
         return buffer;
     }
 
-    public String encode(final byte[] in) {
+    /**
+     * Encodes the given byte array into a Base64-encoded string.
+     *
+     *
+     * @param in the byte array
+     * @return the Base64-encoded string
+     */
+    public static String encode(final byte[] in) {
 
         int modulus = 0;
         int bitWorkArea = 0;
@@ -128,10 +140,14 @@ public String encode(final byte[] in) {
                 break;
         }
 
-        try {
-            return new String(buffer, "UTF-8");
-        } catch (UnsupportedEncodingException e) {
-            throw new MongoException("UTF-8 Charset is not available");
-        }
+        return byteArrayToString(buffer);
+    }
+
+    @SuppressWarnings("deprecation")
+    private static String byteArrayToString(final byte[] buffer) {
+        return new String(buffer, 0, 0, buffer.length);
+    }
+
+    private Base64() {
     }
 }
diff --git a/bson/src/main/org/bson/json/ExtendedJsonBinaryConverter.java b/bson/src/main/org/bson/json/ExtendedJsonBinaryConverter.java
@@ -18,15 +18,14 @@
 package org.bson.json;
 
 import org.bson.BsonBinary;
-
-import static javax.xml.bind.DatatypeConverter.printBase64Binary;
+import org.bson.internal.Base64;
 
 class ExtendedJsonBinaryConverter implements Converter<BsonBinary> {
 
     @Override
     public void convert(final BsonBinary value, final StrictJsonWriter writer) {
         writer.writeStartObject();
-        writer.writeString("$binary", printBase64Binary(value.getData()));
+        writer.writeString("$binary", Base64.encode(value.getData()));
         writer.writeString("$type", String.format("%02X", value.getType()));
         writer.writeEndObject();
     }
diff --git a/bson/src/main/org/bson/json/JsonReader.java b/bson/src/main/org/bson/json/JsonReader.java
@@ -28,6 +28,7 @@
 import org.bson.BsonTimestamp;
 import org.bson.BsonType;
 import org.bson.BsonUndefined;
+import org.bson.internal.Base64;
 import org.bson.BsonReaderMark;
 import org.bson.internal.UnsignedLongs;
 import org.bson.types.Decimal128;
@@ -666,7 +667,7 @@ private BsonBinary visitBinDataConstructor() {
         }
         verifyToken(JsonTokenType.RIGHT_PAREN);
 
-        byte[] bytes = DatatypeConverter.parseBase64Binary(bytesToken.getValue(String.class));
+        byte[] bytes = Base64.decode(bytesToken.getValue(String.class));
         return new BsonBinary(subTypeToken.getValue(Integer.class).byteValue(), bytes);
     }
 
@@ -963,11 +964,11 @@ private BsonBinary visitBinDataExtendedJson() {
 
         for (final BsonBinarySubType st : BsonBinarySubType.values()) {
             if (st.getValue() == subType) {
-                return new BsonBinary(st, DatatypeConverter.parseBase64Binary(bytesToken.getValue(String.class)));
+                return new BsonBinary(st, Base64.decode(bytesToken.getValue(String.class)));
             }
         }
 
-        return new BsonBinary(DatatypeConverter.parseBase64Binary(bytesToken.getValue(String.class)));
+        return new BsonBinary(Base64.decode(bytesToken.getValue(String.class)));
     }
 
     private long visitDateTimeExtendedJson() {
diff --git a/bson/src/main/org/bson/json/ShellBinaryConverter.java b/bson/src/main/org/bson/json/ShellBinaryConverter.java
@@ -18,14 +18,14 @@
 package org.bson.json;
 
 import org.bson.BsonBinary;
+import org.bson.internal.Base64;
 
 import static java.lang.String.format;
-import static javax.xml.bind.DatatypeConverter.printBase64Binary;
 
 class ShellBinaryConverter implements Converter<BsonBinary> {
     @Override
     public void convert(final BsonBinary value, final StrictJsonWriter writer) {
         writer.writeRaw(format("new BinData(%s, \"%s\")", Integer.toString(value.getType() & 0xFF),
-                printBase64Binary(value.getData())));
+                Base64.encode(value.getData())));
     }
 }
diff --git a/bson/src/test/unit/org/bson/json/Base64Specification.groovy b/bson/src/test/unit/org/bson/json/Base64Specification.groovy
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008-2014 MongoDB, Inc.
+ * Copyright 2014-2017 MongoDB, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,21 +14,19 @@
  * limitations under the License.
  */
 
-package com.mongodb.connection
+package org.bson.json
 
+import org.bson.internal.Base64
 import spock.lang.Specification
 import spock.lang.Unroll
 
-class Base64CodecSpecification extends Specification {
+class Base64Specification extends Specification {
 
     @Unroll
     def 'encodes #encoded into #decoded'() {
-        given:
-        def subject = new Base64Codec();
-
         expect:
-        subject.encode(encoded.getBytes()) == decoded
-        subject.decode(decoded) == encoded.getBytes()
+        Base64.encode(encoded.getBytes()) == decoded
+        Base64.decode(decoded) == encoded.getBytes()
 
         where:
         encoded  | decoded
diff --git a/driver-core/src/main/com/mongodb/connection/ScramSha1Authenticator.java b/driver-core/src/main/com/mongodb/connection/ScramSha1Authenticator.java
@@ -19,6 +19,7 @@
 import com.mongodb.MongoCredential;
 import com.mongodb.ServerAddress;
 import com.mongodb.internal.authentication.NativeAuthenticationHelper;
+import org.bson.internal.Base64;
 
 import javax.crypto.Mac;
 import javax.crypto.SecretKeyFactory;
@@ -66,7 +67,6 @@ private static class ScramSha1SaslClient implements SaslClient {
         private static final String GS2_HEADER = "n,,";
         private static final int RANDOM_LENGTH = 24;
 
-        private final Base64Codec base64Codec;
         private final MongoCredential credential;
         private String clientFirstMessageBare;
         private final RandomStringGenerator randomStringGenerator;
@@ -76,7 +76,6 @@ private static class ScramSha1SaslClient implements SaslClient {
 
         ScramSha1SaslClient(final MongoCredential credential, final RandomStringGenerator randomStringGenerator) {
             this.credential = credential;
-            this.base64Codec = new Base64Codec();
             this.randomStringGenerator = randomStringGenerator;
         }
 
@@ -185,7 +184,7 @@ private byte[] computeClientFinalMessage(final byte[] challenge) throws SaslExce
         }
 
         private byte[] decodeBase64(final String str) {
-            return this.base64Codec.decode(str);
+            return Base64.decode(str);
         }
 
         private byte[] decodeUTF8(final String str) throws SaslException {
@@ -198,7 +197,7 @@ private byte[] decodeUTF8(final String str) throws SaslException {
         }
 
         private String encodeBase64(final byte[] bytes) {
-            return this.base64Codec.encode(bytes);
+            return Base64.encode(bytes);
         }
 
         private String encodeUTF8(final byte[] bytes) throws SaslException {
diff --git a/driver/src/main/com/mongodb/util/JSONCallback.java b/driver/src/main/com/mongodb/util/JSONCallback.java
@@ -26,6 +26,7 @@
 import org.bson.BSONObject;
 import org.bson.BasicBSONCallback;
 import org.bson.BsonUndefined;
+import org.bson.internal.Base64;
 import org.bson.types.BSONTimestamp;
 import org.bson.types.Binary;
 import org.bson.types.Code;
@@ -35,7 +36,6 @@
 import org.bson.types.MinKey;
 import org.bson.types.ObjectId;
 
-import javax.xml.bind.DatatypeConverter;
 import java.text.ParsePosition;
 import java.text.SimpleDateFormat;
 import java.util.Date;
@@ -129,7 +129,7 @@ public Object objectDone() {
             o = UUID.fromString((String) b.get("$uuid"));
         } else if (b.containsField("$binary")) {
             int type = (b.get("$type") instanceof String) ? Integer.valueOf((String) b.get("$type"), 16) : (Integer) b.get("$type");
-            byte[] bytes = DatatypeConverter.parseBase64Binary((String) b.get("$binary"));
+            byte[] bytes = Base64.decode((String) b.get("$binary"));
             o = new Binary((byte) type, bytes);
         } else if (b.containsField("$undefined") && b.get("$undefined").equals(true)) {
             o = new BsonUndefined();
diff --git a/driver/src/main/com/mongodb/util/JSONSerializers.java b/driver/src/main/com/mongodb/util/JSONSerializers.java
@@ -21,6 +21,7 @@
 import com.mongodb.DBObject;
 import com.mongodb.DBRef;
 import org.bson.BsonUndefined;
+import org.bson.internal.Base64;
 import org.bson.types.BSONTimestamp;
 import org.bson.types.Binary;
 import org.bson.types.Code;
@@ -31,7 +32,6 @@
 import org.bson.types.ObjectId;
 import org.bson.types.Symbol;
 
-import javax.xml.bind.DatatypeConverter;
 import java.lang.reflect.Array;
 import java.text.SimpleDateFormat;
 import java.util.Date;
@@ -474,7 +474,7 @@ private abstract static class BinarySerializerBase extends CompoundObjectSeriali
 
         protected void serialize(final byte[] bytes, final byte type, final StringBuilder buf) {
             DBObject temp = new BasicDBObject();
-            temp.put("$binary", DatatypeConverter.printBase64Binary(bytes));
+            temp.put("$binary", Base64.encode(bytes));
             temp.put("$type", type);
             serializer.serialize(temp, buf);
         }
diff --git a/driver/src/test/unit/com/mongodb/util/JSONSerializersTest.java b/driver/src/test/unit/com/mongodb/util/JSONSerializersTest.java
@@ -19,6 +19,7 @@
 import com.mongodb.BasicDBObject;
 import com.mongodb.DBRef;
 import org.bson.BsonUndefined;
+import org.bson.internal.Base64;
 import org.bson.types.BSONTimestamp;
 import org.bson.types.BasicBSONList;
 import org.bson.types.Binary;
@@ -31,7 +32,6 @@
 import org.bson.types.Symbol;
 import org.junit.Test;
 
-import javax.xml.bind.DatatypeConverter;
 import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Date;
@@ -203,7 +203,7 @@ public void testStrictSerialization() {
 
         // test  BINARY
         byte[] b = {1, 2, 3, 4};
-        String base64 = DatatypeConverter.printBase64Binary(b);
+        String base64 = Base64.encode(b);
         StringBuilder buf = new StringBuilder();
         serializer.serialize(new Binary(b), buf);
         assertEquals("{ \"$binary\" : \"" + base64 + "\" , \"$type\" : 0}", buf.toString());

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@`
`28`	`28`	`import org.bson.BsonTimestamp;`
`29`	`29`	`import org.bson.BsonType;`
`30`	`30`	`import org.bson.BsonUndefined;`
	`31`	`+import org.bson.internal.Base64;`
`31`	`32`	`import org.bson.BsonReaderMark;`
`32`	`33`	`import org.bson.internal.UnsignedLongs;`
`33`	`34`	`import org.bson.types.Decimal128;`
`@@ -666,7 +667,7 @@ private BsonBinary visitBinDataConstructor() {`
`666`	`667`	`}`
`667`	`668`	`verifyToken(JsonTokenType.RIGHT_PAREN);`
`668`	`669`
`669`		`- byte[] bytes = DatatypeConverter.parseBase64Binary(bytesToken.getValue(String.class));`
	`670`	`+ byte[] bytes = Base64.decode(bytesToken.getValue(String.class));`
`670`	`671`	`return new BsonBinary(subTypeToken.getValue(Integer.class).byteValue(), bytes);`
`671`	`672`	`}`
`672`	`673`
`@@ -963,11 +964,11 @@ private BsonBinary visitBinDataExtendedJson() {`
`963`	`964`
`964`	`965`	`for (final BsonBinarySubType st : BsonBinarySubType.values()) {`
`965`	`966`	`if (st.getValue() == subType) {`
`966`		`- return new BsonBinary(st, DatatypeConverter.parseBase64Binary(bytesToken.getValue(String.class)));`
	`967`	`+ return new BsonBinary(st, Base64.decode(bytesToken.getValue(String.class)));`
`967`	`968`	`}`
`968`	`969`	`}`
`969`	`970`
`970`		`- return new BsonBinary(DatatypeConverter.parseBase64Binary(bytesToken.getValue(String.class)));`
	`971`	`+ return new BsonBinary(Base64.decode(bytesToken.getValue(String.class)));`
`971`	`972`	`}`
`972`	`973`
`973`	`974`	`private long visitDateTimeExtendedJson() {`
Original file line number	Diff line number	Diff line change
`@@ -18,14 +18,14 @@`
`18`	`18`	`package org.bson.json;`
`19`	`19`
`20`	`20`	`import org.bson.BsonBinary;`
	`21`	`+import org.bson.internal.Base64;`
`21`	`22`
`22`	`23`	`import static java.lang.String.format;`
`23`		`-import static javax.xml.bind.DatatypeConverter.printBase64Binary;`
`24`	`24`
`25`	`25`	`class ShellBinaryConverter implements Converter<BsonBinary> {`
`26`	`26`	`@Override`
`27`	`27`	`public void convert(final BsonBinary value, final StrictJsonWriter writer) {`
`28`	`28`	`writer.writeRaw(format("new BinData(%s, \"%s\")", Integer.toString(value.getType() & 0xFF),`
`29`		`- printBase64Binary(value.getData())));`
	`29`	`+ Base64.encode(value.getData())));`
`30`	`30`	`}`
`31`	`31`	`}`