[ViewVC] Diff of: cvs/CBOR-XS/XS.pm

Comparing CBOR-XS/XS.pm (file contents):
Revision 1.7 by root, Sun Oct 27 22:35:15 2013 UTC vs.
Revision 1.76 by root, Tue Dec 1 01:49:47 2020 UTC

…		…
26	substr $many_cbor_strings, 0, $length, ""; # remove decoded cbor string	26	substr $many_cbor_strings, 0, $length, ""; # remove decoded cbor string
27	}	27	}
28		28
29	=head1 DESCRIPTION	29	=head1 DESCRIPTION
30		30
31	WARNING! THIS IS A PRE-ALPHA RELEASE! IT WILL CRASH, CORRUPT YOUR DATA
32	AND EAT YOUR CHILDREN! (Actually, apart from being untested and a bit
33	feature-limited, it might already be useful).
34
35	This module converts Perl data structures to the Concise Binary Object	31	This module converts Perl data structures to the Concise Binary Object
36	Representation (CBOR) and vice versa. CBOR is a fast binary serialisation	32	Representation (CBOR) and vice versa. CBOR is a fast binary serialisation
37	format that aims to use a superset of the JSON data model, i.e. when you	33	format that aims to use an (almost) superset of the JSON data model, i.e.
38	can represent something in JSON, you should be able to represent it in	34	when you can represent something useful in JSON, you should be able to
39	CBOR.	35	represent it in CBOR.
40		36
41	This makes it a faster and more compact binary alternative to JSON, with	37	In short, CBOR is a faster and quite compact binary alternative to JSON,
42	the added ability of supporting serialising of perl objects.	38	with the added ability of supporting serialisation of Perl objects. (JSON
		39	often compresses better than CBOR though, so if you plan to compress the
		40	data later and speed is less important you might want to compare both
		41	formats first).
43		42
44	The primary goal of this module is to be I<correct> and the secondary goal	43	The primary goal of this module is to be I<correct> and the secondary goal
45	is to be I<fast>. To reach the latter goal it was written in C.	44	is to be I<fast>. To reach the latter goal it was written in C.
46		45
		46	To give you a general idea about speed, with texts in the megabyte range,
		47	C<CBOR::XS> usually encodes roughly twice as fast as L<Storable> or
		48	L<JSON::XS> and decodes about 15%-30% faster than those. The shorter the
		49	data, the worse L<Storable> performs in comparison.
		50
		51	Regarding compactness, C<CBOR::XS>-encoded data structures are usually
		52	about 20% smaller than the same data encoded as (compact) JSON or
		53	L<Storable>.
		54
		55	In addition to the core CBOR data format, this module implements a
		56	number of extensions, to support cyclic and shared data structures
		57	(see C<allow_sharing> and C<allow_cycles>), string deduplication (see
		58	C<pack_strings>) and scalar references (always enabled).
		59
47	See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and	60	See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and
48	vice versa.	61	vice versa.
49		62
50	=cut	63	=cut
51		64
52	package CBOR::XS;	65	package CBOR::XS;
53		66
54	use common::sense;	67	use common::sense;
55		68
56	our $VERSION = 0.03;	69	our $VERSION = 1.82;
57	our @ISA = qw(Exporter);	70	our @ISA = qw(Exporter);
58		71
59	our @EXPORT = qw(encode_cbor decode_cbor);	72	our @EXPORT = qw(encode_cbor decode_cbor);
60		73
61	use Exporter;	74	use Exporter;
…		…
98	strings. All boolean flags described below are by default I<disabled>.	111	strings. All boolean flags described below are by default I<disabled>.
99		112
100	The mutators for flags all return the CBOR object again and thus calls can	113	The mutators for flags all return the CBOR object again and thus calls can
101	be chained:	114	be chained:
102		115
103	#TODO
104	my $cbor = CBOR::XS->new->encode ({a => [1,2]});	116	my $cbor = CBOR::XS->new->encode ({a => [1,2]});
		117
		118	=item $cbor = new_safe CBOR::XS
		119
		120	Create a new, safe/secure CBOR::XS object. This is similar to C<new>,
		121	but configures the coder object to be safe to use with untrusted
		122	data. Currently, this is equivalent to:
		123
		124	my $cbor = CBOR::XS
		125	->new
		126	->forbid_objects
		127	->filter (\&CBOR::XS::safe_filter)
		128	->max_size (1e8);
		129
		130	But is more future proof (it is better to crash because of a change than
		131	to be exploited in other ways).
		132
		133	=cut
		134
		135	sub new_safe {
		136	CBOR::XS
		137	->new
		138	->forbid_objects
		139	->filter (\&CBOR::XS::safe_filter)
		140	->max_size (1e8)
		141	}
105		142
106	=item $cbor = $cbor->max_depth ([$maximum_nesting_depth])	143	=item $cbor = $cbor->max_depth ([$maximum_nesting_depth])
107		144
108	=item $max_depth = $cbor->get_max_depth	145	=item $max_depth = $cbor->get_max_depth
109		146
…		…
125		162
126	Note that nesting is implemented by recursion in C. The default value has	163	Note that nesting is implemented by recursion in C. The default value has
127	been chosen to be as large as typical operating systems allow without	164	been chosen to be as large as typical operating systems allow without
128	crashing.	165	crashing.
129		166
130	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.	167	See L<SECURITY CONSIDERATIONS>, below, for more info on why this is useful.
131		168
132	=item $cbor = $cbor->max_size ([$maximum_string_size])	169	=item $cbor = $cbor->max_size ([$maximum_string_size])
133		170
134	=item $max_size = $cbor->get_max_size	171	=item $max_size = $cbor->get_max_size
135		172
…		…
140	effect on C<encode> (yet).	177	effect on C<encode> (yet).
141		178
142	If no argument is given, the limit check will be deactivated (same as when	179	If no argument is given, the limit check will be deactivated (same as when
143	C<0> is specified).	180	C<0> is specified).
144		181
145	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.	182	See L<SECURITY CONSIDERATIONS>, below, for more info on why this is useful.
		183
		184	=item $cbor = $cbor->allow_unknown ([$enable])
		185
		186	=item $enabled = $cbor->get_allow_unknown
		187
		188	If C<$enable> is true (or missing), then C<encode> will I<not> throw an
		189	exception when it encounters values it cannot represent in CBOR (for
		190	example, filehandles) but instead will encode a CBOR C<error> value.
		191
		192	If C<$enable> is false (the default), then C<encode> will throw an
		193	exception when it encounters anything it cannot encode as CBOR.
		194
		195	This option does not affect C<decode> in any way, and it is recommended to
		196	leave it off unless you know your communications partner.
		197
		198	=item $cbor = $cbor->allow_sharing ([$enable])
		199
		200	=item $enabled = $cbor->get_allow_sharing
		201
		202	If C<$enable> is true (or missing), then C<encode> will not double-encode
		203	values that have been referenced before (e.g. when the same object, such
		204	as an array, is referenced multiple times), but instead will emit a
		205	reference to the earlier value.
		206
		207	This means that such values will only be encoded once, and will not result
		208	in a deep cloning of the value on decode, in decoders supporting the value
		209	sharing extension. This also makes it possible to encode cyclic data
		210	structures (which need C<allow_cycles> to be enabled to be decoded by this
		211	module).
		212
		213	It is recommended to leave it off unless you know your
		214	communication partner supports the value sharing extensions to CBOR
		215	(L<http://cbor.schmorp.de/value-sharing>), as without decoder support, the
		216	resulting data structure might be unusable.
		217
		218	Detecting shared values incurs a runtime overhead when values are encoded
		219	that have a reference counter large than one, and might unnecessarily
		220	increase the encoded size, as potentially shared values are encoded as
		221	shareable whether or not they are actually shared.
		222
		223	At the moment, only targets of references can be shared (e.g. scalars,
		224	arrays or hashes pointed to by a reference). Weirder constructs, such as
		225	an array with multiple "copies" of the I<same> string, which are hard but
		226	not impossible to create in Perl, are not supported (this is the same as
		227	with L<Storable>).
		228
		229	If C<$enable> is false (the default), then C<encode> will encode shared
		230	data structures repeatedly, unsharing them in the process. Cyclic data
		231	structures cannot be encoded in this mode.
		232
		233	This option does not affect C<decode> in any way - shared values and
		234	references will always be decoded properly if present.
		235
		236	=item $cbor = $cbor->allow_cycles ([$enable])
		237
		238	=item $enabled = $cbor->get_allow_cycles
		239
		240	If C<$enable> is true (or missing), then C<decode> will happily decode
		241	self-referential (cyclic) data structures. By default these will not be
		242	decoded, as they need manual cleanup to avoid memory leaks, so code that
		243	isn't prepared for this will not leak memory.
		244
		245	If C<$enable> is false (the default), then C<decode> will throw an error
		246	when it encounters a self-referential/cyclic data structure.
		247
		248	FUTURE DIRECTION: the motivation behind this option is to avoid I<real>
		249	cycles - future versions of this module might chose to decode cyclic data
		250	structures using weak references when this option is off, instead of
		251	throwing an error.
		252
		253	This option does not affect C<encode> in any way - shared values and
		254	references will always be encoded properly if present.
		255
		256	=item $cbor = $cbor->forbid_objects ([$enable])
		257
		258	=item $enabled = $cbor->get_forbid_objects
		259
		260	Disables the use of the object serialiser protocol.
		261
		262	If C<$enable> is true (or missing), then C<encode> will will throw an
		263	exception when it encounters perl objects that would be encoded using the
		264	perl-object tag (26). When C<decode> encounters such tags, it will fall
		265	back to the general filter/tagged logic as if this were an unknown tag (by
		266	default resulting in a C<CBOR::XC::Tagged> object).
		267
		268	If C<$enable> is false (the default), then C<encode> will use the
		269	L<Types::Serialiser> object serialisation protocol to serialise objects
		270	into perl-object tags, and C<decode> will do the same to decode such tags.
		271
		272	See L<SECURITY CONSIDERATIONS>, below, for more info on why forbidding this
		273	protocol can be useful.
		274
		275	=item $cbor = $cbor->pack_strings ([$enable])
		276
		277	=item $enabled = $cbor->get_pack_strings
		278
		279	If C<$enable> is true (or missing), then C<encode> will try not to encode
		280	the same string twice, but will instead encode a reference to the string
		281	instead. Depending on your data format, this can save a lot of space, but
		282	also results in a very large runtime overhead (expect encoding times to be
		283	2-4 times as high as without).
		284
		285	It is recommended to leave it off unless you know your
		286	communications partner supports the stringref extension to CBOR
		287	(L<http://cbor.schmorp.de/stringref>), as without decoder support, the
		288	resulting data structure might not be usable.
		289
		290	If C<$enable> is false (the default), then C<encode> will encode strings
		291	the standard CBOR way.
		292
		293	This option does not affect C<decode> in any way - string references will
		294	always be decoded properly if present.
		295
		296	=item $cbor = $cbor->text_keys ([$enable])
		297
		298	=item $enabled = $cbor->get_text_keys
		299
		300	If C<$enabled> is true (or missing), then C<encode> will encode all
		301	perl hash keys as CBOR text strings/UTF-8 string, upgrading them as needed.
		302
		303	If C<$enable> is false (the default), then C<encode> will encode hash keys
		304	normally - upgraded perl strings (strings internally encoded as UTF-8) as
		305	CBOR text strings, and downgraded perl strings as CBOR byte strings.
		306
		307	This option does not affect C<decode> in any way.
		308
		309	This option is useful for interoperability with CBOR decoders that don't
		310	treat byte strings as a form of text. It is especially useful as Perl
		311	gives very little control over hash keys.
		312
		313	Enabling this option can be slow, as all downgraded hash keys that are
		314	encoded need to be scanned and converted to UTF-8.
		315
		316	=item $cbor = $cbor->text_strings ([$enable])
		317
		318	=item $enabled = $cbor->get_text_strings
		319
		320	This option works similar to C<text_keys>, above, but works on all strings
		321	(including hash keys), so C<text_keys> has no further effect after
		322	enabling C<text_strings>.
		323
		324	If C<$enabled> is true (or missing), then C<encode> will encode all perl
		325	strings as CBOR text strings/UTF-8 strings, upgrading them as needed.
		326
		327	If C<$enable> is false (the default), then C<encode> will encode strings
		328	normally (but see C<text_keys>) - upgraded perl strings (strings
		329	internally encoded as UTF-8) as CBOR text strings, and downgraded perl
		330	strings as CBOR byte strings.
		331
		332	This option does not affect C<decode> in any way.
		333
		334	This option has similar advantages and disadvantages as C<text_keys>. In
		335	addition, this option effectively removes the ability to automatically
		336	encode byte strings, which might break some C<FREEZE> and C<TO_CBOR>
		337	methods that rely on this.
		338
		339	A workaround is to use explicit type casts, which are unaffected by this option.
		340
		341	=item $cbor = $cbor->validate_utf8 ([$enable])
		342
		343	=item $enabled = $cbor->get_validate_utf8
		344
		345	If C<$enable> is true (or missing), then C<decode> will validate that
		346	elements (text strings) containing UTF-8 data in fact contain valid UTF-8
		347	data (instead of blindly accepting it). This validation obviously takes
		348	extra time during decoding.
		349
		350	The concept of "valid UTF-8" used is perl's concept, which is a superset
		351	of the official UTF-8.
		352
		353	If C<$enable> is false (the default), then C<decode> will blindly accept
		354	UTF-8 data, marking them as valid UTF-8 in the resulting data structure
		355	regardless of whether that's true or not.
		356
		357	Perl isn't too happy about corrupted UTF-8 in strings, but should
		358	generally not crash or do similarly evil things. Extensions might be not
		359	so forgiving, so it's recommended to turn on this setting if you receive
		360	untrusted CBOR.
		361
		362	This option does not affect C<encode> in any way - strings that are
		363	supposedly valid UTF-8 will simply be dumped into the resulting CBOR
		364	string without checking whether that is, in fact, true or not.
		365
		366	=item $cbor = $cbor->filter ([$cb->($tag, $value)])
		367
		368	=item $cb_or_undef = $cbor->get_filter
		369
		370	Sets or replaces the tagged value decoding filter (when C<$cb> is
		371	specified) or clears the filter (if no argument or C<undef> is provided).
		372
		373	The filter callback is called only during decoding, when a non-enforced
		374	tagged value has been decoded (see L<TAG HANDLING AND EXTENSIONS> for a
		375	list of enforced tags). For specific tags, it's often better to provide a
		376	default converter using the C<%CBOR::XS::FILTER> hash (see below).
		377
		378	The first argument is the numerical tag, the second is the (decoded) value
		379	that has been tagged.
		380
		381	The filter function should return either exactly one value, which will
		382	replace the tagged value in the decoded data structure, or no values,
		383	which will result in default handling, which currently means the decoder
		384	creates a C<CBOR::XS::Tagged> object to hold the tag and the value.
		385
		386	When the filter is cleared (the default state), the default filter
		387	function, C<CBOR::XS::default_filter>, is used. This function simply
		388	looks up the tag in the C<%CBOR::XS::FILTER> hash. If an entry exists
		389	it must be a code reference that is called with tag and value, and is
		390	responsible for decoding the value. If no entry exists, it returns no
		391	values. C<CBOR::XS> provides a number of default filter functions already,
		392	the the C<%CBOR::XS::FILTER> hash can be freely extended with more.
		393
		394	C<CBOR::XS> additionally provides an alternative filter function that is
		395	supposed to be safe to use with untrusted data (which the default filter
		396	might not), called C<CBOR::XS::safe_filter>, which works the same as
		397	the C<default_filter> but uses the C<%CBOR::XS::SAFE_FILTER> variable
		398	instead. It is prepopulated with the tag decoding functions that are
		399	deemed safe (basically the same as C<%CBOR::XS::FILTER> without all
		400	the bignum tags), and can be extended by user code as wlel, although,
		401	obviously, one should be very careful about adding decoding functions
		402	here, since the expectation is that they are safe to use on untrusted
		403	data, after all.
		404
		405	Example: decode all tags not handled internally into C<CBOR::XS::Tagged>
		406	objects, with no other special handling (useful when working with
		407	potentially "unsafe" CBOR data).
		408
		409	CBOR::XS->new->filter (sub { })->decode ($cbor_data);
		410
		411	Example: provide a global filter for tag 1347375694, converting the value
		412	into some string form.
		413
		414	$CBOR::XS::FILTER{1347375694} = sub {
		415	my ($tag, $value);
		416
		417	"tag 1347375694 value $value"
		418	};
		419
		420	Example: provide your own filter function that looks up tags in your own
		421	hash:
		422
		423	my %my_filter = (
		424	998347484 => sub {
		425	my ($tag, $value);
		426
		427	"tag 998347484 value $value"
		428	};
		429	);
		430
		431	my $coder = CBOR::XS->new->filter (sub {
		432	&{ $my_filter{$_[0]} or return }
		433	});
		434
		435
		436	Example: use the safe filter function (see L<SECURITY CONSIDERATIONS> for
		437	more considerations on security).
		438
		439	CBOR::XS->new->filter (\&CBOR::XS::safe_filter)->decode ($cbor_data);
146		440
147	=item $cbor_data = $cbor->encode ($perl_scalar)	441	=item $cbor_data = $cbor->encode ($perl_scalar)
148		442
149	Converts the given Perl data structure (a scalar value) to its CBOR	443	Converts the given Perl data structure (a scalar value) to its CBOR
150	representation.	444	representation.
…		…
160	when there is trailing garbage after the CBOR string, it will silently	454	when there is trailing garbage after the CBOR string, it will silently
161	stop parsing there and return the number of characters consumed so far.	455	stop parsing there and return the number of characters consumed so far.
162		456
163	This is useful if your CBOR texts are not delimited by an outer protocol	457	This is useful if your CBOR texts are not delimited by an outer protocol
164	and you need to know where the first CBOR string ends amd the next one	458	and you need to know where the first CBOR string ends amd the next one
165	starts.	459	starts - CBOR strings are self-delimited, so it is possible to concatenate
		460	CBOR strings without any delimiters or size fields and recover their data.
166		461
167	CBOR::XS->new->decode_prefix ("......")	462	CBOR::XS->new->decode_prefix ("......")
168	=> ("...", 3)	463	=> ("...", 3)
		464
		465	=back
		466
		467	=head2 INCREMENTAL PARSING
		468
		469	In some cases, there is the need for incremental parsing of JSON
		470	texts. While this module always has to keep both CBOR text and resulting
		471	Perl data structure in memory at one time, it does allow you to parse a
		472	CBOR stream incrementally, using a similar to using "decode_prefix" to see
		473	if a full CBOR object is available, but is much more efficient.
		474
		475	It basically works by parsing as much of a CBOR string as possible - if
		476	the CBOR data is not complete yet, the pasrer will remember where it was,
		477	to be able to restart when more data has been accumulated. Once enough
		478	data is available to either decode a complete CBOR value or raise an
		479	error, a real decode will be attempted.
		480
		481	A typical use case would be a network protocol that consists of sending
		482	and receiving CBOR-encoded messages. The solution that works with CBOR and
		483	about anything else is by prepending a length to every CBOR value, so the
		484	receiver knows how many octets to read. More compact (and slightly slower)
		485	would be to just send CBOR values back-to-back, as C<CBOR::XS> knows where
		486	a CBOR value ends, and doesn't need an explicit length.
		487
		488	The following methods help with this:
		489
		490	=over 4
		491
		492	=item @decoded = $cbor->incr_parse ($buffer)
		493
		494	This method attempts to decode exactly one CBOR value from the beginning
		495	of the given C<$buffer>. The value is removed from the C<$buffer> on
		496	success. When C<$buffer> doesn't contain a complete value yet, it returns
		497	nothing. Finally, when the C<$buffer> doesn't start with something
		498	that could ever be a valid CBOR value, it raises an exception, just as
		499	C<decode> would. In the latter case the decoder state is undefined and
		500	must be reset before being able to parse further.
		501
		502	This method modifies the C<$buffer> in place. When no CBOR value can be
		503	decoded, the decoder stores the current string offset. On the next call,
		504	continues decoding at the place where it stopped before. For this to make
		505	sense, the C<$buffer> must begin with the same octets as on previous
		506	unsuccessful calls.
		507
		508	You can call this method in scalar context, in which case it either
		509	returns a decoded value or C<undef>. This makes it impossible to
		510	distinguish between CBOR null values (which decode to C<undef>) and an
		511	unsuccessful decode, which is often acceptable.
		512
		513	=item @decoded = $cbor->incr_parse_multiple ($buffer)
		514
		515	Same as C<incr_parse>, but attempts to decode as many CBOR values as
		516	possible in one go, instead of at most one. Calls to C<incr_parse> and
		517	C<incr_parse_multiple> can be interleaved.
		518
		519	=item $cbor->incr_reset
		520
		521	Resets the incremental decoder. This throws away any saved state, so that
		522	subsequent calls to C<incr_parse> or C<incr_parse_multiple> start to parse
		523	a new CBOR value from the beginning of the C<$buffer> again.
		524
		525	This method can be called at any time, but it I<must> be called if you want
		526	to change your C<$buffer> or there was a decoding error and you want to
		527	reuse the C<$cbor> object for future incremental parsings.
169		528
170	=back	529	=back
171		530
172		531
173	=head1 MAPPING	532	=head1 MAPPING
…		…
191	CBOR integers become (numeric) perl scalars. On perls without 64 bit	550	CBOR integers become (numeric) perl scalars. On perls without 64 bit
192	support, 64 bit integers will be truncated or otherwise corrupted.	551	support, 64 bit integers will be truncated or otherwise corrupted.
193		552
194	=item byte strings	553	=item byte strings
195		554
196	Byte strings will become octet strings in Perl (the byte values 0..255	555	Byte strings will become octet strings in Perl (the Byte values 0..255
197	will simply become characters of the same value in Perl).	556	will simply become characters of the same value in Perl).
198		557
199	=item UTF-8 strings	558	=item UTF-8 strings
200		559
201	UTF-8 strings in CBOR will be decoded, i.e. the UTF-8 octets will be	560	UTF-8 strings in CBOR will be decoded, i.e. the UTF-8 octets will be
…		…
219	C<Types:Serialiser::false> and C<Types::Serialiser::error>,	578	C<Types:Serialiser::false> and C<Types::Serialiser::error>,
220	respectively. They are overloaded to act almost exactly like the numbers	579	respectively. They are overloaded to act almost exactly like the numbers
221	C<1> and C<0> (for true and false) or to throw an exception on access (for	580	C<1> and C<0> (for true and false) or to throw an exception on access (for
222	error). See the L<Types::Serialiser> manpage for details.	581	error). See the L<Types::Serialiser> manpage for details.
223		582
224	=item CBOR tag 256 (perl object)	583	=item tagged values
225		584
226	The tag value C<256> (TODO: pending iana registration) will be used
227	to deserialise a Perl object serialised with C<FREEZE>. See "OBJECT
228	SERIALISATION", below, for details.
229
230	=item CBOR tag 55799 (magic header)
231
232	The tag 55799 is ignored (this tag implements the magic header).
233
234	=item other CBOR tags
235
236	Tagged items consists of a numeric tag and another CBOR value. Tags not	585	Tagged items consists of a numeric tag and another CBOR value.
237	handled internally are currently converted into a L<CBOR::XS::Tagged>
238	object, which is simply a blessed array reference consisting of the
239	numeric tag value followed by the (decoded) CBOR value.
240		586
241	In the future, support for user-supplied conversions might get added.	587	See L<TAG HANDLING AND EXTENSIONS> and the description of C<< ->filter >>
		588	for details on which tags are handled how.
242		589
243	=item anything else	590	=item anything else
244		591
245	Anything else (e.g. unsupported simple values) will raise a decoding	592	Anything else (e.g. unsupported simple values) will raise a decoding
246	error.	593	error.
…		…
249		596
250		597
251	=head2 PERL -> CBOR	598	=head2 PERL -> CBOR
252		599
253	The mapping from Perl to CBOR is slightly more difficult, as Perl is a	600	The mapping from Perl to CBOR is slightly more difficult, as Perl is a
254	truly typeless language, so we can only guess which CBOR type is meant by	601	typeless language. That means this module can only guess which CBOR type
255	a Perl value.	602	is meant by a perl value.
256		603
257	=over 4	604	=over 4
258		605
259	=item hash references	606	=item hash references
260		607
261	Perl hash references become CBOR maps. As there is no inherent ordering in	608	Perl hash references become CBOR maps. As there is no inherent ordering in
262	hash keys (or CBOR maps), they will usually be encoded in a pseudo-random	609	hash keys (or CBOR maps), they will usually be encoded in a pseudo-random
263	order.	610	order. This order can be different each time a hash is encoded.
264		611
265	Currently, tied hashes will use the indefinite-length format, while normal	612	Currently, tied hashes will use the indefinite-length format, while normal
266	hashes will use the fixed-length format.	613	hashes will use the fixed-length format.
267		614
268	=item array references	615	=item array references
269		616
270	Perl array references become fixed-length CBOR arrays.	617	Perl array references become fixed-length CBOR arrays.
271		618
272	=item other references	619	=item other references
273		620
274	Other unblessed references are generally not allowed and will cause an	621	Other unblessed references will be represented using
275	exception to be thrown, except for references to the integers C<0> and	622	the indirection tag extension (tag value C<22098>,
276	C<1>, which get turned into false and true in CBOR.	623	L<http://cbor.schmorp.de/indirection>). CBOR decoders are guaranteed
		624	to be able to decode these values somehow, by either "doing the right
		625	thing", decoding into a generic tagged object, simply ignoring the tag, or
		626	something else.
277		627
278	=item CBOR::XS::Tagged objects	628	=item CBOR::XS::Tagged objects
279		629
280	Objects of this type must be arrays consisting of a single C<[tag, value]>	630	Objects of this type must be arrays consisting of a single C<[tag, value]>
281	pair. The (numerical) tag will be encoded as a CBOR tag, the value will be	631	pair. The (numerical) tag will be encoded as a CBOR tag, the value will
282	encoded as appropriate for the value.	632	be encoded as appropriate for the value. You must use C<CBOR::XS::tag> to
		633	create such objects.
283		634
284	=item Types::Serialiser::true, Types::Serialiser::false, Types::Serialiser::error	635	=item Types::Serialiser::true, Types::Serialiser::false, Types::Serialiser::error
285		636
286	These special values become CBOR true, CBOR false and CBOR undefined	637	These special values become CBOR true, CBOR false and CBOR undefined
287	values, respectively. You can also use C<\1>, C<\0> and C<\undef> directly	638	values, respectively. You can also use C<\1>, C<\0> and C<\undef> directly
288	if you want.	639	if you want.
289		640
290	=item other blessed objects	641	=item other blessed objects
291		642
292	Other blessed objects are serialised via C<TO_CBOR> or C<FREEZE>. See	643	Other blessed objects are serialised via C<TO_CBOR> or C<FREEZE>. See
293	"OBJECT SERIALISATION", below, for details.	644	L<TAG HANDLING AND EXTENSIONS> for specific classes handled by this
		645	module, and L<OBJECT SERIALISATION> for generic object serialisation.
294		646
295	=item simple scalars	647	=item simple scalars
296		648
297	TODO
298	Simple Perl scalars (any scalar that is not a reference) are the most	649	Simple Perl scalars (any scalar that is not a reference) are the most
299	difficult objects to encode: CBOR::XS will encode undefined scalars as	650	difficult objects to encode: CBOR::XS will encode undefined scalars as
300	CBOR null values, scalars that have last been used in a string context	651	CBOR null values, scalars that have last been used in a string context
301	before encoding as CBOR strings, and anything else as number value:	652	before encoding as CBOR strings, and anything else as number value:
302		653
303	# dump as number	654	# dump as number
304	encode_cbor [2] # yields [2]	655	encode_cbor [2] # yields [2]
305	encode_cbor [-3.0e17] # yields [-3e+17]	656	encode_cbor [-3.0e17] # yields [-3e+17]
306	my $value = 5; encode_cbor [$value] # yields [5]	657	my $value = 5; encode_cbor [$value] # yields [5]
307		658
308	# used as string, so dump as string	659	# used as string, so dump as string (either byte or text)
309	print $value;	660	print $value;
310	encode_cbor [$value] # yields ["5"]	661	encode_cbor [$value] # yields ["5"]
311		662
312	# undef becomes null	663	# undef becomes null
313	encode_cbor [undef] # yields [null]	664	encode_cbor [undef] # yields [null]
…		…
316		667
317	my $x = 3.1; # some variable containing a number	668	my $x = 3.1; # some variable containing a number
318	"$x"; # stringified	669	"$x"; # stringified
319	$x .= ""; # another, more awkward way to stringify	670	$x .= ""; # another, more awkward way to stringify
320	print $x; # perl does it for you, too, quite often	671	print $x; # perl does it for you, too, quite often
		672
		673	You can force whether a string is encoded as byte or text string by using
		674	C<utf8::upgrade> and C<utf8::downgrade> (if C<text_strings> is disabled).
		675
		676	utf8::upgrade $x; # encode $x as text string
		677	utf8::downgrade $x; # encode $x as byte string
		678
		679	More options are available, see L<TYPE CASTS>, below, and the C<text_keys>
		680	and C<text_strings> options.
		681
		682	Perl doesn't define what operations up- and downgrade strings, so if the
		683	difference between byte and text is important, you should up- or downgrade
		684	your string as late as possible before encoding. You can also force the
		685	use of CBOR text strings by using C<text_keys> or C<text_strings>.
321		686
322	You can force the type to be a CBOR number by numifying it:	687	You can force the type to be a CBOR number by numifying it:
323		688
324	my $x = "3"; # some variable containing a string	689	my $x = "3"; # some variable containing a string
325	$x += 0; # numify it, ensuring it will be dumped as a number	690	$x += 0; # numify it, ensuring it will be dumped as a number
…		…
336	represent numerical values are supported, but might suffer loss of	701	represent numerical values are supported, but might suffer loss of
337	precision.	702	precision.
338		703
339	=back	704	=back
340		705
		706	=head2 TYPE CASTS
		707
		708	B<EXPERIMENTAL>: As an experimental extension, C<CBOR::XS> allows you to
		709	force specific cbor types to be used when encoding. That allows you to
		710	encode types not normally accessible (e.g. half floats) as well as force
		711	string types even when C<text_strings> is in effect.
		712
		713	Type forcing is done by calling a special "cast" function which keeps a
		714	copy of the value and returns a new value that can be handed over to any
		715	CBOR encoder function.
		716
		717	The following casts are currently available (all of which are unary operators):
		718
		719	=over
		720
		721	=item CBOR::XS::as_int $value
		722
		723	Forces the value to be encoded as some form of (basic, not bignum) integer
		724	type.
		725
		726	=item CBOR::XS::as_text $value
		727
		728	Forces the value to be encoded as (UTF-8) text values.
		729
		730	=item CBOR::XS::as_bytes $value
		731
		732	Forces the value to be encoded as a (binary) string value.
		733
		734	=item CBOR::XS::as_bool $value
		735
		736	Converts a Perl boolean (which can be any kind of scalar) into a CBOR
		737	boolean. Strictly the same, but shorter to write, than:
		738
		739	$value ? Types::Serialiser::true : Types::Serialiser::false
		740
		741	=item CBOR::XS::as_float16 $value
		742
		743	Forces half-float (IEEE 754 binary16) encoding of the given value.
		744
		745	=item CBOR::XS::as_float32 $value
		746
		747	Forces single-float (IEEE 754 binary32) encoding of the given value.
		748
		749	=item CBOR::XS::as_float64 $value
		750
		751	Forces double-float (IEEE 754 binary64) encoding of the given value.
		752
		753	=item, CBOR::XS::as_cbor $cbor_text
		754
		755	Bot a type cast per-se, this type cast forces the argument to eb encoded
		756	as-is. This can be used to embed pre-encoded CBOR data.
		757
		758	Note that no checking on the validity of the C<$cbor_text> is done - it's
		759	the callers responsibility to correctly encode values.
		760
		761	=back
		762
		763	Example: encode a perl string as binary even though C<text_strings> is in
		764	effect.
		765
		766	CBOR::XS->new->text_strings->encode ([4, "text", CBOR::XS::bytes "bytevalue"]);
		767
		768	=cut
		769
		770	sub CBOR::XS::as_cbor ($) { bless [$_[0], 0, undef], CBOR::XS::Tagged:: }
		771	sub CBOR::XS::as_int ($) { bless [$_[0], 1, undef], CBOR::XS::Tagged:: }
		772	sub CBOR::XS::as_bytes ($) { bless [$_[0], 2, undef], CBOR::XS::Tagged:: }
		773	sub CBOR::XS::as_text ($) { bless [$_[0], 3, undef], CBOR::XS::Tagged:: }
		774	sub CBOR::XS::as_float16 ($) { bless [$_[0], 4, undef], CBOR::XS::Tagged:: }
		775	sub CBOR::XS::as_float32 ($) { bless [$_[0], 5, undef], CBOR::XS::Tagged:: }
		776	sub CBOR::XS::as_float64 ($) { bless [$_[0], 6, undef], CBOR::XS::Tagged:: }
		777
		778	sub CBOR::XS::as_bool ($) { $_[0] ? $Types::Serialiser::true : $Types::Serialiser::false }
		779
341	=head2 OBJECT SERIALISATION	780	=head2 OBJECT SERIALISATION
		781
		782	This module implements both a CBOR-specific and the generic
		783	L<Types::Serialier> object serialisation protocol. The following
		784	subsections explain both methods.
		785
		786	=head3 ENCODING
342		787
343	This module knows two way to serialise a Perl object: The CBOR-specific	788	This module knows two way to serialise a Perl object: The CBOR-specific
344	way, and the generic way.	789	way, and the generic way.
345		790
346	Whenever the encoder encounters a Perl object that it cnanot serialise	791	Whenever the encoder encounters a Perl object that it cannot serialise
347	directly (most of them), it will first look up the C<TO_CBOR> method on	792	directly (most of them), it will first look up the C<TO_CBOR> method on
348	it.	793	it.
349		794
350	If it has a C<TO_CBOR> method, it will call it with the object as only	795	If it has a C<TO_CBOR> method, it will call it with the object as only
351	argument, and expects exactly one return value, which it will then	796	argument, and expects exactly one return value, which it will then
…		…
357		802
358	The C<FREEZE> method can return any number of values (i.e. zero or	803	The C<FREEZE> method can return any number of values (i.e. zero or
359	more). These will be encoded as CBOR perl object, together with the	804	more). These will be encoded as CBOR perl object, together with the
360	classname.	805	classname.
361		806
		807	These methods I<MUST NOT> change the data structure that is being
		808	serialised. Failure to comply to this can result in memory corruption -
		809	and worse.
		810
362	If an object supports neither C<TO_CBOR> nor C<FREEZE>, encoding will fail	811	If an object supports neither C<TO_CBOR> nor C<FREEZE>, encoding will fail
363	with an error.	812	with an error.
364		813
		814	=head3 DECODING
		815
365	Objects encoded via C<TO_CBOR> cannot be automatically decoded, but	816	Objects encoded via C<TO_CBOR> cannot (normally) be automatically decoded,
366	objects encoded via C<FREEZE> can be decoded using the following protocol:	817	but objects encoded via C<FREEZE> can be decoded using the following
		818	protocol:
367		819
368	When an encoded CBOR perl object is encountered by the decoder, it will	820	When an encoded CBOR perl object is encountered by the decoder, it will
369	look up the C<THAW> method, by using the stored classname, and will fail	821	look up the C<THAW> method, by using the stored classname, and will fail
370	if the method cannot be found.	822	if the method cannot be found.
371		823
372	After the lookup it will call the C<THAW> method with the stored classname	824	After the lookup it will call the C<THAW> method with the stored classname
373	as first argument, the constant string C<CBOR> as second argument, and all	825	as first argument, the constant string C<CBOR> as second argument, and all
374	values returned by C<FREEZE> as remaining arguments.	826	values returned by C<FREEZE> as remaining arguments.
375		827
376	=head4 EXAMPLES	828	=head3 EXAMPLES
377		829
378	Here is an example C<TO_CBOR> method:	830	Here is an example C<TO_CBOR> method:
379		831
380	sub My::Object::TO_CBOR {	832	sub My::Object::TO_CBOR {
381	my ($obj) = @_;	833	my ($obj) = @_;
…		…
392		844
393	sub URI::TO_CBOR {	845	sub URI::TO_CBOR {
394	my ($self) = @_;	846	my ($self) = @_;
395	my $uri = "$self"; # stringify uri	847	my $uri = "$self"; # stringify uri
396	utf8::upgrade $uri; # make sure it will be encoded as UTF-8 string	848	utf8::upgrade $uri; # make sure it will be encoded as UTF-8 string
397	CBOR::XS::tagged 32, "$_[0]"	849	CBOR::XS::tag 32, "$_[0]"
398	}	850	}
399		851
400	This will encode URIs as a UTF-8 string with tag 32, which indicates an	852	This will encode URIs as a UTF-8 string with tag 32, which indicates an
401	URI.	853	URI.
402		854
…		…
413	"$self" # encode url string	865	"$self" # encode url string
414	}	866	}
415		867
416	sub URI::THAW {	868	sub URI::THAW {
417	my ($class, $serialiser, $uri) = @_;	869	my ($class, $serialiser, $uri) = @_;
418
419	$class->new ($uri)	870	$class->new ($uri)
420	}	871	}
421		872
422	Unlike C<TO_CBOR>, multiple values can be returned by C<FREEZE>. For	873	Unlike C<TO_CBOR>, multiple values can be returned by C<FREEZE>. For
423	example, a C<FREEZE> method that returns "type", "id" and "variant" values	874	example, a C<FREEZE> method that returns "type", "id" and "variant" values
…		…
439	=head1 MAGIC HEADER	890	=head1 MAGIC HEADER
440		891
441	There is no way to distinguish CBOR from other formats	892	There is no way to distinguish CBOR from other formats
442	programmatically. To make it easier to distinguish CBOR from other	893	programmatically. To make it easier to distinguish CBOR from other
443	formats, the CBOR specification has a special "magic string" that can be	894	formats, the CBOR specification has a special "magic string" that can be
444	prepended to any CBOR string without changing it's meaning.	895	prepended to any CBOR string without changing its meaning.
445		896
446	This string is available as C<$CBOR::XS::MAGIC>. This module does not	897	This string is available as C<$CBOR::XS::MAGIC>. This module does not
447	prepend this string tot he CBOR data it generates, but it will ignroe it	898	prepend this string to the CBOR data it generates, but it will ignore it
448	if present, so users can prepend this string as a "file type" indicator as	899	if present, so users can prepend this string as a "file type" indicator as
449	required.	900	required.
450		901
		902
		903	=head1 THE CBOR::XS::Tagged CLASS
		904
		905	CBOR has the concept of tagged values - any CBOR value can be tagged with
		906	a numeric 64 bit number, which are centrally administered.
		907
		908	C<CBOR::XS> handles a few tags internally when en- or decoding. You can
		909	also create tags yourself by encoding C<CBOR::XS::Tagged> objects, and the
		910	decoder will create C<CBOR::XS::Tagged> objects itself when it hits an
		911	unknown tag.
		912
		913	These objects are simply blessed array references - the first member of
		914	the array being the numerical tag, the second being the value.
		915
		916	You can interact with C<CBOR::XS::Tagged> objects in the following ways:
		917
		918	=over 4
		919
		920	=item $tagged = CBOR::XS::tag $tag, $value
		921
		922	This function(!) creates a new C<CBOR::XS::Tagged> object using the given
		923	C<$tag> (0..2**64-1) to tag the given C<$value> (which can be any Perl
		924	value that can be encoded in CBOR, including serialisable Perl objects and
		925	C<CBOR::XS::Tagged> objects).
		926
		927	=item $tagged->[0]
		928
		929	=item $tagged->[0] = $new_tag
		930
		931	=item $tag = $tagged->tag
		932
		933	=item $new_tag = $tagged->tag ($new_tag)
		934
		935	Access/mutate the tag.
		936
		937	=item $tagged->[1]
		938
		939	=item $tagged->[1] = $new_value
		940
		941	=item $value = $tagged->value
		942
		943	=item $new_value = $tagged->value ($new_value)
		944
		945	Access/mutate the tagged value.
		946
		947	=back
		948
		949	=cut
		950
		951	sub tag($$) {
		952	bless [@_], CBOR::XS::Tagged::;
		953	}
		954
		955	sub CBOR::XS::Tagged::tag {
		956	$_[0][0] = $_[1] if $#_;
		957	$_[0][0]
		958	}
		959
		960	sub CBOR::XS::Tagged::value {
		961	$_[0][1] = $_[1] if $#_;
		962	$_[0][1]
		963	}
		964
		965	=head2 EXAMPLES
		966
		967	Here are some examples of C<CBOR::XS::Tagged> uses to tag objects.
		968
		969	You can look up CBOR tag value and emanings in the IANA registry at
		970	L<http://www.iana.org/assignments/cbor-tags/cbor-tags.xhtml>.
		971
		972	Prepend a magic header (C<$CBOR::XS::MAGIC>):
		973
		974	my $cbor = encode_cbor CBOR::XS::tag 55799, $value;
		975	# same as:
		976	my $cbor = $CBOR::XS::MAGIC . encode_cbor $value;
		977
		978	Serialise some URIs and a regex in an array:
		979
		980	my $cbor = encode_cbor [
		981	(CBOR::XS::tag 32, "http://www.nethype.de/"),
		982	(CBOR::XS::tag 32, "http://software.schmorp.de/"),
		983	(CBOR::XS::tag 35, "^[Pp][Ee][Rr][lL]\$"),
		984	];
		985
		986	Wrap CBOR data in CBOR:
		987
		988	my $cbor_cbor = encode_cbor
		989	CBOR::XS::tag 24,
		990	encode_cbor [1, 2, 3];
		991
		992	=head1 TAG HANDLING AND EXTENSIONS
		993
		994	This section describes how this module handles specific tagged values
		995	and extensions. If a tag is not mentioned here and no additional filters
		996	are provided for it, then the default handling applies (creating a
		997	CBOR::XS::Tagged object on decoding, and only encoding the tag when
		998	explicitly requested).
		999
		1000	Tags not handled specifically are currently converted into a
		1001	L<CBOR::XS::Tagged> object, which is simply a blessed array reference
		1002	consisting of the numeric tag value followed by the (decoded) CBOR value.
		1003
		1004	Future versions of this module reserve the right to special case
		1005	additional tags (such as base64url).
		1006
		1007	=head2 ENFORCED TAGS
		1008
		1009	These tags are always handled when decoding, and their handling cannot be
		1010	overridden by the user.
		1011
		1012	=over 4
		1013
		1014	=item 26 (perl-object, L<http://cbor.schmorp.de/perl-object>)
		1015
		1016	These tags are automatically created (and decoded) for serialisable
		1017	objects using the C<FREEZE/THAW> methods (the L<Types::Serialier> object
		1018	serialisation protocol). See L<OBJECT SERIALISATION> for details.
		1019
		1020	=item 28, 29 (shareable, sharedref, L<http://cbor.schmorp.de/value-sharing>)
		1021
		1022	These tags are automatically decoded when encountered (and they do not
		1023	result in a cyclic data structure, see C<allow_cycles>), resulting in
		1024	shared values in the decoded object. They are only encoded, however, when
		1025	C<allow_sharing> is enabled.
		1026
		1027	Not all shared values can be successfully decoded: values that reference
		1028	themselves will I<currently> decode as C<undef> (this is not the same
		1029	as a reference pointing to itself, which will be represented as a value
		1030	that contains an indirect reference to itself - these will be decoded
		1031	properly).
		1032
		1033	Note that considerably more shared value data structures can be decoded
		1034	than will be encoded - currently, only values pointed to by references
		1035	will be shared, others will not. While non-reference shared values can be
		1036	generated in Perl with some effort, they were considered too unimportant
		1037	to be supported in the encoder. The decoder, however, will decode these
		1038	values as shared values.
		1039
		1040	=item 256, 25 (stringref-namespace, stringref, L<http://cbor.schmorp.de/stringref>)
		1041
		1042	These tags are automatically decoded when encountered. They are only
		1043	encoded, however, when C<pack_strings> is enabled.
		1044
		1045	=item 22098 (indirection, L<http://cbor.schmorp.de/indirection>)
		1046
		1047	This tag is automatically generated when a reference are encountered (with
		1048	the exception of hash and array references). It is converted to a reference
		1049	when decoding.
		1050
		1051	=item 55799 (self-describe CBOR, RFC 7049)
		1052
		1053	This value is not generated on encoding (unless explicitly requested by
		1054	the user), and is simply ignored when decoding.
		1055
		1056	=back
		1057
		1058	=head2 NON-ENFORCED TAGS
		1059
		1060	These tags have default filters provided when decoding. Their handling can
		1061	be overridden by changing the C<%CBOR::XS::FILTER> entry for the tag, or by
		1062	providing a custom C<filter> callback when decoding.
		1063
		1064	When they result in decoding into a specific Perl class, the module
		1065	usually provides a corresponding C<TO_CBOR> method as well.
		1066
		1067	When any of these need to load additional modules that are not part of the
		1068	perl core distribution (e.g. L<URI>), it is (currently) up to the user to
		1069	provide these modules. The decoding usually fails with an exception if the
		1070	required module cannot be loaded.
		1071
		1072	=over 4
		1073
		1074	=item 0, 1 (date/time string, seconds since the epoch)
		1075
		1076	These tags are decoded into L<Time::Piece> objects. The corresponding
		1077	C<Time::Piece::TO_CBOR> method always encodes into tag 1 values currently.
		1078
		1079	The L<Time::Piece> API is generally surprisingly bad, and fractional
		1080	seconds are only accidentally kept intact, so watch out. On the plus side,
		1081	the module comes with perl since 5.10, which has to count for something.
		1082
		1083	=item 2, 3 (positive/negative bignum)
		1084
		1085	These tags are decoded into L<Math::BigInt> objects. The corresponding
		1086	C<Math::BigInt::TO_CBOR> method encodes "small" bigints into normal CBOR
		1087	integers, and others into positive/negative CBOR bignums.
		1088
		1089	=item 4, 5, 264, 265 (decimal fraction/bigfloat)
		1090
		1091	Both decimal fractions and bigfloats are decoded into L<Math::BigFloat>
		1092	objects. The corresponding C<Math::BigFloat::TO_CBOR> method I<always>
		1093	encodes into a decimal fraction (either tag 4 or 264).
		1094
		1095	NaN and infinities are not encoded properly, as they cannot be represented
		1096	in CBOR.
		1097
		1098	See L<BIGNUM SECURITY CONSIDERATIONS> for more info.
		1099
		1100	=item 30 (rational numbers)
		1101
		1102	These tags are decoded into L<Math::BigRat> objects. The corresponding
		1103	C<Math::BigRat::TO_CBOR> method encodes rational numbers with denominator
		1104	C<1> via their numerator only, i.e., they become normal integers or
		1105	C<bignums>.
		1106
		1107	See L<BIGNUM SECURITY CONSIDERATIONS> for more info.
		1108
		1109	=item 21, 22, 23 (expected later JSON conversion)
		1110
		1111	CBOR::XS is not a CBOR-to-JSON converter, and will simply ignore these
		1112	tags.
		1113
		1114	=item 32 (URI)
		1115
		1116	These objects decode into L<URI> objects. The corresponding
		1117	C<URI::TO_CBOR> method again results in a CBOR URI value.
		1118
		1119	=back
		1120
		1121	=cut
451		1122
452	=head1 CBOR and JSON	1123	=head1 CBOR and JSON
453		1124
454	CBOR is supposed to implement a superset of the JSON data model, and is,	1125	CBOR is supposed to implement a superset of the JSON data model, and is,
455	with some coercion, able to represent all JSON texts (something that other	1126	with some coercion, able to represent all JSON texts (something that other
…		…
464	CBOR intact.	1135	CBOR intact.
465		1136
466		1137
467	=head1 SECURITY CONSIDERATIONS	1138	=head1 SECURITY CONSIDERATIONS
468		1139
469	When you are using CBOR in a protocol, talking to untrusted potentially	1140	Tl;dr... if you want to decode or encode CBOR from untrusted sources, you
470	hostile creatures requires relatively few measures.	1141	should start with a coder object created via C<new_safe> (which implements
		1142	the mitigations explained below):
471		1143
		1144	my $coder = CBOR::XS->new_safe;
		1145
		1146	my $data = $coder->decode ($cbor_text);
		1147	my $cbor = $coder->encode ($data);
		1148
		1149	Longer version: When you are using CBOR in a protocol, talking to
		1150	untrusted potentially hostile creatures requires some thought:
		1151
		1152	=over 4
		1153
		1154	=item Security of the CBOR decoder itself
		1155
472	First of all, your CBOR decoder should be secure, that is, should not have	1156	First and foremost, your CBOR decoder should be secure, that is, should
		1157	not have any buffer overflows or similar bugs that could potentially be
473	any buffer overflows. Obviously, this module should ensure that and I am	1158	exploited. Obviously, this module should ensure that and I am trying hard
474	trying hard on making that true, but you never know.	1159	on making that true, but you never know.
475		1160
		1161	=item CBOR::XS can invoke almost arbitrary callbacks during decoding
		1162
		1163	CBOR::XS supports object serialisation - decoding CBOR can cause calls
		1164	to I<any> C<THAW> method in I<any> package that exists in your process
		1165	(that is, CBOR::XS will not try to load modules, but any existing C<THAW>
		1166	method or function can be called, so they all have to be secure).
		1167
		1168	Less obviously, it will also invoke C<TO_CBOR> and C<FREEZE> methods -
		1169	even if all your C<THAW> methods are secure, encoding data structures from
		1170	untrusted sources can invoke those and trigger bugs in those.
		1171
		1172	So, if you are not sure about the security of all the modules you
		1173	have loaded (you shouldn't), you should disable this part using
		1174	C<forbid_objects> or using C<new_safe>.
		1175
		1176	=item CBOR can be extended with tags that call library code
		1177
		1178	CBOR can be extended with tags, and C<CBOR::XS> has a registry of
		1179	conversion functions for many existing tags that can be extended via
		1180	third-party modules (see the C<filter> method).
		1181
		1182	If you don't trust these, you should configure the "safe" filter function,
		1183	C<CBOR::XS::safe_filter> (C<new_safe> does this), which by default only
		1184	includes conversion functions that are considered "safe" by the author
		1185	(but again, they can be extended by third party modules).
		1186
		1187	Depending on your level of paranoia, you can use the "safe" filter:
		1188
		1189	$cbor->filter (\&CBOR::XS::safe_filter);
		1190
		1191	... your own filter...
		1192
		1193	$cbor->filter (sub { ... do your stuffs here ... });
		1194
		1195	... or even no filter at all, disabling all tag decoding:
		1196
		1197	$cbor->filter (sub { });
		1198
		1199	This is never a problem for encoding, as the tag mechanism only exists in
		1200	CBOR texts.
		1201
		1202	=item Resource-starving attacks: object memory usage
		1203
476	Second, you need to avoid resource-starving attacks. That means you should	1204	You need to avoid resource-starving attacks. That means you should limit
477	limit the size of CBOR data you accept, or make sure then when your	1205	the size of CBOR data you accept, or make sure then when your resources
478	resources run out, that's just fine (e.g. by using a separate process that	1206	run out, that's just fine (e.g. by using a separate process that can
479	can crash safely). The size of a CBOR string in octets is usually a good	1207	crash safely). The size of a CBOR string in octets is usually a good
480	indication of the size of the resources required to decode it into a Perl	1208	indication of the size of the resources required to decode it into a Perl
481	structure. While CBOR::XS can check the size of the CBOR text, it might be	1209	structure. While CBOR::XS can check the size of the CBOR text (using
482	too late when you already have it in memory, so you might want to check	1210	C<max_size> - done by C<new_safe>), it might be too late when you already
483	the size before you accept the string.	1211	have it in memory, so you might want to check the size before you accept
		1212	the string.
484		1213
		1214	As for encoding, it is possible to construct data structures that are
		1215	relatively small but result in large CBOR texts (for example by having an
		1216	array full of references to the same big data structure, which will all be
		1217	deep-cloned during encoding by default). This is rarely an actual issue
		1218	(and the worst case is still just running out of memory), but you can
		1219	reduce this risk by using C<allow_sharing>.
		1220
		1221	=item Resource-starving attacks: stack overflows
		1222
485	Third, CBOR::XS recurses using the C stack when decoding objects and	1223	CBOR::XS recurses using the C stack when decoding objects and arrays. The
486	arrays. The C stack is a limited resource: for instance, on my amd64	1224	C stack is a limited resource: for instance, on my amd64 machine with 8MB
487	machine with 8MB of stack size I can decode around 180k nested arrays but	1225	of stack size I can decode around 180k nested arrays but only 14k nested
488	only 14k nested CBOR objects (due to perl itself recursing deeply on croak	1226	CBOR objects (due to perl itself recursing deeply on croak to free the
489	to free the temporary). If that is exceeded, the program crashes. To be	1227	temporary). If that is exceeded, the program crashes. To be conservative,
490	conservative, the default nesting limit is set to 512. If your process	1228	the default nesting limit is set to 512. If your process has a smaller
491	has a smaller stack, you should adjust this setting accordingly with the	1229	stack, you should adjust this setting accordingly with the C<max_depth>
492	C<max_depth> method.	1230	method.
		1231
		1232	=item Resource-starving attacks: CPU en-/decoding complexity
		1233
		1234	CBOR::XS will use the L<Math::BigInt>, L<Math::BigFloat> and
		1235	L<Math::BigRat> libraries to represent encode/decode bignums. These can be
		1236	very slow (as in, centuries of CPU time) and can even crash your program
		1237	(and are generally not very trustworthy). See the next section on bignum
		1238	security for details.
		1239
		1240	=item Data breaches: leaking information in error messages
		1241
		1242	CBOR::XS might leak contents of your Perl data structures in its error
		1243	messages, so when you serialise sensitive information you might want to
		1244	make sure that exceptions thrown by CBOR::XS will not end up in front of
		1245	untrusted eyes.
		1246
		1247	=item Something else...
493		1248
494	Something else could bomb you, too, that I forgot to think of. In that	1249	Something else could bomb you, too, that I forgot to think of. In that
495	case, you get to keep the pieces. I am always open for hints, though...	1250	case, you get to keep the pieces. I am always open for hints, though...
496		1251
497	Also keep in mind that CBOR::XS might leak contents of your Perl data	1252	=back
498	structures in its error messages, so when you serialise sensitive	1253
499	information you might want to make sure that exceptions thrown by CBOR::XS	1254
500	will not end up in front of untrusted eyes.	1255	=head1 BIGNUM SECURITY CONSIDERATIONS
		1256
		1257	CBOR::XS provides a C<TO_CBOR> method for both L<Math::BigInt> and
		1258	L<Math::BigFloat> that tries to encode the number in the simplest possible
		1259	way, that is, either a CBOR integer, a CBOR bigint/decimal fraction (tag
		1260	4) or an arbitrary-exponent decimal fraction (tag 264). Rational numbers
		1261	(L<Math::BigRat>, tag 30) can also contain bignums as members.
		1262
		1263	CBOR::XS will also understand base-2 bigfloat or arbitrary-exponent
		1264	bigfloats (tags 5 and 265), but it will never generate these on its own.
		1265
		1266	Using the built-in L<Math::BigInt::Calc> support, encoding and decoding
		1267	decimal fractions is generally fast. Decoding bigints can be slow for very
		1268	big numbers (tens of thousands of digits, something that could potentially
		1269	be caught by limiting the size of CBOR texts), and decoding bigfloats or
		1270	arbitrary-exponent bigfloats can be I<extremely> slow (minutes, decades)
		1271	for large exponents (roughly 40 bit and longer).
		1272
		1273	Additionally, L<Math::BigInt> can take advantage of other bignum
		1274	libraries, such as L<Math::GMP>, which cannot handle big floats with large
		1275	exponents, and might simply abort or crash your program, due to their code
		1276	quality.
		1277
		1278	This can be a concern if you want to parse untrusted CBOR. If it is, you
		1279	might want to disable decoding of tag 2 (bigint) and 3 (negative bigint)
		1280	types. You should also disable types 5 and 265, as these can be slow even
		1281	without bigints.
		1282
		1283	Disabling bigints will also partially or fully disable types that rely on
		1284	them, e.g. rational numbers that use bignums.
		1285
501		1286
502	=head1 CBOR IMPLEMENTATION NOTES	1287	=head1 CBOR IMPLEMENTATION NOTES
503		1288
504	This section contains some random implementation notes. They do not	1289	This section contains some random implementation notes. They do not
505	describe guaranteed behaviour, but merely behaviour as-is implemented	1290	describe guaranteed behaviour, but merely behaviour as-is implemented
…		…
514	Only the double data type is supported for NV data types - when Perl uses	1299	Only the double data type is supported for NV data types - when Perl uses
515	long double to represent floating point values, they might not be encoded	1300	long double to represent floating point values, they might not be encoded
516	properly. Half precision types are accepted, but not encoded.	1301	properly. Half precision types are accepted, but not encoded.
517		1302
518	Strict mode and canonical mode are not implemented.	1303	Strict mode and canonical mode are not implemented.
		1304
		1305
		1306	=head1 LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT
		1307
		1308	On perls that were built without 64 bit integer support (these are rare
		1309	nowadays, even on 32 bit architectures, as all major Perl distributions
		1310	are built with 64 bit integer support), support for any kind of 64 bit
		1311	value in CBOR is very limited - most likely, these 64 bit values will
		1312	be truncated, corrupted, or otherwise not decoded correctly. This also
		1313	includes string, float, array and map sizes that are stored as 64 bit
		1314	integers.
519		1315
520		1316
521	=head1 THREADS	1317	=head1 THREADS
522		1318
523	This module is I<not> guaranteed to be thread safe and there are no	1319	This module is I<not> guaranteed to be thread safe and there are no
…		…
537	Please refrain from using rt.cpan.org or any other bug reporting	1333	Please refrain from using rt.cpan.org or any other bug reporting
538	service. I put the contact address into my modules for a reason.	1334	service. I put the contact address into my modules for a reason.
539		1335
540	=cut	1336	=cut
541		1337
		1338	# clumsy and slow hv_store-in-hash helper function
		1339	sub _hv_store {
		1340	$_[0]{$_[1]} = $_[2];
		1341	}
		1342
		1343	our %FILTER = (
		1344	0 => sub { # rfc4287 datetime, utf-8
		1345	require Time::Piece;
		1346	# Time::Piece::Strptime uses the "incredibly flexible date parsing routine"
		1347	# from FreeBSD, which can't parse ISO 8601, RFC3339, RFC4287 or much of anything
		1348	# else either. Whats incredibe over standard strptime totally escapes me.
		1349	# doesn't do fractional times, either. sigh.
		1350	# In fact, it's all a lie, it uses whatever strptime it wants, and of course,
		1351	# they are all incompatible. The openbsd one simply ignores %z (but according to the
		1352	# docs, it would be much more incredibly flexible indeed. If it worked, that is.).
		1353	scalar eval {
		1354	my $s = $_[1];
		1355
		1356	$s =~ s/Z$/+00:00/;
		1357	$s =~ s/(\.[0-9]+)?([+-][0-9][0-9]):([0-9][0-9])$//
		1358	or die;
		1359
		1360	my $b = $1 - ($2 * 60 + $3) * 60; # fractional part + offset. hopefully
		1361	my $d = Time::Piece->strptime ($s, "%Y-%m-%dT%H:%M:%S");
		1362
		1363	Time::Piece::gmtime ($d->epoch + $b)
		1364	} \|\| die "corrupted CBOR date/time string ($_[0])";
		1365	},
		1366
		1367	1 => sub { # seconds since the epoch, possibly fractional
		1368	require Time::Piece;
		1369	scalar Time::Piece::gmtime (pop)
		1370	},
		1371
		1372	2 => sub { # pos bigint
		1373	require Math::BigInt;
		1374	Math::BigInt->new ("0x" . unpack "H*", pop)
		1375	},
		1376
		1377	3 => sub { # neg bigint
		1378	require Math::BigInt;
		1379	-Math::BigInt->new ("0x" . unpack "H*", pop)
		1380	},
		1381
		1382	4 => sub { # decimal fraction, array
		1383	require Math::BigFloat;
		1384	Math::BigFloat->new ($_[1][1] . "E" . $_[1][0])
		1385	},
		1386
		1387	264 => sub { # decimal fraction with arbitrary exponent
		1388	require Math::BigFloat;
		1389	Math::BigFloat->new ($_[1][1] . "E" . $_[1][0])
		1390	},
		1391
		1392	5 => sub { # bigfloat, array
		1393	require Math::BigFloat;
		1394	scalar Math::BigFloat->new ($_[1][1]) * Math::BigFloat->new (2)->bpow ($_[1][0])
		1395	},
		1396
		1397	265 => sub { # bigfloat with arbitrary exponent
		1398	require Math::BigFloat;
		1399	scalar Math::BigFloat->new ($_[1][1]) * Math::BigFloat->new (2)->bpow ($_[1][0])
		1400	},
		1401
		1402	30 => sub { # rational number
		1403	require Math::BigRat;
		1404	Math::BigRat->new ("$_[1][0]/$_[1][1]") # separate parameters only work in recent versons
		1405	},
		1406
		1407	21 => sub { pop }, # expected conversion to base64url encoding
		1408	22 => sub { pop }, # expected conversion to base64 encoding
		1409	23 => sub { pop }, # expected conversion to base16 encoding
		1410
		1411	# 24 # embedded cbor, byte string
		1412
		1413	32 => sub {
		1414	require URI;
		1415	URI->new (pop)
		1416	},
		1417
		1418	# 33 # base64url rfc4648, utf-8
		1419	# 34 # base64 rfc46484, utf-8
		1420	# 35 # regex pcre/ecma262, utf-8
		1421	# 36 # mime message rfc2045, utf-8
		1422	);
		1423
		1424	sub default_filter {
		1425	&{ $FILTER{$_[0]} or return }
		1426	}
		1427
		1428	our %SAFE_FILTER = map { $_ => $FILTER{$_} } 0, 1, 21, 22, 23, 32;
		1429
		1430	sub safe_filter {
		1431	&{ $SAFE_FILTER{$_[0]} or return }
		1432	}
		1433
		1434	sub URI::TO_CBOR {
		1435	my $uri = $_[0]->as_string;
		1436	utf8::upgrade $uri;
		1437	tag 32, $uri
		1438	}
		1439
		1440	sub Math::BigInt::TO_CBOR {
		1441	if (-2147483648 <= $_[0] && $_[0] <= 2147483647) {
		1442	$_[0]->numify
		1443	} else {
		1444	my $hex = substr $_[0]->as_hex, 2;
		1445	$hex = "0$hex" if 1 & length $hex; # sigh
		1446	tag $_[0] >= 0 ? 2 : 3, pack "H*", $hex
		1447	}
		1448	}
		1449
		1450	sub Math::BigFloat::TO_CBOR {
		1451	my ($m, $e) = $_[0]->parts;
		1452
		1453	-9223372036854775808 <= $e && $e <= 18446744073709551615
		1454	? tag 4, [$e->numify, $m]
		1455	: tag 264, [$e, $m]
		1456	}
		1457
		1458	sub Math::BigRat::TO_CBOR {
		1459	my ($n, $d) = $_[0]->parts;
		1460
		1461	# older versions of BigRat need *1, as they not always return numbers
		1462
		1463	$d*1 == 1
		1464	? $n*1
		1465	: tag 30, [$n1, $d1]
		1466	}
		1467
		1468	sub Time::Piece::TO_CBOR {
		1469	tag 1, 0 + $_[0]->epoch
		1470	}
		1471
542	XSLoader::load "CBOR::XS", $VERSION;	1472	XSLoader::load "CBOR::XS", $VERSION;
543		1473
544	=head1 SEE ALSO	1474	=head1 SEE ALSO
545		1475
546	The L<JSON> and L<JSON::XS> modules that do similar, but human-readable,	1476	The L<JSON> and L<JSON::XS> modules that do similar, but human-readable,

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing CBOR-XS/XS.pm (file contents): Revision 1.7 by root, Sun Oct 27 22:35:15 2013 UTC vs. Revision 1.76 by root, Tue Dec 1 01:49:47 2020 UTC

Diff Legend

Comparing CBOR-XS/XS.pm (file contents):
Revision 1.7 by root, Sun Oct 27 22:35:15 2013 UTC vs.
Revision 1.76 by root, Tue Dec 1 01:49:47 2020 UTC