ChangeLog 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  1. 0.13.1 (up to commit 0f814e5, 2018/03/04)
  2. =========================================
  3. * Bump the major version of the .so library generated up to 4.0 to avoid
  4. conflicts because some downstream packagers of json-c had already done
  5. their own bump to ".so.3" for a much older 0.12 release.
  6. * Add const size_t json_c_object_sizeof()
  7. * Avoid invalid free (and thus a segfault) when ref_count gets < 0
  8. * PR#394: fix handling of custom double formats that include a ".0"
  9. * Avoid uninitialized variable warnings in json_object_object_foreach
  10. * Issue #396: fix build for certain uClibc based systems.
  11. * Add a top level fuzz directory for fuzzers run by OSS-Fuzz
  12. 0.13 (up to commit 5dae561, 2017/11/29)
  13. =================================
  14. This release, being three and a half years after the 0.12 branch (f84d9c),
  15. has quite a number of changes included. The following is a sampling of
  16. the most significant ones.
  17. Since the 0.12 release, 250 issues and pull requests have been closed.
  18. See issues_closed_for_0.13.md for a complete list.
  19. Deprecated and removed features:
  20. --------------------------------
  21. * All internal use of bits.h has been eliminated. The file will be removed.
  22. Do not use: hexdigit(), error_ptr(), error_descrition() and it_error()
  23. * lh_abort() is deprecated. It will be removed.
  24. Behavior changes:
  25. -----------------
  26. * Tighten the number parsing algorithm to raise errors instead of truncating
  27. the results. For example 12.3.4 or 2015-01-15, which now return null.
  28. See commit 99d8fc
  29. * Use size_t for array length and size. Platforms where sizeof(size_t) != sizeof(int) may not be backwards compatible
  30. See commits 45c56b, 92e9a5 and others.
  31. * Check for failue when allocating memory, returning NULL and errno=ENOMEM.
  32. See commit 2149a04.
  33. * Change json_object_object_add() return type from void to int, and will return -1 on failures, instead of exiting. (Note: this is not an ABI change)
  34. New features:
  35. -------------
  36. * We're aiming to follow RFC 7159 now.
  37. * Add a couple of additional option to json_object_to_json_string_ext:
  38. JSON_C_TO_STRING_PRETTY_TAB
  39. JSON_C_TO_STRING_NOSLASHESCAPE
  40. * Add a json_object_object_add_ex() function to allow for performance
  41. improvements when certain constraints are known to be true.
  42. * Make serialization format of doubles configurable, in two different ways:
  43. Call json_object_set_serializer with json_object_double_to_json_string and a custom
  44. format on each double object, or
  45. Call json_c_set_serialization_double_format() to set a global or thread-wide format.
  46. * Add utility function for comparing json_objects - json_object_equal()
  47. * Add a way to copy entire object trees: json_object_deep_copy()
  48. * Add json_object_set_<type> function to modify the value of existing json_object's
  49. without the need to recreate them. Also add a json_object_int_inc function to
  50. adjust an int's value.
  51. * Add support for JSON pointer, RFC 6901. See json_pointer.h
  52. * Add a json_util_get_last_err() function to retrieve the string describing the
  53. cause of errors, instead of printing to stderr.
  54. * Add perllike hash function for strings, and json_global_set_string_hash() 8f8d03d
  55. * Add a json_c_visit() function to provide a way to iterate over a tree of json-c objects.
  56. Notable bug fixes and other improvements:
  57. -----------------------------------------
  58. * Make reference increment and decrement atomic to allow passing json objects between threads.
  59. * Fix json_object_object_foreach to avoid uninitialized variable warnings.
  60. * Improve performance by removing unneeded data items from hashtable code and reducing duplicate hash computation.
  61. * Improve performance by storing small strings inside json_object
  62. * Improve performance of json_object_to_json_string by removing variadic printf. commit 9ff0f49
  63. * Issue #371: fix parsing of "-Infinity", and avoid needlessly copying the input when doing so.
  64. * Fix stack buffer overflow in json_object_double_to_json_string_format() - commit 2c2deb87
  65. * Fix various potential null ptr deref and int32 overflows
  66. * Issue #332: fix a long-standing bug in array_list_put_idx() where it would attempt to free previously free'd entries due to not checking the current array length.
  67. * Issue #195: use uselocale() instead of setlocale() in json_tokener to behave better in threaded environments.
  68. * Issue #275: fix out of bounds read when handling unicode surrogate pairs.
  69. * Ensure doubles that happen to be a whole number are emitted with ".0" - commit ca7a19
  70. * PR#331: for Visual Studio, use a snprintf/vsnprintf wrapper that ensures the string is terminated.
  71. * Fix double to int cast overflow in json_object_get_int64.
  72. * Clamp double to int32 when narrowing in json_object_get_int.
  73. * Use strtoll() to parse ints - instead of sscanf
  74. * Miscellaneous smaller changes, including removing unused variables, fixing warning
  75. about uninitialized variables adding const qualifiers, reformatting code, etc...
  76. Build changes:
  77. --------------
  78. * Add Appveyor and Travis build support
  79. * Switch to using CMake when building on Windows with Visual Studio.
  80. A dynamic .dll is generated instead of a .lib
  81. config.h is now generated, config.h.win32 should no longer be manually copied
  82. * Add support for MacOS through CMake too.
  83. * Enable silent build by default
  84. * Link against libm when needed
  85. * Add support for building with AddressSanitizer
  86. * Add support for building with Clang
  87. * Add a --enable-threading configure option, and only use the (slower) __sync_add_and_fetch()/__sync_sub_and_fetch() function when it is specified.
  88. List of new functions added:
  89. ----------------------------
  90. ### json_object.h
  91. * array_list_bsearch()
  92. * array_list_del_idx()
  93. * json_object_to_json_string_length()
  94. * json_object_get_userdata()
  95. * json_object_set_userdata()
  96. * json_object_object_add_ex()
  97. * json_object_array_bsearch()
  98. * json_object_array_del_idx()
  99. * json_object_set_boolean()
  100. * json_object_set_int()
  101. * json_object_int_inc()
  102. * json_object_set_int64()
  103. * json_c_set_serialization_double_format()
  104. * json_object_double_to_json_string()
  105. * json_object_set_double()
  106. * json_object_set_string()
  107. * json_object_set_string_len()
  108. * json_object_equal()
  109. * json_object_deep_copy()
  110. ### json_pointer.h
  111. * json_pointer_get()
  112. * json_pointer_getf()
  113. * json_pointer_set()
  114. * json_pointer_setf()
  115. ### json_util.h
  116. * json_object_from_fd()
  117. * json_object_to_fd()
  118. * json_util_get_last_err()
  119. ### json_visit.h
  120. * json_c_visit()
  121. ### linkhash.h
  122. * json_global_set_string_hash()
  123. * lh_table_resize()
  124. ### printbuf.h
  125. * printbuf_strappend()
  126. 0.12.1
  127. ======
  128. * Minimal changes to address compile issues.
  129. 0.12
  130. ====
  131. * Address security issues:
  132. * CVE-2013-6371: hash collision denial of service
  133. * CVE-2013-6370: buffer overflow if size_t is larger than int
  134. * Avoid potential overflow in json_object_get_double
  135. * Eliminate the mc_abort() function and MC_ABORT macro.
  136. * Make the json_tokener_errors array local. It has been deprecated for
  137. a while, and json_tokener_error_desc() should be used instead.
  138. * change the floating point output format to %.17g so values with
  139. more than 6 digits show up in the output.
  140. * Remove the old libjson.so name compatibility support. The library is
  141. only created as libjson-c.so now and headers are only installed
  142. into the ${prefix}/json-c directory.
  143. * When supported by the linker, add the -Bsymbolic-functions flag.
  144. * Various changes to fix the build on MSVC.
  145. * Make strict mode more strict:
  146. * number must not start with 0
  147. * no single-quote strings
  148. * no comments
  149. * trailing char not allowed
  150. * only allow lowercase literals
  151. * Added a json_object_new_double_s() convenience function to allow
  152. an exact string representation of a double to be specified when
  153. creating the object and use it in json_tokener_parse_ex() so
  154. a re-serialized object more exactly matches the input.
  155. * Add support NaN and Infinity
  156. 0.11
  157. ====
  158. * IMPORTANT: the name of the library has changed to libjson-c.so and
  159. the header files are now in include/json-c.
  160. The pkgconfig name has also changed from json to json-c.
  161. You should change your build to use appropriate -I and -l options.
  162. A compatibility shim is in place so builds using the old name will
  163. continue to work, but that will be removed in the next release.
  164. * Maximum recursion depth is now a runtime option.
  165. json_tokener_new() is provided for compatibility.
  166. json_tokener_new_ex(depth)
  167. * Include json_object_iterator.h in the installed headers.
  168. * Add support for building on Android.
  169. * Rewrite json_object_object_add to replace just the value if the key already exists so keys remain valid.
  170. * Make it safe to delete keys while iterating with the json_object_object_foreach macro.
  171. * Add a json_set_serializer() function to allow the string output of a json_object to be customized.
  172. * Make float parsing locale independent.
  173. * Add a json_tokener_set_flags() function and a JSON_TOKENER_STRICT flag.
  174. * Enable -Werror when building.
  175. * speed improvements to parsing 64-bit integers on systems with working sscanf
  176. * Add a json_object_object_length function.
  177. * Fix a bug (buffer overrun) when expanding arrays to more than 64 entries.
  178. 0.10
  179. ====
  180. * Add a json_object_to_json_string_ext() function to allow output to be
  181. formatted in a more human readable form.
  182. * Add json_object_object_get_ex(), a NULL-safe get object method, to be able
  183. to distinguish between a key not present and the value being NULL.
  184. * Add an alternative iterator implementation, see json_object_iterator.h
  185. * Make json_object_iter public to enable external use of the
  186. json_object_object_foreachC macro.
  187. * Add a printbuf_memset() function to provide an effecient way to set and
  188. append things like whitespace indentation.
  189. * Adjust json_object_is_type and json_object_get_type so they return
  190. json_type_null for NULL objects and handle NULL passed to
  191. json_objct_object_get().
  192. * Rename boolean type to json_bool.
  193. * Fix various compile issues for Visual Studio and MinGW.
  194. * Allow json_tokener_parse_ex() to be re-used to parse multiple object.
  195. Also, fix some parsing issues with capitalized hexadecimal numbers and
  196. number in E notation.
  197. * Add json_tokener_get_error() and json_tokener_error_desc() to better
  198. encapsulate the process of retrieving errors while parsing.
  199. * Various improvements to the documentation of many functions.
  200. * Add new json_object_array_sort() function.
  201. * Fix a bug in json_object_get_int(), which would incorrectly return 0
  202. when called on a string type object.
  203. Eric Haszlakiewicz
  204. * Add a json_type_to_name() function.
  205. Eric Haszlakiewicz
  206. * Add a json_tokener_parse_verbose() function.
  207. Jehiah Czebotar
  208. * Improve support for null bytes within JSON strings.
  209. Jehiah Czebotar
  210. * Fix file descriptor leak if memory allocation fails in json_util
  211. Zachary Blair, zack_blair at hotmail dot com
  212. * Add int64 support. Two new functions json_object_net_int64 and
  213. json_object_get_int64. Binary compatibility preserved.
  214. Eric Haszlakiewicz, EHASZLA at transunion com
  215. Rui Miguel Silva Seabra, rms at 1407 dot org
  216. * Fix subtle bug in linkhash where lookup could hang after all slots
  217. were filled then successively freed.
  218. Spotted by Jean-Marc Naud, j dash m at newtraxtech dot com
  219. * Make json_object_from_file take const char *filename
  220. Spotted by Vikram Raj V, vsagar at attinteractive dot com
  221. * Add handling of surrogate pairs (json_tokener.c, test4.c, Makefile.am)
  222. Brent Miller, bdmiller at yahoo dash inc dot com
  223. * Correction to comment describing printbuf_memappend in printbuf.h
  224. Brent Miller, bdmiller at yahoo dash inc dot com
  225. 0.9
  226. ===
  227. * Add README.html README-WIN32.html config.h.win32 to Makefile.am
  228. Michael Clark, <michael@metaparadigm.com>
  229. * Add const qualifier to the json_tokener_parse functions
  230. Eric Haszlakiewicz, EHASZLA at transunion dot com
  231. * Rename min and max so we can never clash with C or C++ std library
  232. Ian Atha, thatha at yahoo dash inc dot com
  233. * Fix any noticeable spelling or grammar errors.
  234. * Make sure every va_start has a va_end.
  235. * Check all pointers for validity.
  236. Erik Hovland, erik at hovland dot org
  237. * Fix json_object_get_boolean to return false for empty string
  238. Spotted by Vitaly Kruglikov, Vitaly dot Kruglikov at palm dot com
  239. * optimizations to json_tokener_parse_ex(), printbuf_memappend()
  240. Brent Miller, bdmiller at yahoo dash inc dot com
  241. * Disable REFCOUNT_DEBUG by default in json_object.c
  242. * Don't use this as a variable, so we can compile with a C++ compiler
  243. * Add casts from void* to type of assignment when using malloc
  244. * Add #ifdef __cplusplus guards to all of the headers
  245. * Add typedefs for json_object, json_tokener, array_list, printbuf, lh_table
  246. Michael Clark, <michael@metaparadigm.com>
  247. * Null pointer dereference fix. Fix json_object_get_boolean strlen test
  248. to not return TRUE for zero length string. Remove redundant includes.
  249. Erik Hovland, erik at hovland dot org
  250. * Fixed warning reported by adding -Wstrict-prototypes
  251. -Wold-style-definition to the compilatin flags.
  252. Dotan Barak, dotanba at gmail dot com
  253. * Add const correctness to public interfaces
  254. Gerard Krol, g dot c dot krol at student dot tudelft dot nl
  255. 0.8
  256. ===
  257. * Add va_end for every va_start
  258. Dotan Barak, dotanba at gmail dot com
  259. * Add macros to enable compiling out debug code
  260. Geoffrey Young, geoff at modperlcookbook dot org
  261. * Fix bug with use of capital E in numbers with exponents
  262. Mateusz Loskot, mateusz at loskot dot net
  263. * Add stddef.h include
  264. * Patch allows for json-c compile with -Werror and not fail due to
  265. -Wmissing-prototypes -Wstrict-prototypes -Wmissing-declarations
  266. Geoffrey Young, geoff at modperlcookbook dot org
  267. 0.7
  268. ===
  269. * Add escaping of backslash to json output
  270. * Add escaping of foward slash on tokenizing and output
  271. * Changes to internal tokenizer from using recursion to
  272. using a depth state structure to allow incremental parsing
  273. 0.6
  274. ===
  275. * Fix bug in escaping of control characters
  276. Johan Björklund, johbjo09 at kth dot se
  277. * Remove include "config.h" from headers (should only
  278. be included from .c files)
  279. Michael Clark <michael@metaparadigm.com>
  280. 0.5
  281. ===
  282. * Make headers C++ compatible by change *this to *obj
  283. * Add ifdef C++ extern "C" to headers
  284. * Use simpler definition of min and max in bits.h
  285. Larry Lansing, llansing at fuzzynerd dot com
  286. * Remove automake 1.6 requirement
  287. * Move autogen commands into autogen.sh. Update README
  288. * Remove error pointer special case for Windows
  289. * Change license from LGPL to MIT
  290. Michael Clark <michael@metaparadigm.com>
  291. 0.4
  292. ===
  293. * Fix additional error case in object parsing
  294. * Add back sign reversal in nested object parse as error pointer
  295. value is negative, while error value is positive.
  296. Michael Clark <michael@metaparadigm.com>
  297. 0.3
  298. ===
  299. * fix pointer arithmetic bug for error pointer check in is_error() macro
  300. * fix type passed to printbuf_memappend in json_tokener
  301. * update autotools bootstrap instructions in README
  302. Michael Clark <michael@metaparadigm.com>
  303. 0.2
  304. ===
  305. * printbuf.c - C. Watford (christopher.watford@gmail.com)
  306. Added a Win32/Win64 compliant implementation of vasprintf
  307. * debug.c - C. Watford (christopher.watford@gmail.com)
  308. Removed usage of vsyslog on Win32/Win64 systems, needs to be handled
  309. by a configure script
  310. * json_object.c - C. Watford (christopher.watford@gmail.com)
  311. Added scope operator to wrap usage of json_object_object_foreach, this
  312. needs to be rethought to be more ANSI C friendly
  313. * json_object.h - C. Watford (christopher.watford@gmail.com)
  314. Added Microsoft C friendly version of json_object_object_foreach
  315. * json_tokener.c - C. Watford (christopher.watford@gmail.com)
  316. Added a Win32/Win64 compliant implementation of strndup
  317. * json_util.c - C. Watford (christopher.watford@gmail.com)
  318. Added cast and mask to suffice size_t v. unsigned int conversion
  319. correctness
  320. * json_tokener.c - sign reversal issue on error info for nested object parse
  321. spotted by Johan Björklund (johbjo09 at kth.se)
  322. * json_object.c - escape " in json_escape_str
  323. * Change to automake and libtool to build shared and static library
  324. Michael Clark <michael@metaparadigm.com>
  325. 0.1
  326. ===
  327. * initial release