[ViewVC] Annotation of: cvs/cvsroot/CBOR-XS/Changes

Revision history for Perl extension CBOR::XS

TODO: pack_keys?
TODO: document encode_cbor_sharing?
TODO: large negative integers
TODO: type cast tests.
TODO: round-tripping of types, such as float16 - maybe types::Serialiser support?
TODO: possibly implement https://peteroupc.github.io/CBOR/extended.html, but NaNs are nonportable. rely on libecb?
TODO: https://github.com/svaarala/cbor-specs/blob/master/cbor-nonutf8-string-tags.rst, but maybe that is overkill?
TODO: non-string-keys:
TODO: https://datatracker.ietf.org/doc/rfc9254/ https://datatracker.ietf.org/doc/rfc9581/
TODO: https://github.com/shanewholloway/js-cbor-codec/blob/master/docs/CBOR-259-spec--explicit-maps.md https://github.com/svaarala/cbor-specs/blob/master/cbor-absent-tag.rst
TODO: canonical_order

        - varios minor typo corrections.

1.87 Fri 08 Sep 2023 22:14:18 CEST
        - shared references were not decoded correctly: instead of getting
          multiple references to the same object, you got the same
          reference to the same object, causing a number of issues. For
          example, modifying the reference would modify all places the
          reference was used, and encoding the decoded structure would
          unshare the previously shared hashes, as trheir reference count
          would be 1. Fixing this was rather involved, as perl lacks the
          ability to easily swap or copy arrays and hashes.
        - \0, \1, \undef do not work, and were not intended to ever work, as
          special values, despite being mentioned in the documentation (reported
          by nuclightq).
        - new feature: allow_weak_cycles.

1.86 Thu 04 Nov 2021 17:48:16 CET
        - fixed a wrong printf format specifier (reported by Petr Písař).

