JAVA-1070: Restricted NULL Unicode character checks to cstring, so that a normal value string can contain one

Author: jyemin

src/main/org/bson/BasicBSONEncoder.java

@@ -18,6 +18,30 @@
 
 package org.bson;
 
+import com.mongodb.DBRefBase;
+import org.bson.io.BasicOutputBuffer;
+import org.bson.io.OutputBuffer;
+import org.bson.types.BSONTimestamp;
+import org.bson.types.Binary;
+import org.bson.types.Code;
+import org.bson.types.CodeWScope;
+import org.bson.types.MaxKey;
+import org.bson.types.MinKey;
+import org.bson.types.ObjectId;
+import org.bson.types.Symbol;
+
+import java.lang.reflect.Array;
+import java.nio.Buffer;
+import java.util.Date;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Set;
+import java.util.UUID;
+import java.util.concurrent.atomic.AtomicInteger;
+import java.util.concurrent.atomic.AtomicLong;
+import java.util.regex.Pattern;
+
 import static org.bson.BSON.ARRAY;
 import static org.bson.BSON.BINARY;
 import static org.bson.BSON.BOOLEAN;
@@ -43,31 +67,6 @@
 import static org.bson.BSON.UNDEFINED;
 import static org.bson.BSON.regexFlags;
 
-import java.lang.reflect.Array;
-import java.nio.Buffer;
-import java.util.Date;
-import java.util.List;
-import java.util.Map;
-import java.util.Map.Entry;
-import java.util.Set;
-import java.util.UUID;
-import java.util.concurrent.atomic.AtomicInteger;
-import java.util.concurrent.atomic.AtomicLong;
-import java.util.regex.Pattern;
-
-import org.bson.io.BasicOutputBuffer;
-import org.bson.io.OutputBuffer;
-import org.bson.types.BSONTimestamp;
-import org.bson.types.Binary;
-import org.bson.types.Code;
-import org.bson.types.CodeWScope;
-import org.bson.types.MaxKey;
-import org.bson.types.MinKey;
-import org.bson.types.ObjectId;
-import org.bson.types.Symbol;
-
-import com.mongodb.DBRefBase;
-
 /**
  * this is meant to be pooled or cached
  * there is some per instance memory for string conversion, etc...
@@ -433,8 +432,8 @@ protected void putObjectId( String name , ObjectId oid ){
 
     private void putPattern( String name, Pattern p ) {
         _put( REGEX , name );
-        _put( p.pattern() );
-        _put( regexFlags( p.flags() ) );
+        _put( p.pattern(), true );
+        _put( regexFlags( p.flags() ), true );
     }
 
     private void putMinKey( String name ) {
@@ -454,13 +453,13 @@ private void putMaxKey( String name ) {
      */
     protected void _put( byte type , String name ){
         _buf.write( type );
-        _put( name );
+        _put( name, true );
     }
 
     protected void _putValueString( String s ){
         int lenPos = _buf.getPosition();
         _buf.writeInt( 0 ); // making space for size
-        int strLen = _put( s );
+        int strLen = _put( s, false );
         _buf.writeInt( lenPos , strLen );
     }
 
@@ -473,14 +472,21 @@ void _reset( Buffer b ){
      * puts as utf-8 string
      */
     protected int _put( String str ){
+        return _put(str, false);
+    }
+
+    /**
+     * puts as utf-8 string
+     */
+    private int _put(String str, boolean checkForNullCharacters) {
 
         final int len = str.length();
         int total = 0;
 
         for ( int i=0; i<len; ){
             int c = Character.codePointAt( str , i );
 
-            if (c == 0x0) {
+            if (checkForNullCharacters && c == 0x0) {
                 throw new BSONException(
                         String.format("BSON cstring '%s' is not valid because it contains a null character at index %d", str, i));
             }
@@ -525,7 +531,7 @@ public void writeLong( long x ){
     }
 
     public void writeCString( String s ){
-        _put( s );
+        _put(s, true);
     }
 
     protected OutputBuffer _buf;

src/test/com/mongodb/DBCollectionTest.java

@@ -17,7 +17,6 @@
 package com.mongodb;
 
 import com.mongodb.util.TestCase;
-
 import org.bson.types.ObjectId;
 import org.testng.Assert;
 import org.testng.annotations.Test;
@@ -335,7 +334,7 @@ public void testMultiInsertWithContinue() {
         } catch (MongoException e) {
             assertEquals(11000, e.getCode());
         }
-        assertEquals( c.count(), 2 );
+        assertEquals(c.count(), 2);
     }
 
     @Test( expectedExceptions = IllegalArgumentException.class )
@@ -348,17 +347,27 @@ public void testDotKeysFail() {
     }
 
     @Test( expectedExceptions = IllegalArgumentException.class )
-    public void testNullKeysFail() {
-        DBCollection c = _db.getCollection("testnullkeysFail");
+    public void testNullCharacterInKeyFails() {
+        DBCollection c = _db.getCollection("testNullCharacterInKeyFails");
         c.drop();
 
         DBObject obj = BasicDBObjectBuilder.start().add("x",1).add("y",2).add("foo\0bar","baz").get();
         c.insert(obj);
     }
 
+    @Test
+    public void testNullCharacterInValueSucceeds() {
+        DBCollection c = _db.getCollection("testNullCharacterInValueSucceeds");
+        c.drop();
+
+        DBObject obj = BasicDBObjectBuilder.start().add("x", "foo\0bar").add("nested", new BasicDBObject("y", "foo\0bar")).get();
+        c.insert(obj);
+        assertEquals(obj, c.findOne());
+    }
+
     @Test( expectedExceptions = IllegalArgumentException.class )
-    public void testNullKeysFailWhenNested() {
-        DBCollection c = _db.getCollection("testnullkeysFailWhenNested");
+    public void testNullCharacterInNestedKeyFails() {
+        DBCollection c = _db.getCollection("testNullCharacterInNestedKeyFails");
         c.drop();
 
         final BasicDBList list = new BasicDBList();

src/test/org/bson/BasicBSONEncoderTest.java

@@ -21,12 +21,35 @@
 import org.testng.Assert;
 import org.testng.annotations.Test;
 
+import java.util.regex.Pattern;
+
 public class BasicBSONEncoderTest extends Assert {
 
     @Test(expectedExceptions = BSONException.class)
-    public void testNullCharacterInCString() {
+    public void nullCharacterInCStringShouldThrowException() {
         BasicBSONEncoder encoder = new BasicBSONEncoder();
         encoder.set(new BasicOutputBuffer());
         encoder.writeCString("hell\u0000world");
     }
+
+    @Test(expectedExceptions = BSONException.class)
+    public void nullCharacterInKeyShouldThrowException() {
+        BasicBSONEncoder encoder = new BasicBSONEncoder();
+        encoder.set(new BasicOutputBuffer());
+        encoder.putString("ke\u0000y", "helloWorld");
+    }
+
+    @Test(expectedExceptions = BSONException.class)
+    public void nullCharacterInRegexStringShouldThrowException() {
+        BasicBSONEncoder encoder = new BasicBSONEncoder();
+        encoder.set(new BasicOutputBuffer());
+        encoder._putObjectField("key", Pattern.compile("hello\u0000World"));
+    }
+
+    @Test
+    public void nullCharacterInStringShouldNotThrowException() {
+        BasicBSONEncoder encoder = new BasicBSONEncoder();
+        encoder.set(new BasicOutputBuffer());
+        encoder.putString("key", "hell\u0000world");
+    }
 }