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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.156 by root, Sun Feb 21 15:37:53 2016 UTC vs.
Revision 1.158 by root, Thu Sep 1 11:38:39 2016 UTC

101 101
102package JSON::XS; 102package JSON::XS;
103 103
104use common::sense; 104use common::sense;
105 105
106our $VERSION = 3.01; 106our $VERSION = 3.02;
107our @ISA = qw(Exporter); 107our @ISA = qw(Exporter);
108 108
109our @EXPORT = qw(encode_json decode_json); 109our @EXPORT = qw(encode_json decode_json);
110 110
111use Exporter; 111use Exporter;
748C<incr_skip> to skip the erroneous part). This is the most common way of 748C<incr_skip> to skip the erroneous part). This is the most common way of
749using the method. 749using the method.
750 750
751And finally, in list context, it will try to extract as many objects 751And finally, in list context, it will try to extract as many objects
752from the stream as it can find and return them, or the empty list 752from the stream as it can find and return them, or the empty list
753otherwise. For this to work, there must be no separators between the JSON 753otherwise. For this to work, there must be no separators (other than
754objects or arrays, instead they must be concatenated back-to-back. If 754whitespace) between the JSON objects or arrays, instead they must be
755an error occurs, an exception will be raised as in the scalar context 755concatenated back-to-back. If an error occurs, an exception will be
756case. Note that in this case, any previously-parsed JSON texts will be 756raised as in the scalar context case. Note that in this case, any
757lost. 757previously-parsed JSON texts will be lost.
758 758
759Example: Parse some JSON arrays/objects in a given string and return 759Example: Parse some JSON arrays/objects in a given string and return
760them. 760them.
761 761
762 my @objs = JSON::XS->new->incr_parse ("[5][7][1,2]"); 762 my @objs = JSON::XS->new->incr_parse ("[5][7][1,2]");
1563are browser design bugs, but it is still you who will have to deal with 1563are browser design bugs, but it is still you who will have to deal with
1564it, as major browser developers care only for features, not about getting 1564it, as major browser developers care only for features, not about getting
1565security right). 1565security right).
1566 1566
1567 1567
1568=head1 "OLD" VS. "NEW" JSON (RFC 4627 VS. RFC 7159)
1569
1570TL;DR: Due to security concerns, JSON::XS will not allow scalar data in
1571JSON texts by default - you need to create your own JSON::XS object and
1572enable C<allow_nonref>:
1573
1574
1575 my $json = JSON::XS->new->allow_nonref;
1576
1577 $text = $json->encode ($data);
1578 $data = $json->decode ($text);
1579
1580The long version: JSON being an important and supposedly stable format,
1581the IETF standardised it as RFC 4627 in 2006. Unfortunately, the inventor
1582of JSON, Dougles Crockford, unilaterally changed the definition of JSON in
1583javascript. Rather than create a fork, the IETF decided to standardise the
1584new syntax (apparently, so Iw as told, without finding it very amusing).
1585
1586The biggest difference between thed original JSON and the new JSON is that
1587the new JSON supports scalars (anything other than arrays and objects) at
1588the toplevel of a JSON text. While this is strictly backwards compatible
1589to older versions, it breaks a number of protocols that relied on sending
1590JSON back-to-back, and is a minor security concern.
1591
1592For example, imagine you have two banks communicating, and on one side,
1593trhe JSON coder gets upgraded. Two messages, such as C<10> and C<1000>
1594might then be confused to mean C<101000>, something that couldn't happen
1595in the original JSON, because niether of these messages would be valid
1596JSON.
1597
1598If one side accepts these messages, then an upgrade in the coder on either
1599side could result in this becoming exploitable.
1600
1601This module has always allowed these messages as an optional extension, by
1602default disabled. The security concerns are the reason why the default is
1603still disabled, but future versions might/will likely upgrade to the newer
1604RFC as default format, so you are advised to check your implementation
1605and/or override the default with C<< ->allow_nonref (0) >> to ensure that
1606future versions are safe.
1607
1608
1568=head1 INTEROPERABILITY WITH OTHER MODULES 1609=head1 INTEROPERABILITY WITH OTHER MODULES
1569 1610
1570C<JSON::XS> uses the L<Types::Serialiser> module to provide boolean 1611C<JSON::XS> uses the L<Types::Serialiser> module to provide boolean
1571constants. That means that the JSON true and false values will be 1612constants. That means that the JSON true and false values will be
1572comaptible to true and false values of iother modules that do the same, 1613comaptible to true and false values of iother modules that do the same,

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines