bson 4.15.0 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d0c420e8204cb354acfc6adadb5097b71f4a8346620a5461153c6461aece1e2
-  data.tar.gz: ce5e7172180e7e9f5c60d2af3207b50e0ead96283d36828e75a118cc53cdd7fa
+  metadata.gz: 41a002d14b035c9cf01534ee489ca61c012202aac1e2729fa850960c359ba5cd
+  data.tar.gz: f63478ad673c6dfbed91eaed8477b45287a264fa6c06e29d2273c41a0951e4e1
 SHA512:
-  metadata.gz: 990f1be935132660ad51dab98c9233e12f9af5d03eac5f52a5bef82a78af2d258c12721564bfaf042977766c65d9adc7dbc7d88241283207213fe9ac15c9a024
-  data.tar.gz: 8004b3cd0e51a769df76fd9027058f403efe6b5a565eff39aca3e43f700f0b77a7a670793dfb043d0cf963537eda0426e8a885dd4044adc2800934beaeb59286
+  metadata.gz: 67721ba06f0154a5dc37bc460602f878843243706e0194375c0350a095774beb06ba7a5b861b137d95bd0e753ed74b35d3b541283864aaec02b61dd94952d9ed
+  data.tar.gz: 525cc2a1da23ceaec40243cf7cc9ab504e81c11b56bf22e9f51f156c24294231fcd300874ae3b22c80fa473be568d84d43c627eabd4434c3895458c332364f6a

data/README.md

@@ -1,34 +1,122 @@
 BSON
 [![Gem Version][rubygems-img]][rubygems-url]
 [![Build Status][ghactions-img]][ghactions-url]
-[![Coverage Status][coveralls-img]][coveralls-url]
-[![Inline docs][inch-img]][inch-url]
 ====
 
 An implementation of the BSON specification in Ruby.
 
+Installation
+------------
+
+BSON can be installed via RubyGems:
+
+```
+> gem install bson
+```
+
+Or by adding it to your project's Gemfile:
+
+```ruby
+gem 'bson'
+```
+
+### Release Integrity
+
+Each release of the BSON library for Ruby after version 5.0.0 has been automatically built and signed using the team's GPG key.
+
+To verify the bson gem file:
+
+1. [Download the GPG key](https://pgp.mongodb.com/ruby-driver.asc).
+2. Import the key into your GPG keyring with `gpg --import ruby-driver.asc`.
+3. Download the gem file (if you don't already have it). You can download it from RubyGems with `gem fetch bson`, or you can download it from the [releases page](https://github.com/mongodb/bson-ruby/releases) on GitHub.
+4. Download the corresponding detached signature file from the [same release](https://github.com/mongodb/bson-ruby/releases). Look at the bottom of the release that corresponds to the gem file, under the 'Assets' list, for a `.sig` file with the same version number as the gem you wish to install.
+5. Verify the gem with `gpg --verify bson-X.Y.Z.gem.sig bson-X.Y.Z.gem` (replacing `X.Y.Z` with the actual version number).
+
+You are looking for text like "Good signature from "MongoDB Ruby Driver Release Signing Key <packaging@mongodb.com>" in the output. If you see that, the signature was found to correspond to the given gem file.
+
+(Note that other output, like "This key is not certified with a trusted signature!", is related to *web of trust* and depends on how strongly you, personally, trust the `ruby-driver.asc` key that you downloaded from us. To learn more, see https://www.gnupg.org/gph/en/manual/x334.html)
+
+### Why not use RubyGems' gem-signing functionality?
+
+RubyGems' own gem signing is problematic, most significantly because there is no established chain of trust related to the keys used to sign gems. RubyGems' own documentation admits that "this method of signing gems is not widely used" (see https://guides.rubygems.org/security/). Discussions about this in the RubyGems community have been off-and-on for more than a decade, and while a solution will eventually arrive, we have settled on using GPG instead for the following reasons:
+
+1. Many of the other driver teams at MongoDB are using GPG to sign their product releases. Consistency with the other teams means that we can reuse existing tooling for our own product releases.
+2. GPG is widely available and has existing tools and procedures for dealing with web of trust (though they are admittedly quite arcane and intimidating to the uninitiated, unfortunately).
+
+Ultimately, most users do not bother to verify gems, and will not be impacted by our choice of GPG over RubyGems' native method.
+
 Compatibility
 -------------
 
-BSON is tested against MRI (2.5) and JRuby (9.2+).
+BSON is tested against MRI (2.7+) and JRuby (9.3+).
 
 Documentation
 -------------
 
 Current documentation can be found
-[here](http://docs.mongodb.org/ecosystem/tutorial/ruby-bson-tutorial/#ruby-bson-tutorial).
+[here](https://www.mongodb.com/docs/ruby-driver/current/bson-tutorials/).
 
 API Documentation
 -----------------
 
-The [API Documentation](https://api.mongodb.com/bson-ruby/current/) is
-located at api.mongodb.com.
+The [API Documentation](https://www.mongodb.com/docs/ruby-driver/master/api/) is
+located at mongodb.com/docs.
 
 BSON Specification
 ------------------
 
 The [BSON specification](http://bsonspec.org) is at bsonspec.org.
 
+## Bugs & Feature Requests
+
+To report a bug in the `bson` gem or request a feature:
+
+1. Visit [our issue tracker](https://jira.mongodb.org/) and login
+   (or create an account if you do not have one already).
+2. Navigate to the [RUBY project](https://jira.mongodb.org/browse/RUBY).
+3. Click 'Create Issue' and fill out all of the applicable form fields, making
+sure to select `BSON` in the _Component/s_ field.
+
+When creating an issue, please keep in mind that all information in JIRA
+for the RUBY project, as well as the core server (the SERVER project),
+is publicly visible.
+
+**PLEASE DO:**
+
+- Provide as much information as possible about the issue.
+- Provide detailed steps for reproducing the issue.
+- Provide any applicable code snippets, stack traces and log data.
+- Specify version numbers of the `bson` gem and/or Ruby driver and MongoDB 
+server.
+
+**PLEASE DO NOT:**
+
+- Provide any sensitive data or server logs.
+- Report potential security issues publicly (see 'Security Issues' below).
+
+## Security Issues
+
+If you have identified a potential security-related issue in the `bson` gem
+(or any other MongoDB product), please report it by following the
+[instructions here](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report).
+
+## Product Feature Requests
+
+To request a feature which is not specific to the `bson` gem, or which
+affects more than the `bson` gem and/or Ruby driver alone (for example, a 
+feature which requires MongoDB server support), please submit your idea through 
+the [MongoDB Feedback Forum](https://feedback.mongodb.com/forums/924286-drivers).
+
+## Maintenance and Bug Fix Policy
+
+New library functionality is generally added in a backwards-compatible manner
+and results in new minor releases. Bug fixes are generally made on
+master first and are backported to the current minor library release. Exceptions
+may be made on a case-by-case basis, for example security fixes may be
+backported to older stable branches. Only the most recent minor release
+is officially supported. Customers should use the most recent release in
+their applications.
+
 Versioning
 ----------
 
@@ -56,7 +144,3 @@ limitations under the License.
 [rubygems-url]: http://badge.fury.io/rb/bson
 [ghactions-img]: https://github.com/mongodb/bson-ruby/actions/workflows/bson-ruby.yml/badge.svg?query=branch%3Amaster
 [ghactions-url]: https://github.com/mongodb/bson-ruby/actions/workflows/bson-ruby.yml?query=branch%3Amaster
-[coveralls-img]: https://coveralls.io/repos/mongodb/bson-ruby/badge.svg?branch=master
-[coveralls-url]: https://coveralls.io/r/mongodb/bson-ruby?branch=master
-[inch-img]: http://inch-ci.org/github/mongodb/bson-ruby.svg?branch=master
-[inch-url]: http://inch-ci.org/github/mongodb/bson-ruby

data/Rakefile

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
 # Copyright (C) 2009-2013 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -32,6 +35,8 @@ if jruby?
     ext.name = "bson-ruby"
     ext.ext_dir = "src"
     ext.lib_dir = "lib"
+    ext.target_version = ENV['TARGET_VERSION'] if ENV['TARGET_VERSION']
+    ext.source_version = ENV['SOURCE_VERSION'] if ENV['SOURCE_VERSION']
   end
 else
   require "rake/extensiontask"
@@ -42,28 +47,37 @@ else
   end
 end
 
-require "bson/version"
+RSpec::Core::RakeTask.new(:rspec)
 
-def extension
-  RUBY_PLATFORM =~ /darwin/ ? "bundle" : "so"
+desc 'Build the bson gem'
+task :build => [ :clean_all, *(jruby? ? :compile : nil) ] do
+  output = "--output=#{ENV['GEM_FILE_NAME']}" if ENV['GEM_FILE_NAME']
+  system "gem build #{output} bson.gemspec"
 end
 
-require_relative "perf/bench"
-
-RSpec::Core::RakeTask.new(:rspec)
+# `rake version` is used by the deployment system so get the release version
+# of the product beng deployed. It must do nothing more than just print the
+# product version number.
+desc 'Print the current version of the Ruby-BSON library'
+task :version do
+  require 'bson/version'
+  puts BSON::VERSION
+end
 
-if jruby?
-  task :build => [ :clean_all, :compile ] do
-    system "gem build bson.gemspec"
-  end
-else
-  task :build => :clean_all do
-    system "gem build bson.gemspec"
-  end
+# `rake gem_file_name` is used by the deployment system so get the name of
+# the gem file to be generated. It must do nothing more than just print the
+# name of the gem file to generate.
+desc 'Print the name of the gem file to generate.'
+task :gem_file_name do
+  require 'bson/version'
+  base = "bson-#{BSON::VERSION}"
+  base << '-java' if jruby?
+  puts "#{base}.gem"
 end
 
 task :clean_all => :clean do
-  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson_native.#{extension}"))
+  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson_native.bundle"))
+  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson_native.so"))
   FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson_native.o"))
   FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson-ruby.jar"))
 end
@@ -72,49 +86,63 @@ task :spec => :compile do
   Rake::Task["rspec"].invoke
 end
 
-# Run bundle exec rake release with mri and jruby. Ex:
-#
-# rvm use 2.1.0@bson
-# bundle exec rake release
-# rvm use jruby@bson
-# bundle exec rake release
-task :release => :build do
-  system "git tag -a v#{BSON::VERSION} -m 'Tagging release: #{BSON::VERSION}'"
-  system "git push --tags"
-  if jruby?
-    system "gem push bson-#{BSON::VERSION}-java.gem"
-    system "rm bson-#{BSON::VERSION}-java.gem"
-  else
-    system "gem push bson-#{BSON::VERSION}.gem"
-    system "rm bson-#{BSON::VERSION}.gem"
+# overrides the default Bundler-provided `release` task, which also
+# builds the gem. Our release process assumes the gem has already
+# been built (and signed via GPG), so we just need `rake release` to
+# push the gem to rubygems.
+task :release do
+  require 'bson/version'
+
+  # confirm: there ought to be two gems, one for MRI, and one for Java. These
+  # will have been previously generated by the 'BSON Release' GitHub action.
+  gems = Dir['*.gem']
+  if gems.length != 2
+    abort "Expected two gem files to be ready to release; got #{gems.length}"
+  end
+
+  if ENV['GITHUB_ACTION'].nil?
+    abort <<~WARNING
+      `rake release` must be invoked from the `BSON Release` GitHub action,
+      and must not be invoked locally. This ensures the gem is properly signed
+      and distributed by the appropriate user.
+
+      Note that it is the `rubygems/release-gem@v1` step in the `BSON Release`
+      action that invokes this task. Do not rename or remove this task, or the
+      release-gem step will fail. Reimplement this task with caution.
+
+      NO GEMS were pushed to RubyGems.
+    WARNING
+  end
+
+  gems.each do |gem|
+    system 'gem', 'push', gem
   end
 end
 
 namespace :benchmark do
 
-  task :ruby => :clean_all do
+  task :prep do
+    require_relative "perf/bench"
+  end
+
+  task ruby: [ :clean_all, 'benchmark:prep' ] do
     puts "Benchmarking pure Ruby..."
-    require "bson"
     benchmark!
   end
 
-  task :native => :compile do
+  task native: [ :compile, 'benchmark:prep' ] do
     puts "Benchmarking with native extensions..."
-    require "bson"
     benchmark!
   end
 
   namespace :decimal128 do
-
-    task :from_string do
+    task from_string: 'benchmark:prep' do
       puts "Benchmarking creating Decimal128 objects from a string"
-      require 'bson'
       benchmark_decimal128_from_string!
     end
 
-    task :to_string do
+    task to_string: 'benchmark:prep' do
       puts "Benchmarking getting a string representation of a Decimal128"
-      require 'bson'
       benchmark_decimal128_to_string!
     end
   end
@@ -128,6 +156,7 @@ task :docs => 'docs:yard'
 namespace :docs do
   desc "Generate yard documention"
   task :yard do
+    require 'bson/version'
     out = File.join('yard-docs', BSON::VERSION)
     FileUtils.rm_rf(out)
     system "yardoc -o #{out} --title bson-#{BSON::VERSION}"

data/ext/bson/bson-native.h

@@ -17,6 +17,7 @@
 #include <ruby.h>
 #include <stdbool.h>
 #include <stdint.h>
+#include <stdlib.h>
 #include <unistd.h>
 #include <time.h>
 #include "bson-endian.h"
@@ -91,14 +92,16 @@ VALUE rb_bson_byte_buffer_put_uint32(VALUE self, VALUE i);
 VALUE rb_bson_byte_buffer_put_int64(VALUE self, VALUE i);
 VALUE rb_bson_byte_buffer_put_string(VALUE self, VALUE string);
 VALUE rb_bson_byte_buffer_put_symbol(VALUE self, VALUE symbol);
-VALUE rb_bson_byte_buffer_put_hash(VALUE self, VALUE hash, VALUE validating_keys);
-VALUE rb_bson_byte_buffer_put_array(VALUE self, VALUE array, VALUE validating_keys);
+VALUE rb_bson_byte_buffer_put_hash(VALUE self, VALUE hash);
+VALUE rb_bson_byte_buffer_put_array(VALUE self, VALUE array);
 VALUE rb_bson_byte_buffer_read_position(VALUE self);
 VALUE rb_bson_byte_buffer_replace_int32(VALUE self, VALUE index, VALUE i);
 VALUE rb_bson_byte_buffer_rewind(VALUE self);
 VALUE rb_bson_byte_buffer_write_position(VALUE self);
 VALUE rb_bson_byte_buffer_to_s(VALUE self);
+
 VALUE rb_bson_object_id_generator_next(int argc, VALUE* args, VALUE self);
+VALUE rb_bson_object_id_generator_reset_counter(int argc, VALUE* args, VALUE self);
 
 size_t rb_bson_byte_buffer_memsize(const void *ptr);
 void rb_bson_byte_buffer_free(void *ptr);
@@ -113,6 +116,13 @@ VALUE pvt_const_get_3(const char *c1, const char *c2, const char *c3);
 
 int pvt_get_mode_option(int argc, VALUE *argv);
 
+#define BSON_OBJECT_ID_RANDOM_VALUE_LENGTH  ( 5 )
+
+uint8_t* pvt_get_object_id_random_value();
+void pvt_init_rand();
+void pvt_rand_buf(uint8_t* bytes, int len, int pid);
+int pvt_rand();
+
 /**
  * The counter for incrementing object ids.
  */
@@ -120,8 +130,6 @@ extern uint32_t rb_bson_object_id_counter;
 
 extern VALUE rb_bson_registry;
 
-extern VALUE rb_bson_illegal_key;
-
 extern const rb_data_type_t rb_byte_buffer_data_type;
 
 extern VALUE _ref_str, _id_str, _db_str;

data/ext/bson/extconf.rb

@@ -1,3 +1,8 @@
-require "mkmf"
-$CFLAGS << " -Wall -g -std=c99"
-create_makefile("bson_native")
+# frozen_string_literal: true
+# rubocop:disable all
+
+require 'mkmf'
+
+$CFLAGS << ' -Wall -g -std=c99'
+
+create_makefile('bson_native')

data/ext/bson/init.c

@@ -23,8 +23,6 @@ uint32_t rb_bson_object_id_counter;
 
 VALUE rb_bson_registry;
 
-VALUE rb_bson_illegal_key;
-
 const rb_data_type_t rb_byte_buffer_data_type = {
   "bson/byte_buffer",
   { NULL, rb_bson_byte_buffer_free, rb_bson_byte_buffer_memsize }
@@ -46,6 +44,8 @@ void Init_bson_native()
   _db_str = rb_str_new_cstr("$db");
   rb_gc_register_mark_object(_db_str);
 
+  rb_require("digest/md5");
+
   VALUE rb_bson_module = rb_define_module("BSON");
 
   /* Document-class: BSON::ByteBuffer
@@ -60,9 +60,6 @@ void Init_bson_native()
   VALUE rb_digest_class = rb_const_get(rb_cObject, rb_intern("Digest"));
   VALUE rb_md5_class = rb_const_get(rb_digest_class, rb_intern("MD5"));
 
-  rb_bson_illegal_key = rb_const_get(rb_const_get(rb_bson_module, rb_intern("String")),rb_intern("IllegalKey"));
-  rb_gc_register_mark_object(rb_bson_illegal_key);
-
   rb_define_alloc_func(rb_byte_buffer_class, rb_bson_byte_buffer_allocate);
   rb_define_method(rb_byte_buffer_class, "initialize", rb_bson_byte_buffer_initialize, -1);
 
@@ -116,7 +113,7 @@ void Init_bson_native()
   rb_define_method(rb_byte_buffer_class, "get_array", rb_bson_byte_buffer_get_array, -1);
 
   rb_define_method(rb_byte_buffer_class, "get_int32", rb_bson_byte_buffer_get_int32, 0);
-  
+
   /*
    * call-seq:
    *   buffer.get_uint32(buffer) -> Fixnum
@@ -285,13 +282,13 @@ void Init_bson_native()
 
   /*
    * call-seq:
-   *   buffer.put_hash(hash, validating_keys) -> ByteBuffer
+   *   buffer.put_hash(hash) -> ByteBuffer
    *
    * Writes a Hash into the byte buffer.
    *
    * Returns the modified +self+.
    */
-  rb_define_method(rb_byte_buffer_class, "put_hash", rb_bson_byte_buffer_put_hash, 2);
+  rb_define_method(rb_byte_buffer_class, "put_hash", rb_bson_byte_buffer_put_hash, 1);
 
   /*
    * call-seq:
@@ -301,7 +298,7 @@ void Init_bson_native()
    *
    * Returns the modified +self+.
    */
-  rb_define_method(rb_byte_buffer_class, "put_array", rb_bson_byte_buffer_put_array, 2);
+  rb_define_method(rb_byte_buffer_class, "put_array", rb_bson_byte_buffer_put_array, 1);
 
   /*
    * call-seq:
@@ -349,6 +346,7 @@ void Init_bson_native()
   rb_define_method(rb_byte_buffer_class, "to_s", rb_bson_byte_buffer_to_s, 0);
 
   rb_define_method(rb_bson_object_id_generator_class, "next_object_id", rb_bson_object_id_generator_next, -1);
+  rb_define_method(rb_bson_object_id_generator_class, "reset_counter", rb_bson_object_id_generator_reset_counter, -1);
 
   // Get the object id machine id and hash it.
   rb_require("digest/md5");
@@ -356,8 +354,10 @@ void Init_bson_native()
   rb_bson_machine_id[255] = '\0';
   rb_bson_generate_machine_id(rb_md5_class, rb_bson_machine_id);
 
-  // Set the object id counter to a random number
-  rb_bson_object_id_counter = FIX2INT(rb_funcall(rb_mKernel, rb_intern("rand"), 1, INT2FIX(0x1000000)));
+  pvt_init_rand();
+
+  // Set the object id counter to a random 3-byte integer
+  rb_bson_object_id_counter = pvt_rand() % 0xFFFFFF;
 
   rb_bson_registry = rb_const_get(rb_bson_module, rb_intern("Registry"));
   rb_gc_register_mark_object(rb_bson_registry);

data/ext/bson/read.c

@@ -29,6 +29,7 @@ static VALUE pvt_get_symbol(byte_buffer_t *b, VALUE rb_buffer, int argc, VALUE *
 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);
+static size_t pvt_strnlen(const byte_buffer_t *b);
 
 void pvt_raise_decode_error(volatile VALUE msg) {
   VALUE klass = pvt_const_get_3("BSON", "Error", "BSONDecodeError");
@@ -80,8 +81,23 @@ VALUE pvt_read_field(byte_buffer_t *b, VALUE rb_buffer, uint8_t type, int argc,
     case BSON_TYPE_BOOLEAN: return pvt_get_boolean(b);
     default:
     {
-      VALUE klass = rb_funcall(rb_bson_registry,rb_intern("get"),1, INT2FIX(type));
-      VALUE value = rb_funcall(klass, rb_intern("from_bson"),1, rb_buffer);
+      VALUE klass = rb_funcall(rb_bson_registry, rb_intern("get"), 1, INT2FIX(type));
+      VALUE value;
+      if (argc > 1) {
+        rb_raise(rb_eArgError, "At most one argument is allowed");
+      } else if (argc > 0) {
+        VALUE call_args[2];
+        call_args[0] = rb_buffer;
+        Check_Type(argv[0], T_HASH);
+        call_args[1] = argv[0];
+#ifdef RB_PASS_KEYWORDS /* Ruby 2.7+ */
+        value = rb_funcallv_kw(klass, rb_intern("from_bson"), 2, call_args, RB_PASS_KEYWORDS);
+#else /* Ruby 2.6 and below */
+        value = rb_funcallv(klass, rb_intern("from_bson"), 2, call_args);
+#endif
+      } else {
+        value = rb_funcall(klass, rb_intern("from_bson"), 1, rb_buffer);
+      }
       RB_GC_GUARD(klass);
       return value;
     }
@@ -128,7 +144,7 @@ VALUE rb_bson_byte_buffer_get_bytes(VALUE self, VALUE i)
 }
 
 VALUE pvt_get_boolean(byte_buffer_t *b){
-  VALUE result;
+  VALUE result = Qnil;
   char byte_value;
   ENSURE_BSON_READ(b, 1);
   byte_value = *READ_PTR(b);
@@ -221,7 +237,7 @@ VALUE rb_bson_byte_buffer_get_cstring(VALUE self)
   int length;
 
   TypedData_Get_Struct(self, byte_buffer_t, &rb_byte_buffer_data_type, b);
-  length = (int)strlen(READ_PTR(b));
+  length = (int)pvt_strnlen(b);
   ENSURE_BSON_READ(b, length);
   string = rb_enc_str_new(READ_PTR(b), length, rb_utf8_encoding());
   b->read_position += length + 1;
@@ -234,7 +250,7 @@ VALUE rb_bson_byte_buffer_get_cstring(VALUE self)
 void pvt_skip_cstring(byte_buffer_t *b)
 {
   int length;
-  length = (int)strlen(READ_PTR(b));
+  length = (int)pvt_strnlen(b);
   ENSURE_BSON_READ(b, length);
   b->read_position += length + 1;
 }
@@ -366,17 +382,17 @@ static int pvt_is_dbref(VALUE doc) {
   if (NIL_P(ref) || !RB_TYPE_P(ref, T_STRING)) {
     return 0;
   }
-  
+
   id = rb_hash_aref(doc, _id_str);
   if (NIL_P(id)) {
     return 0;
   }
-  
+
   db = rb_hash_aref(doc, _db_str);
   if (!NIL_P(db) && !RB_TYPE_P(db, T_STRING)) {
     return 0;
   }
-  
+
   return 1;
 }
 
@@ -404,7 +420,7 @@ VALUE rb_bson_byte_buffer_get_hash(int argc, VALUE *argv, VALUE self){
   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));
   }
-  
+
   if (pvt_is_dbref(doc)) {
     VALUE cDBRef = pvt_const_get_2("BSON", "DBRef");
     doc = rb_funcall(cDBRef, rb_intern("new"), 1, doc);
@@ -438,3 +454,17 @@ VALUE rb_bson_byte_buffer_get_array(int argc, VALUE *argv, VALUE self){
 
   return array;
 }
+
+/**
+ * Returns the length of the given string `str`. If no null-terminating byte
+ * is present when `len` bytes have been scanned, then `len` is
+ * returned.
+ */
+size_t pvt_strnlen(const byte_buffer_t *b) {
+  const char *ptr = memchr(READ_PTR(b), '\0', READ_SIZE(b));
+
+  if (!ptr)
+    rb_raise(rb_eRangeError, "string is too long (possibly not null-terminated)");
+
+  return (size_t)(ptr - READ_PTR(b));
+}