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

Comparing CBOR-XS/XS.pm (file contents):
Revision 1.31 by root, Sat Nov 30 18:13:53 2013 UTC vs.
Revision 1.69 by root, Sat Nov 9 07:23:31 2019 UTC

…		…
38	with the added ability of supporting serialisation of Perl objects. (JSON	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	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	40	data later and speed is less important you might want to compare both
41	formats first).	41	formats first).
42		42
		43	The primary goal of this module is to be I<correct> and the secondary goal
		44	is to be I<fast>. To reach the latter goal it was written in C.
		45
43	To give you a general idea about speed, with texts in the megabyte range,	46	To give you a general idea about speed, with texts in the megabyte range,
44	C<CBOR::XS> usually encodes roughly twice as fast as L<Storable> or	47	C<CBOR::XS> usually encodes roughly twice as fast as L<Storable> or
45	L<JSON::XS> and decodes about 15%-30% faster than those. The shorter the	48	L<JSON::XS> and decodes about 15%-30% faster than those. The shorter the
46	data, the worse L<Storable> performs in comparison.	49	data, the worse L<Storable> performs in comparison.
47		50
…		…
52	In addition to the core CBOR data format, this module implements a	55	In addition to the core CBOR data format, this module implements a
53	number of extensions, to support cyclic and shared data structures	56	number of extensions, to support cyclic and shared data structures
54	(see C<allow_sharing> and C<allow_cycles>), string deduplication (see	57	(see C<allow_sharing> and C<allow_cycles>), string deduplication (see
55	C<pack_strings>) and scalar references (always enabled).	58	C<pack_strings>) and scalar references (always enabled).
56		59
57	The primary goal of this module is to be I<correct> and the secondary goal
58	is to be I<fast>. To reach the latter goal it was written in C.
59
60	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
61	vice versa.	61	vice versa.
62		62
63	=cut	63	=cut
64		64
65	package CBOR::XS;	65	package CBOR::XS;
66		66
67	use common::sense;	67	use common::sense;
68		68
69	our $VERSION = '1.0';	69	our $VERSION = 1.71;
70	our @ISA = qw(Exporter);	70	our @ISA = qw(Exporter);
71		71
72	our @EXPORT = qw(encode_cbor decode_cbor);	72	our @EXPORT = qw(encode_cbor decode_cbor);
73		73
74	use Exporter;	74	use Exporter;
…		…
112		112
113	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
114	be chained:	114	be chained:
115		115
116	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	}
117		142
118	=item $cbor = $cbor->max_depth ([$maximum_nesting_depth])	143	=item $cbor = $cbor->max_depth ([$maximum_nesting_depth])
119		144
120	=item $max_depth = $cbor->get_max_depth	145	=item $max_depth = $cbor->get_max_depth
121		146
…		…
137		162
138	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
139	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
140	crashing.	165	crashing.
141		166
142	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.
143		168
144	=item $cbor = $cbor->max_size ([$maximum_string_size])	169	=item $cbor = $cbor->max_size ([$maximum_string_size])
145		170
146	=item $max_size = $cbor->get_max_size	171	=item $max_size = $cbor->get_max_size
147		172
…		…
152	effect on C<encode> (yet).	177	effect on C<encode> (yet).
153		178
154	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
155	C<0> is specified).	180	C<0> is specified).
156		181
157	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.
158		183
159	=item $cbor = $cbor->allow_unknown ([$enable])	184	=item $cbor = $cbor->allow_unknown ([$enable])
160		185
161	=item $enabled = $cbor->get_allow_unknown	186	=item $enabled = $cbor->get_allow_unknown
162		187
…		…
180	reference to the earlier value.	205	reference to the earlier value.
181		206
182	This means that such values will only be encoded once, and will not result	207	This means that such values will only be encoded once, and will not result
183	in a deep cloning of the value on decode, in decoders supporting the value	208	in a deep cloning of the value on decode, in decoders supporting the value
184	sharing extension. This also makes it possible to encode cyclic data	209	sharing extension. This also makes it possible to encode cyclic data
185	structures (which need C<allow_cycles> to ne enabled to be decoded by this	210	structures (which need C<allow_cycles> to be enabled to be decoded by this
186	module).	211	module).
187		212
188	It is recommended to leave it off unless you know your	213	It is recommended to leave it off unless you know your
189	communication partner supports the value sharing extensions to CBOR	214	communication partner supports the value sharing extensions to CBOR
190	(L<http://cbor.schmorp.de/value-sharing>), as without decoder support, the	215	(L<http://cbor.schmorp.de/value-sharing>), as without decoder support, the
191	resulting data structure might be unusable.	216	resulting data structure might be unusable.
192		217
193	Detecting shared values incurs a runtime overhead when values are encoded	218	Detecting shared values incurs a runtime overhead when values are encoded
194	that have a reference counter large than one, and might unnecessarily	219	that have a reference counter large than one, and might unnecessarily
195	increase the encoded size, as potentially shared values are encode as	220	increase the encoded size, as potentially shared values are encoded as
196	shareable whether or not they are actually shared.	221	shareable whether or not they are actually shared.
197		222
198	At the moment, only targets of references can be shared (e.g. scalars,	223	At the moment, only targets of references can be shared (e.g. scalars,
199	arrays or hashes pointed to by a reference). Weirder constructs, such as	224	arrays or hashes pointed to by a reference). Weirder constructs, such as
200	an array with multiple "copies" of the I<same> string, which are hard but	225	an array with multiple "copies" of the I<same> string, which are hard but
…		…
218	isn't prepared for this will not leak memory.	243	isn't prepared for this will not leak memory.
219		244
220	If C<$enable> is false (the default), then C<decode> will throw an error	245	If C<$enable> is false (the default), then C<decode> will throw an error
221	when it encounters a self-referential/cyclic data structure.	246	when it encounters a self-referential/cyclic data structure.
222		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
223	This option does not affect C<encode> in any way - shared values and	253	This option does not affect C<encode> in any way - shared values and
224	references will always be decoded properly if present.	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.
225		274
226	=item $cbor = $cbor->pack_strings ([$enable])	275	=item $cbor = $cbor->pack_strings ([$enable])
227		276
228	=item $enabled = $cbor->get_pack_strings	277	=item $enabled = $cbor->get_pack_strings
229		278
…		…
242	the standard CBOR way.	291	the standard CBOR way.
243		292
244	This option does not affect C<decode> in any way - string references will	293	This option does not affect C<decode> in any way - string references will
245	always be decoded properly if present.	294	always be decoded properly if present.
246		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 encode byte
		336	strings, which might break some C<FREEZE> and C<TO_CBOR> methods that rely
		337	on this, such as bignum encoding, so this option is mainly useful for very
		338	simple data.
		339
		340	=item $cbor = $cbor->validate_utf8 ([$enable])
		341
		342	=item $enabled = $cbor->get_validate_utf8
		343
		344	If C<$enable> is true (or missing), then C<decode> will validate that
		345	elements (text strings) containing UTF-8 data in fact contain valid UTF-8
		346	data (instead of blindly accepting it). This validation obviously takes
		347	extra time during decoding.
		348
		349	The concept of "valid UTF-8" used is perl's concept, which is a superset
		350	of the official UTF-8.
		351
		352	If C<$enable> is false (the default), then C<decode> will blindly accept
		353	UTF-8 data, marking them as valid UTF-8 in the resulting data structure
		354	regardless of whether that's true or not.
		355
		356	Perl isn't too happy about corrupted UTF-8 in strings, but should
		357	generally not crash or do similarly evil things. Extensions might be not
		358	so forgiving, so it's recommended to turn on this setting if you receive
		359	untrusted CBOR.
		360
		361	This option does not affect C<encode> in any way - strings that are
		362	supposedly valid UTF-8 will simply be dumped into the resulting CBOR
		363	string without checking whether that is, in fact, true or not.
		364
247	=item $cbor = $cbor->filter ([$cb->($tag, $value)])	365	=item $cbor = $cbor->filter ([$cb->($tag, $value)])
248		366
249	=item $cb_or_undef = $cbor->get_filter	367	=item $cb_or_undef = $cbor->get_filter
250		368
251	Sets or replaces the tagged value decoding filter (when C<$cb> is	369	Sets or replaces the tagged value decoding filter (when C<$cb> is
…		…
263	replace the tagged value in the decoded data structure, or no values,	381	replace the tagged value in the decoded data structure, or no values,
264	which will result in default handling, which currently means the decoder	382	which will result in default handling, which currently means the decoder
265	creates a C<CBOR::XS::Tagged> object to hold the tag and the value.	383	creates a C<CBOR::XS::Tagged> object to hold the tag and the value.
266		384
267	When the filter is cleared (the default state), the default filter	385	When the filter is cleared (the default state), the default filter
268	function, C<CBOR::XS::default_filter>, is used. This function simply looks	386	function, C<CBOR::XS::default_filter>, is used. This function simply
269	up the tag in the C<%CBOR::XS::FILTER> hash. If an entry exists it must be	387	looks up the tag in the C<%CBOR::XS::FILTER> hash. If an entry exists
270	a code reference that is called with tag and value, and is responsible for	388	it must be a code reference that is called with tag and value, and is
271	decoding the value. If no entry exists, it returns no values.	389	responsible for decoding the value. If no entry exists, it returns no
		390	values. C<CBOR::XS> provides a number of default filter functions already,
		391	the the C<%CBOR::XS::FILTER> hash can be freely extended with more.
		392
		393	C<CBOR::XS> additionally provides an alternative filter function that is
		394	supposed to be safe to use with untrusted data (which the default filter
		395	might not), called C<CBOR::XS::safe_filter>, which works the same as
		396	the C<default_filter> but uses the C<%CBOR::XS::SAFE_FILTER> variable
		397	instead. It is prepopulated with the tag decoding functions that are
		398	deemed safe (basically the same as C<%CBOR::XS::FILTER> without all
		399	the bignum tags), and can be extended by user code as wlel, although,
		400	obviously, one should be very careful about adding decoding functions
		401	here, since the expectation is that they are safe to use on untrusted
		402	data, after all.
272		403
273	Example: decode all tags not handled internally into C<CBOR::XS::Tagged>	404	Example: decode all tags not handled internally into C<CBOR::XS::Tagged>
274	objects, with no other special handling (useful when working with	405	objects, with no other special handling (useful when working with
275	potentially "unsafe" CBOR data).	406	potentially "unsafe" CBOR data).
276		407
…		…
283	my ($tag, $value);	414	my ($tag, $value);
284		415
285	"tag 1347375694 value $value"	416	"tag 1347375694 value $value"
286	};	417	};
287		418
		419	Example: provide your own filter function that looks up tags in your own
		420	hash:
		421
		422	my %my_filter = (
		423	998347484 => sub {
		424	my ($tag, $value);
		425
		426	"tag 998347484 value $value"
		427	};
		428	);
		429
		430	my $coder = CBOR::XS->new->filter (sub {
		431	&{ $my_filter{$_[0]} or return }
		432	});
		433
		434
		435	Example: use the safe filter function (see L<SECURITY CONSIDERATIONS> for
		436	more considerations on security).
		437
		438	CBOR::XS->new->filter (\&CBOR::XS::safe_filter)->decode ($cbor_data);
		439
288	=item $cbor_data = $cbor->encode ($perl_scalar)	440	=item $cbor_data = $cbor->encode ($perl_scalar)
289		441
290	Converts the given Perl data structure (a scalar value) to its CBOR	442	Converts the given Perl data structure (a scalar value) to its CBOR
291	representation.	443	representation.
292		444
…		…
305	and you need to know where the first CBOR string ends amd the next one	457	and you need to know where the first CBOR string ends amd the next one
306	starts.	458	starts.
307		459
308	CBOR::XS->new->decode_prefix ("......")	460	CBOR::XS->new->decode_prefix ("......")
309	=> ("...", 3)	461	=> ("...", 3)
		462
		463	=back
		464
		465	=head2 INCREMENTAL PARSING
		466
		467	In some cases, there is the need for incremental parsing of JSON
		468	texts. While this module always has to keep both CBOR text and resulting
		469	Perl data structure in memory at one time, it does allow you to parse a
		470	CBOR stream incrementally, using a similar to using "decode_prefix" to see
		471	if a full CBOR object is available, but is much more efficient.
		472
		473	It basically works by parsing as much of a CBOR string as possible - if
		474	the CBOR data is not complete yet, the pasrer will remember where it was,
		475	to be able to restart when more data has been accumulated. Once enough
		476	data is available to either decode a complete CBOR value or raise an
		477	error, a real decode will be attempted.
		478
		479	A typical use case would be a network protocol that consists of sending
		480	and receiving CBOR-encoded messages. The solution that works with CBOR and
		481	about anything else is by prepending a length to every CBOR value, so the
		482	receiver knows how many octets to read. More compact (and slightly slower)
		483	would be to just send CBOR values back-to-back, as C<CBOR::XS> knows where
		484	a CBOR value ends, and doesn't need an explicit length.
		485
		486	The following methods help with this:
		487
		488	=over 4
		489
		490	=item @decoded = $cbor->incr_parse ($buffer)
		491
		492	This method attempts to decode exactly one CBOR value from the beginning
		493	of the given C<$buffer>. The value is removed from the C<$buffer> on
		494	success. When C<$buffer> doesn't contain a complete value yet, it returns
		495	nothing. Finally, when the C<$buffer> doesn't start with something
		496	that could ever be a valid CBOR value, it raises an exception, just as
		497	C<decode> would. In the latter case the decoder state is undefined and
		498	must be reset before being able to parse further.
		499
		500	This method modifies the C<$buffer> in place. When no CBOR value can be
		501	decoded, the decoder stores the current string offset. On the next call,
		502	continues decoding at the place where it stopped before. For this to make
		503	sense, the C<$buffer> must begin with the same octets as on previous
		504	unsuccessful calls.
		505
		506	You can call this method in scalar context, in which case it either
		507	returns a decoded value or C<undef>. This makes it impossible to
		508	distinguish between CBOR null values (which decode to C<undef>) and an
		509	unsuccessful decode, which is often acceptable.
		510
		511	=item @decoded = $cbor->incr_parse_multiple ($buffer)
		512
		513	Same as C<incr_parse>, but attempts to decode as many CBOR values as
		514	possible in one go, instead of at most one. Calls to C<incr_parse> and
		515	C<incr_parse_multiple> can be interleaved.
		516
		517	=item $cbor->incr_reset
		518
		519	Resets the incremental decoder. This throws away any saved state, so that
		520	subsequent calls to C<incr_parse> or C<incr_parse_multiple> start to parse
		521	a new CBOR value from the beginning of the C<$buffer> again.
		522
		523	This method can be called at any time, but it I<must> be called if you want
		524	to change your C<$buffer> or there was a decoding error and you want to
		525	reuse the C<$cbor> object for future incremental parsings.
310		526
311	=back	527	=back
312		528
313		529
314	=head1 MAPPING	530	=head1 MAPPING
…		…
387		603
388	=item hash references	604	=item hash references
389		605
390	Perl hash references become CBOR maps. As there is no inherent ordering in	606	Perl hash references become CBOR maps. As there is no inherent ordering in
391	hash keys (or CBOR maps), they will usually be encoded in a pseudo-random	607	hash keys (or CBOR maps), they will usually be encoded in a pseudo-random
392	order. This order can be different each time a hahs is encoded.	608	order. This order can be different each time a hash is encoded.
393		609
394	Currently, tied hashes will use the indefinite-length format, while normal	610	Currently, tied hashes will use the indefinite-length format, while normal
395	hashes will use the fixed-length format.	611	hashes will use the fixed-length format.
396		612
397	=item array references	613	=item array references
…		…
450	my $x = 3.1; # some variable containing a number	666	my $x = 3.1; # some variable containing a number
451	"$x"; # stringified	667	"$x"; # stringified
452	$x .= ""; # another, more awkward way to stringify	668	$x .= ""; # another, more awkward way to stringify
453	print $x; # perl does it for you, too, quite often	669	print $x; # perl does it for you, too, quite often
454		670
455	You can force whether a string ie encoded as byte or text string by using	671	You can force whether a string is encoded as byte or text string by using
456	C<utf8::upgrade> and C<utf8::downgrade>):	672	C<utf8::upgrade> and C<utf8::downgrade> (if C<text_strings> is disabled):
457		673
458	utf8::upgrade $x; # encode $x as text string	674	utf8::upgrade $x; # encode $x as text string
459	utf8::downgrade $x; # encode $x as byte string	675	utf8::downgrade $x; # encode $x as byte string
460		676
461	Perl doesn't define what operations up- and downgrade strings, so if the	677	Perl doesn't define what operations up- and downgrade strings, so if the
462	difference between byte and text is important, you should up- or downgrade	678	difference between byte and text is important, you should up- or downgrade
463	your string as late as possible before encoding.	679	your string as late as possible before encoding. You can also force the
		680	use of CBOR text strings by using C<text_keys> or C<text_strings>.
