PHPC-1897: Test serialization of BSON with embedded null bytes in strings (#1255)

jmikola · web-flow · commit 93bd10bd2145 · 2021-10-25T13:27:33.000-04:00
* BSON corpus prose tests for null bytes For tests that already existed we just add a reference to the prose test * BSON corpus tests for null bytes Synced with mongodb/specifications@c64fc79 This sync also removes some old DBRef tests, which should have been removed in 6929bcb. * Bump libmongoc to 1.19.1 to pull in changes from CDRIVER-4083
diff --git a/src/LIBMONGOC_VERSION_CURRENT b/src/LIBMONGOC_VERSION_CURRENT
@@ -1 +1 @@
-1.19.0
+1.19.1
diff --git a/src/libmongoc b/src/libmongoc
@@ -1 +1 @@
-Subproject commit 2ff367a5b6473b3f0dd93b833c530af0db5a0424
+Subproject commit 3f40be28e0b6a247105c1010005e00c892408fb0
diff --git a/tests/bson-corpus/document-decodeError-004.phpt b/tests/bson-corpus/document-decodeError-004.phpt
@@ -0,0 +1,23 @@
+--TEST--
+Document type (sub-documents): Null byte in sub-document key
+--DESCRIPTION--
+Generated by scripts/convert-bson-corpus-tests.php
+
+DO NOT EDIT THIS FILE
+--FILE--
+<?php
+
+require_once __DIR__ . '/../utils/basic.inc';
+
+$bson = hex2bin('150000000378000D00000010610000010000000000');
+
+throws(function() use ($bson) {
+    var_dump(toPHP($bson));
+}, 'MongoDB\Driver\Exception\UnexpectedValueException');
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+OK: Got MongoDB\Driver\Exception\UnexpectedValueException
+===DONE===
diff --git a/tests/bson-corpus/regex-decodeError-001.phpt b/tests/bson-corpus/regex-decodeError-001.phpt
@@ -1,5 +1,5 @@
 --TEST--
-Regular Expression type: embedded null in pattern
+Regular Expression type: Null byte in pattern string
 --DESCRIPTION--
 Generated by scripts/convert-bson-corpus-tests.php
 
diff --git a/tests/bson-corpus/regex-decodeError-002.phpt b/tests/bson-corpus/regex-decodeError-002.phpt
@@ -1,5 +1,5 @@
 --TEST--
-Regular Expression type: embedded null in flags
+Regular Expression type: Null byte in flags string
 --DESCRIPTION--
 Generated by scripts/convert-bson-corpus-tests.php
 
diff --git a/tests/bson-corpus/top-decodeError-015.phpt b/tests/bson-corpus/top-decodeError-015.phpt
@@ -0,0 +1,23 @@
+--TEST--
+Top-level document validity: Null byte in document key
+--DESCRIPTION--
+Generated by scripts/convert-bson-corpus-tests.php
+
+DO NOT EDIT THIS FILE
+--FILE--
+<?php
+
+require_once __DIR__ . '/../utils/basic.inc';
+
+$bson = hex2bin('0D000000107800000100000000');
+
+throws(function() use ($bson) {
+    var_dump(toPHP($bson));
+}, 'MongoDB\Driver\Exception\UnexpectedValueException');
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+OK: Got MongoDB\Driver\Exception\UnexpectedValueException
+===DONE===
diff --git a/tests/bson-corpus/top-parseError-041.phpt b/tests/bson-corpus/top-parseError-041.phpt
@@ -1,5 +1,5 @@
 --TEST--
-Top-level document validity: Bad $maxKey (extra field)
+Top-level document validity: Null byte in document key
 --DESCRIPTION--
 Generated by scripts/convert-bson-corpus-tests.php
 
@@ -10,7 +10,7 @@ DO NOT EDIT THIS FILE
 require_once __DIR__ . '/../utils/basic.inc';
 
 throws(function() {
-    fromJSON('{"a" : {"$maxKey" : 1, "unrelated": true}}');
+    fromJSON('{"a\\u0000": 1 }');
 }, 'MongoDB\Driver\Exception\UnexpectedValueException');
 
 ?>
diff --git a/tests/bson-corpus/top-parseError-042.phpt b/tests/bson-corpus/top-parseError-042.phpt
@@ -1,5 +1,5 @@
 --TEST--
-Top-level document validity: Bad DBpointer (extra field)
+Top-level document validity: Null byte in sub-document key
 --DESCRIPTION--
 Generated by scripts/convert-bson-corpus-tests.php
 
@@ -10,7 +10,7 @@ DO NOT EDIT THIS FILE
 require_once __DIR__ . '/../utils/basic.inc';
 
 throws(function() {
-    fromJSON('{"a": {"$dbPointer": {"a": {"$numberInt": "1"}, "$id": {"$oid": "56e1fc72e0c917e9c4714161"}, "c": {"$numberInt": "2"}, "$ref": "b"}}}');
+    fromJSON('{"a" : {"b\\u0000": 1 }}');
 }, 'MongoDB\Driver\Exception\UnexpectedValueException');
 
 ?>
diff --git a/tests/bson-corpus/top-parseError-043.phpt b/tests/bson-corpus/top-parseError-043.phpt
@@ -0,0 +1,21 @@
+--TEST--
+Top-level document validity: Null byte in $regularExpression pattern
+--DESCRIPTION--
+Generated by scripts/convert-bson-corpus-tests.php
+
+DO NOT EDIT THIS FILE
+--FILE--
+<?php
+
+require_once __DIR__ . '/../utils/basic.inc';
+
+throws(function() {
+    fromJSON('{"a" : {"$regularExpression" : { "pattern": "b\\u0000", "options" : "i"}}}');
+}, 'MongoDB\Driver\Exception\UnexpectedValueException');
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+OK: Got MongoDB\Driver\Exception\UnexpectedValueException
+===DONE===
diff --git a/tests/bson-corpus/top-parseError-044.phpt b/tests/bson-corpus/top-parseError-044.phpt
@@ -0,0 +1,21 @@
+--TEST--
+Top-level document validity: Null byte in $regularExpression options
+--DESCRIPTION--
+Generated by scripts/convert-bson-corpus-tests.php
+
+DO NOT EDIT THIS FILE
+--FILE--
+<?php
+
+require_once __DIR__ . '/../utils/basic.inc';
+
+throws(function() {
+    fromJSON('{"a" : {"$regularExpression" : { "pattern": "b", "options" : "i\\u0000"}}}');
+}, 'MongoDB\Driver\Exception\UnexpectedValueException');
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+OK: Got MongoDB\Driver\Exception\UnexpectedValueException
+===DONE===
diff --git a/tests/bson/bson-fromPHP_error-006.phpt b/tests/bson/bson-fromPHP_error-006.phpt
@@ -1,5 +1,7 @@
 --TEST--
 MongoDB\BSON\fromPHP(): PHP documents with null bytes in field name
+--DESCRIPTION--
+BSON Corpus spec prose test #1
 --FILE--
 <?php
 
@@ -25,6 +27,11 @@ echo throws(function() {
     fromPHP((object) ["a\0" => 1]);
 }, 'MongoDB\Driver\Exception\UnexpectedValueException'), "\n";
 
+echo "\nTesting nested array with one trailing null byte in field name\n";
+echo throws(function() {
+    fromPHP(['a' => ["b\0" => 1]]);
+}, 'MongoDB\Driver\Exception\UnexpectedValueException'), "\n";
+
 ?>
 ===DONE===
 <?php exit(0); ?>
@@ -44,4 +51,8 @@ BSON keys cannot contain null bytes. Unexpected null byte after "".
 Testing object with one trailing null byte in field name
 OK: Got MongoDB\Driver\Exception\UnexpectedValueException
 BSON keys cannot contain null bytes. Unexpected null byte after "a".
+
+Testing nested array with one trailing null byte in field name
+OK: Got MongoDB\Driver\Exception\UnexpectedValueException
+BSON keys cannot contain null bytes. Unexpected null byte after "b".
 ===DONE===
diff --git a/tests/bson/bson-regex-serialization_error-002.phpt b/tests/bson/bson-regex-serialization_error-002.phpt
@@ -1,5 +1,7 @@
 --TEST--
 MongoDB\BSON\Regex unserialization does not allow pattern or flags to contain null bytes (Serializable interface)
+--DESCRIPTION--
+BSON Corpus spec prose test #1
 --FILE--
 <?php
 
diff --git a/tests/bson/bson-regex-serialization_error-004.phpt b/tests/bson/bson-regex-serialization_error-004.phpt
@@ -1,5 +1,7 @@
 --TEST--
 MongoDB\BSON\Regex unserialization does not allow pattern or flags to contain null bytes (__serialize and __unserialize)
+--DESCRIPTION--
+BSON Corpus spec prose test #1
 --SKIPIF--
 <?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
 <?php skip_if_php_version('<', '7.4.0'); ?>
diff --git a/tests/bson/bson-regex-set_state_error-002.phpt b/tests/bson/bson-regex-set_state_error-002.phpt
@@ -1,5 +1,7 @@
 --TEST--
 MongoDB\BSON\Regex::__set_state() does not allow pattern or flags to contain null bytes
+--DESCRIPTION--
+BSON Corpus spec prose test #1
 --FILE--
 <?php
 
diff --git a/tests/bson/bson-regex_error-003.phpt b/tests/bson/bson-regex_error-003.phpt
@@ -1,5 +1,7 @@
 --TEST--
 MongoDB\BSON\Regex::__construct() does not allow pattern or flags to contain null bytes
+--DESCRIPTION--
+BSON Corpus spec prose test #1
 --FILE--
 <?php
 
