bson 4.8.2 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e38ba3f134f5442df04b99f97b72d5804958bd0e67a0671120c68b8e478a6bbc
-  data.tar.gz: aea2543db1c169057f384ee24b3823c7ecee63c50db026666e5a0ac3b657de02
+  metadata.gz: 05c17fcaee2ceaefe97d801594460178acaf6a2f82c152ce33db819f01d624fa
+  data.tar.gz: 3343dfda6f4038fa261d077ddf860dd43ff001d2fbea7189110b6fa500fb2558
 SHA512:
-  metadata.gz: 4cb39ca20cec492ae47a8ec79135dac10bc9abbd3efcbd75463af6659a37450048160a7ee72015ed5c0c1f15252b3ce2d760d1a9ecaa36135b5335e3792ec211
-  data.tar.gz: 981cb9b77564419678f14382ba5e63c8c55ad4ae8d500953a7b64bbc031614c1b235d76140e62573f806a0e37a680eaafd7e0699e57a41e810d028f8c74fee56
+  metadata.gz: 7756cee7923f3ca584e6a1bfa3666f70d2f14804b3ddb913f0695be3495a061a632803a90d1cd87a63c95d5b9222c02b18fe475a38e2a8a680914819f90f4471
+  data.tar.gz: 88bf0b45ecbe2aa47c955ca5281568cbe6d48a4c144a5b49680f6f7d8684fa61524dcc80474118c12e9df13b6bfc4ffca1a0d0e55679c0325dcdfd48543aab96

data/README.md

@@ -38,7 +38,7 @@ As of 2.0.0, this project adheres to the
 License
 -------
 
-Copyright (C) 2009-2019 MongoDB Inc.
+Copyright (C) 2009-2020 MongoDB Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/ext/bson/bson-endian.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2015-2019 MongoDB, Inc.
+ * Copyright (C) 2015-2020 MongoDB Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

data/ext/bson/bson-native.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2019 MongoDB, Inc.
+ * Copyright (C) 2009-2020 MongoDB Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

data/ext/bson/bytebuf.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2019 MongoDB, Inc.
+ * Copyright (C) 2009-2020 MongoDB Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

data/ext/bson/endian.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2015-2019 MongoDB, Inc.
+ * Copyright (C) 2015-2020 MongoDB Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

data/ext/bson/init.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2019 MongoDB Inc.
+ * Copyright (C) 2009-2020 MongoDB Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

data/ext/bson/read.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2019 MongoDB, Inc.
+ * Copyright (C) 2009-2020 MongoDB Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,22 +17,28 @@
 #include "bson-native.h"
 #include <ruby/encoding.h>
 
-static void pvt_validate_length(byte_buffer_t *b);
+static void pvt_raise_decode_error(volatile VALUE msg);
+static int32_t pvt_validate_length(byte_buffer_t *b);
 static uint8_t pvt_get_type_byte(byte_buffer_t *b);
 static VALUE pvt_get_int32(byte_buffer_t *b);
 static VALUE pvt_get_int64(byte_buffer_t *b, int argc, VALUE *argv);
 static VALUE pvt_get_double(byte_buffer_t *b);
-static VALUE pvt_get_string(byte_buffer_t *b);
+static VALUE pvt_get_string(byte_buffer_t *b, const char *data_type);
 static VALUE pvt_get_symbol(byte_buffer_t *b, VALUE rb_buffer, int argc, VALUE *argv);
 static VALUE pvt_get_boolean(byte_buffer_t *b);
 static VALUE pvt_read_field(byte_buffer_t *b, VALUE rb_buffer, uint8_t type, int argc, VALUE *argv);
 static void pvt_skip_cstring(byte_buffer_t *b);
 
+void pvt_raise_decode_error(volatile VALUE msg) {
+  VALUE klass = pvt_const_get_3("BSON", "Error", "BSONDecodeError");
+  rb_exc_raise(rb_exc_new_str(klass, msg));
+}
+
 /**
  * validate the buffer contains the amount of bytes the array / hash claimns
  * and that it is null terminated
  */
