[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: 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?

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