/usr/share/doc/python-defusedxml/README.html is in python-defusedxml 0.4.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 | <?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" />
<title>defusedxml -- defusing XML bombs and other exploits</title>
<style type="text/css">
/*
Stylesheet for Docutils.
Based on `blue_box.css` by Ian Bicking
and `voidspace.css` by Ian Bicking, Michael Foord
and `html4css1.css`
*/
.borderless, table.borderless td, table.borderless th
{
border: 0;
}
table.borderless td, table.borderless th
{
padding: 0 0.5em 0 0 ! important;
}
.first
{
margin-top: 0 ! important;
}
.last, .with-subtitle
{
margin-bottom: 0 ! important;
}
.hidden
{
display: none;
}
a.toc-backref
{
color: black;
text-decoration: none;
}
blockquote.epigraph
{
margin: 2em 5em;
}
dl.docutils dd
{
margin-bottom: 0.5em;
}
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"]
{
overflow: hidden;
}
div.abstract
{
margin: 2em 5em;
}
div.abstract p.topic-title
{
font-weight: bold;
text-align: center;
}
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning
{
border: medium outset;
margin: 2em;
padding: 1em;
}
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title
{
font-family: sans-serif;
font-weight: bold;
}
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title
{
color: red;
font-family: sans-serif;
font-weight: bold;
}
div.dedication
{
font-style: italic;
margin: 2em 5em;
text-align: center;
}
div.dedication p.topic-title
{
font-style: normal;
font-weight: bold;
}
div.figure
{
margin-left: 2em;
margin-right: 2em;
}
div.footer, div.header
{
clear: both;
font-size: smaller;
}
div.line-block
{
display: block;
margin-bottom: 1em;
margin-top: 1em;
}
div.line-block div.line-block
{
margin-bottom: 0;
margin-left: 1.5em;
margin-top: 0;
}
div.sidebar
{
background-color: #ffffee;
border: medium outset;
clear: right;
float: right;
margin: 0 0 0.5em 1em;
padding: 1em;
width: 40%;
}
div.sidebar p.rubric
{
font-family: sans-serif;
font-size: medium;
}
div.system-messages
{
margin: 5em;
}
div.system-messages h1
{
color: red;
}
div.system-message
{
border: medium outset;
padding: 1em;
}
div.system-message p.system-message-title
{
color: red;
font-weight: bold;
}
div.topic
{
margin: 2em;
}
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle
{
margin-top: 0.4em;
}
h1.title
{
text-align: center;
}
h2.subtitle
{
text-align: center;
}
hr.docutils
{
width: 75%;
}
img.align-left, .figure.align-left, object.align-left
{
clear: left;
float: left;
margin-right: 1em;
}
img.align-right, .figure.align-right, object.align-right
{
clear: right;
float: right;
margin-left: 1em;
}
img.align-center, .figure.align-center, object.align-center
{
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left
{
text-align: left;
}
.align-center
{
clear: both;
text-align: center;
}
.align-right
{
text-align: right;
}
div.align-right
{
text-align: inherit;
}
ol.simple, ul.simple
{
margin-bottom: 1em;
}
ol.arabic
{
list-style: decimal;
}
ol.loweralpha
{
list-style: lower-alpha;
}
ol.upperalpha
{
list-style: upper-alpha;
}
ol.lowerroman
{
list-style: lower-roman;
}
ol.upperroman
{
list-style: upper-roman;
}
p.attribution
{
margin-left: 50%;
text-align: right;
}
p.caption
{
font-style: italic;
}
p.credits
{
font-size: smaller;
font-style: italic;
}
p.label
{
white-space: nowrap;
}
p.rubric
{
color: maroon;
font-size: larger;
font-weight: bold;
text-align: center;
}
p.sidebar-title
{
font-family: sans-serif;
font-size: larger;
font-weight: bold;
}
p.sidebar-subtitle
{
font-family: sans-serif;
font-weight: bold;
}
p.topic-title
{
font-weight: bold;
}
pre.address
{
font: inherit;
margin-bottom: 0;
margin-top: 0;
}
pre.literal-block, pre.doctest-block, pre.math
{
margin-left: 2em;
margin-right: 2em;
background-color: #eeeeee;
}
span.classifier
{
font-family: sans-serif;
font-style: oblique;
}
span.classifier-delimiter
{
font-family: sans-serif;
font-weight: bold;
}
span.interpreted
{
font-family: sans-serif;
}
span.option
{
white-space: nowrap;
}
span.pre
{
white-space: pre;
}
span.problematic
{
color: red;
}
span.section-subtitle
{
font-size: 80%;
}
table.citation
{
border-left: solid 1px gray;
margin-left: 1px;
}
table.docinfo
{
margin: 2em 4em;
}
table.docutils
{
margin-bottom: 0.5em;
margin-top: 0.5em;
}
table.footnote
{
border-left: solid 1px black;
margin-left: 1px;
}
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th
{
padding-left: 0.5em;
padding-right: 0.5em;
vertical-align: top;
}
table.docutils th.field-name, table.docinfo th.docinfo-name
{
font-weight: bold;
padding-left: 0;
text-align: left;
white-space: nowrap;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils
{
font-size: 100%;
}
ul.auto-toc
{
list-style-type: none;
}
body
{
font-family: Arial, sans-serif;
margin-left: auto;
margin-right: auto;
width: 800px;
}
em, i
{
font-family: Times New Roman, Times, serif;
}
a.target
{
color: blue;
}
a.target
{
color: blue;
}
a.toc-backref
{
color: black;
text-decoration: none;
}
a.toc-backref:hover
{
background-color: inherit;
}
a:hover
{
background-color: #cccccc;
}
div.attention, div.caution, div.danger, div.error, div.hint,
div.important, div.note, div.tip, div.warning
{
padding: 3px;
width: 80%;
}
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title
{
display: block;
margin: 0;
text-align: center;
}
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title
{
display: block;
font-family: sans-serif;
margin: 0;
text-align: center;
}
h1.title
{
text-align: center;
}
table.footnote
{
padding-left: 0.5ex;
}
table.citation
{
padding-left: 0.5ex;
}
pre.literal-block, pre.doctest-block
{
padding: 5px;
}
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt
{
font-size: 100%;
}
code, tt
{
color: #000066;
}
p
{
text-align: justify;
}
dt
{
font-weight: bold;
}
tt.literal
{
background-color: #eeeeee;
}
h1
{
border-bottom: solid 1px black;
padding-top: 20px;
}
caption
{
margin-bottom: 0.4em;
font-weight: bold;
font-size: 120%;
}
</style>
</head>
<body>
<div class="document" id="defusedxml-defusing-xml-bombs-and-other-exploits">
<h1 class="title">defusedxml -- defusing XML bombs and other exploits</h1>
<blockquote>
"It's just XML, what could probably go wrong?"</blockquote>
<p>Christian Heimes <<a class="reference external" href="mailto:christian@python.org">christian@python.org</a>></p>
<div class="section" id="synopsis">
<h1><a class="toc-backref" href="#id2">Synopsis</a></h1>
<p>The results of an attack on a vulnerable XML library can be fairly dramatic.
With just a few hundred <strong>Bytes</strong> of XML data an attacker can occupy several
<strong>Gigabytes</strong> of memory within <strong>seconds</strong>. An attacker can also keep
CPUs busy for a long time with a small to medium size request. Under some
circumstances it is even possible to access local files on your
server, to circumvent a firewall, or to abuse services to rebound attacks to
third parties.</p>
<p>The attacks use and abuse less common features of XML and its parsers. The
majority of developers are unacquainted with features such as processing
instructions and entity expansions that XML inherited from SGML. At best
they know about <tt class="docutils literal"><!DOCTYPE></tt> from experience with HTML but they are not
aware that a document type definition (DTD) can generate an HTTP request
or load a file from the file system.</p>
<p>None of the issues is new. They have been known for a long time. Billion
laughs was first reported in 2003. Nevertheless some XML libraries and
applications are still vulnerable and even heavy users of XML are
surprised by these features. It's hard to say whom to blame for the
situation. It's too short sighted to shift all blame on XML parsers and
XML libraries for using insecure default settings. After all they
properly implement XML specifications. Application developers must not rely
that a library is always configured for security and potential harmful data
by default.</p>
<div class="contents topic" id="table-of-contents">
<p class="topic-title first">Table of Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#synopsis" id="id2">Synopsis</a></li>
<li><a class="reference internal" href="#attack-vectors" id="id3">Attack vectors</a><ul>
<li><a class="reference internal" href="#billion-laughs-exponential-entity-expansion" id="id4">billion laughs / exponential entity expansion</a></li>
<li><a class="reference internal" href="#quadratic-blowup-entity-expansion" id="id5">quadratic blowup entity expansion</a></li>
<li><a class="reference internal" href="#external-entity-expansion-remote" id="id6">external entity expansion (remote)</a></li>
<li><a class="reference internal" href="#external-entity-expansion-local-file" id="id7">external entity expansion (local file)</a></li>
<li><a class="reference internal" href="#dtd-retrieval" id="id8">DTD retrieval</a></li>
</ul>
</li>
<li><a class="reference internal" href="#python-xml-libraries" id="id9">Python XML Libraries</a><ul>
<li><a class="reference internal" href="#settings-in-standard-library" id="id10">Settings in standard library</a></li>
</ul>
</li>
<li><a class="reference internal" href="#defusedxml" id="id11">defusedxml</a><ul>
<li><a class="reference internal" href="#defusedxml-package" id="id12">defusedxml (package)</a></li>
<li><a class="reference internal" href="#defusedxml-celementtree" id="id13">defusedxml.cElementTree</a></li>
<li><a class="reference internal" href="#defusedxml-elementtree" id="id14">defusedxml.ElementTree</a></li>
<li><a class="reference internal" href="#defusedxml-expatreader" id="id15">defusedxml.expatreader</a></li>
<li><a class="reference internal" href="#defusedxml-sax" id="id16">defusedxml.sax</a></li>
<li><a class="reference internal" href="#defusedxml-expatbuilder" id="id17">defusedxml.expatbuilder</a></li>
<li><a class="reference internal" href="#defusedxml-minidom" id="id18">defusedxml.minidom</a></li>
<li><a class="reference internal" href="#defusedxml-pulldom" id="id19">defusedxml.pulldom</a></li>
<li><a class="reference internal" href="#defusedxml-xmlrpc" id="id20">defusedxml.xmlrpc</a></li>
<li><a class="reference internal" href="#defusedxml-lxml" id="id21">defusedxml.lxml</a></li>
</ul>
</li>
<li><a class="reference internal" href="#defusedexpat" id="id22">defusedexpat</a><ul>
<li><a class="reference internal" href="#modifications-in-expat" id="id23">Modifications in expat</a></li>
</ul>
</li>
<li><a class="reference internal" href="#how-to-avoid-xml-vulnerabilities" id="id24">How to avoid XML vulnerabilities</a><ul>
<li><a class="reference internal" href="#best-practices" id="id25">Best practices</a></li>
</ul>
</li>
<li><a class="reference internal" href="#other-things-to-consider" id="id26">Other things to consider</a><ul>
<li><a class="reference internal" href="#attribute-blowup-hash-collision-attack" id="id27">attribute blowup / hash collision attack</a></li>
<li><a class="reference internal" href="#decompression-bomb" id="id28">decompression bomb</a></li>
<li><a class="reference internal" href="#processing-instruction" id="id29">Processing Instruction</a></li>
<li><a class="reference internal" href="#other-dtd-features" id="id30">Other DTD features</a></li>
<li><a class="reference internal" href="#xpath" id="id31">XPath</a></li>
<li><a class="reference internal" href="#xpath-injection-attacks" id="id32">XPath injection attacks</a></li>
<li><a class="reference internal" href="#xinclude" id="id33">XInclude</a></li>
<li><a class="reference internal" href="#xmlschema-location" id="id34">XMLSchema location</a></li>
<li><a class="reference internal" href="#xsl-transformation" id="id35">XSL Transformation</a></li>
</ul>
</li>
<li><a class="reference internal" href="#related-cves" id="id36">Related CVEs</a></li>
<li><a class="reference internal" href="#other-languages-frameworks" id="id37">Other languages / frameworks</a><ul>
<li><a class="reference internal" href="#perl" id="id38">Perl</a></li>
<li><a class="reference internal" href="#ruby" id="id39">Ruby</a></li>
<li><a class="reference internal" href="#php" id="id40">PHP</a></li>
<li><a class="reference internal" href="#c-net-mono" id="id41">C# / .NET / Mono</a></li>
<li><a class="reference internal" href="#java" id="id42">Java</a></li>
</ul>
</li>
<li><a class="reference internal" href="#todo" id="id43">TODO</a></li>
<li><a class="reference internal" href="#license" id="id44">License</a></li>
<li><a class="reference internal" href="#acknowledgements" id="id45">Acknowledgements</a></li>
<li><a class="reference internal" href="#references" id="id46">References</a></li>
<li><a class="reference internal" href="#changelog" id="id47">Changelog</a><ul>
<li><a class="reference internal" href="#defusedxml-0-4-1" id="id48">defusedxml 0.4.1</a></li>
<li><a class="reference internal" href="#defusedxml-0-4" id="id49">defusedxml 0.4</a></li>
<li><a class="reference internal" href="#defusedxml-0-3" id="id50">defusedxml 0.3</a></li>
<li><a class="reference internal" href="#defusedxml-0-2" id="id51">defusedxml 0.2</a></li>
<li><a class="reference internal" href="#defusedxml-0-1" id="id52">defusedxml 0.1</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="attack-vectors">
<h1><a class="toc-backref" href="#id3">Attack vectors</a></h1>
<div class="section" id="billion-laughs-exponential-entity-expansion">
<h2><a class="toc-backref" href="#id4">billion laughs / exponential entity expansion</a></h2>
<p>The <a class="reference external" href="http://en.wikipedia.org/wiki/Billion_laughs">Billion Laughs</a> attack -- also known as exponential entity expansion --
uses multiple levels of nested entities. The original example uses 9 levels
of 10 expansions in each level to expand the string <tt class="docutils literal">lol</tt> to a string of
3 * 10 <sup>9</sup> bytes, hence the name "billion laughs". The resulting string
occupies 3 GB (2.79 GiB) of memory; intermediate strings require additional
memory. Because most parsers don't cache the intermediate step for every
expansion it is repeated over and over again. It increases the CPU load even
more.</p>
<p>An XML document of just a few hundred bytes can disrupt all services on a
machine within seconds.</p>
<p>Example XML:</p>
<pre class="literal-block">
<!DOCTYPE xmlbomb [
<!ENTITY a "1234567890" >
<!ENTITY b "&a;&a;&a;&a;&a;&a;&a;&a;">
<!ENTITY c "&b;&b;&b;&b;&b;&b;&b;&b;">
<!ENTITY d "&c;&c;&c;&c;&c;&c;&c;&c;">
]>
<bomb>&d;</bomb>
</pre>
</div>
<div class="section" id="quadratic-blowup-entity-expansion">
<h2><a class="toc-backref" href="#id5">quadratic blowup entity expansion</a></h2>
<p>A quadratic blowup attack is similar to a <a class="reference external" href="http://en.wikipedia.org/wiki/Billion_laughs">Billion Laughs</a> attack; it abuses
entity expansion, too. Instead of nested entities it repeats one large entity
with a couple of thousand chars over and over again. The attack isn't as
efficient as the exponential case but it avoids triggering countermeasures of
parsers against heavily nested entities. Some parsers limit the depth and
breadth of a single entity but not the total amount of expanded text
throughout an entire XML document.</p>
<p>A medium-sized XML document with a couple of hundred kilobytes can require a
couple of hundred MB to several GB of memory. When the attack is combined
with some level of nested expansion an attacker is able to achieve a higher
ratio of success.</p>
<pre class="literal-block">
<!DOCTYPE bomb [
<!ENTITY a "xxxxxxx... a couple of ten thousand chars">
]>
<bomb>&a;&a;&a;... repeat</bomb>
</pre>
</div>
<div class="section" id="external-entity-expansion-remote">
<h2><a class="toc-backref" href="#id6">external entity expansion (remote)</a></h2>
<p>Entity declarations can contain more than just text for replacement. They can
also point to external resources by public identifiers or system identifiers.
System identifiers are standard URIs. When the URI is a URL (e.g. a
<tt class="docutils literal"><span class="pre">http://</span></tt> locator) some parsers download the resource from the remote
location and embed them into the XML document verbatim.</p>
<p>Simple example of a parsed external entity:</p>
<pre class="literal-block">
<!DOCTYPE external [
<!ENTITY ee SYSTEM "http://www.python.org/some.xml">
]>
<root>&ee;</root>
</pre>
<p>The case of parsed external entities works only for valid XML content. The
XML standard also supports unparsed external entities with a
<tt class="docutils literal">NData declaration</tt>.</p>
<p>External entity expansion opens the door to plenty of exploits. An attacker
can abuse a vulnerable XML library and application to rebound and forward
network requests with the IP address of the server. It highly depends
on the parser and the application what kind of exploit is possible. For
example:</p>
<ul class="simple">
<li>An attacker can circumvent firewalls and gain access to restricted
resources as all the requests are made from an internal and trustworthy
IP address, not from the outside.</li>
<li>An attacker can abuse a service to attack, spy on or DoS your servers but
also third party services. The attack is disguised with the IP address of
the server and the attacker is able to utilize the high bandwidth of a big
machine.</li>
<li>An attacker can exhaust additional resources on the machine, e.g. with
requests to a service that doesn't respond or responds with very large
files.</li>
<li>An attacker may gain knowledge, when, how often and from which IP address
a XML document is accessed.</li>
<li>An attacker could send mail from inside your network if the URL handler
supports <tt class="docutils literal"><span class="pre">smtp://</span></tt> URIs.</li>
</ul>
</div>
<div class="section" id="external-entity-expansion-local-file">
<h2><a class="toc-backref" href="#id7">external entity expansion (local file)</a></h2>
<p>External entities with references to local files are a sub-case of external
entity expansion. It's listed as an extra attack because it deserves extra
attention. Some XML libraries such as lxml disable network access by default
but still allow entity expansion with local file access by default. Local
files are either referenced with a <tt class="docutils literal"><span class="pre">file://</span></tt> URL or by a file path (either
relative or absolute).</p>
<p>An attacker may be able to access and download all files that can be read by
the application process. This may include critical configuration files, too.</p>
<pre class="literal-block">
<!DOCTYPE external [
<!ENTITY ee SYSTEM "file:///PATH/TO/simple.xml">
]>
<root>&ee;</root>
</pre>
</div>
<div class="section" id="dtd-retrieval">
<h2><a class="toc-backref" href="#id8">DTD retrieval</a></h2>
<p>This case is similar to external entity expansion, too. Some XML libraries
like Python's xml.dom.pulldom retrieve document type definitions from remote
or local locations. Several attack scenarios from the external entity case
apply to this issue as well.</p>
<pre class="literal-block">
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head/>
<body>text</body>
</html>
</pre>
</div>
</div>
<div class="section" id="python-xml-libraries">
<h1><a class="toc-backref" href="#id9">Python XML Libraries</a></h1>
<table border="1" class="docutils">
<caption>vulnerabilities and features</caption>
<colgroup>
<col width="31%" />
<col width="9%" />
<col width="10%" />
<col width="10%" />
<col width="9%" />
<col width="10%" />
<col width="10%" />
<col width="10%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">kind</th>
<th class="head">sax</th>
<th class="head">etree</th>
<th class="head">minidom</th>
<th class="head">pulldom</th>
<th class="head">xmlrpc</th>
<th class="head">lxml</th>
<th class="head">genshi</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>billion laughs</td>
<td><strong>True</strong></td>
<td><strong>True</strong></td>
<td><strong>True</strong></td>
<td><strong>True</strong></td>
<td><strong>True</strong></td>
<td>False (1)</td>
<td>False (5)</td>
</tr>
<tr><td>quadratic blowup</td>
<td><strong>True</strong></td>
<td><strong>True</strong></td>
<td><strong>True</strong></td>
<td><strong>True</strong></td>
<td><strong>True</strong></td>
<td><strong>True</strong></td>
<td>False (5)</td>
</tr>
<tr><td>external entity expansion (remote)</td>
<td><strong>True</strong></td>
<td>False (3)</td>
<td>False (4)</td>
<td><strong>True</strong></td>
<td>false</td>
<td>False (1)</td>
<td>False (5)</td>
</tr>
<tr><td>external entity expansion (local file)</td>
<td><strong>True</strong></td>
<td>False (3)</td>
<td>False (4)</td>
<td><strong>True</strong></td>
<td>false</td>
<td><strong>True</strong></td>
<td>False (5)</td>
</tr>
<tr><td>DTD retrieval</td>
<td><strong>True</strong></td>
<td>False</td>
<td>False</td>
<td><strong>True</strong></td>
<td>false</td>
<td>False (1)</td>
<td>False</td>
</tr>
<tr><td>gzip bomb</td>
<td>False</td>
<td>False</td>
<td>False</td>
<td>False</td>
<td><strong>True</strong></td>
<td><strong>partly</strong> (2)</td>
<td>False</td>
</tr>
<tr><td>xpath support (7)</td>
<td>False</td>
<td>False</td>
<td>False</td>
<td>False</td>
<td>False</td>
<td><strong>True</strong></td>
<td>False</td>
</tr>
<tr><td>xsl(t) support (7)</td>
<td>False</td>
<td>False</td>
<td>False</td>
<td>False</td>
<td>False</td>
<td><strong>True</strong></td>
<td>False</td>
</tr>
<tr><td>xinclude support (7)</td>
<td>False</td>
<td><strong>True</strong> (6)</td>
<td>False</td>
<td>False</td>
<td>False</td>
<td><strong>True</strong> (6)</td>
<td><strong>True</strong></td>
</tr>
<tr><td>C library</td>
<td>expat</td>
<td>expat</td>
<td>expat</td>
<td>expat</td>
<td>expat</td>
<td>libxml2</td>
<td>expat</td>
</tr>
</tbody>
</table>
<ol class="arabic simple">
<li>Lxml is protected against billion laughs attacks and doesn't do network
lookups by default.</li>
<li>libxml2 and lxml are not directly vulnerable to gzip decompression bombs
but they don't protect you against them either.</li>
<li>xml.etree doesn't expand entities and raises a ParserError when an entity
occurs.</li>
<li>minidom doesn't expand entities and simply returns the unexpanded entity
verbatim.</li>
<li>genshi.input of genshi 0.6 doesn't support entity expansion and raises a
ParserError when an entity occurs.</li>
<li>Library has (limited) XInclude support but requires an additional step to
process inclusion.</li>
<li>These are features but they may introduce exploitable holes, see
<a class="reference internal" href="#other-things-to-consider">Other things to consider</a></li>
</ol>
<div class="section" id="settings-in-standard-library">
<h2><a class="toc-backref" href="#id10">Settings in standard library</a></h2>
<div class="section" id="xml-sax-handler-features">
<h3>xml.sax.handler Features</h3>
<dl class="docutils">
<dt>feature_external_ges (<a class="reference external" href="http://xml.org/sax/features/external-general-entities">http://xml.org/sax/features/external-general-entities</a>)</dt>
<dd>disables external entity expansion</dd>
<dt>feature_external_pes (<a class="reference external" href="http://xml.org/sax/features/external-parameter-entities">http://xml.org/sax/features/external-parameter-entities</a>)</dt>
<dd>the option is ignored and doesn't modify any functionality</dd>
</dl>
</div>
<div class="section" id="dom-xml-dom-xmlbuilder-options">
<h3>DOM xml.dom.xmlbuilder.Options</h3>
<dl class="docutils">
<dt>external_parameter_entities</dt>
<dd>ignored</dd>
<dt>external_general_entities</dt>
<dd>ignored</dd>
<dt>external_dtd_subset</dt>
<dd>ignored</dd>
<dt>entities</dt>
<dd>unsure</dd>
</dl>
</div>
</div>
</div>
<div class="section" id="defusedxml">
<h1><a class="toc-backref" href="#id11">defusedxml</a></h1>
<p>The <a class="reference external" href="https://bitbucket.org/tiran/defusedxml">defusedxml package</a> (<a class="reference external" href="https://pypi.python.org/pypi/defusedxml">defusedxml on PyPI</a>)
contains several Python-only workarounds and fixes
for denial of service and other vulnerabilities in Python's XML libraries.
In order to benefit from the protection you just have to import and use the
listed functions / classes from the right defusedxml module instead of the
original module. Merely <a class="reference internal" href="#defusedxml-xmlrpc">defusedxml.xmlrpc</a> is implemented as monkey patch.</p>
<p>Instead of:</p>
<pre class="literal-block">
>>> from xml.etree.ElementTree import parse
>>> et = parse(xmlfile)
</pre>
<p>alter code to:</p>
<pre class="literal-block">
>>> from defusedxml.ElementTree import parse
>>> et = parse(xmlfile)
</pre>
<p>Additionally the package has an <strong>untested</strong> function to monkey patch
all stdlib modules with <tt class="docutils literal">defusedxml.defuse_stdlib()</tt>.</p>
<p>All functions and parser classes accept three additional keyword arguments.
They return either the same objects as the original functions or compatible
subclasses.</p>
<dl class="docutils">
<dt>forbid_dtd (default: False)</dt>
<dd>disallow XML with a <tt class="docutils literal"><!DOCTYPE></tt> processing instruction and raise a
<em>DTDForbidden</em> exception when a DTD processing instruction is found.</dd>
<dt>forbid_entities (default: True)</dt>
<dd>disallow XML with <tt class="docutils literal"><!ENTITY></tt> declarations inside the DTD and raise an
<em>EntitiesForbidden</em> exception when an entity is declared.</dd>
<dt>forbid_external (default: True)</dt>
<dd>disallow any access to remote or local resources in external entities
or DTD and raising an <em>ExternalReferenceForbidden</em> exception when a DTD
or entity references an external resource.</dd>
</dl>
<div class="section" id="defusedxml-package">
<h2><a class="toc-backref" href="#id12">defusedxml (package)</a></h2>
<p>DefusedXmlException, DTDForbidden, EntitiesForbidden,
ExternalReferenceForbidden, NotSupportedError</p>
<p>defuse_stdlib() (<em>experimental</em>)</p>
</div>
<div class="section" id="defusedxml-celementtree">
<h2><a class="toc-backref" href="#id13">defusedxml.cElementTree</a></h2>
<p>parse(), iterparse(), fromstring(), XMLParser</p>
</div>
<div class="section" id="defusedxml-elementtree">
<h2><a class="toc-backref" href="#id14">defusedxml.ElementTree</a></h2>
<p>parse(), iterparse(), fromstring(), XMLParser</p>
</div>
<div class="section" id="defusedxml-expatreader">
<h2><a class="toc-backref" href="#id15">defusedxml.expatreader</a></h2>
<p>create_parser(), DefusedExpatParser</p>
</div>
<div class="section" id="defusedxml-sax">
<h2><a class="toc-backref" href="#id16">defusedxml.sax</a></h2>
<p>parse(), parseString(), create_parser()</p>
</div>
<div class="section" id="defusedxml-expatbuilder">
<h2><a class="toc-backref" href="#id17">defusedxml.expatbuilder</a></h2>
<p>parse(), parseString(), DefusedExpatBuilder, DefusedExpatBuilderNS</p>
</div>
<div class="section" id="defusedxml-minidom">
<h2><a class="toc-backref" href="#id18">defusedxml.minidom</a></h2>
<p>parse(), parseString()</p>
</div>
<div class="section" id="defusedxml-pulldom">
<h2><a class="toc-backref" href="#id19">defusedxml.pulldom</a></h2>
<p>parse(), parseString()</p>
</div>
<div class="section" id="defusedxml-xmlrpc">
<h2><a class="toc-backref" href="#id20">defusedxml.xmlrpc</a></h2>
<p>The fix is implemented as monkey patch for the stdlib's xmlrpc package (3.x)
or xmlrpclib module (2.x). The function <cite>monkey_patch()</cite> enables the fixes,
<cite>unmonkey_patch()</cite> removes the patch and puts the code in its former state.</p>
<p>The monkey patch protects against XML related attacks as well as
decompression bombs and excessively large requests or responses. The default
setting is 30 MB for requests, responses and gzip decompression. You can
modify the default by changing the module variable <cite>MAX_DATA</cite>. A value of
<cite>-1</cite> disables the limit.</p>
</div>
<div class="section" id="defusedxml-lxml">
<h2><a class="toc-backref" href="#id21">defusedxml.lxml</a></h2>
<p>The module acts as an <em>example</em> how you could protect code that uses
lxml.etree. It implements a custom Element class that filters out
Entity instances, a custom parser factory and a thread local storage for
parser instances. It also has a check_docinfo() function which inspects
a tree for internal or external DTDs and entity declarations. In order to
check for entities lxml > 3.0 is required.</p>
<p>parse(), fromstring()
RestrictedElement, GlobalParserTLS, getDefaultParser(), check_docinfo()</p>
</div>
</div>
<div class="section" id="defusedexpat">
<h1><a class="toc-backref" href="#id22">defusedexpat</a></h1>
<p>The <a class="reference external" href="https://bitbucket.org/tiran/defusedexpat">defusedexpat package</a> (<a class="reference external" href="https://pypi.python.org/pypi/defusedexpat">defusedexpat on PyPI</a>)
comes with binary extensions and a
<a class="reference external" href="https://bitbucket.org/tiran/expat">modified expat</a> libary instead of the standard <a class="reference external" href="http://expat.sourceforge.net/">expat parser</a>. It's
basically a stand-alone version of the patches for Python's standard
library C extensions.</p>
<div class="section" id="modifications-in-expat">
<h2><a class="toc-backref" href="#id23">Modifications in expat</a></h2>
<p>new definitions:</p>
<pre class="literal-block">
XML_BOMB_PROTECTION
XML_DEFAULT_MAX_ENTITY_INDIRECTIONS
XML_DEFAULT_MAX_ENTITY_EXPANSIONS
XML_DEFAULT_RESET_DTD
</pre>
<p>new XML_FeatureEnum members:</p>
<pre class="literal-block">
XML_FEATURE_MAX_ENTITY_INDIRECTIONS
XML_FEATURE_MAX_ENTITY_EXPANSIONS
XML_FEATURE_IGNORE_DTD
</pre>
<p>new XML_Error members:</p>
<pre class="literal-block">
XML_ERROR_ENTITY_INDIRECTIONS
XML_ERROR_ENTITY_EXPANSION
</pre>
<p>new API functions:</p>
<pre class="literal-block">
int XML_GetFeature(XML_Parser parser,
enum XML_FeatureEnum feature,
long *value);
int XML_SetFeature(XML_Parser parser,
enum XML_FeatureEnum feature,
long value);
int XML_GetFeatureDefault(enum XML_FeatureEnum feature,
long *value);
int XML_SetFeatureDefault(enum XML_FeatureEnum feature,
long value);
</pre>
<dl class="docutils">
<dt>XML_FEATURE_MAX_ENTITY_INDIRECTIONS</dt>
<dd><p class="first">Limit the amount of indirections that are allowed to occur during the
expansion of a nested entity. A counter starts when an entity reference
is encountered. It resets after the entity is fully expanded. The limit
protects the parser against exponential entity expansion attacks (aka
billion laughs attack). When the limit is exceeded the parser stops and
fails with <cite>XML_ERROR_ENTITY_INDIRECTIONS</cite>.
A value of 0 disables the protection.</p>
<dl class="last docutils">
<dt>Supported range</dt>
<dd>0 .. UINT_MAX</dd>
<dt>Default</dt>
<dd>40</dd>
</dl>
</dd>
<dt>XML_FEATURE_MAX_ENTITY_EXPANSIONS</dt>
<dd><p class="first">Limit the total length of all entity expansions throughout the entire
document. The lengths of all entities are accumulated in a parser variable.
The setting protects against quadratic blowup attacks (lots of expansions
of a large entity declaration). When the sum of all entities exceeds
the limit, the parser stops and fails with <cite>XML_ERROR_ENTITY_EXPANSION</cite>.
A value of 0 disables the protection.</p>
<dl class="last docutils">
<dt>Supported range</dt>
<dd>0 .. UINT_MAX</dd>
<dt>Default</dt>
<dd>8 MiB</dd>
</dl>
</dd>
<dt>XML_FEATURE_RESET_DTD</dt>
<dd><p class="first">Reset all DTD information after the <!DOCTYPE> block has been parsed. When
the flag is set (default: false) all DTD information after the
endDoctypeDeclHandler has been called. The flag can be set inside the
endDoctypeDeclHandler. Without DTD information any entity reference in
the document body leads to <cite>XML_ERROR_UNDEFINED_ENTITY</cite>.</p>
<dl class="last docutils">
<dt>Supported range</dt>
<dd>0, 1</dd>
<dt>Default</dt>
<dd>0</dd>
</dl>
</dd>
</dl>
</div>
</div>
<div class="section" id="how-to-avoid-xml-vulnerabilities">
<h1><a class="toc-backref" href="#id24">How to avoid XML vulnerabilities</a></h1>
<div class="section" id="best-practices">
<h2><a class="toc-backref" href="#id25">Best practices</a></h2>
<ul class="simple">
<li>Don't allow DTDs</li>
<li>Don't expand entities</li>
<li>Don't resolve externals</li>
<li>Limit parse depth</li>
<li>Limit total input size</li>
<li>Limit parse time</li>
<li>Favor a SAX or iterparse-like parser for potential large data</li>
<li>Validate and properly quote arguments to XSL transformations and
XPath queries</li>
<li>Don't use XPath expression from untrusted sources</li>
<li>Don't apply XSL transformations that come untrusted sources</li>
</ul>
<p>(based on Brad Hill's <a class="reference external" href="https://www.isecpartners.com/media/12976/iSEC-HILL-Attacking-XML-Security-bh07.pdf">Attacking XML Security</a>)</p>
</div>
</div>
<div class="section" id="other-things-to-consider">
<h1><a class="toc-backref" href="#id26">Other things to consider</a></h1>
<p>XML, XML parsers and processing libraries have more features and possible
issue that could lead to DoS vulnerabilities or security exploits in
applications. I have compiled an incomplete list of theoretical issues that
need further research and more attention. The list is deliberately pessimistic
and a bit paranoid, too. It contains things that might go wrong under daffy
circumstances.</p>
<div class="section" id="attribute-blowup-hash-collision-attack">
<h2><a class="toc-backref" href="#id27">attribute blowup / hash collision attack</a></h2>
<p>XML parsers may use an algorithm with quadratic runtime O(n <sup>2</sup>) to
handle attributes and namespaces. If it uses hash tables (dictionaries) to
store attributes and namespaces the implementation may be vulnerable to
hash collision attacks, thus reducing the performance to O(n <sup>2</sup>) again.
In either case an attacker is able to forge a denial of service attack with
an XML document that contains thousands upon thousands of attributes in
a single node.</p>
<p>I haven't researched yet if expat, pyexpat or libxml2 are vulnerable.</p>
</div>
<div class="section" id="decompression-bomb">
<h2><a class="toc-backref" href="#id28">decompression bomb</a></h2>
<p>The issue of decompression bombs (aka <a class="reference external" href="http://en.wikipedia.org/wiki/Zip_bomb">ZIP bomb</a>) apply to all XML libraries
that can parse compressed XML stream like gzipped HTTP streams or LZMA-ed
files. For an attacker it can reduce the amount of transmitted data by three
magnitudes or more. Gzip is able to compress 1 GiB zeros to roughly 1 MB,
lzma is even better:</p>
<pre class="literal-block">
$ dd if=/dev/zero bs=1M count=1024 | gzip > zeros.gz
$ dd if=/dev/zero bs=1M count=1024 | lzma -z > zeros.xy
$ ls -sh zeros.*
1020K zeros.gz
148K zeros.xy
</pre>
<p>None of Python's standard XML libraries decompress streams except for
<tt class="docutils literal">xmlrpclib</tt>. The module is vulnerable <<a class="reference external" href="http://bugs.python.org/issue16043">http://bugs.python.org/issue16043</a>>
to decompression bombs.</p>
<p>lxml can load and process compressed data through libxml2 transparently.
libxml2 can handle even very large blobs of compressed data efficiently
without using too much memory. But it doesn't protect applications from
decompression bombs. A carefully written SAX or iterparse-like approach can
be safe.</p>
</div>
<div class="section" id="processing-instruction">
<h2><a class="toc-backref" href="#id29">Processing Instruction</a></h2>
<p><a class="reference external" href="https://en.wikipedia.org/wiki/Processing_Instruction">PI</a>'s like:</p>
<pre class="literal-block">
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
</pre>
<p>may impose more threats for XML processing. It depends if and how a
processor handles processing instructions. The issue of URL retrieval with
network or local file access apply to processing instructions, too.</p>
</div>
<div class="section" id="other-dtd-features">
<h2><a class="toc-backref" href="#id30">Other DTD features</a></h2>
<p><a class="reference external" href="http://en.wikipedia.org/wiki/Document_Type_Definition">DTD</a> has more features like <tt class="docutils literal"><!NOTATION></tt>. I haven't researched how
these features may be a security threat.</p>
</div>
<div class="section" id="xpath">
<h2><a class="toc-backref" href="#id31">XPath</a></h2>
<p>XPath statements may introduce DoS vulnerabilities. Code should never execute
queries from untrusted sources. An attacker may also be able to create a XML
document that makes certain XPath queries costly or resource hungry.</p>
</div>
<div class="section" id="xpath-injection-attacks">
<h2><a class="toc-backref" href="#id32">XPath injection attacks</a></h2>
<p>XPath injeciton attacks pretty much work like SQL injection attacks.
Arguments to XPath queries must be quoted and validated properly, especially
when they are taken from the user. The page <a class="reference external" href="http://www.ibm.com/developerworks/xml/library/x-xpathinjection/index.html">Avoid the dangers of XPath injection</a>
list some ramifications of XPath injections.</p>
<p>Python's standard library doesn't have XPath support. Lxml supports
parameterized XPath queries which does proper quoting. You just have to use
its xpath() method correctly:</p>
<pre class="literal-block">
# DON'T
>>> tree.xpath("/tag[@id='%s']" % value)
# instead do
>>> tree.xpath("/tag[@id=$tagid]", tagid=name)
</pre>
</div>
<div class="section" id="xinclude">
<h2><a class="toc-backref" href="#id33">XInclude</a></h2>
<p><a class="reference external" href="http://www.w3.org/TR/xinclude/#include_element">XML Inclusion</a> is another way to load and include external files:</p>
<pre class="literal-block">
<root xmlns:xi="http://www.w3.org/2001/XInclude">
<xi:include href="filename.txt" parse="text" />
</root>
</pre>
<p>This feature should be disabled when XML files from an untrusted source are
processed. Some Python XML libraries and libxml2 support XInclude but don't
have an option to sandbox inclusion and limit it to allowed directories.</p>
</div>
<div class="section" id="xmlschema-location">
<h2><a class="toc-backref" href="#id34">XMLSchema location</a></h2>
<p>A validating XML parser may download schema files from the information in a
<tt class="docutils literal">xsi:schemaLocation</tt> attribute.</p>
<pre class="literal-block">
<ead xmlns="urn:isbn:1-931666-22-9"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:isbn:1-931666-22-9 http://www.loc.gov/ead/ead.xsd">
</ead>
</pre>
</div>
<div class="section" id="xsl-transformation">
<h2><a class="toc-backref" href="#id35">XSL Transformation</a></h2>
<p>You should keep in mind that XSLT is a Turing complete language. Never
process XSLT code from unknown or untrusted source! XSLT processors may
allow you to interact with external resources in ways you can't even imagine.
Some processors even support extensions that allow read/write access to file
system, access to JRE objects or scripting with Jython.</p>
<p>Example from <a class="reference external" href="https://www.isecpartners.com/media/12976/iSEC-HILL-Attacking-XML-Security-bh07.pdf">Attacking XML Security</a> for Xalan-J:</p>
<pre class="literal-block">
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:rt="http://xml.apache.org/xalan/java/java.lang.Runtime"
xmlns:ob="http://xml.apache.org/xalan/java/java.lang.Object"
exclude-result-prefixes= "rt ob">
<xsl:template match="/">
<xsl:variable name="runtimeObject" select="rt:getRuntime()"/>
<xsl:variable name="command"
select="rt:exec($runtimeObject, &apos;c:\Windows\system32\cmd.exe&apos;)"/>
<xsl:variable name="commandAsString" select="ob:toString($command)"/>
<xsl:value-of select="$commandAsString"/>
</xsl:template>
</xsl:stylesheet>
</pre>
</div>
</div>
<div class="section" id="related-cves">
<h1><a class="toc-backref" href="#id36">Related CVEs</a></h1>
<dl class="docutils">
<dt>CVE-2013-1664</dt>
<dd>Unrestricted entity expansion induces DoS vulnerabilities in Python XML
libraries (XML bomb)</dd>
<dt>CVE-2013-1665</dt>
<dd>External entity expansion in Python XML libraries inflicts potential
security flaws and DoS vulnerabilities</dd>
</dl>
</div>
<div class="section" id="other-languages-frameworks">
<h1><a class="toc-backref" href="#id37">Other languages / frameworks</a></h1>
<p>Several other programming languages and frameworks are vulnerable as well. A
couple of them are affected by the fact that libxml2 up to 2.9.0 has no
protection against quadratic blowup attacks. Most of them have potential
dangerous default settings for entity expansion and external entities, too.</p>
<div class="section" id="perl">
<h2><a class="toc-backref" href="#id38">Perl</a></h2>
<p>Perl's XML::Simple is vulnerable to quadratic entity expansion and external
entity expansion (both local and remote).</p>
</div>
<div class="section" id="ruby">
<h2><a class="toc-backref" href="#id39">Ruby</a></h2>
<p>Ruby's REXML document parser is vulnerable to entity expansion attacks
(both quadratic and exponential) but it doesn't do external entity
expansion by default. In order to counteract entity expansion you have to
disable the feature:</p>
<pre class="literal-block">
REXML::Document.entity_expansion_limit = 0
</pre>
<p>libxml-ruby and hpricot don't expand entities in their default configuration.</p>
</div>
<div class="section" id="php">
<h2><a class="toc-backref" href="#id40">PHP</a></h2>
<p>PHP's SimpleXML API is vulnerable to quadratic entity expansion and loads
entites from local and remote resources. The option <tt class="docutils literal">LIBXML_NONET</tt> disables
network access but still allows local file access. <tt class="docutils literal">LIBXML_NOENT</tt> seems to
have no effect on entity expansion in PHP 5.4.6.</p>
</div>
<div class="section" id="c-net-mono">
<h2><a class="toc-backref" href="#id41">C# / .NET / Mono</a></h2>
<p>Information in <a class="reference external" href="http://msdn.microsoft.com/en-us/magazine/ee335713.aspx">XML DoS and Defenses (MSDN)</a> suggest that .NET is
vulnerable with its default settings. The article contains code snippets
how to create a secure XML reader:</p>
<pre class="literal-block">
XmlReaderSettings settings = new XmlReaderSettings();
settings.ProhibitDtd = false;
settings.MaxCharactersFromEntities = 1024;
settings.XmlResolver = null;
XmlReader reader = XmlReader.Create(stream, settings);
</pre>
</div>
<div class="section" id="java">
<h2><a class="toc-backref" href="#id42">Java</a></h2>
<p>Untested. The documentation of Xerces and its <a class="reference external" href="http://xerces.apache.org/xerces2-j/javadocs/xerces2/org/apache/xerces/util/SecurityManager.html">Xerces SecurityMananger</a>
sounds like Xerces is also vulnerable to billion laugh attacks with its
default settings. It also does entity resolving when an
<tt class="docutils literal">org.xml.sax.EntityResolver</tt> is configured. I'm not yet sure about the
default setting here.</p>
<p>Java specialists suggest to have a custom builder factory:</p>
<pre class="literal-block">
DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance();
builderFactory.setXIncludeAware(False);
builderFactory.setExpandEntityReferences(False);
builderFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, True);
# either
builderFactory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", True);
# or if you need DTDs
builderFactory.setFeature("http://xml.org/sax/features/external-general-entities", False);
builderFactory.setFeature("http://xml.org/sax/features/external-parameter-entities", False);
builderFactory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", False);
builderFactory.setFeature("http://apache.org/xml/features/nonvalidating/load-dtd-grammar", False);
</pre>
</div>
</div>
<div class="section" id="todo">
<h1><a class="toc-backref" href="#id43">TODO</a></h1>
<ul class="simple">
<li>DOM: Use xml.dom.xmlbuilder options for entity handling</li>
<li>SAX: take feature_external_ges and feature_external_pes (?) into account</li>
<li>test experimental monkey patching of stdlib modules</li>
<li>improve documentation</li>
</ul>
</div>
<div class="section" id="license">
<h1><a class="toc-backref" href="#id44">License</a></h1>
<p>Copyright (c) 2013 by Christian Heimes <<a class="reference external" href="mailto:christian@python.org">christian@python.org</a>></p>
<p>Licensed to PSF under a Contributor Agreement.</p>
<p>See <a class="reference external" href="http://www.python.org/psf/license">http://www.python.org/psf/license</a> for licensing details.</p>
</div>
<div class="section" id="acknowledgements">
<h1><a class="toc-backref" href="#id45">Acknowledgements</a></h1>
<dl class="docutils">
<dt>Brett Cannon (Python Core developer)</dt>
<dd>review and code cleanup</dd>
<dt>Antoine Pitrou (Python Core developer)</dt>
<dd>code review</dd>
<dt>Aaron Patterson, Ben Murphy and Michael Koziarski (Ruby community)</dt>
<dd>Many thanks to Aaron, Ben and Michael from the Ruby community for their
report and assistance.</dd>
<dt>Thierry Carrez (OpenStack)</dt>
<dd>Many thanks to Thierry for his report to the Python Security Response
Team on behalf of the OpenStack security team.</dd>
<dt>Carl Meyer (Django)</dt>
<dd>Many thanks to Carl for his report to PSRT on behalf of the Django security
team.</dd>
<dt>Daniel Veillard (libxml2)</dt>
<dd>Many thanks to Daniel for his insight and assistance with libxml2.</dd>
<dt>semantics GmbH (<a class="reference external" href="http://www.semantics.de/">http://www.semantics.de/</a>)</dt>
<dd>Many thanks to my employer semantics for letting me work on the issue
during working hours as part of semantics's open source initiative.</dd>
</dl>
</div>
<div class="section" id="references">
<h1><a class="toc-backref" href="#id46">References</a></h1>
<ul class="simple">
<li><a class="reference external" href="http://msdn.microsoft.com/en-us/magazine/ee335713.aspx">XML DoS and Defenses (MSDN)</a></li>
<li><a class="reference external" href="http://en.wikipedia.org/wiki/Billion_laughs">Billion Laughs</a> on Wikipedia</li>
<li><a class="reference external" href="http://en.wikipedia.org/wiki/Zip_bomb">ZIP bomb</a> on Wikipedia</li>
<li><a class="reference external" href="http://www.ibm.com/developerworks/xml/library/x-tipcfsx/index.html">Configure SAX parsers for secure processing</a></li>
<li><a class="reference external" href="https://www.owasp.org/index.php/Testing_for_XML_Injection_(OWASP-DV-008)">Testing for XML Injection</a></li>
</ul>
</div>
<div class="section" id="changelog">
<h1><a class="toc-backref" href="#id47">Changelog</a></h1>
<div class="section" id="defusedxml-0-4-1">
<h2><a class="toc-backref" href="#id48">defusedxml 0.4.1</a></h2>
<p><em>Release date: 28-Mar-2013</em></p>
<ul class="simple">
<li>Add more demo exploits, e.g. python_external.py and Xalan XSLT demos.</li>
<li>Improved documentation.</li>
</ul>
</div>
<div class="section" id="defusedxml-0-4">
<h2><a class="toc-backref" href="#id49">defusedxml 0.4</a></h2>
<p><em>Release date: 25-Feb-2013</em></p>
<ul class="simple">
<li>As per <a class="reference external" href="http://seclists.org/oss-sec/2013/q1/340">http://seclists.org/oss-sec/2013/q1/340</a> please REJECT
CVE-2013-0278, CVE-2013-0279 and CVE-2013-0280 and use CVE-2013-1664,
CVE-2013-1665 for OpenStack/etc.</li>
<li>Add missing parser_list argument to sax.make_parser(). The argument is
ignored, though. (thanks to Florian Apolloner)</li>
<li>Add demo exploit for external entity attack on Python's SAX parser, XML-RPC
and WebDAV.</li>
</ul>
</div>
<div class="section" id="defusedxml-0-3">
<h2><a class="toc-backref" href="#id50">defusedxml 0.3</a></h2>
<p><em>Release date: 19-Feb-2013</em></p>
<ul class="simple">
<li>Improve documentation</li>
</ul>
</div>
<div class="section" id="defusedxml-0-2">
<h2><a class="toc-backref" href="#id51">defusedxml 0.2</a></h2>
<p><em>Release date: 15-Feb-2013</em></p>
<ul class="simple">
<li>Rename ExternalEntitiesForbidden to ExternalReferenceForbidden</li>
<li>Rename defusedxml.lxml.check_dtd() to check_docinfo()</li>
<li>Unify argument names in callbacks</li>
<li>Add arguments and formatted representation to exceptions</li>
<li>Add forbid_external argument to all functions and classs</li>
<li>More tests</li>
<li>LOTS of documentation</li>
<li>Add example code for other languages (Ruby, Perl, PHP) and parsers (Genshi)</li>
<li>Add protection against XML and gzip attacks to xmlrpclib</li>
</ul>
</div>
<div class="section" id="defusedxml-0-1">
<h2><a class="toc-backref" href="#id52">defusedxml 0.1</a></h2>
<p><em>Release date: 08-Feb-2013</em></p>
<ul class="simple">
<li>Initial and internal release for PSRT review</li>
</ul>
</div>
</div>
</div>
</body>
</html>
|