-void pvt_validate_length(byte_buffer_t *b)
+int32_t pvt_validate_length(byte_buffer_t *b)
 {
   int32_t length;
   
@@ -53,6 +59,8 @@ void pvt_validate_length(byte_buffer_t *b)
   else{
     rb_raise(rb_eRangeError, "Buffer contained invalid length %d at %zu", length, b->read_position);
   }
+  
+  return length;
 }
 
 /**
@@ -64,7 +72,7 @@ VALUE pvt_read_field(byte_buffer_t *b, VALUE rb_buffer, uint8_t type, int argc,
     case BSON_TYPE_INT32: return pvt_get_int32(b);
     case BSON_TYPE_INT64: return pvt_get_int64(b, argc, argv);
     case BSON_TYPE_DOUBLE: return pvt_get_double(b);
-    case BSON_TYPE_STRING: return pvt_get_string(b);
+    case BSON_TYPE_STRING: return pvt_get_string(b, "String");
     case BSON_TYPE_SYMBOL: return pvt_get_symbol(b, rb_buffer, argc, argv);
     case BSON_TYPE_ARRAY: return rb_bson_byte_buffer_get_array(argc, argv, rb_buffer);
     case BSON_TYPE_DOCUMENT: return rb_bson_byte_buffer_get_hash(argc, argv, rb_buffer);
@@ -119,9 +127,20 @@ VALUE rb_bson_byte_buffer_get_bytes(VALUE self, VALUE i)
 }
 
 VALUE pvt_get_boolean(byte_buffer_t *b){
-  VALUE result = Qnil;
+  VALUE result;
+  char byte_value;
   ENSURE_BSON_READ(b, 1);
-  result = *READ_PTR(b) == 1 ? Qtrue: Qfalse;
+  byte_value = *READ_PTR(b);
+  switch (byte_value) {
+    case 1:
+      result = Qtrue;
+      break;
+    case 0:
+      result = Qfalse;
+      break;
+    default:
+      pvt_raise_decode_error(rb_sprintf("Invalid boolean byte value: %d", (int) byte_value));
+  }
   b->read_position += 1;
   return result;
 }
@@ -134,22 +153,35 @@ VALUE rb_bson_byte_buffer_get_string(VALUE self)
   byte_buffer_t *b;
 
   TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
-  return pvt_get_string(b);
+  return pvt_get_string(b, "String");
 }
 
-VALUE pvt_get_string(byte_buffer_t *b)
+VALUE pvt_get_string(byte_buffer_t *b, const char *data_type)
 {
-  int32_t length;
   int32_t length_le;
+  int32_t length;
+  char *str_ptr;
   VALUE string;
+  unsigned char last_byte;
 
   ENSURE_BSON_READ(b, 4);
-  memcpy(&length, READ_PTR(b), 4);
-  length_le = BSON_UINT32_FROM_LE(length);
-  b->read_position += 4;
-  ENSURE_BSON_READ(b, length_le);
-  string = rb_enc_str_new(READ_PTR(b), length_le - 1, rb_utf8_encoding());
-  b->read_position += length_le;
+  memcpy(&length_le, READ_PTR(b), 4);
+  length = BSON_UINT32_FROM_LE(length_le);
+  if (length < 0) {
+    pvt_raise_decode_error(rb_sprintf("String length is negative: %d", length));
+  }
+  if (length == 0) {
+    pvt_raise_decode_error(rb_str_new_cstr("String length is zero but string must be null-terminated"));
+  }
+  ENSURE_BSON_READ(b, 4 + length);
+  str_ptr = READ_PTR(b) + 4;
+  last_byte = *(READ_PTR(b) + 4 + length_le - 1);
+  if (last_byte != 0) {
+    pvt_raise_decode_error(rb_sprintf("Last byte of the string is not null: 0x%x", (int) last_byte));
+  }
+  rb_bson_utf8_validate(str_ptr, length - 1, true, data_type);
+  string = rb_enc_str_new(str_ptr, length - 1, rb_utf8_encoding());
+  b->read_position += 4 + length_le;
   return string;
 }
 
@@ -166,7 +198,7 @@ VALUE pvt_get_symbol(byte_buffer_t *b, VALUE rb_buffer, int argc, VALUE *argv)
   VALUE value, klass;
 
   if (pvt_get_mode_option(argc, argv) == BSON_MODE_BSON) {
-    value = pvt_get_string(b);
+    value = pvt_get_string(b, "Symbol");
     klass = pvt_const_get_3("BSON", "Symbol", "Raw");
     value = rb_funcall(klass, rb_intern("new"), 1, value);
   } else {
@@ -306,10 +338,13 @@ VALUE rb_bson_byte_buffer_get_hash(int argc, VALUE *argv, VALUE self){
   byte_buffer_t *b = NULL;
   uint8_t type;
   VALUE cDocument = pvt_const_get_2("BSON", "Document");
+  int32_t length;
+  char *start_ptr;
 
   TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
 
-  pvt_validate_length(b);
+  start_ptr = READ_PTR(b);
+  length = pvt_validate_length(b);
 
   doc = rb_funcall(cDocument, rb_intern("allocate"), 0);
 
@@ -318,6 +353,11 @@ VALUE rb_bson_byte_buffer_get_hash(int argc, VALUE *argv, VALUE self){
     rb_hash_aset(doc, field, pvt_read_field(b, self, type, argc, argv));
     RB_GC_GUARD(field);
   }
+  
+  if (READ_PTR(b) - start_ptr != length) {
+    pvt_raise_decode_error(rb_sprintf("Expected to read %d bytes for the hash but read %ld bytes", length, READ_PTR(b) - start_ptr));
+  }
+  
   return doc;
 }
 
@@ -325,10 +365,13 @@ VALUE rb_bson_byte_buffer_get_array(int argc, VALUE *argv, VALUE self){
   byte_buffer_t *b;
   VALUE array = Qnil;
   uint8_t type;
+  int32_t length;
+  char *start_ptr;
 
   TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
 
-  pvt_validate_length(b);
+  start_ptr = READ_PTR(b);
+  length = pvt_validate_length(b);
 
   array = rb_ary_new();
   while((type = pvt_get_type_byte(b)) != 0){
@@ -336,5 +379,10 @@ VALUE rb_bson_byte_buffer_get_array(int argc, VALUE *argv, VALUE self){
     rb_ary_push(array,  pvt_read_field(b, self, type, argc, argv));
   }
   RB_GC_GUARD(array);
+  
+  if (READ_PTR(b) - start_ptr != length) {
+    pvt_raise_decode_error(rb_sprintf("Expected to read %d bytes for the hash but read %ld bytes", length, READ_PTR(b) - start_ptr));
+  }
+  
   return array;
 }

data/ext/bson/util.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2019 MongoDB, Inc.
+ * Copyright (C) 2009-2020 MongoDB Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

data/ext/bson/write.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2019 MongoDB, Inc.
+ * Copyright (C) 2009-2020 MongoDB Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

data/lib/bson.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/active_support.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/array.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -119,7 +119,8 @@ module BSON
           buffer.get_array(**options)
         else
           array = new
-          buffer.get_int32 # throw away the length
+          start_position = buffer.read_position
+          expected_byte_size = buffer.get_int32
           while (type = buffer.get_byte) != NULL_BYTE
             buffer.get_cstring
             cls = BSON::Registry.get(type)
@@ -130,6 +131,10 @@ module BSON
             end
             array << value
           end
+          actual_byte_size = buffer.read_position - start_position
+          if actual_byte_size != expected_byte_size
+            raise Error::BSONDecodeError, "Expected array to take #{expected_byte_size} bytes but it took #{actual_byte_size} bytes"
+          end
           array
         end
       end

data/lib/bson/binary.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/boolean.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -39,7 +39,14 @@ module BSON
     #
     # @since 2.0.0
     def self.from_bson(buffer, **options)
-      buffer.get_byte == TrueClass::TRUE_BYTE
+      case v = buffer.get_byte
+      when TrueClass::TRUE_BYTE
+        true
+      when FalseClass::FALSE_BYTE
+        false
+      else
+        raise Error::BSONDecodeError, "Invalid boolean byte value: #{v}"
+      end
     end
 
     # Register this type when the module is loaded.

data/lib/bson/code.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/code_with_scope.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -119,13 +119,20 @@ module BSON
     #
     # @since 2.0.0
     def self.from_bson(buffer, **options)
-      buffer.get_int32 # Throw away the total length.
+      # Code with scope has a length (?) field which is not needed for
+      # decoding, but spec tests want this field validated.
+      start_position = buffer.read_position
+      length = buffer.get_int32
       javascript = buffer.get_string
       scope = if options.empty?
         ::Hash.from_bson(buffer)
       else
         ::Hash.from_bson(buffer, **options)
       end
+      read_bytes = buffer.read_position - start_position
+      if read_bytes != length
+        raise Error::BSONDecodeError, "CodeWithScope invalid: claimed length #{length}, actual length #{read_bytes}"
+      end
       new(javascript, scope)
     end
 

data/lib/bson/config.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2019 MongoDB Inc.
+# Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/date.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/date_time.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/decimal128.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2019 MongoDB Inc.
+# Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/decimal128/builder.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2019 MongoDB Inc.
+# Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/document.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/environment.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -41,6 +41,7 @@ module BSON
     # @return [ true, false ] If the Ruby version is 1.9.
     #
     # @since 4.2.0
+    # @deprecated
     def ruby_1_9?
       @ruby_1_9 ||= RUBY_VERSION < '2.0.0'
     end

data/lib/bson/error.rb

@@ -13,5 +13,9 @@ module BSON
     # unsupported binary subtype.
     class UnsupportedBinarySubtype < Error
     end
+
+    # Exception raised when BSON decoding fails.
+    class BSONDecodeError < Error
+    end
   end
 end

data/lib/bson/ext_json.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/false_class.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/float.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.