1.85 Sat 23 Oct 2021 04:59:56 CEST
        - left debugging printf in code, need a test for that :(

1.84 Thu 21 Oct 2021 03:11:52 CEST
        - fix a bug in validate_utf8 where we call perl's is_utf8_string with
          a lenght of zero for empty strings, but perl interprets that as
          "calculate length", causing spurious validation errors for
          empty strings.
        - include validate_utf8 in new_safe.
        - avoid some warnings.

1.83 Tue Dec  8 09:27:06 CET 2020
        - add CBOR::XS::as_map cast function.

1.82 Tue Dec  1 02:47:40 CET 2020
        - add CBOR::XS::as_bool cast function.

1.81 Mon Nov 30 19:29:33 CET 2020
        - cast functions were broken due to last-minute renaming. thats
          what you get for not having a tessuite.
        - Math::BigInt and Math::BigFloat are pretty broken (again),
          so disable some tests. (try printing the bigfloat
          799999999999999999998E99999999999999999998).

1.8  Sun Nov 29 22:35:13 CET 2020
        - experimental support for some type casts, as well as embedding
          raw cbor data.

1.71 Thu Nov 15 20:52:13 CET 2018
        - work around what smells like a perl bug w.r.t. exceptions
          thrown in callbacks.
        - update libecb.

1.7  Tue Jun 27 04:02:23 CEST 2017
        - SECURITY FIX: fix two bugs found by american fuzzy lop,
          upgrade is advised if you accept data from untrusted
          sources.
        - an out-of bound sharedref or stringref index could cause an
          out of bounds access - might be exploitable.
        - a decoding error during indefinite array or hash decoding
          could cause an endless loop.

1.6  Wed Dec  7 15:13:23 CET 2016
        - greatly expand the SECURITY IMPLICATIONS and similar sections.
        - new constructor new_safe, to create a secure CBOR::XS object.
        - new option forbid_objects, to disallow serialisation.
        - new CBOR::XS::safe_filter functionality.
        - fix a crash when decoding a cyclic data structure using
          stringref/pack_strings when allow_cycles is disabled.
        - fix a crash when decoding hash keys with length >= 2**31.
        - avoid unreasonably long decoding times for certain
          types of (corrupt) cbor texts.
        - support arrays and hashes with >= 2**31 members.
        - avoid overflow on pointer arithmetic when checking whether enough
          data is available.
        - fix a memory leak that occured when decoding failed while decoding
          a tagged value.
        - do not leak the partially constructed result when stringifying
          a hash key throws an exception.
        - various code size and efficiency optimizations (reduced code
          from 42 to 40kB on my system, despite the new features).

1.5  Wed Apr 27 11:38:39 CEST 2016
        - Math::BigFloat madness workaround, see
          http://blog.schmorp.de/2016-04-23-mathbigfloat-maintainer-fail.html
          (bugreport by zdm@softvisio.net).
        - add text_keys and text_strings options to force CBOR text encoding
          for perl hash keys or all strings, as a result of discussions
          with Fredrik Ljunggren.
        - implement support for arbitrary-exponent numbers (see
          http://peteroupc.github.io/CBOR/bigfrac.html, tags 264 and 265)
          for both en- and decoding.
        - implement support for rational numbers (see
          http://peteroupc.github.io/CBOR/rational.html, tag 30) for both
          en- and decoding.
        - the above effectively implements all registered CBOR extensions
          in a sensible manner.
        - remove some weird dead code that was duplicated (%FILTER).
        - add t/58_hv.t, which tests hashes and the new text_* flags.
          hashes apparently were not encoded at all in any of the existing
          tests.
        - document Math::BigFloat base-2 performance/crash issues.
        - use stability canary.

1.41 Thu 25 Feb 15:22:03 CET 2016
        - avoid perl panics on nested FREEZE/THAW calls (testcase by
          Victor Efimov).

1.4  Mon Feb  8 05:10:15 CET 2016
        - buffer overflow fix: a fast path during decoding did not check
          remaining length when decoding hash keys, found by fuzzing.
          This can potentially leak information in the error message
          or crash the process.
        - use C style { 0 } struct initializer.
        - upgrade libecb.

1.3  Mon Apr 27 22:21:04 CEST 2015
        - the incremental parser didn't properly parse tagged values
          (testcase by Mons Anderson).
        - slightly speed up encoding of plain (nonmagical) arrays.
        - try to clarify further that effectively all 32 bit architectures
          have 64 bit integer support.
        - upgrade libecb.

1.26 Sat Oct 25 08:35:44 CEST 2014
        - update the t/57_incr.t subtest that would rely on 64 bit ints.
        - disable t/50_rfc.t test that fails because of broken data::dumper.

1.25 Sun Jan  5 15:19:14 CET 2014
        - map key decoding was pretty much botched due to the recent cleanups.
        - work around Time::Piece->epoch returning a string value, avoid encoding
          this as a tag 1 string.
        - enable more testcases in t/50_rfc.t, now that they work :)

1.2  Tue Dec 10 22:06:42 CET 2013
        - implement an incremental decoder.

1.12 Tue Dec  3 11:23:22 CET 2013
        - work around broken Time::Piece (in old versions of the module, %z doesn't
          work as documented, gives different results on different platforms(!)).

1.11 Sun Dec  1 18:00:00 CET 2013
        - new setting: validate_utf8, for when you can't trust your cbor data.
        - do not leak memory on decoding errors, when allow_cycles is enabled.
        - add default filters for tags 0 and 1, using Time::Piece.
        - more tests added.

1.1  Sat Nov 30 19:14:27 CET 2013
        - INCOMPATIBLE CHANGE: new decoder setting: allow_cyclic, needed to decode
          cyclic data structures (to avoid memleaks in unsuspecting code).
        - no longer "share" references that aren't, i.e. true/false/null/error/tagged.
        - fix stringref w.r.t. indefinite-length strings.
        - verify indefinite-length string chunk types.
        - do not allow extremely large arrays - assume an array element
          requires at least one CBOR byte, to avoid memory exhaustion attacks.
        - major code overhaul.

1.0  Thu Nov 28 16:43:31 CET 2013
        - use the now official tag values for extensions. remove the
          experimental notice. it's the real thing now, with real bugs.
        - renamed allow_stringref to pack_strings.
        - port to perl <= 5.16.
        - slightly improve the documentation.

0.09  Fri Nov 22 16:54:18 CET 2013
        - bignum/bigfloat/decimal support.
        - uri support.
        - tag filter functions support for decoding.
        - do not support reference-to-1/0/undef anymore, you need to use
          the Types::Serialiser objects now.
        - experimental sharable extension support (http://cbor.schmorp.de/value-sharing).
        - experimental stringref extension support (http://cbor.schmorp.de/stringref).
        - implement indirection tag (http://cbor.schmorp.de/indirection).

0.08  Wed Oct 30 11:10:43 CET 2013
        - defused another too fragile test.

0.07  Tue Oct 29 23:04:07 CET 2013
        - don't crash in decode when silly values are passed in.
        - considerably speed up map decoding when map keys
          are utf-8 or byte strings.
        - raising an exception in THAW should now work without
          leaking.

0.06  Tue Oct 29 16:56:07 CET 2013
        - do not leak when deserialiasing via THAW.
        - implement and document CBOR::XS creation/access/mutate
          methods.

0.05  Mon Oct 28 22:27:47 CET 2013
        - do not leak hash keys on decoding.

0.04  Sun Oct 27 23:47:47 CET 2013
        - implement TO_CBOR/FREEZE/THAW serialisation protocols.
        - requested perl-object and generic-object tags from iana.
        - switched to Types::Serialiser for true, false and error.
        - disabled some fragile tests (thanks, andk).

0.03  Sun Oct 27 00:28:41 CEST 2013
        - improve 32 bit platform compatibility.
        - take more advantage of ecb.h.
        - preliminary and bare-bones tagged support.
        - improved docs.

0.02  Sat Oct 26 13:08:05 CEST 2013
        - no aborts left.
        - add $CBOR::XS::MAGIC.
        - preliminary tagged decoding to arrayref.
        - indefinite encoding fixed.
        - half float decoding implemented.
        - t/50_rfc.t adds test vectors from the rfc, which
          are checked as applicable.

0.01  Fri Oct 25 21:39:56 CEST 2013
        - original version; cloned from JSON-XS

Revision:	1.100
Committed:	Sat Dec 28 13:00:32 2024 UTC (20 months, 2 weeks ago) by root
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.99:	+6 -0 lines
Log Message:	nuclight
#	User	Rev	Content
1	root	1.1	Revision history for Perl extension CBOR::XS
2
3	root	1.30	TODO: pack_keys?
4	root	1.36	TODO: document encode_cbor_sharing?
5	root	1.70	TODO: large negative integers
6	root	1.79	TODO: type cast tests.
7	root	1.93	TODO: round-tripping of types, such as float16 - maybe types::Serialiser support?
8	root	1.81	TODO: possibly implement https://peteroupc.github.io/CBOR/extended.html, but NaNs are nonportable. rely on libecb?
9			TODO: https://github.com/svaarala/cbor-specs/blob/master/cbor-nonutf8-string-tags.rst, but maybe that is overkill?
10	root	1.100	TODO: non-string-keys:
11			TODO: https://datatracker.ietf.org/doc/rfc9254/ https://datatracker.ietf.org/doc/rfc9581/
12			TODO: https://github.com/shanewholloway/js-cbor-codec/blob/master/docs/CBOR-259-spec--explicit-maps.md https://github.com/svaarala/cbor-specs/blob/master/cbor-absent-tag.rst
13			TODO: canonical_order
14
15			- varios minor typo corrections.
16	root	1.84
17	root	1.99	1.87 Fri 08 Sep 2023 22:14:18 CEST
18	root	1.97	- shared references were not decoded correctly: instead of getting
19			multiple references to the same object, you got the same
20			reference to the same object, causing a number of issues. For
21			example, modifying the reference would modify all places the
22			reference was used, and encoding the decoded structure would
23			unshare the previously shared hashes, as trheir reference count
24	root	1.99	would be 1. Fixing this was rather involved, as perl lacks the
25			ability to easily swap or copy arrays and hashes.
26	root	1.95	- \0, \1, \undef do not work, and were not intended to ever work, as
27			special values, despite being mentioned in the documentation (reported
28			by nuclightq).
29	root	1.98	- new feature: allow_weak_cycles.
30	root	1.95
31	root	1.93	1.86 Thu 04 Nov 2021 17:48:16 CET
32	root	1.92	- fixed a wrong printf format specifier (reported by Petr Písař).
33
34	root	1.91	1.85 Sat 23 Oct 2021 04:59:56 CEST
35			- left debugging printf in code, need a test for that :(
36
37	root	1.90	1.84 Thu 21 Oct 2021 03:11:52 CEST
38			- fix a bug in validate_utf8 where we call perl's is_utf8_string with
39			a lenght of zero for empty strings, but perl interprets that as
40			"calculate length", causing spurious validation errors for
41			empty strings.
42	root	1.89	- include validate_utf8 in new_safe.
43	root	1.88	- avoid some warnings.
44
45	root	1.87	1.83 Tue Dec 8 09:27:06 CET 2020
46			- add CBOR::XS::as_map cast function.
47
48	root	1.85	1.82 Tue Dec 1 02:47:40 CET 2020
49	root	1.84	- add CBOR::XS::as_bool cast function.
50	root	1.81
51	root	1.82	1.81 Mon Nov 30 19:29:33 CET 2020
52	root	1.84	- cast functions were broken due to last-minute renaming. thats
53			what you get for not having a tessuite.
54	root	1.81	- Math::BigInt and Math::BigFloat are pretty broken (again),
55			so disable some tests. (try printing the bigfloat
56			799999999999999999998E99999999999999999998).
57	root	1.79
58	root	1.80	1.8 Sun Nov 29 22:35:13 CET 2020
59	root	1.79	- experimental support for some type casts, as well as embedding
60			raw cbor data.
61	root	1.76
62	root	1.78	1.71 Thu Nov 15 20:52:13 CET 2018
63			- work around what smells like a perl bug w.r.t. exceptions
64			thrown in callbacks.
65			- update libecb.
66
67	root	1.77	1.7 Tue Jun 27 04:02:23 CEST 2017
68			- SECURITY FIX: fix two bugs found by american fuzzy lop,
69			upgrade is advised if you accept data from untrusted
70			sources.
71			- an out-of bound sharedref or stringref index could cause an
72			out of bounds access - might be exploitable.
73			- a decoding error during indefinite array or hash decoding
74			could cause an endless loop.
75
76	root	1.76	1.6 Wed Dec 7 15:13:23 CET 2016
77	root	1.75	- greatly expand the SECURITY IMPLICATIONS and similar sections.
78	root	1.74	- new constructor new_safe, to create a secure CBOR::XS object.
79			- new option forbid_objects, to disallow serialisation.
80			- new CBOR::XS::safe_filter functionality.
81	root	1.69	- fix a crash when decoding a cyclic data structure using
82			stringref/pack_strings when allow_cycles is disabled.
83	root	1.71	- fix a crash when decoding hash keys with length >= 2**31.
84			- avoid unreasonably long decoding times for certain
85	root	1.75	types of (corrupt) cbor texts.
86	root	1.71	- support arrays and hashes with >= 2**31 members.
87			- avoid overflow on pointer arithmetic when checking whether enough
88			data is available.
89	root	1.72	- fix a memory leak that occured when decoding failed while decoding
90			a tagged value.
91	root	1.73	- do not leak the partially constructed result when stringifying
92			a hash key throws an exception.
93	root	1.74	- various code size and efficiency optimizations (reduced code
94	root	1.75	from 42 to 40kB on my system, despite the new features).
95	root	1.46
96	root	1.67	1.5 Wed Apr 27 11:38:39 CEST 2016
97	root	1.61	- Math::BigFloat madness workaround, see
98			http://blog.schmorp.de/2016-04-23-mathbigfloat-maintainer-fail.html
99	root	1.57	(bugreport by zdm@softvisio.net).
100	root	1.61	- add text_keys and text_strings options to force CBOR text encoding
101			for perl hash keys or all strings, as a result of discussions
102			with Fredrik Ljunggren.
103	root	1.64	- implement support for arbitrary-exponent numbers (see
104			http://peteroupc.github.io/CBOR/bigfrac.html, tags 264 and 265)
105			for both en- and decoding.
106	root	1.65	- implement support for rational numbers (see
107			http://peteroupc.github.io/CBOR/rational.html, tag 30) for both
108			en- and decoding.
109	root	1.67	- the above effectively implements all registered CBOR extensions
110	root	1.66	in a sensible manner.
111	root	1.67	- remove some weird dead code that was duplicated (%FILTER).
112	root	1.60	- add t/58_hv.t, which tests hashes and the new text_* flags.
113	root	1.67	hashes apparently were not encoded at all in any of the existing
114	root	1.60	tests.
115	root	1.67	- document Math::BigFloat base-2 performance/crash issues.
116	root	1.62	- use stability canary.
117	root	1.57
118	root	1.56	1.41 Thu 25 Feb 15:22:03 CET 2016
119			- avoid perl panics on nested FREEZE/THAW calls (testcase by
120			Victor Efimov).
121
122	root	1.54	1.4 Mon Feb 8 05:10:15 CET 2016
123			- buffer overflow fix: a fast path during decoding did not check
124			remaining length when decoding hash keys, found by fuzzing.
125	root	1.55	This can potentially leak information in the error message
126			or crash the process.
127	root	1.53	- use C style { 0 } struct initializer.
128	root	1.54	- upgrade libecb.
129	root	1.53
130	root	1.52	1.3 Mon Apr 27 22:21:04 CEST 2015
131			- the incremental parser didn't properly parse tagged values
132			(testcase by Mons Anderson).
133	root	1.50	- slightly speed up encoding of plain (nonmagical) arrays.
134	root	1.51	- try to clarify further that effectively all 32 bit architectures
135			have 64 bit integer support.
136	root	1.52	- upgrade libecb.
137	root	1.50
138	root	1.49	1.26 Sat Oct 25 08:35:44 CEST 2014
139	root	1.47	- update the t/57_incr.t subtest that would rely on 64 bit ints.
140	root	1.48	- disable t/50_rfc.t test that fails because of broken data::dumper.
141	root	1.47
142	root	1.46	1.25 Sun Jan 5 15:19:14 CET 2014
143			- map key decoding was pretty much botched due to the recent cleanups.
144			- work around Time::Piece->epoch returning a string value, avoid encoding
145			this as a tag 1 string.
146			- enable more testcases in t/50_rfc.t, now that they work :)
147
148			1.2 Tue Dec 10 22:06:42 CET 2013
149			- implement an incremental decoder.
150	root	1.39
151	root	1.44	1.12 Tue Dec 3 11:23:22 CET 2013
152	root	1.45	- work around broken Time::Piece (in old versions of the module, %z doesn't
153			work as documented, gives different results on different platforms(!)).
154	root	1.43
155	root	1.42	1.11 Sun Dec 1 18:00:00 CET 2013
156	root	1.39	- new setting: validate_utf8, for when you can't trust your cbor data.
157			- do not leak memory on decoding errors, when allow_cycles is enabled.
158	root	1.41	- add default filters for tags 0 and 1, using Time::Piece.
159	root	1.42	- more tests added.
160	root	1.30
161	root	1.37	1.1 Sat Nov 30 19:14:27 CET 2013
162	root	1.36	- INCOMPATIBLE CHANGE: new decoder setting: allow_cyclic, needed to decode
163			cyclic data structures (to avoid memleaks in unsuspecting code).
164	root	1.37	- no longer "share" references that aren't, i.e. true/false/null/error/tagged.
165	root	1.32	- fix stringref w.r.t. indefinite-length strings.
166			- verify indefinite-length string chunk types.
167	root	1.35	- do not allow extremely large arrays - assume an array element
168	root	1.37	requires at least one CBOR byte, to avoid memory exhaustion attacks.
169	root	1.34	- major code overhaul.
170	root	1.32
171	root	1.31	1.0 Thu Nov 28 16:43:31 CET 2013
172	root	1.28	- use the now official tag values for extensions. remove the
173			experimental notice. it's the real thing now, with real bugs.
174	root	1.29	- renamed allow_stringref to pack_strings.
175	root	1.27	- port to perl <= 5.16.
176	root	1.31	- slightly improve the documentation.
177	root	1.27
178	root	1.25	0.09 Fri Nov 22 16:54:18 CET 2013
179	root	1.24	- bignum/bigfloat/decimal support.
180			- uri support.
181			- tag filter functions support for decoding.
182	root	1.21	- do not support reference-to-1/0/undef anymore, you need to use
183			the Types::Serialiser objects now.
184			- experimental sharable extension support (http://cbor.schmorp.de/value-sharing).
185	root	1.22	- experimental stringref extension support (http://cbor.schmorp.de/stringref).
186	root	1.21	- implement indirection tag (http://cbor.schmorp.de/indirection).
187
188	root	1.20	0.08 Wed Oct 30 11:10:43 CET 2013
189	root	1.19	- defused another too fragile test.
190
191	root	1.18	0.07 Tue Oct 29 23:04:07 CET 2013
192	root	1.17	- don't crash in decode when silly values are passed in.
193			- considerably speed up map decoding when map keys
194			are utf-8 or byte strings.
195	root	1.18	- raising an exception in THAW should now work without
196			leaking.
197	root	1.17
198	root	1.16	0.06 Tue Oct 29 16:56:07 CET 2013
199	root	1.14	- do not leak when deserialiasing via THAW.
200	root	1.15	- implement and document CBOR::XS creation/access/mutate
201			methods.
202	root	1.14
203	root	1.13	0.05 Mon Oct 28 22:27:47 CET 2013
204	root	1.12	- do not leak hash keys on decoding.
205
206	root	1.11	0.04 Sun Oct 27 23:47:47 CET 2013
207	root	1.10	- implement TO_CBOR/FREEZE/THAW serialisation protocols.
208	root	1.7	- requested perl-object and generic-object tags from iana.
209	root	1.9	- switched to Types::Serialiser for true, false and error.
210	root	1.8	- disabled some fragile tests (thanks, andk).
211	root	1.7
212	root	1.6	0.03 Sun Oct 27 00:28:41 CEST 2013
213	root	1.4	- improve 32 bit platform compatibility.
214	root	1.5	- take more advantage of ecb.h.
215	root	1.6	- preliminary and bare-bones tagged support.
216			- improved docs.
217	root	1.4
218	root	1.3	0.02 Sat Oct 26 13:08:05 CEST 2013
219			- no aborts left.
220			- add $CBOR::XS::MAGIC.
221			- preliminary tagged decoding to arrayref.
222	root	1.2	- indefinite encoding fixed.
223			- half float decoding implemented.
224			- t/50_rfc.t adds test vectors from the rfc, which
225			are checked as applicable.
226
227	root	1.1	0.01 Fri Oct 25 21:39:56 CEST 2013
228			- original version; cloned from JSON-XS
229