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

Revision history for Perl extension CBOR::XS

TODO: pack_keys?
TODO: document encode_cbor_sharing?
TODO: weaken cyclic structures?
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: as_object -> key value pair list to allow non-string hash keys
        - \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).

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