Deprecate unsafe default options of JSON.load

[Feature #19528] Ref: https://bugs.ruby-lang.org/issues/19528 `load` is understood as the default method for serializer kind of libraries, and the default options of `JSON.load` has caused many security vulnerabilities over the years. The plan is to do like YAML/Psych, deprecate these default options and direct users toward using `JSON.unsafe_load` so at least it's obvious it should be used against untrusted data.
ruby · Oct 24, 2024 · 798d0f5 · 798d0f5
1 parent d45135c
commit 798d0f5
Show file tree

Hide file tree

Showing 9 changed files with 393 additions and 162 deletions.
diff --git a/ext/json/ext/parser/parser.c b/ext/json/ext/parser/parser.c
diff --git a/ext/json/ext/parser/parser.h b/ext/json/ext/parser/parser.h
@@ -26,6 +26,7 @@ typedef struct JSON_ParserStruct {
     bool symbolize_names;
     bool freeze;
     bool create_additions;
+    bool deprecated_create_additions;
 } JSON_Parser;
 
 #define GET_PARSER                          \

diff --git a/ext/json/ext/parser/parser.rl b/ext/json/ext/parser/parser.rl
@@ -196,6 +196,9 @@ static char *JSON_parse_object(JSON_Parser *json, char *p, char *pe, VALUE *resu
             if (!NIL_P(klassname)) {
                 VALUE klass = rb_funcall(mJSON, i_deep_const_get, 1, klassname);
                 if (RTEST(rb_funcall(klass, i_json_creatable_p, 0))) {
+                    if (json->deprecated_create_additions) {
+                        rb_warn("JSON.load implicit support for `create_additions: true` is deprecated and will be removed in 3.0, use JSON.unsafe_load or explicitly pass `create_additions: true`");
+                    }
                     *result = rb_funcall(klass, i_json_create, 1, *result);
                 }
             }
@@ -783,10 +786,16 @@ static VALUE cParser_initialize(int argc, VALUE *argv, VALUE self)
         }
         tmp = ID2SYM(i_create_additions);
         if (option_given_p(opts, tmp)) {
-            json->create_additions = RTEST(rb_hash_aref(opts, tmp));
-        } else {
-            json->create_additions = 0;
+            tmp = rb_hash_aref(opts, tmp);
+            if (NIL_P(tmp)) {
+                json->create_additions = true;
+                json->deprecated_create_additions = true;
+            } else {
+                json->create_additions = RTEST(tmp);
+                json->deprecated_create_additions = false;
+            }
         }
+
         if (json->symbolize_names && json->create_additions) {
             rb_raise(rb_eArgError,
                 "options :symbolize_names and :create_additions cannot be "