1Template: 2- [Fix issue X in feature Y](https://github.com/PJK/libcbor/pull/XXX) (by [YYY](https://github.com/YYY)) 3 4Next 5--------------------- 6 70.11.0 (2024-02-04) 8--------------------- 9- [Updated documentation to refer to RFC 8949](https://github.com/PJK/libcbor/issues/269) 10- Improvements to `cbor_describe` 11 - [Bytestring data will now be printed as well](https://github.com/PJK/libcbor/pull/281) by [akallabeth](https://github.com/akallabeth) 12 - [Formatting consistency and clarity improvements](https://github.com/PJK/libcbor/pull/285) 13- [Fix `cbor_string_set_handle` not setting the codepoint count](https://github.com/PJK/libcbor/pull/286) 14- BREAKING: [`cbor_load` will no longer fail on input strings that are well-formed but not valid UTF-8](https://github.com/PJK/libcbor/pull/286) 15 - If you were relying on the validation, please check the result using `cbor_string_codepoint_count` instead 16- BREAKING: [All decoders like `cbor_load` and `cbor_stream_decode` will accept all well-formed tag values](https://github.com/PJK/libcbor/pull/308) (bug discovered by [dskern-github](https://github.com/dskern-github)) 17 - Previously, decoding of certain values would fail with `CBOR_ERR_MALFORMATED` or `CBOR_DECODER_ERROR` 18 - This also makes decoding symmetrical with serialization, which already accepts all values 19 200.10.2 (2023-01-31) 21--------------------- 22- [Fixed minor test bug causing failures for x86 Linux](https://github.com/PJK/libcbor/pull/266) (discovered by [trofi](https://github.com/PJK/libcbor/issues/263)) 23 - Actual libcbor functionality not affected, bug was in the test suite 24- [Made tests platform-independent](https://github.com/PJK/libcbor/pull/272) 25 260.10.1 (2022-12-30) 27--------------------- 28- [Fix a regression in `cbor_serialize_alloc` that caused serialization of zero-length strings and bytestrings or byte/strings with zero-length chunks to fail](https://github.com/PJK/libcbor/pull/260) (discovered by [martelletto](https://github.com/martelletto)) 29 300.10.0 (2022-12-29) 31--------------------- 32- Make the buffer_size optional in `cbor_serialize_alloc` [[#205]](https://github.com/PJK/libcbor/pull/205) (by [hughsie](https://github.com/hughsie)) 33- BREAKING: Improved half-float encoding for denormalized numbers. [[#208]](https://github.com/PJK/libcbor/pull/208) (by [ranvis](https://github.com/ranvis)) 34 - Denormalized half-floats will now preserve data in the mantissa 35 - Note: Half-float NaNs still lose data (https://github.com/PJK/libcbor/issues/215) 36- BUILD BREAKING: Minimum CMake version is 3.0 [[#201]](https://github.com/PJK/libcbor/pull/201) (by [thewtex@](https://github.com/thewtex)) 37 - See https://repology.org/project/cmake/versions for support; the vast majority of users should not be affected. 38- Fix a potential memory leak when the allocator fails during array or map decoding [[#224]](https://github.com/PJK/libcbor/pull/224) (by [James-ZHANG](https://github.com/James-ZHANG)) 39- [Fix a memory leak when the allocator fails when adding chunks to indefinite bytestrings.](https://github.com/PJK/libcbor/pull/242) ([discovered](https://github.com/PJK/libcbor/pull/228) by [James-ZHANG](https://github.com/James-ZHANG)) 40- [Fix a memory leak when the allocator fails when adding chunks to indefinite strings](https://github.com/PJK/libcbor/pull/246) 41- Potentially BUILD BREAKING: [Add nodiscard attributes to most functions](https://github.com/PJK/libcbor/pull/248) 42 - **Warning**: This may cause new build warnings and (in rare cases, depending on your configuration) errors 43- BREAKING: [Fix `cbor_copy` leaking memory and creating invalid items when the allocator fails](https://github.com/PJK/libcbor/pull/249). 44 - Previously, the failures were not handled in the interface. Now, `cbor_copy` may return `NULL` upon failure; clients should check the return value 45- [Fix `cbor_build_tag` illegal memory behavior when the allocator fails](https://github.com/PJK/libcbor/pull/249) 46- [Add a new `cbor_serialized_size` API](https://github.com/PJK/libcbor/pull/250) 47- [Reworked `cbor_serialize_alloc` to allocate the exact amount of memory necessary upfront](https://github.com/PJK/libcbor/pull/251) 48 - This should significantly speed up `cbor_serialize_alloc` for large items by avoiding multiple reallocation iterations 49 - Clients should not use the return value of `cbor_serialize_alloc`. It may be removed in the future. 50- BUILD BREAKING: [Deprecate CBOR_CUSTOM_ALLOC](https://github.com/PJK/libcbor/pull/237) 51 - `cbor_set_allocs` will always be enabled from now on 52 - Note: The flag will be kept as a no-op triggering a warning when used for one version and then removed completely 53 540.9.0 (2021-11-14) 55--------------------- 56- Improved pkg-config paths handling [[#164]](https://github.com/PJK/libcbor/pull/164) (by [jtojnar@](https://github.com/jtojnar)) 57- Use explicit math.h linkage [[#170]](https://github.com/PJK/libcbor/pull/170) 58- BREAKING: Fixed handling of items that exceed the host size_t range [[#186]](https://github.com/PJK/libcbor/pull/186hg) 59 - Callbacks for bytestrings, strings, arrays, and maps use uint64_t instead of size_t to allow handling of large items that exceed size_t even if size_t < uint64_t 60 - cbor_decode explicitly checks size to avoid overflows (previously broken, potentially resulting in erroneous decoding on affected systems) 61 - The change should be a noop for 64b systems 62- Added a [Bazel](https://bazel.build/) build example [[#196]](https://github.com/PJK/libcbor/pull/196) (by [andyjgf@](https://github.com/andyjgf)) 63 640.8.0 (2020-09-20) 65--------------------- 66- BUILD BREAKING: Use BUILD_SHARED_LIBS to determine how to build libraries (fixed Windows linkage) [[#148]](https://github.com/PJK/libcbor/pull/148) (by [intelligide@](https://github.com/intelligide)) 67- BREAKING: Fix `cbor_tag_item` not increasing the reference count on the tagged item reference it returns [[Fixes #109](https://github.com/PJK/libcbor/issues/109)] (discovered bt [JohnGilmour](https://github.com/JohnGilmour)) 68 - If you have previously relied on the broken behavior, you can use `cbor_move` to emulate as long as the returned handle is an "rvalue" 69- BREAKING: [`CBOR_DECODER_EBUFFER` removed from `cbor_decoder_status`](https://github.com/PJK/libcbor/pull/156) 70 - `cbor_stream_decode` will set `CBOR_DECODER_NEDATA` instead if the input buffer is empty 71- [Fix `cbor_stream_decode`](https://github.com/PJK/libcbor/pull/156) to set `cbor_decoder_result.required` to the minimum number of input bytes necessary to receive the next callback (as long as at least one byte was passed) (discovered by [woefulwabbit](https://github.com/woefulwabbit)) 72- Fixed several minor manpage issues [[#159]](https://github.com/PJK/libcbor/pull/159) (discovered by [kloczek@](https://github.com/kloczek)) 73 740.7.0 (2020-04-25) 75--------------------- 76- Fix bad encoding of NaN half-floats [[Fixes #53]](https://github.com/PJK/libcbor/issues/53) (discovered by [BSipos-RKF](https://github.com/BSipos-RKF)) 77 - **Warning**: Previous versions encoded NaNs as `0xf9e700` instead of `0xf97e00`; if you rely on the broken behavior, this will be a breaking change 78- Fix potentially bad encoding of negative half-float with exponent < -14 [[Fixes #112]](https://github.com/PJK/libcbor/issues/112) (discovered by [yami36](https://github.com/yami36)) 79- BREAKING: Improved bool support [[Fixes #63]](https://github.com/PJK/libcbor/issues/63) 80 - Rename `cbor_ctrl_is_bool` to `cbor_get_bool` and fix the behavior 81 - Add `cbor_set_bool` 82- Fix memory_allocation_test breaking the build without CBOR_CUSTOM_ALLOC [[Fixes #128]](https://github.com/PJK/libcbor/issues/128) (by [panlinux](https://github.com/panlinux)) 83- [Fix a potential build issue where cJSON includes may be misconfigured](https://github.com/PJK/libcbor/pull/132) 84- Breaking: [Add a limit on the size of the decoding context stack](https://github.com/PJK/libcbor/pull/138) (by [James-ZHANG](https://github.com/James-ZHANG)) 85 - If your usecase requires parsing very deeply nested structures, you might need to increase the default 2k limit via `CBOR_MAX_STACK_SIZE` 86- Enable LTO/IPO based on [CheckIPOSupported](https://cmake.org/cmake/help/latest/module/CheckIPOSupported.html#module:CheckIPOSupported) [[#143]](https://github.com/PJK/libcbor/pull/143) (by [xanderlent](https://github.com/xanderlent)) 87 - If you rely on LTO being enabled and use CMake version older than 3.9, you will need to re-enable it manually or upgrade your CMake 88 890.6.1 (2020-03-26) 90--------------------- 91- [Fix bad shared library version number](https://github.com/PJK/libcbor/pull/131) 92 - **Warning**: Shared library built from the 0.6.0 release is erroneously marked as version "0.6.0", which makes it incompatible with future releases *including the v0.6.X line* even though they may be compatible API/ABI-wise. Refer to the documentation for the new SO versioning scheme. 93 940.6.0 (2020-03-15) 95--------------------- 96- Correctly set .so version [[Fixes #52]](https://github.com/PJK/libcbor/issues/52). 97 - **Warning**: All previous releases will be identified as 0.0 by the linker. 98- Fix & prevent heap overflow error in example code [[#74]](https://github.com/PJK/libcbor/pull/74) [[#76]](https://github.com/PJK/libcbor/pull/76) (by @nevun) 99- Correctly set OSX dynamic library version [[Fixes #75]](https://github.com/PJK/libcbor/issues/75) 100- [Fix misplaced 0xFF bytes in maps possibly causing memory corruption](https://github.com/PJK/libcbor/pull/82) 101- BREAKING: Fix handling & cleanup of failed memory allocation in constructor 102 and builder helper functions [[Fixes #84]](https://github.com/PJK/libcbor/issues/84) 103 - All cbor_new_* and cbor_build_* functions will now explicitly return NULL when memory allocation fails 104 - It is up to the client to handle such cases 105- Globally enforced code style [[Fixes #83]](https://github.com/PJK/libcbor/issues/83) 106- Fix issue possible memory corruption bug on repeated 107 cbor_(byte)string_add_chunk calls with intermittently failing realloc calls 108- Fix possibly misaligned reads and writes when endian.h is uses or when 109 running on a big-endian machine [[Fixes #99](https://github.com/PJK/libcbor/issues/99), [#100](https://github.com/PJK/libcbor/issues/100)] 110- [Improved CI setup with Travis-native arm64 support](https://github.com/PJK/libcbor/pull/116) 111- [Docs migrated to Sphinx 2.4 and Python3](https://github.com/PJK/libcbor/pull/117) 112 1130.5.0 (2017-02-06) 114--------------------- 115- Remove cmocka from the subtree (always rely on system or user-provided version) 116- Windows CI 117- Only build tests if explicitly enabled (`-DWITH_TESTS=ON`) 118- Fixed static header declarations (by cedric-d) 119- Improved documentation (by Michael Richardson) 120- Improved `examples/readfile.c` 121- Reworked (re)allocation to handle huge inputs and overflows in size_t [[Fixes #16]](https://github.com/PJK/libcbor/issues/16) 122- Improvements to C++ linkage (corrected `cbor_empty_callbacks`, fixed `restrict` pointers) (by Dennis Bijwaard) 123- Fixed Linux installation directory depending on architecture [[Fixes #34]](https://github.com/PJK/libcbor/issues/34) (by jvymazal) 124- Improved 32-bit support [[Fixes #35]](https://github.com/PJK/libcbor/issues/35) 125- Fixed MSVC compatibility [[Fixes #31]](https://github.com/PJK/libcbor/issues/31) 126- Fixed and improved half-float encoding [[Fixes #5](https://github.com/PJK/libcbor/issues/5), [#11](https://github.com/PJK/libcbor/issues/11)] 127 1280.4.0 (2015-12-25) 129--------------------- 130Breaks build & header compatibility due to: 131 132- Improved build configuration and feature check macros 133- Endianness configuration fixes (by Erwin Kroon and David Grigsby) 134- pkg-config compatibility (by Vincent Bernat) 135- enable use of versioned SONAME (by Vincent Bernat) 136- better fuzzer (wasn't random until now, ooops) 137 1380.3.1 (2015-05-21) 139--------------------- 140- documentation and comments improvements, mostly for the API reference 141 1420.3.0 (2015-05-21) 143--------------------- 144 145- Fixes, polishing, niceties across the code base 146- Updated examples 147- `cbor_copy` 148- `cbor_build_negint8`, 16, 32, 64, matching asserts 149- `cbor_build_stringn` 150- `cbor_build_tag` 151- `cbor_build_float2`, ... 152 1530.2.1 (2015-05-17) 154--------------------- 155- C99 support 156 1570.2.0 (2015-05-17) 158--------------------- 159 160- `cbor_ctrl_bool` -> `cbor_ctrl_is_bool` 161- Added `cbor_array_allocated` & map equivalent 162- Overhauled endianess conversion - ARM now works as expected 163- 'sort.c' example added 164- Significantly improved and doxyfied documentation 165 1660.1.0 (2015-05-06) 167--------------------- 168 169The initial release, yay! 170