ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/CBOR-XS/XS.pm
(Generate patch)

Comparing CBOR-XS/XS.pm (file contents):
Revision 1.30 by root, Sat Nov 30 16:19:59 2013 UTC vs.
Revision 1.69 by root, Sat Nov 9 07:23:31 2019 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines