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

Comparing CBOR-XS/README (file contents):
Revision 1.8 by root, Tue Oct 29 22:04:52 2013 UTC vs.
Revision 1.22 by root, Thu Oct 21 01:14:58 2021 UTC

… …
21 # data was decoded 21 # data was decoded
22 substr $many_cbor_strings, 0, $length, ""; # remove decoded cbor string 22 substr $many_cbor_strings, 0, $length, ""; # remove decoded cbor string
23 } 23 }
24 24
25DESCRIPTION 25DESCRIPTION
26 WARNING! This module is very new, and not very well tested (that's up to
27 you to do). Furthermore, details of the implementation might change
28 freely before version 1.0. And lastly, the object serialisation protocol
29 depends on a pending IANA assignment, and until that assignment is
30 official, this implementation is not interoperable with other
31 implementations (even future versions of this module) until the
32 assignment is done.
33
34 You are still invited to try out CBOR, and this module.
35
36 This module converts Perl data structures to the Concise Binary Object 26 This module converts Perl data structures to the Concise Binary Object
37 Representation (CBOR) and vice versa. CBOR is a fast binary 27 Representation (CBOR) and vice versa. CBOR is a fast binary
38 serialisation format that aims to use a superset of the JSON data model, 28 serialisation format that aims to use an (almost) superset of the JSON
39 i.e. when you can represent something in JSON, you should be able to 29 data model, i.e. when you can represent something useful in JSON, you
40 represent it in CBOR. 30 should be able to represent it in CBOR.
41 31
42 In short, CBOR is a faster and very compact binary alternative to JSON, 32 In short, CBOR is a faster and quite compact binary alternative to JSON,
43 with the added ability of supporting serialisation of Perl objects. 33 with the added ability of supporting serialisation of Perl objects.
44 (JSON often compresses better than CBOR though, so if you plan to 34 (JSON often compresses better than CBOR though, so if you plan to
45 compress the data later you might want to compare both formats first). 35 compress the data later and speed is less important you might want to
36 compare both formats first).
37
38 The primary goal of this module is to be *correct* and the secondary
39 goal is to be *fast*. To reach the latter goal it was written in C.
46 40
47 To give you a general idea about speed, with texts in the megabyte 41 To give you a general idea about speed, with texts in the megabyte
48 range, "CBOR::XS" usually encodes roughly twice as fast as Storable or 42 range, "CBOR::XS" usually encodes roughly twice as fast as Storable or
49 JSON::XS and decodes about 15%-30% faster than those. The shorter the 43 JSON::XS and decodes about 15%-30% faster than those. The shorter the
50 data, the worse Storable performs in comparison. 44 data, the worse Storable performs in comparison.
51 45
52 As for compactness, "CBOR::XS" encoded data structures are usually about 46 Regarding compactness, "CBOR::XS"-encoded data structures are usually
53 20% smaller than the same data encoded as (compact) JSON or Storable. 47 about 20% smaller than the same data encoded as (compact) JSON or
48 Storable.
54 49
55 The primary goal of this module is to be *correct* and the secondary 50 In addition to the core CBOR data format, this module implements a
56 goal is to be *fast*. To reach the latter goal it was written in C. 51 number of extensions, to support cyclic and shared data structures (see
52 "allow_sharing" and "allow_cycles"), string deduplication (see
53 "pack_strings") and scalar references (always enabled).
57 54
58 See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and 55 See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and
59 vice versa. 56 vice versa.
60 57
61FUNCTIONAL INTERFACE 58FUNCTIONAL INTERFACE
… …
80 *disabled*. 77 *disabled*.
81 78
82 The mutators for flags all return the CBOR object again and thus 79 The mutators for flags all return the CBOR object again and thus
83 calls can be chained: 80 calls can be chained:
84 81
85 #TODO my $cbor = CBOR::XS->new->encode ({a => [1,2]}); 82 my $cbor = CBOR::XS->new->encode ({a => [1,2]});
83
84 $cbor = new_safe CBOR::XS
85 Create a new, safe/secure CBOR::XS object. This is similar to "new",
86 but configures the coder object to be safe to use with untrusted
87 data. Currently, this is equivalent to:
88
89 my $cbor = CBOR::XS
90 ->new
91 ->validate_utf8
92 ->forbid_objects
93 ->filter (\&CBOR::XS::safe_filter)
94 ->max_size (1e8);
95
96 But is more future proof (it is better to crash because of a change
97 than to be exploited in other ways).
86 98
87 $cbor = $cbor->max_depth ([$maximum_nesting_depth]) 99 $cbor = $cbor->max_depth ([$maximum_nesting_depth])
88 $max_depth = $cbor->get_max_depth 100 $max_depth = $cbor->get_max_depth
89 Sets the maximum nesting level (default 512) accepted while encoding 101 Sets the maximum nesting level (default 512) accepted while encoding
90 or decoding. If a higher nesting level is detected in CBOR data or a 102 or decoding. If a higher nesting level is detected in CBOR data or a
… …
104 116
105 Note that nesting is implemented by recursion in C. The default 117 Note that nesting is implemented by recursion in C. The default
106 value has been chosen to be as large as typical operating systems 118 value has been chosen to be as large as typical operating systems
107 allow without crashing. 119 allow without crashing.
108 120
109 See SECURITY CONSIDERATIONS, below, for more info on why this is 121 See "SECURITY CONSIDERATIONS", below, for more info on why this is
110 useful. 122 useful.
111 123
112 $cbor = $cbor->max_size ([$maximum_string_size]) 124 $cbor = $cbor->max_size ([$maximum_string_size])
113 $max_size = $cbor->get_max_size 125 $max_size = $cbor->get_max_size
114 Set the maximum length a CBOR string may have (in bytes) where 126 Set the maximum length a CBOR string may have (in bytes) where
… …
118 exception. This setting has no effect on "encode" (yet). 130 exception. This setting has no effect on "encode" (yet).
119 131
120 If no argument is given, the limit check will be deactivated (same 132 If no argument is given, the limit check will be deactivated (same
121 as when 0 is specified). 133 as when 0 is specified).
122 134
123 See SECURITY CONSIDERATIONS, below, for more info on why this is 135 See "SECURITY CONSIDERATIONS", below, for more info on why this is
124 useful. 136 useful.
137
138 $cbor = $cbor->allow_unknown ([$enable])
139 $enabled = $cbor->get_allow_unknown
140 If $enable is true (or missing), then "encode" will *not* throw an
141 exception when it encounters values it cannot represent in CBOR (for
142 example, filehandles) but instead will encode a CBOR "error" value.
143
144 If $enable is false (the default), then "encode" will throw an
145 exception when it encounters anything it cannot encode as CBOR.
146
147 This option does not affect "decode" in any way, and it is
148 recommended to leave it off unless you know your communications
149 partner.
150
151 $cbor = $cbor->allow_sharing ([$enable])
152 $enabled = $cbor->get_allow_sharing
153 If $enable is true (or missing), then "encode" will not
154 double-encode values that have been referenced before (e.g. when the
155 same object, such as an array, is referenced multiple times), but
156 instead will emit a reference to the earlier value.
157
158 This means that such values will only be encoded once, and will not
159 result in a deep cloning of the value on decode, in decoders
160 supporting the value sharing extension. This also makes it possible
161 to encode cyclic data structures (which need "allow_cycles" to be
162 enabled to be decoded by this module).
163
164 It is recommended to leave it off unless you know your communication
165 partner supports the value sharing extensions to CBOR
166 (<http://cbor.schmorp.de/value-sharing>), as without decoder
167 support, the resulting data structure might be unusable.
168
169 Detecting shared values incurs a runtime overhead when values are
170 encoded that have a reference counter large than one, and might
171 unnecessarily increase the encoded size, as potentially shared
172 values are encoded as shareable whether or not they are actually
173 shared.
174
175 At the moment, only targets of references can be shared (e.g.
176 scalars, arrays or hashes pointed to by a reference). Weirder
177 constructs, such as an array with multiple "copies" of the *same*
178 string, which are hard but not impossible to create in Perl, are not
179 supported (this is the same as with Storable).
180
181 If $enable is false (the default), then "encode" will encode shared
182 data structures repeatedly, unsharing them in the process. Cyclic
183 data structures cannot be encoded in this mode.
184
185 This option does not affect "decode" in any way - shared values and
186 references will always be decoded properly if present.
187
188 $cbor = $cbor->allow_cycles ([$enable])
189 $enabled = $cbor->get_allow_cycles
190 If $enable is true (or missing), then "decode" will happily decode
191 self-referential (cyclic) data structures. By default these will not
192 be decoded, as they need manual cleanup to avoid memory leaks, so
193 code that isn't prepared for this will not leak memory.
194
195 If $enable is false (the default), then "decode" will throw an error
196 when it encounters a self-referential/cyclic data structure.
197
198 FUTURE DIRECTION: the motivation behind this option is to avoid
199 *real* cycles - future versions of this module might chose to decode
200 cyclic data structures using weak references when this option is
201 off, instead of throwing an error.
202
203 This option does not affect "encode" in any way - shared values and
204 references will always be encoded properly if present.
205
206 $cbor = $cbor->forbid_objects ([$enable])
207 $enabled = $cbor->get_forbid_objects
208 Disables the use of the object serialiser protocol.
209
210 If $enable is true (or missing), then "encode" will will throw an
211 exception when it encounters perl objects that would be encoded
212 using the perl-object tag (26). When "decode" encounters such tags,
213 it will fall back to the general filter/tagged logic as if this were
214 an unknown tag (by default resulting in a "CBOR::XC::Tagged"
215 object).
216
217 If $enable is false (the default), then "encode" will use the
218 Types::Serialiser object serialisation protocol to serialise objects
219 into perl-object tags, and "decode" will do the same to decode such
220 tags.
221
222 See "SECURITY CONSIDERATIONS", below, for more info on why
223 forbidding this protocol can be useful.
224
225 $cbor = $cbor->pack_strings ([$enable])
226 $enabled = $cbor->get_pack_strings
227 If $enable is true (or missing), then "encode" will try not to
228 encode the same string twice, but will instead encode a reference to
229 the string instead. Depending on your data format, this can save a
230 lot of space, but also results in a very large runtime overhead
231 (expect encoding times to be 2-4 times as high as without).
232
233 It is recommended to leave it off unless you know your
234 communications partner supports the stringref extension to CBOR
235 (<http://cbor.schmorp.de/stringref>), as without decoder support,
236 the resulting data structure might not be usable.
237
238 If $enable is false (the default), then "encode" will encode strings
239 the standard CBOR way.
240
241 This option does not affect "decode" in any way - string references
242 will always be decoded properly if present.
243
244 $cbor = $cbor->text_keys ([$enable])
245 $enabled = $cbor->get_text_keys
246 If $enabled is true (or missing), then "encode" will encode all perl
247 hash keys as CBOR text strings/UTF-8 string, upgrading them as
248 needed.
249
250 If $enable is false (the default), then "encode" will encode hash
251 keys normally - upgraded perl strings (strings internally encoded as
252 UTF-8) as CBOR text strings, and downgraded perl strings as CBOR
253 byte strings.
254
255 This option does not affect "decode" in any way.
256
257 This option is useful for interoperability with CBOR decoders that
258 don't treat byte strings as a form of text. It is especially useful
259 as Perl gives very little control over hash keys.
260
261 Enabling this option can be slow, as all downgraded hash keys that
262 are encoded need to be scanned and converted to UTF-8.
263
264 $cbor = $cbor->text_strings ([$enable])
265 $enabled = $cbor->get_text_strings
266 This option works similar to "text_keys", above, but works on all
267 strings (including hash keys), so "text_keys" has no further effect
268 after enabling "text_strings".
269
270 If $enabled is true (or missing), then "encode" will encode all perl
271 strings as CBOR text strings/UTF-8 strings, upgrading them as
272 needed.
273
274 If $enable is false (the default), then "encode" will encode strings
275 normally (but see "text_keys") - upgraded perl strings (strings
276 internally encoded as UTF-8) as CBOR text strings, and downgraded
277 perl strings as CBOR byte strings.
278
279 This option does not affect "decode" in any way.
280
281 This option has similar advantages and disadvantages as "text_keys".
282 In addition, this option effectively removes the ability to
283 automatically encode byte strings, which might break some "FREEZE"
284 and "TO_CBOR" methods that rely on this.
285
286 A workaround is to use explicit type casts, which are unaffected by
287 this option.
288
289 $cbor = $cbor->validate_utf8 ([$enable])
290 $enabled = $cbor->get_validate_utf8
291 If $enable is true (or missing), then "decode" will validate that
292 elements (text strings) containing UTF-8 data in fact contain valid
293 UTF-8 data (instead of blindly accepting it). This validation
294 obviously takes extra time during decoding.
295
296 The concept of "valid UTF-8" used is perl's concept, which is a
297 superset of the official UTF-8.
298
299 If $enable is false (the default), then "decode" will blindly accept
300 UTF-8 data, marking them as valid UTF-8 in the resulting data
301 structure regardless of whether that's true or not.
302
303 Perl isn't too happy about corrupted UTF-8 in strings, but should
304 generally not crash or do similarly evil things. Extensions might be
305 not so forgiving, so it's recommended to turn on this setting if you
306 receive untrusted CBOR.
307
308 This option does not affect "encode" in any way - strings that are
309 supposedly valid UTF-8 will simply be dumped into the resulting CBOR
310 string without checking whether that is, in fact, true or not.
311
312 $cbor = $cbor->filter ([$cb->($tag, $value)])
313 $cb_or_undef = $cbor->get_filter
314 Sets or replaces the tagged value decoding filter (when $cb is
315 specified) or clears the filter (if no argument or "undef" is
316 provided).
317
318 The filter callback is called only during decoding, when a
319 non-enforced tagged value has been decoded (see "TAG HANDLING AND
320 EXTENSIONS" for a list of enforced tags). For specific tags, it's
321 often better to provide a default converter using the
322 %CBOR::XS::FILTER hash (see below).
323
324 The first argument is the numerical tag, the second is the (decoded)
325 value that has been tagged.
326
327 The filter function should return either exactly one value, which
328 will replace the tagged value in the decoded data structure, or no
329 values, which will result in default handling, which currently means
330 the decoder creates a "CBOR::XS::Tagged" object to hold the tag and
331 the value.
332
333 When the filter is cleared (the default state), the default filter
334 function, "CBOR::XS::default_filter", is used. This function simply
335 looks up the tag in the %CBOR::XS::FILTER hash. If an entry exists
336 it must be a code reference that is called with tag and value, and
337 is responsible for decoding the value. If no entry exists, it
338 returns no values. "CBOR::XS" provides a number of default filter
339 functions already, the the %CBOR::XS::FILTER hash can be freely
340 extended with more.
341
342 "CBOR::XS" additionally provides an alternative filter function that
343 is supposed to be safe to use with untrusted data (which the default
344 filter might not), called "CBOR::XS::safe_filter", which works the
345 same as the "default_filter" but uses the %CBOR::XS::SAFE_FILTER
346 variable instead. It is prepopulated with the tag decoding functions
347 that are deemed safe (basically the same as %CBOR::XS::FILTER
348 without all the bignum tags), and can be extended by user code as
349 wlel, although, obviously, one should be very careful about adding
350 decoding functions here, since the expectation is that they are safe
351 to use on untrusted data, after all.
352
353 Example: decode all tags not handled internally into
354 "CBOR::XS::Tagged" objects, with no other special handling (useful
355 when working with potentially "unsafe" CBOR data).
356
357 CBOR::XS->new->filter (sub { })->decode ($cbor_data);
358
359 Example: provide a global filter for tag 1347375694, converting the
360 value into some string form.
361
362 $CBOR::XS::FILTER{1347375694} = sub {
363 my ($tag, $value);
364
365 "tag 1347375694 value $value"
366 };
367
368 Example: provide your own filter function that looks up tags in your
369 own hash:
370
371 my %my_filter = (
372 998347484 => sub {
373 my ($tag, $value);
374
375 "tag 998347484 value $value"
376 };
377 );
378
379 my $coder = CBOR::XS->new->filter (sub {
380 &{ $my_filter{$_[0]} or return }
381 });
382
383 Example: use the safe filter function (see "SECURITY CONSIDERATIONS"
384 for more considerations on security).
385
386 CBOR::XS->new->filter (\&CBOR::XS::safe_filter)->decode ($cbor_data);
125 387
126 $cbor_data = $cbor->encode ($perl_scalar) 388 $cbor_data = $cbor->encode ($perl_scalar)
127 Converts the given Perl data structure (a scalar value) to its CBOR 389 Converts the given Perl data structure (a scalar value) to its CBOR
128 representation. 390 representation.
129 391
… …
137 will silently stop parsing there and return the number of characters 399 will silently stop parsing there and return the number of characters
138 consumed so far. 400 consumed so far.
139 401
140 This is useful if your CBOR texts are not delimited by an outer 402 This is useful if your CBOR texts are not delimited by an outer
141 protocol and you need to know where the first CBOR string ends amd 403 protocol and you need to know where the first CBOR string ends amd
142 the next one starts. 404 the next one starts - CBOR strings are self-delimited, so it is
405 possible to concatenate CBOR strings without any delimiters or size
406 fields and recover their data.
143 407
144 CBOR::XS->new->decode_prefix ("......") 408 CBOR::XS->new->decode_prefix ("......")
145 => ("...", 3) 409 => ("...", 3)
410
411 INCREMENTAL PARSING
412 In some cases, there is the need for incremental parsing of JSON texts.
413 While this module always has to keep both CBOR text and resulting Perl
414 data structure in memory at one time, it does allow you to parse a CBOR
415 stream incrementally, using a similar to using "decode_prefix" to see if
416 a full CBOR object is available, but is much more efficient.
417
418 It basically works by parsing as much of a CBOR string as possible - if
419 the CBOR data is not complete yet, the pasrer will remember where it
420 was, to be able to restart when more data has been accumulated. Once
421 enough data is available to either decode a complete CBOR value or raise
422 an error, a real decode will be attempted.
423
424 A typical use case would be a network protocol that consists of sending
425 and receiving CBOR-encoded messages. The solution that works with CBOR
426 and about anything else is by prepending a length to every CBOR value,
427 so the receiver knows how many octets to read. More compact (and
428 slightly slower) would be to just send CBOR values back-to-back, as
429 "CBOR::XS" knows where a CBOR value ends, and doesn't need an explicit
430 length.
431
432 The following methods help with this:
433
434 @decoded = $cbor->incr_parse ($buffer)
435 This method attempts to decode exactly one CBOR value from the
436 beginning of the given $buffer. The value is removed from the
437 $buffer on success. When $buffer doesn't contain a complete value
438 yet, it returns nothing. Finally, when the $buffer doesn't start
439 with something that could ever be a valid CBOR value, it raises an
440 exception, just as "decode" would. In the latter case the decoder
441 state is undefined and must be reset before being able to parse
442 further.
443
444 This method modifies the $buffer in place. When no CBOR value can be
445 decoded, the decoder stores the current string offset. On the next
446 call, continues decoding at the place where it stopped before. For
447 this to make sense, the $buffer must begin with the same octets as
448 on previous unsuccessful calls.
449
450 You can call this method in scalar context, in which case it either
451 returns a decoded value or "undef". This makes it impossible to
452 distinguish between CBOR null values (which decode to "undef") and
453 an unsuccessful decode, which is often acceptable.
454
455 @decoded = $cbor->incr_parse_multiple ($buffer)
456 Same as "incr_parse", but attempts to decode as many CBOR values as
457 possible in one go, instead of at most one. Calls to "incr_parse"
458 and "incr_parse_multiple" can be interleaved.
459
460 $cbor->incr_reset
461 Resets the incremental decoder. This throws away any saved state, so
462 that subsequent calls to "incr_parse" or "incr_parse_multiple" start
463 to parse a new CBOR value from the beginning of the $buffer again.
464
465 This method can be called at any time, but it *must* be called if
466 you want to change your $buffer or there was a decoding error and
467 you want to reuse the $cbor object for future incremental parsings.
146 468
147MAPPING 469MAPPING
148 This section describes how CBOR::XS maps Perl values to CBOR values and 470 This section describes how CBOR::XS maps Perl values to CBOR values and
149 vice versa. These mappings are designed to "do the right thing" in most 471 vice versa. These mappings are designed to "do the right thing" in most
150 circumstances automatically, preserving round-tripping characteristics 472 circumstances automatically, preserving round-tripping characteristics
… …
158 integers 480 integers
159 CBOR integers become (numeric) perl scalars. On perls without 64 bit 481 CBOR integers become (numeric) perl scalars. On perls without 64 bit
160 support, 64 bit integers will be truncated or otherwise corrupted. 482 support, 64 bit integers will be truncated or otherwise corrupted.
161 483
162 byte strings 484 byte strings
163 Byte strings will become octet strings in Perl (the byte values 485 Byte strings will become octet strings in Perl (the Byte values
164 0..255 will simply become characters of the same value in Perl). 486 0..255 will simply become characters of the same value in Perl).
165 487
166 UTF-8 strings 488 UTF-8 strings
167 UTF-8 strings in CBOR will be decoded, i.e. the UTF-8 octets will be 489 UTF-8 strings in CBOR will be decoded, i.e. the UTF-8 octets will be
168 decoded into proper Unicode code points. At the moment, the validity 490 decoded into proper Unicode code points. At the moment, the validity
… …
182 "Types:Serialiser::false" and "Types::Serialiser::error", 504 "Types:Serialiser::false" and "Types::Serialiser::error",
183 respectively. They are overloaded to act almost exactly like the 505 respectively. They are overloaded to act almost exactly like the
184 numbers 1 and 0 (for true and false) or to throw an exception on 506 numbers 1 and 0 (for true and false) or to throw an exception on
185 access (for error). See the Types::Serialiser manpage for details. 507 access (for error). See the Types::Serialiser manpage for details.
186 508
187 CBOR tag 256 (perl object) 509 tagged values
188 The tag value 256 (TODO: pending iana registration) will be used to
189 deserialise a Perl object serialised with "FREEZE". See OBJECT
190 SERIALISATION, below, for details.
191
192 CBOR tag 55799 (magic header)
193 The tag 55799 is ignored (this tag implements the magic header).
194
195 other CBOR tags
196 Tagged items consists of a numeric tag and another CBOR value. Tags 510 Tagged items consists of a numeric tag and another CBOR value.
197 not handled internally are currently converted into a
198 CBOR::XS::Tagged object, which is simply a blessed array reference
199 consisting of the numeric tag value followed by the (decoded) CBOR
200 value.
201 511
202 In the future, support for user-supplied conversions might get 512 See "TAG HANDLING AND EXTENSIONS" and the description of "->filter"
203 added. 513 for details on which tags are handled how.
204 514
205 anything else 515 anything else
206 Anything else (e.g. unsupported simple values) will raise a decoding 516 Anything else (e.g. unsupported simple values) will raise a decoding
207 error. 517 error.
208 518
209 PERL -> CBOR 519 PERL -> CBOR
210 The mapping from Perl to CBOR is slightly more difficult, as Perl is a 520 The mapping from Perl to CBOR is slightly more difficult, as Perl is a
211 truly typeless language, so we can only guess which CBOR type is meant 521 typeless language. That means this module can only guess which CBOR type
212 by a Perl value. 522 is meant by a perl value.
213 523
214 hash references 524 hash references
215 Perl hash references become CBOR maps. As there is no inherent 525 Perl hash references become CBOR maps. As there is no inherent
216 ordering in hash keys (or CBOR maps), they will usually be encoded 526 ordering in hash keys (or CBOR maps), they will usually be encoded
217 in a pseudo-random order. 527 in a pseudo-random order. This order can be different each time a
528 hash is encoded.
218 529
219 Currently, tied hashes will use the indefinite-length format, while 530 Currently, tied hashes will use the indefinite-length format, while
220 normal hashes will use the fixed-length format. 531 normal hashes will use the fixed-length format.
221 532
222 array references 533 array references
223 Perl array references become fixed-length CBOR arrays. 534 Perl array references become fixed-length CBOR arrays.
224 535
225 other references 536 other references
226 Other unblessed references are generally not allowed and will cause 537 Other unblessed references will be represented using the indirection
227 an exception to be thrown, except for references to the integers 0 538 tag extension (tag value 22098,
228 and 1, which get turned into false and true in CBOR. 539 <http://cbor.schmorp.de/indirection>). CBOR decoders are guaranteed
540 to be able to decode these values somehow, by either "doing the
541 right thing", decoding into a generic tagged object, simply ignoring
542 the tag, or something else.
229 543
230 CBOR::XS::Tagged objects 544 CBOR::XS::Tagged objects
231 Objects of this type must be arrays consisting of a single "[tag, 545 Objects of this type must be arrays consisting of a single "[tag,
232 value]" pair. The (numerical) tag will be encoded as a CBOR tag, the 546 value]" pair. The (numerical) tag will be encoded as a CBOR tag, the
233 value will be encoded as appropriate for the value. You cna use 547 value will be encoded as appropriate for the value. You must use
234 "CBOR::XS::tag" to create such objects. 548 "CBOR::XS::tag" to create such objects.
235 549
236 Types::Serialiser::true, Types::Serialiser::false, 550 Types::Serialiser::true, Types::Serialiser::false,
237 Types::Serialiser::error 551 Types::Serialiser::error
238 These special values become CBOR true, CBOR false and CBOR undefined 552 These special values become CBOR true, CBOR false and CBOR undefined
239 values, respectively. You can also use "\1", "\0" and "\undef" 553 values, respectively. You can also use "\1", "\0" and "\undef"
240 directly if you want. 554 directly if you want.
241 555
242 other blessed objects 556 other blessed objects
243 Other blessed objects are serialised via "TO_CBOR" or "FREEZE". See 557 Other blessed objects are serialised via "TO_CBOR" or "FREEZE". See
244 "OBJECT SERIALISATION", below, for details. 558 "TAG HANDLING AND EXTENSIONS" for specific classes handled by this
559 module, and "OBJECT SERIALISATION" for generic object serialisation.
245 560
246 simple scalars 561 simple scalars
247 TODO Simple Perl scalars (any scalar that is not a reference) are 562 Simple Perl scalars (any scalar that is not a reference) are the
248 the most difficult objects to encode: CBOR::XS will encode undefined 563 most difficult objects to encode: CBOR::XS will encode undefined
249 scalars as CBOR null values, scalars that have last been used in a 564 scalars as CBOR null values, scalars that have last been used in a
250 string context before encoding as CBOR strings, and anything else as 565 string context before encoding as CBOR strings, and anything else as
251 number value: 566 number value:
252 567
253 # dump as number 568 # dump as number
254 encode_cbor [2] # yields [2] 569 encode_cbor [2] # yields [2]
255 encode_cbor [-3.0e17] # yields [-3e+17] 570 encode_cbor [-3.0e17] # yields [-3e+17]
256 my $value = 5; encode_cbor [$value] # yields [5] 571 my $value = 5; encode_cbor [$value] # yields [5]
257 572
258 # used as string, so dump as string 573 # used as string, so dump as string (either byte or text)
259 print $value; 574 print $value;
260 encode_cbor [$value] # yields ["5"] 575 encode_cbor [$value] # yields ["5"]
261 576
262 # undef becomes null 577 # undef becomes null
263 encode_cbor [undef] # yields [null] 578 encode_cbor [undef] # yields [null]
… …
266 581
267 my $x = 3.1; # some variable containing a number 582 my $x = 3.1; # some variable containing a number
268 "$x"; # stringified 583 "$x"; # stringified
269 $x .= ""; # another, more awkward way to stringify 584 $x .= ""; # another, more awkward way to stringify
270 print $x; # perl does it for you, too, quite often 585 print $x; # perl does it for you, too, quite often
586
587 You can force whether a string is encoded as byte or text string by
588 using "utf8::upgrade" and "utf8::downgrade" (if "text_strings" is
589 disabled).
590
591 utf8::upgrade $x; # encode $x as text string
592 utf8::downgrade $x; # encode $x as byte string
593
594 More options are available, see "TYPE CASTS", below, and the
595 "text_keys" and "text_strings" options.
596
597 Perl doesn't define what operations up- and downgrade strings, so if
598 the difference between byte and text is important, you should up- or
599 downgrade your string as late as possible before encoding. You can
600 also force the use of CBOR text strings by using "text_keys" or
601 "text_strings".
271 602
272 You can force the type to be a CBOR number by numifying it: 603 You can force the type to be a CBOR number by numifying it:
273 604
274 my $x = "3"; # some variable containing a string 605 my $x = "3"; # some variable containing a string
275 $x += 0; # numify it, ensuring it will be dumped as a number 606 $x += 0; # numify it, ensuring it will be dumped as a number
… …
284 IEEE single format if possible without loss of precision, otherwise 615 IEEE single format if possible without loss of precision, otherwise
285 the IEEE double format will be used. Perls that use formats other 616 the IEEE double format will be used. Perls that use formats other
286 than IEEE double to represent numerical values are supported, but 617 than IEEE double to represent numerical values are supported, but
287 might suffer loss of precision. 618 might suffer loss of precision.
288 619
620 TYPE CASTS
621 EXPERIMENTAL: As an experimental extension, "CBOR::XS" allows you to
622 force specific CBOR types to be used when encoding. That allows you to
623 encode types not normally accessible (e.g. half floats) as well as force
624 string types even when "text_strings" is in effect.
625
626 Type forcing is done by calling a special "cast" function which keeps a
627 copy of the value and returns a new value that can be handed over to any
628 CBOR encoder function.
629
630 The following casts are currently available (all of which are unary
631 operators, that is, have a prototype of "$"):
632
633 CBOR::XS::as_int $value
634 Forces the value to be encoded as some form of (basic, not bignum)
635 integer type.
636
637 CBOR::XS::as_text $value
638 Forces the value to be encoded as (UTF-8) text values.
639
640 CBOR::XS::as_bytes $value
641 Forces the value to be encoded as a (binary) string value.
642
643 Example: encode a perl string as binary even though "text_strings"
644 is in effect.
645
646 CBOR::XS->new->text_strings->encode ([4, "text", CBOR::XS::bytes "bytevalue"]);
647
648 CBOR::XS::as_bool $value
649 Converts a Perl boolean (which can be any kind of scalar) into a
650 CBOR boolean. Strictly the same, but shorter to write, than:
651
652 $value ? Types::Serialiser::true : Types::Serialiser::false
653
654 CBOR::XS::as_float16 $value
655 Forces half-float (IEEE 754 binary16) encoding of the given value.
656
657 CBOR::XS::as_float32 $value
658 Forces single-float (IEEE 754 binary32) encoding of the given value.
659
660 CBOR::XS::as_float64 $value
661 Forces double-float (IEEE 754 binary64) encoding of the given value.
662
663 CBOR::XS::as_cbor $cbor_text
664 Not a type cast per-se, this type cast forces the argument to be
665 encoded as-is. This can be used to embed pre-encoded CBOR data.
666
667 Note that no checking on the validity of the $cbor_text is done -
668 it's the callers responsibility to correctly encode values.
669
670 CBOR::XS::as_map [key => value...]
671 Treat the array reference as key value pairs and output a CBOR map.
672 This allows you to generate CBOR maps with arbitrary key types (or,
673 if you don't care about semantics, duplicate keys or pairs in a
674 custom order), which is otherwise hard to do with Perl.
675
676 The single argument must be an array reference with an even number
677 of elements.
678
679 Note that only the reference to the array is copied, the array
680 itself is not. Modifications done to the array before calling an
681 encoding function will be reflected in the encoded output.
682
683 Example: encode a CBOR map with a string and an integer as keys.
684
685 encode_cbor CBOR::XS::as_map [string => "value", 5 => "value"]
686
289 OBJECT SERIALISATION 687 OBJECT SERIALISATION
688 This module implements both a CBOR-specific and the generic
689 Types::Serialier object serialisation protocol. The following
690 subsections explain both methods.
691
692 ENCODING
290 This module knows two way to serialise a Perl object: The CBOR-specific 693 This module knows two way to serialise a Perl object: The CBOR-specific
291 way, and the generic way. 694 way, and the generic way.
292 695
293 Whenever the encoder encounters a Perl object that it cnanot serialise 696 Whenever the encoder encounters a Perl object that it cannot serialise
294 directly (most of them), it will first look up the "TO_CBOR" method on 697 directly (most of them), it will first look up the "TO_CBOR" method on
295 it. 698 it.
296 699
297 If it has a "TO_CBOR" method, it will call it with the object as only 700 If it has a "TO_CBOR" method, it will call it with the object as only
298 argument, and expects exactly one return value, which it will then 701 argument, and expects exactly one return value, which it will then
… …
303 "CBOR" as the second argument, to distinguish it from other serialisers. 706 "CBOR" as the second argument, to distinguish it from other serialisers.
304 707
305 The "FREEZE" method can return any number of values (i.e. zero or more). 708 The "FREEZE" method can return any number of values (i.e. zero or more).
306 These will be encoded as CBOR perl object, together with the classname. 709 These will be encoded as CBOR perl object, together with the classname.
307 710
711 These methods *MUST NOT* change the data structure that is being
712 serialised. Failure to comply to this can result in memory corruption -
713 and worse.
714
308 If an object supports neither "TO_CBOR" nor "FREEZE", encoding will fail 715 If an object supports neither "TO_CBOR" nor "FREEZE", encoding will fail
309 with an error. 716 with an error.
310 717
718 DECODING
311 Objects encoded via "TO_CBOR" cannot be automatically decoded, but 719 Objects encoded via "TO_CBOR" cannot (normally) be automatically
312 objects encoded via "FREEZE" can be decoded using the following 720 decoded, but objects encoded via "FREEZE" can be decoded using the
313 protocol: 721 following protocol:
314 722
315 When an encoded CBOR perl object is encountered by the decoder, it will 723 When an encoded CBOR perl object is encountered by the decoder, it will
316 look up the "THAW" method, by using the stored classname, and will fail 724 look up the "THAW" method, by using the stored classname, and will fail
317 if the method cannot be found. 725 if the method cannot be found.
318 726
… …
339 747
340 sub URI::TO_CBOR { 748 sub URI::TO_CBOR {
341 my ($self) = @_; 749 my ($self) = @_;
342 my $uri = "$self"; # stringify uri 750 my $uri = "$self"; # stringify uri
343 utf8::upgrade $uri; # make sure it will be encoded as UTF-8 string 751 utf8::upgrade $uri; # make sure it will be encoded as UTF-8 string
344 CBOR::XS::tagged 32, "$_[0]" 752 CBOR::XS::tag 32, "$_[0]"
345 } 753 }
346 754
347 This will encode URIs as a UTF-8 string with tag 32, which indicates an 755 This will encode URIs as a UTF-8 string with tag 32, which indicates an
348 URI. 756 URI.
349 757
… …
360 "$self" # encode url string 768 "$self" # encode url string
361 } 769 }
362 770
363 sub URI::THAW { 771 sub URI::THAW {
364 my ($class, $serialiser, $uri) = @_; 772 my ($class, $serialiser, $uri) = @_;
365
366 $class->new ($uri) 773 $class->new ($uri)
367 } 774 }
368 775
369 Unlike "TO_CBOR", multiple values can be returned by "FREEZE". For 776 Unlike "TO_CBOR", multiple values can be returned by "FREEZE". For
370 example, a "FREEZE" method that returns "type", "id" and "variant" 777 example, a "FREEZE" method that returns "type", "id" and "variant"
… …
384 791
385MAGIC HEADER 792MAGIC HEADER
386 There is no way to distinguish CBOR from other formats programmatically. 793 There is no way to distinguish CBOR from other formats programmatically.
387 To make it easier to distinguish CBOR from other formats, the CBOR 794 To make it easier to distinguish CBOR from other formats, the CBOR
388 specification has a special "magic string" that can be prepended to any 795 specification has a special "magic string" that can be prepended to any
389 CBOR string without changing it's meaning. 796 CBOR string without changing its meaning.
390 797
391 This string is available as $CBOR::XS::MAGIC. This module does not 798 This string is available as $CBOR::XS::MAGIC. This module does not
392 prepend this string tot he CBOR data it generates, but it will ignroe it 799 prepend this string to the CBOR data it generates, but it will ignore it
393 if present, so users can prepend this string as a "file type" indicator 800 if present, so users can prepend this string as a "file type" indicator
394 as required. 801 as required.
395 802
396THE CBOR::XS::Tagged CLASS 803THE CBOR::XS::Tagged CLASS
397 CBOR has the concept of tagged values - any CBOR value can be tagged 804 CBOR has the concept of tagged values - any CBOR value can be tagged
… …
448 Wrap CBOR data in CBOR: 855 Wrap CBOR data in CBOR:
449 856
450 my $cbor_cbor = encode_cbor 857 my $cbor_cbor = encode_cbor
451 CBOR::XS::tag 24, 858 CBOR::XS::tag 24,
452 encode_cbor [1, 2, 3]; 859 encode_cbor [1, 2, 3];
860
861TAG HANDLING AND EXTENSIONS
862 This section describes how this module handles specific tagged values
863 and extensions. If a tag is not mentioned here and no additional filters
864 are provided for it, then the default handling applies (creating a
865 CBOR::XS::Tagged object on decoding, and only encoding the tag when
866 explicitly requested).
867
868 Tags not handled specifically are currently converted into a
869 CBOR::XS::Tagged object, which is simply a blessed array reference
870 consisting of the numeric tag value followed by the (decoded) CBOR
871 value.
872
873 Future versions of this module reserve the right to special case
874 additional tags (such as base64url).
875
876 ENFORCED TAGS
877 These tags are always handled when decoding, and their handling cannot
878 be overridden by the user.
879
880 26 (perl-object, <http://cbor.schmorp.de/perl-object>)
881 These tags are automatically created (and decoded) for serialisable
882 objects using the "FREEZE/THAW" methods (the Types::Serialier object
883 serialisation protocol). See "OBJECT SERIALISATION" for details.
884
885 28, 29 (shareable, sharedref, <http://cbor.schmorp.de/value-sharing>)
886 These tags are automatically decoded when encountered (and they do
887 not result in a cyclic data structure, see "allow_cycles"),
888 resulting in shared values in the decoded object. They are only
889 encoded, however, when "allow_sharing" is enabled.
890
891 Not all shared values can be successfully decoded: values that
892 reference themselves will *currently* decode as "undef" (this is not
893 the same as a reference pointing to itself, which will be
894 represented as a value that contains an indirect reference to itself
895 - these will be decoded properly).
896
897 Note that considerably more shared value data structures can be
898 decoded than will be encoded - currently, only values pointed to by
899 references will be shared, others will not. While non-reference
900 shared values can be generated in Perl with some effort, they were
901 considered too unimportant to be supported in the encoder. The
902 decoder, however, will decode these values as shared values.
903
904 256, 25 (stringref-namespace, stringref,
905 <http://cbor.schmorp.de/stringref>)
906 These tags are automatically decoded when encountered. They are only
907 encoded, however, when "pack_strings" is enabled.
908
909 22098 (indirection, <http://cbor.schmorp.de/indirection>)
910 This tag is automatically generated when a reference are encountered
911 (with the exception of hash and array references). It is converted
912 to a reference when decoding.
913
914 55799 (self-describe CBOR, RFC 7049)
915 This value is not generated on encoding (unless explicitly requested
916 by the user), and is simply ignored when decoding.
917
918 NON-ENFORCED TAGS
919 These tags have default filters provided when decoding. Their handling
920 can be overridden by changing the %CBOR::XS::FILTER entry for the tag,
921 or by providing a custom "filter" callback when decoding.
922
923 When they result in decoding into a specific Perl class, the module
924 usually provides a corresponding "TO_CBOR" method as well.
925
926 When any of these need to load additional modules that are not part of
927 the perl core distribution (e.g. URI), it is (currently) up to the user
928 to provide these modules. The decoding usually fails with an exception
929 if the required module cannot be loaded.
930
931 0, 1 (date/time string, seconds since the epoch)
932 These tags are decoded into Time::Piece objects. The corresponding
933 "Time::Piece::TO_CBOR" method always encodes into tag 1 values
934 currently.
935
936 The Time::Piece API is generally surprisingly bad, and fractional
937 seconds are only accidentally kept intact, so watch out. On the plus
938 side, the module comes with perl since 5.10, which has to count for
939 something.
940
941 2, 3 (positive/negative bignum)
942 These tags are decoded into Math::BigInt objects. The corresponding
943 "Math::BigInt::TO_CBOR" method encodes "small" bigints into normal
944 CBOR integers, and others into positive/negative CBOR bignums.
945
946 4, 5, 264, 265 (decimal fraction/bigfloat)
947 Both decimal fractions and bigfloats are decoded into Math::BigFloat
948 objects. The corresponding "Math::BigFloat::TO_CBOR" method *always*
949 encodes into a decimal fraction (either tag 4 or 264).
950
951 NaN and infinities are not encoded properly, as they cannot be
952 represented in CBOR.
953
954 See "BIGNUM SECURITY CONSIDERATIONS" for more info.
955
956 30 (rational numbers)
957 These tags are decoded into Math::BigRat objects. The corresponding
958 "Math::BigRat::TO_CBOR" method encodes rational numbers with
959 denominator 1 via their numerator only, i.e., they become normal
960 integers or "bignums".
961
962 See "BIGNUM SECURITY CONSIDERATIONS" for more info.
963
964 21, 22, 23 (expected later JSON conversion)
965 CBOR::XS is not a CBOR-to-JSON converter, and will simply ignore
966 these tags.
967
968 32 (URI)
969 These objects decode into URI objects. The corresponding
970 "URI::TO_CBOR" method again results in a CBOR URI value.
453 971
454CBOR and JSON 972CBOR and JSON
455 CBOR is supposed to implement a superset of the JSON data model, and is, 973 CBOR is supposed to implement a superset of the JSON data model, and is,
456 with some coercion, able to represent all JSON texts (something that 974 with some coercion, able to represent all JSON texts (something that
457 other "binary JSON" formats such as BSON generally do not support). 975 other "binary JSON" formats such as BSON generally do not support).
… …
463 interoperability is improved in the future, then the goal will be to 981 interoperability is improved in the future, then the goal will be to
464 ensure that decoded JSON data will round-trip encoding and decoding to 982 ensure that decoded JSON data will round-trip encoding and decoding to
465 CBOR intact. 983 CBOR intact.
466 984
467SECURITY CONSIDERATIONS 985SECURITY CONSIDERATIONS
468 When you are using CBOR in a protocol, talking to untrusted potentially 986 Tl;dr... if you want to decode or encode CBOR from untrusted sources,
469 hostile creatures requires relatively few measures. 987 you should start with a coder object created via "new_safe" (which
988 implements the mitigations explained below):
470 989
990 my $coder = CBOR::XS->new_safe;
991
992 my $data = $coder->decode ($cbor_text);
993 my $cbor = $coder->encode ($data);
994
995 Longer version: When you are using CBOR in a protocol, talking to
996 untrusted potentially hostile creatures requires some thought:
997
998 Security of the CBOR decoder itself
471 First of all, your CBOR decoder should be secure, that is, should not 999 First and foremost, your CBOR decoder should be secure, that is,
472 have any buffer overflows. Obviously, this module should ensure that and 1000 should not have any buffer overflows or similar bugs that could
1001 potentially be exploited. Obviously, this module should ensure that
473 I am trying hard on making that true, but you never know. 1002 and I am trying hard on making that true, but you never know.
474 1003
1004 CBOR::XS can invoke almost arbitrary callbacks during decoding
1005 CBOR::XS supports object serialisation - decoding CBOR can cause
1006 calls to *any* "THAW" method in *any* package that exists in your
1007 process (that is, CBOR::XS will not try to load modules, but any
1008 existing "THAW" method or function can be called, so they all have
1009 to be secure).
1010
1011 Less obviously, it will also invoke "TO_CBOR" and "FREEZE" methods -
1012 even if all your "THAW" methods are secure, encoding data structures
1013 from untrusted sources can invoke those and trigger bugs in those.
1014
1015 So, if you are not sure about the security of all the modules you
1016 have loaded (you shouldn't), you should disable this part using
1017 "forbid_objects" or using "new_safe".
1018
1019 CBOR can be extended with tags that call library code
1020 CBOR can be extended with tags, and "CBOR::XS" has a registry of
1021 conversion functions for many existing tags that can be extended via
1022 third-party modules (see the "filter" method).
1023
1024 If you don't trust these, you should configure the "safe" filter
1025 function, "CBOR::XS::safe_filter" ("new_safe" does this), which by
1026 default only includes conversion functions that are considered
1027 "safe" by the author (but again, they can be extended by third party
1028 modules).
1029
1030 Depending on your level of paranoia, you can use the "safe" filter:
1031
1032 $cbor->filter (\&CBOR::XS::safe_filter);
1033
1034 ... your own filter...
1035
1036 $cbor->filter (sub { ... do your stuffs here ... });
1037
1038 ... or even no filter at all, disabling all tag decoding:
1039
1040 $cbor->filter (sub { });
1041
1042 This is never a problem for encoding, as the tag mechanism only
1043 exists in CBOR texts.
1044
1045 Resource-starving attacks: object memory usage
475 Second, you need to avoid resource-starving attacks. That means you 1046 You need to avoid resource-starving attacks. That means you should
476 should limit the size of CBOR data you accept, or make sure then when 1047 limit the size of CBOR data you accept, or make sure then when your
477 your resources run out, that's just fine (e.g. by using a separate 1048 resources run out, that's just fine (e.g. by using a separate
478 process that can crash safely). The size of a CBOR string in octets is 1049 process that can crash safely). The size of a CBOR string in octets
479 usually a good indication of the size of the resources required to 1050 is usually a good indication of the size of the resources required
480 decode it into a Perl structure. While CBOR::XS can check the size of 1051 to decode it into a Perl structure. While CBOR::XS can check the
1052 size of the CBOR text (using "max_size" - done by "new_safe"), it
481 the CBOR text, it might be too late when you already have it in memory, 1053 might be too late when you already have it in memory, so you might
482 so you might want to check the size before you accept the string. 1054 want to check the size before you accept the string.
483 1055
1056 As for encoding, it is possible to construct data structures that
1057 are relatively small but result in large CBOR texts (for example by
1058 having an array full of references to the same big data structure,
1059 which will all be deep-cloned during encoding by default). This is
1060 rarely an actual issue (and the worst case is still just running out
1061 of memory), but you can reduce this risk by using "allow_sharing".
1062
1063 Resource-starving attacks: stack overflows
484 Third, CBOR::XS recurses using the C stack when decoding objects and 1064 CBOR::XS recurses using the C stack when decoding objects and
485 arrays. The C stack is a limited resource: for instance, on my amd64 1065 arrays. The C stack is a limited resource: for instance, on my amd64
486 machine with 8MB of stack size I can decode around 180k nested arrays 1066 machine with 8MB of stack size I can decode around 180k nested
487 but only 14k nested CBOR objects (due to perl itself recursing deeply on 1067 arrays but only 14k nested CBOR objects (due to perl itself
488 croak to free the temporary). If that is exceeded, the program crashes. 1068 recursing deeply on croak to free the temporary). If that is
489 To be conservative, the default nesting limit is set to 512. If your 1069 exceeded, the program crashes. To be conservative, the default
490 process has a smaller stack, you should adjust this setting accordingly 1070 nesting limit is set to 512. If your process has a smaller stack,
491 with the "max_depth" method. 1071 you should adjust this setting accordingly with the "max_depth"
1072 method.
492 1073
1074 Resource-starving attacks: CPU en-/decoding complexity
1075 CBOR::XS will use the Math::BigInt, Math::BigFloat and Math::BigRat
1076 libraries to represent encode/decode bignums. These can be very slow
1077 (as in, centuries of CPU time) and can even crash your program (and
1078 are generally not very trustworthy). See the next section on bignum
1079 security for details.
1080
1081 Data breaches: leaking information in error messages
1082 CBOR::XS might leak contents of your Perl data structures in its
1083 error messages, so when you serialise sensitive information you
1084 might want to make sure that exceptions thrown by CBOR::XS will not
1085 end up in front of untrusted eyes.
1086
1087 Something else...
493 Something else could bomb you, too, that I forgot to think of. In that 1088 Something else could bomb you, too, that I forgot to think of. In
494 case, you get to keep the pieces. I am always open for hints, though... 1089 that case, you get to keep the pieces. I am always open for hints,
1090 though...
495 1091
496 Also keep in mind that CBOR::XS might leak contents of your Perl data 1092BIGNUM SECURITY CONSIDERATIONS
497 structures in its error messages, so when you serialise sensitive 1093 CBOR::XS provides a "TO_CBOR" method for both Math::BigInt and
498 information you might want to make sure that exceptions thrown by 1094 Math::BigFloat that tries to encode the number in the simplest possible
499 CBOR::XS will not end up in front of untrusted eyes. 1095 way, that is, either a CBOR integer, a CBOR bigint/decimal fraction (tag
1096 4) or an arbitrary-exponent decimal fraction (tag 264). Rational numbers
1097 (Math::BigRat, tag 30) can also contain bignums as members.
1098
1099 CBOR::XS will also understand base-2 bigfloat or arbitrary-exponent
1100 bigfloats (tags 5 and 265), but it will never generate these on its own.
1101
1102 Using the built-in Math::BigInt::Calc support, encoding and decoding
1103 decimal fractions is generally fast. Decoding bigints can be slow for
1104 very big numbers (tens of thousands of digits, something that could
1105 potentially be caught by limiting the size of CBOR texts), and decoding
1106 bigfloats or arbitrary-exponent bigfloats can be *extremely* slow
1107 (minutes, decades) for large exponents (roughly 40 bit and longer).
1108
1109 Additionally, Math::BigInt can take advantage of other bignum libraries,
1110 such as Math::GMP, which cannot handle big floats with large exponents,
1111 and might simply abort or crash your program, due to their code quality.
1112
1113 This can be a concern if you want to parse untrusted CBOR. If it is, you
1114 might want to disable decoding of tag 2 (bigint) and 3 (negative bigint)
1115 types. You should also disable types 5 and 265, as these can be slow
1116 even without bigints.
1117
1118 Disabling bigints will also partially or fully disable types that rely
1119 on them, e.g. rational numbers that use bignums.
500 1120
501CBOR IMPLEMENTATION NOTES 1121CBOR IMPLEMENTATION NOTES
502 This section contains some random implementation notes. They do not 1122 This section contains some random implementation notes. They do not
503 describe guaranteed behaviour, but merely behaviour as-is implemented 1123 describe guaranteed behaviour, but merely behaviour as-is implemented
504 right now. 1124 right now.
… …
512 Only the double data type is supported for NV data types - when Perl 1132 Only the double data type is supported for NV data types - when Perl
513 uses long double to represent floating point values, they might not be 1133 uses long double to represent floating point values, they might not be
514 encoded properly. Half precision types are accepted, but not encoded. 1134 encoded properly. Half precision types are accepted, but not encoded.
515 1135
516 Strict mode and canonical mode are not implemented. 1136 Strict mode and canonical mode are not implemented.
1137
1138LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT
1139 On perls that were built without 64 bit integer support (these are rare
1140 nowadays, even on 32 bit architectures, as all major Perl distributions
1141 are built with 64 bit integer support), support for any kind of 64 bit
1142 value in CBOR is very limited - most likely, these 64 bit values will be
1143 truncated, corrupted, or otherwise not decoded correctly. This also
1144 includes string, float, array and map sizes that are stored as 64 bit
1145 integers.
517 1146
518THREADS 1147THREADS
519 This module is *not* guaranteed to be thread safe and there are no plans 1148 This module is *not* guaranteed to be thread safe and there are no plans
520 to change this until Perl gets thread support (as opposed to the 1149 to change this until Perl gets thread support (as opposed to the
521 horribly slow so-called "threads" which are simply slow and bloated 1150 horribly slow so-called "threads" which are simply slow and bloated

Diff Legend

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