Json5, a more forgiving and developer-friendly version of JSON, experienced a pivotal early update, transitioning from version 0.0.1 to 0.1.0. While both versions share fundamental characteristics, such as the absence of runtime dependencies and reliance on Mocha for development testing, the key differentiator lies in the descriptive narrative. Version 0.0.1 characterizes Json5 as "Modern JSON," whereas version 0.1.0 refines this, defining it as "JSON for the ES5 era." This subtle but significant change hints at a more specific purpose: catering to environments limited to the ECMAScript 5 standard.
For developers, this evolution suggests improved compatibility and stability when working within ES5 constraints. The core functionality of Json5 likely remains consistent between versions, offering its signature features such as comments, trailing commas, unquoted keys, single-quoted strings, and multi-line strings, enhancing readability and ease of use compared to strict JSON. Though the basic characteristics are the same, the change in description might suggest an increased focus on interoperability with older Javascript implementations, possibly addressing specific parsing or encoding issues. Both packages are delivered as a single tarball and the source code is stored in github. For developers working with legacy systems or striving for broader browser support, opting for version 0.1.0 might present a safer and more suitable choice.
All the vulnerabilities related to the version 0.1.0 of the package
Prototype Pollution in JSON5 via Parse Method
The parse method of the JSON5 library before and including version 2.2.1 does not restrict parsing of keys named __proto__, allowing specially crafted strings to pollute the prototype of the resulting object.
This vulnerability pollutes the prototype of the object returned by JSON5.parse and not the global Object prototype, which is the commonly understood definition of Prototype Pollution. However, polluting the prototype of a single object can have significant security impact for an application if the object is later used in trusted operations.
This vulnerability could allow an attacker to set arbitrary and unexpected keys on the object returned from JSON5.parse. The actual impact will depend on how applications utilize the returned object and how they filter unwanted keys, but could include denial of service, cross-site scripting, elevation of privilege, and in extreme cases, remote code execution.
This vulnerability is patched in json5 v2.2.2 and later. A patch has also been backported for json5 v1 in versions v1.0.2 and later.
Suppose a developer wants to allow users and admins to perform some risky operation, but they want to restrict what non-admins can do. To accomplish this, they accept a JSON blob from the user, parse it using JSON5.parse, confirm that the provided data does not set some sensitive keys, and then performs the risky operation using the validated data:
const JSON5 = require('json5');
const doSomethingDangerous = (props) => {
if (props.isAdmin) {
console.log('Doing dangerous thing as admin.');
} else {
console.log('Doing dangerous thing as user.');
}
};
const secCheckKeysSet = (obj, searchKeys) => {
let searchKeyFound = false;
Object.keys(obj).forEach((key) => {
if (searchKeys.indexOf(key) > -1) {
searchKeyFound = true;
}
});
return searchKeyFound;
};
const props = JSON5.parse('{"foo": "bar"}');
if (!secCheckKeysSet(props, ['isAdmin', 'isMod'])) {
doSomethingDangerous(props); // "Doing dangerous thing as user."
} else {
throw new Error('Forbidden...');
}
If the user attempts to set the isAdmin key, their request will be rejected:
const props = JSON5.parse('{"foo": "bar", "isAdmin": true}');
if (!secCheckKeysSet(props, ['isAdmin', 'isMod'])) {
doSomethingDangerous(props);
} else {
throw new Error('Forbidden...'); // Error: Forbidden...
}
However, users can instead set the __proto__ key to {"isAdmin": true}. JSON5 will parse this key and will set the isAdmin key on the prototype of the returned object, allowing the user to bypass the security check and run their request as an admin:
const props = JSON5.parse('{"foo": "bar", "__proto__": {"isAdmin": true}}');
if (!secCheckKeysSet(props, ['isAdmin', 'isMod'])) {
doSomethingDangerous(props); // "Doing dangerous thing as admin."
} else {
throw new Error('Forbidden...');
}