summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Heimes <christian@cheimes.de>2013-02-15 14:41:39 +0100
committerChristian Heimes <christian@cheimes.de>2013-02-15 14:41:39 +0100
commit83353c69d41fd34d1096b77a8db87efa78302eb9 (patch)
tree47936e1f2611d806fb6d72fe0d33e7e7bec597c2
parentd1b4402ac5398ee4eeb90f7bd25ab79873e1881d (diff)
downloaddefusedxml-83353c69d41fd34d1096b77a8db87efa78302eb9.tar.gz
document lxml and xmlrpc modules
-rw-r--r--README.txt23
1 files changed, 18 insertions, 5 deletions
diff --git a/README.txt b/README.txt
index 02df7db..f32747b 100644
--- a/README.txt
+++ b/README.txt
@@ -281,18 +281,31 @@ defused.pulldom
parse(), parseString()
-defused.xmlrpclib
------------------
+defused.xmlrpc
+--------------
-TODO
+The fix is implemented as monkey patch for the stdlib's xmlrpc package (3.x)
+or xmlrpclib module (2.x). The function `monkey_patch()` enables the fixes,
+`unmonkey_patch()` removes the patch and puts the code in its former state.
+
+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 `MAX_DATA`. A value of
+`-1` disables the limit.
defused.lxml
------------
-parse(), fromstring()
+The module acts as an *example* 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.
-RestrictedElement, GlobalParserTLS, getDefaultParser, check_docinfo()
+parse(), fromstring()
+RestrictedElement, GlobalParserTLS, getDefaultParser(), check_docinfo()
defusedexpat