464		681
465	You can force the type to be a CBOR number by numifying it:	682	You can force the type to be a CBOR number by numifying it:
466		683
467	my $x = "3"; # some variable containing a string	684	my $x = "3"; # some variable containing a string
468	$x += 0; # numify it, ensuring it will be dumped as a number	685	$x += 0; # numify it, ensuring it will be dumped as a number
…		…
569	"$self" # encode url string	786	"$self" # encode url string
570	}	787	}
571		788
572	sub URI::THAW {	789	sub URI::THAW {
573	my ($class, $serialiser, $uri) = @_;	790	my ($class, $serialiser, $uri) = @_;
574
575	$class->new ($uri)	791	$class->new ($uri)
576	}	792	}
577		793
578	Unlike C<TO_CBOR>, multiple values can be returned by C<FREEZE>. For	794	Unlike C<TO_CBOR>, multiple values can be returned by C<FREEZE>. For
579	example, a C<FREEZE> method that returns "type", "id" and "variant" values	795	example, a C<FREEZE> method that returns "type", "id" and "variant" values
…		…
710	additional tags (such as base64url).	926	additional tags (such as base64url).
711		927
712	=head2 ENFORCED TAGS	928	=head2 ENFORCED TAGS
713		929
714	These tags are always handled when decoding, and their handling cannot be	930	These tags are always handled when decoding, and their handling cannot be
715	overriden by the user.	931	overridden by the user.
716		932
717	=over 4	933	=over 4
718		934
719	=item 26 (perl-object, L<http://cbor.schmorp.de/perl-object>)	935	=item 26 (perl-object, L<http://cbor.schmorp.de/perl-object>)
720		936
721	These tags are automatically created (and decoded) for serialisable	937	These tags are automatically created (and decoded) for serialisable
722	objects using the C<FREEZE/THAW> methods (the L<Types::Serialier> object	938	objects using the C<FREEZE/THAW> methods (the L<Types::Serialier> object
723	serialisation protocol). See L<OBJECT SERIALISATION> for details.	939	serialisation protocol). See L<OBJECT SERIALISATION> for details.
724		940
725	=item 28, 29 (shareable, sharedref, L <http://cbor.schmorp.de/value-sharing>)	941	=item 28, 29 (shareable, sharedref, L<http://cbor.schmorp.de/value-sharing>)
726		942
727	These tags are automatically decoded when encountered (and they do not	943	These tags are automatically decoded when encountered (and they do not
728	result in a cyclic data structure, see C<allow_cycles>), resulting in	944	result in a cyclic data structure, see C<allow_cycles>), resulting in
729	shared values in the decoded object. They are only encoded, however, when	945	shared values in the decoded object. They are only encoded, however, when
730	C<allow_sharing> is enabled.	946	C<allow_sharing> is enabled.
…		…
740	will be shared, others will not. While non-reference shared values can be	956	will be shared, others will not. While non-reference shared values can be
741	generated in Perl with some effort, they were considered too unimportant	957	generated in Perl with some effort, they were considered too unimportant
742	to be supported in the encoder. The decoder, however, will decode these	958	to be supported in the encoder. The decoder, however, will decode these
743	values as shared values.	959	values as shared values.
744		960
745	=item 256, 25 (stringref-namespace, stringref, L <http://cbor.schmorp.de/stringref>)	961	=item 256, 25 (stringref-namespace, stringref, L<http://cbor.schmorp.de/stringref>)
746		962
747	These tags are automatically decoded when encountered. They are only	963	These tags are automatically decoded when encountered. They are only
748	encoded, however, when C<pack_strings> is enabled.	964	encoded, however, when C<pack_strings> is enabled.
749		965
750	=item 22098 (indirection, L<http://cbor.schmorp.de/indirection>)	966	=item 22098 (indirection, L<http://cbor.schmorp.de/indirection>)
751		967
752	This tag is automatically generated when a reference are encountered (with	968	This tag is automatically generated when a reference are encountered (with
753	the exception of hash and array refernces). It is converted to a reference	969	the exception of hash and array references). It is converted to a reference
754	when decoding.	970	when decoding.
755		971
756	=item 55799 (self-describe CBOR, RFC 7049)	972	=item 55799 (self-describe CBOR, RFC 7049)
757		973
758	This value is not generated on encoding (unless explicitly requested by	974	This value is not generated on encoding (unless explicitly requested by
…		…
761	=back	977	=back
762		978
763	=head2 NON-ENFORCED TAGS	979	=head2 NON-ENFORCED TAGS
764		980
765	These tags have default filters provided when decoding. Their handling can	981	These tags have default filters provided when decoding. Their handling can
766	be overriden by changing the C<%CBOR::XS::FILTER> entry for the tag, or by	982	be overridden by changing the C<%CBOR::XS::FILTER> entry for the tag, or by
767	providing a custom C<filter> callback when decoding.	983	providing a custom C<filter> callback when decoding.
768		984
769	When they result in decoding into a specific Perl class, the module	985	When they result in decoding into a specific Perl class, the module
770	usually provides a corresponding C<TO_CBOR> method as well.	986	usually provides a corresponding C<TO_CBOR> method as well.
771		987
…		…
774	provide these modules. The decoding usually fails with an exception if the	990	provide these modules. The decoding usually fails with an exception if the
775	required module cannot be loaded.	991	required module cannot be loaded.
776		992
777	=over 4	993	=over 4
778		994
		995	=item 0, 1 (date/time string, seconds since the epoch)
		996
		997	These tags are decoded into L<Time::Piece> objects. The corresponding
		998	C<Time::Piece::TO_CBOR> method always encodes into tag 1 values currently.
		999
		1000	The L<Time::Piece> API is generally surprisingly bad, and fractional
		1001	seconds are only accidentally kept intact, so watch out. On the plus side,
		1002	the module comes with perl since 5.10, which has to count for something.
		1003
779	=item 2, 3 (positive/negative bignum)	1004	=item 2, 3 (positive/negative bignum)
780		1005
781	These tags are decoded into L<Math::BigInt> objects. The corresponding	1006	These tags are decoded into L<Math::BigInt> objects. The corresponding
782	C<Math::BigInt::TO_CBOR> method encodes "small" bigints into normal CBOR	1007	C<Math::BigInt::TO_CBOR> method encodes "small" bigints into normal CBOR
783	integers, and others into positive/negative CBOR bignums.	1008	integers, and others into positive/negative CBOR bignums.
784		1009
785	=item 4, 5 (decimal fraction/bigfloat)	1010	=item 4, 5, 264, 265 (decimal fraction/bigfloat)
786		1011
787	Both decimal fractions and bigfloats are decoded into L<Math::BigFloat>	1012	Both decimal fractions and bigfloats are decoded into L<Math::BigFloat>
788	objects. The corresponding C<Math::BigFloat::TO_CBOR> method I<always>	1013	objects. The corresponding C<Math::BigFloat::TO_CBOR> method I<always>
789	encodes into a decimal fraction.	1014	encodes into a decimal fraction (either tag 4 or 264).
790		1015
791	CBOR cannot represent bigfloats with I<very> large exponents - conversion	1016	NaN and infinities are not encoded properly, as they cannot be represented
792	of such big float objects is undefined.	1017	in CBOR.
793		1018
794	Also, NaN and infinities are not encoded properly.	1019	See L<BIGNUM SECURITY CONSIDERATIONS> for more info.
		1020
		1021	=item 30 (rational numbers)
		1022
		1023	These tags are decoded into L<Math::BigRat> objects. The corresponding
		1024	C<Math::BigRat::TO_CBOR> method encodes rational numbers with denominator
		1025	C<1> via their numerator only, i.e., they become normal integers or
		1026	C<bignums>.
		1027
		1028	See L<BIGNUM SECURITY CONSIDERATIONS> for more info.
795		1029
796	=item 21, 22, 23 (expected later JSON conversion)	1030	=item 21, 22, 23 (expected later JSON conversion)
797		1031
798	CBOR::XS is not a CBOR-to-JSON converter, and will simply ignore these	1032	CBOR::XS is not a CBOR-to-JSON converter, and will simply ignore these
799	tags.	1033	tags.
…		…
804	C<URI::TO_CBOR> method again results in a CBOR URI value.	1038	C<URI::TO_CBOR> method again results in a CBOR URI value.
805		1039
806	=back	1040	=back
807		1041
808	=cut	1042	=cut
809
810	our %FILTER = (
811	# 0 # rfc4287 datetime, utf-8
812	# 1 # unix timestamp, any
813
814	2 => sub { # pos bigint
815	require Math::BigInt;
816	Math::BigInt->new ("0x" . unpack "H*", pop)
817	},
818
819	3 => sub { # neg bigint
820	require Math::BigInt;
821	-Math::BigInt->new ("0x" . unpack "H*", pop)
822	},
823
824	4 => sub { # decimal fraction, array
825	require Math::BigFloat;
826	Math::BigFloat->new ($_[1][1] . "E" . $_[1][0])
827	},
828
829	5 => sub { # bigfloat, array
830	require Math::BigFloat;
831	scalar Math::BigFloat->new ($_[1][1])->blsft ($_[1][0], 2)
832	},
833
834	21 => sub { pop }, # expected conversion to base64url encoding
835	22 => sub { pop }, # expected conversion to base64 encoding
836	23 => sub { pop }, # expected conversion to base16 encoding
837
838	# 24 # embedded cbor, byte string
839
840	32 => sub {
841	require URI;
842	URI->new (pop)
843	},
844
845	# 33 # base64url rfc4648, utf-8
846	# 34 # base64 rfc46484, utf-8
847	# 35 # regex pcre/ecma262, utf-8
848	# 36 # mime message rfc2045, utf-8
849	);
850
851		1043
852	=head1 CBOR and JSON	1044	=head1 CBOR and JSON
853		1045
854	CBOR is supposed to implement a superset of the JSON data model, and is,	1046	CBOR is supposed to implement a superset of the JSON data model, and is,
855	with some coercion, able to represent all JSON texts (something that other	1047	with some coercion, able to represent all JSON texts (something that other
…		…
864	CBOR intact.	1056	CBOR intact.
865		1057
866		1058
867	=head1 SECURITY CONSIDERATIONS	1059	=head1 SECURITY CONSIDERATIONS
868		1060
869	When you are using CBOR in a protocol, talking to untrusted potentially	1061	Tl;dr... if you want to decode or encode CBOR from untrusted sources, you
870	hostile creatures requires relatively few measures.	1062	should start with a coder object created via C<new_safe> (which implements
		1063	the mitigations explained below):
871		1064
		1065	my $coder = CBOR::XS->new_safe;
		1066
		1067	my $data = $coder->decode ($cbor_text);
		1068	my $cbor = $coder->encode ($data);
		1069
		1070	Longer version: When you are using CBOR in a protocol, talking to
		1071	untrusted potentially hostile creatures requires some thought:
		1072
		1073	=over 4
		1074
		1075	=item Security of the CBOR decoder itself
		1076
872	First of all, your CBOR decoder should be secure, that is, should not have	1077	First and foremost, your CBOR decoder should be secure, that is, should
		1078	not have any buffer overflows or similar bugs that could potentially be
873	any buffer overflows. Obviously, this module should ensure that and I am	1079	exploited. Obviously, this module should ensure that and I am trying hard
874	trying hard on making that true, but you never know.	1080	on making that true, but you never know.
875		1081
		1082	=item CBOR::XS can invoke almost arbitrary callbacks during decoding
		1083
		1084	CBOR::XS supports object serialisation - decoding CBOR can cause calls
		1085	to I<any> C<THAW> method in I<any> package that exists in your process
		1086	(that is, CBOR::XS will not try to load modules, but any existing C<THAW>
		1087	method or function can be called, so they all have to be secure).
		1088
		1089	Less obviously, it will also invoke C<TO_CBOR> and C<FREEZE> methods -
		1090	even if all your C<THAW> methods are secure, encoding data structures from
		1091	untrusted sources can invoke those and trigger bugs in those.
		1092
		1093	So, if you are not sure about the security of all the modules you
		1094	have loaded (you shouldn't), you should disable this part using
		1095	C<forbid_objects> or using C<new_safe>.
		1096
		1097	=item CBOR can be extended with tags that call library code
		1098
		1099	CBOR can be extended with tags, and C<CBOR::XS> has a registry of
		1100	conversion functions for many existing tags that can be extended via
		1101	third-party modules (see the C<filter> method).
		1102
		1103	If you don't trust these, you should configure the "safe" filter function,
		1104	C<CBOR::XS::safe_filter> (C<new_safe> does this), which by default only
		1105	includes conversion functions that are considered "safe" by the author
		1106	(but again, they can be extended by third party modules).
		1107
		1108	Depending on your level of paranoia, you can use the "safe" filter:
		1109
		1110	$cbor->filter (\&CBOR::XS::safe_filter);
		1111
		1112	... your own filter...
		1113
		1114	$cbor->filter (sub { ... do your stuffs here ... });
		1115
		1116	... or even no filter at all, disabling all tag decoding:
		1117
		1118	$cbor->filter (sub { });
		1119
		1120	This is never a problem for encoding, as the tag mechanism only exists in
		1121	CBOR texts.
		1122
		1123	=item Resource-starving attacks: object memory usage
		1124
876	Second, you need to avoid resource-starving attacks. That means you should	1125	You need to avoid resource-starving attacks. That means you should limit
877	limit the size of CBOR data you accept, or make sure then when your	1126	the size of CBOR data you accept, or make sure then when your resources
878	resources run out, that's just fine (e.g. by using a separate process that	1127	run out, that's just fine (e.g. by using a separate process that can
879	can crash safely). The size of a CBOR string in octets is usually a good	1128	crash safely). The size of a CBOR string in octets is usually a good
880	indication of the size of the resources required to decode it into a Perl	1129	indication of the size of the resources required to decode it into a Perl
881	structure. While CBOR::XS can check the size of the CBOR text, it might be	1130	structure. While CBOR::XS can check the size of the CBOR text (using
882	too late when you already have it in memory, so you might want to check	1131	C<max_size> - done by C<new_safe>), it might be too late when you already
883	the size before you accept the string.	1132	have it in memory, so you might want to check the size before you accept
		1133	the string.
884		1134
		1135	As for encoding, it is possible to construct data structures that are
		1136	relatively small but result in large CBOR texts (for example by having an
		1137	array full of references to the same big data structure, which will all be
		1138	deep-cloned during encoding by default). This is rarely an actual issue
		1139	(and the worst case is still just running out of memory), but you can
		1140	reduce this risk by using C<allow_sharing>.
		1141
		1142	=item Resource-starving attacks: stack overflows
		1143
885	Third, CBOR::XS recurses using the C stack when decoding objects and	1144	CBOR::XS recurses using the C stack when decoding objects and arrays. The
886	arrays. The C stack is a limited resource: for instance, on my amd64	1145	C stack is a limited resource: for instance, on my amd64 machine with 8MB
887	machine with 8MB of stack size I can decode around 180k nested arrays but	1146	of stack size I can decode around 180k nested arrays but only 14k nested
888	only 14k nested CBOR objects (due to perl itself recursing deeply on croak	1147	CBOR objects (due to perl itself recursing deeply on croak to free the
889	to free the temporary). If that is exceeded, the program crashes. To be	1148	temporary). If that is exceeded, the program crashes. To be conservative,
890	conservative, the default nesting limit is set to 512. If your process	1149	the default nesting limit is set to 512. If your process has a smaller
891	has a smaller stack, you should adjust this setting accordingly with the	1150	stack, you should adjust this setting accordingly with the C<max_depth>
892	C<max_depth> method.	1151	method.
		1152
		1153	=item Resource-starving attacks: CPU en-/decoding complexity
		1154
		1155	CBOR::XS will use the L<Math::BigInt>, L<Math::BigFloat> and
		1156	L<Math::BigRat> libraries to represent encode/decode bignums. These can be
		1157	very slow (as in, centuries of CPU time) and can even crash your program
		1158	(and are generally not very trustworthy). See the next section on bignum
		1159	security for details.
		1160
		1161	=item Data breaches: leaking information in error messages
		1162
		1163	CBOR::XS might leak contents of your Perl data structures in its error
		1164	messages, so when you serialise sensitive information you might want to
		1165	make sure that exceptions thrown by CBOR::XS will not end up in front of
		1166	untrusted eyes.
		1167
		1168	=item Something else...
893		1169
894	Something else could bomb you, too, that I forgot to think of. In that	1170	Something else could bomb you, too, that I forgot to think of. In that
895	case, you get to keep the pieces. I am always open for hints, though...	1171	case, you get to keep the pieces. I am always open for hints, though...
896		1172
897	Also keep in mind that CBOR::XS might leak contents of your Perl data	1173	=back
898	structures in its error messages, so when you serialise sensitive	1174
899	information you might want to make sure that exceptions thrown by CBOR::XS	1175
900	will not end up in front of untrusted eyes.	1176	=head1 BIGNUM SECURITY CONSIDERATIONS
		1177
		1178	CBOR::XS provides a C<TO_CBOR> method for both L<Math::BigInt> and
		1179	L<Math::BigFloat> that tries to encode the number in the simplest possible
		1180	way, that is, either a CBOR integer, a CBOR bigint/decimal fraction (tag
		1181	4) or an arbitrary-exponent decimal fraction (tag 264). Rational numbers
		1182	(L<Math::BigRat>, tag 30) can also contain bignums as members.
		1183
		1184	CBOR::XS will also understand base-2 bigfloat or arbitrary-exponent
		1185	bigfloats (tags 5 and 265), but it will never generate these on its own.
		1186
		1187	Using the built-in L<Math::BigInt::Calc> support, encoding and decoding
		1188	decimal fractions is generally fast. Decoding bigints can be slow for very
		1189	big numbers (tens of thousands of digits, something that could potentially
		1190	be caught by limiting the size of CBOR texts), and decoding bigfloats or
		1191	arbitrary-exponent bigfloats can be I<extremely> slow (minutes, decades)
		1192	for large exponents (roughly 40 bit and longer).
		1193
		1194	Additionally, L<Math::BigInt> can take advantage of other bignum
		1195	libraries, such as L<Math::GMP>, which cannot handle big floats with large
		1196	exponents, and might simply abort or crash your program, due to their code
		1197	quality.
		1198
		1199	This can be a concern if you want to parse untrusted CBOR. If it is, you
		1200	might want to disable decoding of tag 2 (bigint) and 3 (negative bigint)
		1201	types. You should also disable types 5 and 265, as these can be slow even
		1202	without bigints.
		1203
		1204	Disabling bigints will also partially or fully disable types that rely on
		1205	them, e.g. rational numbers that use bignums.
		1206
901		1207
902	=head1 CBOR IMPLEMENTATION NOTES	1208	=head1 CBOR IMPLEMENTATION NOTES
903		1209
904	This section contains some random implementation notes. They do not	1210	This section contains some random implementation notes. They do not
905	describe guaranteed behaviour, but merely behaviour as-is implemented	1211	describe guaranteed behaviour, but merely behaviour as-is implemented
…		…
919		1225
920		1226
921	=head1 LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT	1227	=head1 LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT
922		1228
923	On perls that were built without 64 bit integer support (these are rare	1229	On perls that were built without 64 bit integer support (these are rare
924	nowadays, even on 32 bit architectures), support for any kind of 64 bit	1230	nowadays, even on 32 bit architectures, as all major Perl distributions
		1231	are built with 64 bit integer support), support for any kind of 64 bit
925	integer in CBOR is very limited - most likely, these 64 bit values will	1232	integer in CBOR is very limited - most likely, these 64 bit values will
926	be truncated, corrupted, or otherwise not decoded correctly. This also	1233	be truncated, corrupted, or otherwise not decoded correctly. This also
927	includes string, array and map sizes that are stored as 64 bit integers.	1234	includes string, array and map sizes that are stored as 64 bit integers.
928		1235
929		1236
…		…
946	Please refrain from using rt.cpan.org or any other bug reporting	1253	Please refrain from using rt.cpan.org or any other bug reporting
947	service. I put the contact address into my modules for a reason.	1254	service. I put the contact address into my modules for a reason.
948		1255
949	=cut	1256	=cut
950		1257
		1258	# clumsy and slow hv_store-in-hash helper function
		1259	sub _hv_store {
		1260	$_[0]{$_[1]} = $_[2];
		1261	}
		1262
951	our %FILTER = (	1263	our %FILTER = (
952	# 0 # rfc4287 datetime, utf-8	1264	0 => sub { # rfc4287 datetime, utf-8
953	# 1 # unix timestamp, any	1265	require Time::Piece;
		1266	# Time::Piece::Strptime uses the "incredibly flexible date parsing routine"
		1267	# from FreeBSD, which can't parse ISO 8601, RFC3339, RFC4287 or much of anything
		1268	# else either. Whats incredibe over standard strptime totally escapes me.
		1269	# doesn't do fractional times, either. sigh.
		1270	# In fact, it's all a lie, it uses whatever strptime it wants, and of course,
		1271	# they are all incompatible. The openbsd one simply ignores %z (but according to the
		1272	# docs, it would be much more incredibly flexible indeed. If it worked, that is.).
		1273	scalar eval {
		1274	my $s = $_[1];
		1275
		1276	$s =~ s/Z$/+00:00/;
		1277	$s =~ s/(\.[0-9]+)?([+-][0-9][0-9]):([0-9][0-9])$//
		1278	or die;
		1279
		1280	my $b = $1 - ($2 * 60 + $3) * 60; # fractional part + offset. hopefully
		1281	my $d = Time::Piece->strptime ($s, "%Y-%m-%dT%H:%M:%S");
		1282
		1283	Time::Piece::gmtime ($d->epoch + $b)
		1284	} \|\| die "corrupted CBOR date/time string ($_[0])";
		1285	},
		1286
		1287	1 => sub { # seconds since the epoch, possibly fractional
		1288	require Time::Piece;
		1289	scalar Time::Piece::gmtime (pop)
		1290	},
954		1291
955	2 => sub { # pos bigint	1292	2 => sub { # pos bigint
956	require Math::BigInt;	1293	require Math::BigInt;
957	Math::BigInt->new ("0x" . unpack "H*", pop)	1294	Math::BigInt->new ("0x" . unpack "H*", pop)
958	},	1295	},
…		…
965	4 => sub { # decimal fraction, array	1302	4 => sub { # decimal fraction, array
966	require Math::BigFloat;	1303	require Math::BigFloat;
967	Math::BigFloat->new ($_[1][1] . "E" . $_[1][0])	1304	Math::BigFloat->new ($_[1][1] . "E" . $_[1][0])
968	},	1305	},
969		1306
		1307	264 => sub { # decimal fraction with arbitrary exponent
		1308	require Math::BigFloat;
		1309	Math::BigFloat->new ($_[1][1] . "E" . $_[1][0])
		1310	},
		1311
970	5 => sub { # bigfloat, array	1312	5 => sub { # bigfloat, array
971	require Math::BigFloat;	1313	require Math::BigFloat;
972	scalar Math::BigFloat->new ($_[1][1])->blsft ($_[1][0], 2)	1314	scalar Math::BigFloat->new ($_[1][1]) * Math::BigFloat->new (2)->bpow ($_[1][0])
		1315	},
		1316
		1317	265 => sub { # bigfloat with arbitrary exponent
		1318	require Math::BigFloat;
		1319	scalar Math::BigFloat->new ($_[1][1]) * Math::BigFloat->new (2)->bpow ($_[1][0])
		1320	},
		1321
		1322	30 => sub { # rational number
		1323	require Math::BigRat;
		1324	Math::BigRat->new ("$_[1][0]/$_[1][1]") # separate parameters only work in recent versons
973	},	1325	},
974		1326
975	21 => sub { pop }, # expected conversion to base64url encoding	1327	21 => sub { pop }, # expected conversion to base64url encoding
976	22 => sub { pop }, # expected conversion to base64 encoding	1328	22 => sub { pop }, # expected conversion to base64 encoding
977	23 => sub { pop }, # expected conversion to base16 encoding	1329	23 => sub { pop }, # expected conversion to base16 encoding
…		…
987	# 34 # base64 rfc46484, utf-8	1339	# 34 # base64 rfc46484, utf-8
988	# 35 # regex pcre/ecma262, utf-8	1340	# 35 # regex pcre/ecma262, utf-8
989	# 36 # mime message rfc2045, utf-8	1341	# 36 # mime message rfc2045, utf-8
990	);	1342	);
991		1343
992	sub CBOR::XS::default_filter {	1344	sub default_filter {
993	&{ $FILTER{$_[0]} or return }	1345	&{ $FILTER{$_[0]} or return }
		1346	}
		1347
		1348	our %SAFE_FILTER = map { $_ => $FILTER{$_} } 0, 1, 21, 22, 23, 32;
		1349
		1350	sub safe_filter {
		1351	&{ $SAFE_FILTER{$_[0]} or return }
994	}	1352	}
995		1353
996	sub URI::TO_CBOR {	1354	sub URI::TO_CBOR {
997	my $uri = $_[0]->as_string;	1355	my $uri = $_[0]->as_string;
998	utf8::upgrade $uri;	1356	utf8::upgrade $uri;
999	CBOR::XS::tag 32, $uri	1357	tag 32, $uri
1000	}	1358	}
1001		1359
1002	sub Math::BigInt::TO_CBOR {	1360	sub Math::BigInt::TO_CBOR {
1003	if ($_[0] >= -2147483648 && $_[0] <= 2147483647) {	1361	if (-2147483648 <= $_[0] && $_[0] <= 2147483647) {
1004	$_[0]->numify	1362	$_[0]->numify
1005	} else {	1363	} else {
1006	my $hex = substr $_[0]->as_hex, 2;	1364	my $hex = substr $_[0]->as_hex, 2;
1007	$hex = "0$hex" if 1 & length $hex; # sigh	1365	$hex = "0$hex" if 1 & length $hex; # sigh
1008	CBOR::XS::tag $_[0] >= 0 ? 2 : 3, pack "H*", $hex	1366	tag $_[0] >= 0 ? 2 : 3, pack "H*", $hex
1009	}	1367	}
1010	}	1368	}
1011		1369
1012	sub Math::BigFloat::TO_CBOR {	1370	sub Math::BigFloat::TO_CBOR {
1013	my ($m, $e) = $_[0]->parts;	1371	my ($m, $e) = $_[0]->parts;
		1372
		1373	-9223372036854775808 <= $e && $e <= 18446744073709551615
1014	CBOR::XS::tag 4, [$e->numify, $m]	1374	? tag 4, [$e->numify, $m]
		1375	: tag 264, [$e, $m]
		1376	}
		1377
		1378	sub Math::BigRat::TO_CBOR {
		1379	my ($n, $d) = $_[0]->parts;
		1380
		1381	# older versions of BigRat need *1, as they not always return numbers
		1382
		1383	$d*1 == 1
		1384	? $n*1
		1385	: tag 30, [$n1, $d1]
		1386	}
		1387
		1388	sub Time::Piece::TO_CBOR {
		1389	tag 1, 0 + $_[0]->epoch
1015	}	1390	}
1016		1391
1017	XSLoader::load "CBOR::XS", $VERSION;	1392	XSLoader::load "CBOR::XS", $VERSION;
1018		1393
1019	=head1 SEE ALSO	1394	=head1 SEE ALSO

Diff Legend

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

Comparing CBOR-XS/XS.pm (file contents): Revision 1.31 by root, Sat Nov 30 18:13:53 2013 UTC vs. Revision 1.69 by root, Sat Nov 9 07:23:31 2019 UTC

Diff Legend

Comparing CBOR-XS/XS.pm (file contents):
Revision 1.31 by root, Sat Nov 30 18:13:53 2013 UTC vs.
Revision 1.69 by root, Sat Nov 9 07:23:31 2019 UTC