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.155 by root, Mon Nov 24 18:42:51 2014 UTC vs.
Revision 1.159 by root, Wed Sep 7 17:14:56 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;
697 697
698This is useful if your JSON texts are not delimited by an outer protocol 698This is useful if your JSON texts are not delimited by an outer protocol
699and you need to know where the JSON text ends. 699and you need to know where the JSON text ends.
700 700
701 JSON::XS->new->decode_prefix ("[1] the tail") 701 JSON::XS->new->decode_prefix ("[1] the tail")
702 => ([], 3) 702 => ([1], 3)
703 703
704=back 704=back
705 705
706 706
707=head1 INCREMENTAL PARSING 707=head1 INCREMENTAL PARSING
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 other modules that do the same,
1573such as L<JSON::PP> and L<CBOR::XS>. 1614such as L<JSON::PP> and L<CBOR::XS>.
1574 1615
1575 1616
1576=head1 INTEROPERABILITY WITH OTHER JSON DECODERS 1617=head1 INTEROPERABILITY WITH OTHER JSON DECODERS
1577 1618
1594 1635
1595When you use C<allow_tags> to use the extended (and also nonstandard and 1636When you use C<allow_tags> to use the extended (and also nonstandard and
1596invalid) JSON syntax for serialised objects, and you still want to decode 1637invalid) JSON syntax for serialised objects, and you still want to decode
1597the generated When you want to serialise objects, you can run a regex 1638the generated When you want to serialise objects, you can run a regex
1598to replace the tagged syntax by standard JSON arrays (it only works for 1639to replace the tagged syntax by standard JSON arrays (it only works for
1599"normal" packagesnames without comma, newlines or single colons). First, 1640"normal" package names without comma, newlines or single colons). First,
1600the readable Perl version: 1641the readable Perl version:
1601 1642
1602 # if your FREEZE methods return no values, you need this replace first: 1643 # if your FREEZE methods return no values, you need this replace first:
1603 $json =~ s/\( \s* (" (?: [^\\":,]+|\\.|::)* ") \s* \) \s* \[\s*\]/[$1]/gx; 1644 $json =~ s/\( \s* (" (?: [^\\":,]+|\\.|::)* ") \s* \) \s* \[\s*\]/[$1]/gx;
1604 1645
1640Since this module was written, Google has written a new JSON RFC, RFC 7159 1681Since this module was written, Google has written a new JSON RFC, RFC 7159
1641(and RFC7158). Unfortunately, this RFC breaks compatibility with both the 1682(and RFC7158). Unfortunately, this RFC breaks compatibility with both the
1642original JSON specification on www.json.org and RFC4627. 1683original JSON specification on www.json.org and RFC4627.
1643 1684
1644As far as I can see, you can get partial compatibility when parsing by 1685As far as I can see, you can get partial compatibility when parsing by
1645using C<< ->allow_nonref >>. However, consider thew security implications 1686using C<< ->allow_nonref >>. However, consider the security implications
1646of doing so. 1687of doing so.
1647 1688
1648I haven't decided yet when to break compatibility with RFC4627 by default 1689I haven't decided yet when to break compatibility with RFC4627 by default
1649(and potentially leave applications insecure) and change the default to 1690(and potentially leave applications insecure) and change the default to
1650follow RFC7159, but application authors are well advised to call C<< 1691follow RFC7159, but application authors are well advised to call C<<
1651->allow_nonref(0) >> even if this is the current default, if they cannot 1692->allow_nonref(0) >> even if this is the current default, if they cannot
1652handle non-reference values, in preparation for the day when the4 default 1693handle non-reference values, in preparation for the day when the default
1653will change. 1694will change.
1654 1695
1655 1696
1656=head1 THREADS 1697=head1 THREADS
1657 1698

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines