geoip2_c 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08ccfe015bb26a4af300f07f11c20ff027b4de7ee76413755df7d8a7c1e74822'
-  data.tar.gz: 282c25e8603af880c2bd7dc081c7792c1337a09d6421c4738bc78f02b005b158
+  metadata.gz: 25a17a86c77f7e092f8f24a224cd8a57d6bba8595f51d0e052e3a846a3fd67e8
+  data.tar.gz: 1bb129e6fba2ff42f583dff127ba4168d958c12af6a7c1521d23a07fbf59dab8
 SHA512:
-  metadata.gz: 8bdd737733f0dff3b8691c5b33fcb823b03111af2c09c0fac3c59e12430c55a5b1c46fd9fd19d3fd1a5caa26559f280ad291031d05af76383e67f69450260ff7
-  data.tar.gz: 773ce3df6dbf835c00267c24c45588efdfc81a2934b839741d80445f401fa0dba56025863745fec01939b4f1fbba3b755e80130697e584a78eff7f3ed023a1c2
+  metadata.gz: 22d90d27edebbf88c8d0a9ec2edc304fc0265b1f6814012ca47e4cd5b9ef5f8422fe3b92a63ed90bbba1f3a2eb874c98d1f52f9d28d246f8df83f5d19e3a4819
+  data.tar.gz: 4ba29b9f46963e6be9c298c686885b6224e4b7346069da485972d48ac91f0baf025fa882461df943461a0798102a3429cd165d7c13340c7c1aecae576e0fbf97

data/.github/dependabot.yml

@@ -0,0 +1,23 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'monthly'
+    groups:
+      # PR: "Security update [package] from [old] to [new]"
+      # This PR should be merged in hurry
+      security-updates:
+        applies-to: security-updates
+        patterns:
+          - '*'
+
+      # PR: "Bump [package] from [old] to [new]"
+      # No need to be merged this PR in hurry. It is enough to merge
+      # once in a month.
+      monthly-updates:
+        applies-to: version-updates
+        patterns:
+          - '*'
+    # Allow to create PR both of security and normal updates.
+    open-pull-requests-limit: 1

data/.github/workflows/ubuntu.yml

@@ -1,24 +1,33 @@
 name: ubuntu
 
 on:
-  - push
-  - pull_request
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  schedule:
+    - cron: '0 0 1 * *'
 
 jobs:
+  ruby-versions:
+    uses: ruby/actions/.github/workflows/ruby_versions.yml@master
+    with:
+      engine: cruby
+      min_version: 3.0
   build:
+    needs: ruby-versions
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby:
-          - "3.2"
-          - "3.1"
-          - "3.0"
+        ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
+        exclude:
+          - ruby: head
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
           submodules: true
       - name: Setup ruby
-        uses: ruby/setup-ruby@09a7688d3b55cf0e976497ff046b70949eeaccfd # v1.288.0
+        uses: ruby/setup-ruby@0dafeac902942906541bc140009cdbf32665b601 # v1.315.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler: latest

data/.github/workflows/windows.yml

@@ -1,17 +1,27 @@
 name: windows
 
 on:
-  - push
-  - pull_request
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  schedule:
+    - cron: '0 0 1 * *'
 
 jobs:
+  ruby-versions:
+    uses: ruby/actions/.github/workflows/ruby_versions.yml@master
+    with:
+      engine: cruby
+      min_version: 3.1
   build:
+    needs: ruby-versions
     runs-on: windows-latest
     strategy:
       matrix:
-        ruby:
-          - "3.2"
-          - "3.1"
+        ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
+        exclude:
+          - ruby: head
         include:
           - ruby: "3.0.3"
             # On Ruby 3.0, we need to use fiddle 1.0.8 or later to retrieve correct
@@ -23,7 +33,7 @@ jobs:
             # * https://github.com/oneclick/rubyinstaller2/blob/8225034c22152d8195bc0aabc42a956c79d6c712/lib/ruby_installer/build/dll_directory.rb
             ruby-lib-opt: RUBYLIB=%RUNNER_TOOL_CACHE%/Ruby/3.0.3/x64/lib/ruby/gems/3.0.0/gems/fiddle-1.1.0/lib
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
           submodules: true
       - name: Install dependencies
@@ -31,7 +41,7 @@ jobs:
           ridk enable
           pacman -Sy --noconfirm mingw-w64-x86_64-libmaxminddb
       - name: Setup ruby
-        uses: ruby/setup-ruby@09a7688d3b55cf0e976497ff046b70949eeaccfd # v1.288.0
+        uses: ruby/setup-ruby@0dafeac902942906541bc140009cdbf32665b601 # v1.315.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler: latest

data/ext/geoip2/geoip2.c

@@ -33,6 +33,23 @@ typedef struct {
   bool symbolize_keys;
 } ParseRequest;
 
+/* A LookupResult holds a copy of the libmaxminddb lookup result (whose
+ * entry.mmdb points into the owning Database's MMDB_s) together with a
+ * reference to that Database VALUE. Keeping the reference and marking it
+ * prevents the Database (and its mmap'd file) from being freed while a
+ * LookupResult derived from it is still alive. */
+typedef struct {
+  MMDB_lookup_result_s result;
+  VALUE db;
+} LookupResult;
+
+static void
+lookup_result_mark(void *ptr)
+{
+  LookupResult *lr = (LookupResult *)ptr;
+  rb_gc_mark(lr->db);
+}
+
 static const rb_data_type_t rb_mmdb_type = {
   "geoip2/mmdb", {
     0, mmdb_free, 0,
@@ -42,11 +59,25 @@ static const rb_data_type_t rb_mmdb_type = {
 
 static const rb_data_type_t rb_lookup_result_type = {
   "geoip2/lookup_result", {
-    0, RUBY_DEFAULT_FREE, 0,
+    lookup_result_mark, RUBY_DEFAULT_FREE, 0,
   }, NULL, NULL,
   RUBY_TYPED_FREE_IMMEDIATELY
 };
 
+/* Fetch the LookupResult and ensure its backing database is still usable.
+ * Raises rather than dereferencing a freed/unmapped MMDB_s (use-after-free). */
+static LookupResult *
+lookup_result_get_open(VALUE self)
+{
+  LookupResult *lr;
+  TypedData_Get_Struct(self, LookupResult, &rb_lookup_result_type, lr);
+  if (lr->result.entry.mmdb == NULL ||
+      mmdb_is_closed((MMDB_s *)lr->result.entry.mmdb)) {
+    rb_raise(rb_eGeoIP2Error, "the database is closed");
+  }
+  return lr;
+}
+
 static void
 mmdb_open(const char *db_path, MMDB_s *mmdb)
 {
@@ -141,10 +172,20 @@ mmdb_entry_data_decode(MMDB_entry_data_s *entry_data)
   case MMDB_DATA_TYPE_UINT64:
     return UINT2NUM(entry_data->uint64);
   case MMDB_DATA_TYPE_UINT128:
+    /* uint128 does not fit in a C unsigned long, so build the Integer from the
+     * full 128 bits instead of truncating it through UINT2NUM. */
 #if !(MMDB_UINT128_IS_BYTE_ARRAY)
-    return UINT2NUM(entry_data->uint128);
+    {
+      mmdb_uint128_t value = entry_data->uint128;
+      return rb_integer_unpack(&value, 1, sizeof(value), 0,
+                               INTEGER_PACK_NATIVE_BYTE_ORDER |
+                               INTEGER_PACK_LSWORD_FIRST);
+    }
 #else
-    rb_raise(rb_eNotImpError, "TODO: unit8_t[16] -> Integer");
+    /* entry_data->uint128 is a big-endian uint8_t[16]. */
+    return rb_integer_unpack(entry_data->uint128, 16, 1, 0,
+                             INTEGER_PACK_BIG_ENDIAN |
+                             INTEGER_PACK_MSWORD_FIRST);
 #endif
   case MMDB_DATA_TYPE_ARRAY:
     /* TODO: not implemented */
@@ -266,6 +307,14 @@ rb_geoip2_db_open_mmdb(VALUE self, VALUE path)
   db_path = StringValueCStr(path);
 
   TypedData_Get_Struct(self, struct MMDB_s, &rb_mmdb_type, mmdb);
+
+  /* Reopening over an already-open database would overwrite the MMDB_s in
+   * place and leak libmaxminddb's internal allocations (and the previous
+   * mmap). Close the current database first. */
+  if (!mmdb_is_closed(mmdb)) {
+    mmdb_close(mmdb);
+  }
+
   mmdb_open(db_path, mmdb);
 
   return Qnil;
@@ -291,7 +340,7 @@ rb_geoip2_db_lookup(VALUE self, VALUE ip)
   char *ip_str;
   MMDB_s *mmdb;
   MMDB_lookup_result_s result;
-  MMDB_lookup_result_s *result_ptr;
+  LookupResult *result_ptr;
   VALUE obj;
 
   Check_Type(ip, T_STRING);
@@ -305,12 +354,11 @@ rb_geoip2_db_lookup(VALUE self, VALUE ip)
   }
 
   obj = TypedData_Make_Struct(rb_cGeoIP2LookupResult,
-                              struct MMDB_lookup_result_s,
+                              LookupResult,
                               &rb_lookup_result_type,
                               result_ptr);
-  result_ptr->found_entry = result.found_entry;
-  result_ptr->entry = result.entry;
-  result_ptr->netmask = result.netmask;
+  result_ptr->result = result;
+  result_ptr->db = self;
 
   rb_iv_set(obj, "@symbolize_keys", rb_iv_get(self, "@symbolize_keys"));
 
@@ -321,11 +369,12 @@ static VALUE
 rb_geoip2_lr_alloc(VALUE klass)
 {
   VALUE obj;
-  MMDB_lookup_result_s *result;
+  LookupResult *result;
   obj = TypedData_Make_Struct(klass,
-                              struct MMDB_lookup_result_s,
+                              LookupResult,
                               &rb_lookup_result_type,
                               result);
+  result->db = Qnil;
   return obj;
 }
 
@@ -351,13 +400,15 @@ rb_geoip2_lr_get_value(int argc, VALUE *argv, VALUE self)
   VALUE arg;
   VALUE rest;
   char **path;
+  VALUE path_tmp;
   int i = 0;
-  MMDB_lookup_result_s *result = NULL;
+  LookupResult *result = NULL;
   MMDB_entry_s entry;
   MMDB_entry_data_s entry_data;
   char *tmp;
   VALUE e;
   int status;
+  VALUE val;
 
   rb_scan_args(argc, argv, "1*", &arg, &rest);
   switch(TYPE(arg)) {
@@ -370,12 +421,14 @@ rb_geoip2_lr_get_value(int argc, VALUE *argv, VALUE self)
       rb_raise(rb_eArgError, "Expected a String or a Symbol");
       break;
   }
-  path = malloc(sizeof(char *) * (RARRAY_LEN(rest) + 2));
 
-  TypedData_Get_Struct(self,
-                       struct MMDB_lookup_result_s,
-                       &rb_lookup_result_type,
-                       result);
+  result = lookup_result_get_open(self);
+
+  /* ALLOCV_N ties the allocation to path_tmp: it is released automatically even
+   * if a later key conversion raises (e.g. a non-String key, or a String with
+   * an embedded NUL that makes StringValueCStr raise), and it raises
+   * NoMemoryError instead of returning NULL on allocation failure. */
+  path = ALLOCV_N(char *, path_tmp, RARRAY_LEN(rest) + 2);
 
   path[i] = rb_geoip2_lr_arg_convert_to_cstring(arg);
   while (RARRAY_LEN(rest) != 0) {
@@ -387,18 +440,18 @@ rb_geoip2_lr_get_value(int argc, VALUE *argv, VALUE self)
 
   path[i+1] = NULL;
 
-  entry = result->entry;
+  entry = result->result.entry;
 
   status = MMDB_aget_value(&entry, &entry_data, (const char *const *const)path);
 
   if (status != MMDB_SUCCESS) {
-    free(path);
     /* fprintf(stderr, "%s:%s\n", __FUNCTION__, MMDB_strerror(status)); */
+    ALLOCV_END(path_tmp);
     return Qnil;
   }
 
   if (!entry_data.has_data) {
-    free(path);
+    ALLOCV_END(path_tmp);
     return Qnil;
   }
 
@@ -407,38 +460,38 @@ rb_geoip2_lr_get_value(int argc, VALUE *argv, VALUE self)
     // FIXME optimize below code
     VALUE array = rb_ary_new();
     VALUE hash;
-    VALUE val;
     bool symbolize_keys = RTEST(rb_iv_get(self, "@symbolize_keys"));
     for (int j = 0; path[j] != NULL; j++) {
       rb_ary_push(array, symbolize_keys ? ID2SYM(rb_intern(path[j])) : rb_str_new_cstr(path[j]));
     }
     hash = rb_funcall(self, rb_intern("to_h"), 0);
     val = rb_apply(hash, rb_intern("dig"), array);
-    free(path);
+    ALLOCV_END(path_tmp);
     return val;
   }
 
-  free(path);
-  return mmdb_entry_data_decode(&entry_data);
+  val = mmdb_entry_data_decode(&entry_data);
+  ALLOCV_END(path_tmp);
+  return val;
 }
 
 static VALUE
 rb_geoip2_lr_netmask(VALUE self)
 {
-  MMDB_lookup_result_s *result = NULL;
+  LookupResult *result = NULL;
 
   TypedData_Get_Struct(self,
-                       struct MMDB_lookup_result_s,
+                       LookupResult,
                        &rb_lookup_result_type,
                        result);
 
-  return UINT2NUM(result->netmask);
+  return UINT2NUM(result->result.netmask);
 }
 
 static VALUE
 rb_geoip2_lr_to_h(VALUE self)
 {
-  MMDB_lookup_result_s *result = NULL;
+  LookupResult *result = NULL;
   MMDB_entry_data_list_s *entry_data_list = NULL;
   VALUE hash;
   VALUE cache;
@@ -452,11 +505,8 @@ rb_geoip2_lr_to_h(VALUE self)
     }
   }
 
-  TypedData_Get_Struct(self,
-                       struct MMDB_lookup_result_s,
-                       &rb_lookup_result_type,
-                       result);
-  status = MMDB_get_entry_data_list(&result->entry, &entry_data_list);
+  result = lookup_result_get_open(self);
+  status = MMDB_get_entry_data_list(&result->result.entry, &entry_data_list);
   if (status != MMDB_SUCCESS) {
     rb_raise(rb_eGeoIP2Error, "%s", MMDB_strerror(status));
   }

data/lib/geoip2/version.rb

@@ -1,3 +1,3 @@
 module GeoIP2
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geoip2_c
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - okkez
@@ -101,6 +101,7 @@ extensions:
 - ext/geoip2/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/ubuntu.yml"
 - ".github/workflows/windows.yml"
 - ".gitignore"
@@ -141,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.4
+rubygems_version: 4.0.15
 specification_version: 4
 summary: Write a short summary, because Rubygems requires one.
 test_files: []