Skip to content

Commit 09afc8c

Browse files
committed
Document issues with xmlrpc security of python built in libraries
Added note to changes with better description and link to defusedxml in the xmlrpc doc.
1 parent 73fde6c commit 09afc8c

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

CHANGES.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Fixed:
7070
is used. Fixed three places where the value of a hidden @action
7171
input field was translated. (Reported by Ludwig Reiter. John
7272
Rouillard)
73+
- Document security issues in xmlrpc interface in doc/xmlrpc.txt.
7374

7475
2019-10-23 2.0.0 alpha 0
7576

doc/xmlrpc.txt

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,11 @@ stand alone roundup-xmlrpc-server
5050
Using roundup to access the xmlrpc interface is preferred. Roundup
5151
provides better control over who can use the interface.
5252

53-
The Roundup XML-RPC standalone server must be started before remote clients can access the
54-
tracker via XML-RPC. ``roundup-xmlrpc-server`` is installed in the scripts
55-
directory alongside ``roundup-server`` and roundup-admin``. When invoked, the
56-
location of the tracker instance must be specified.
53+
The Roundup XML-RPC standalone server must be started before remote
54+
clients can access the tracker via XML-RPC. ``roundup-xmlrpc-server``
55+
is installed in the scripts directory alongside ``roundup-server`` and
56+
``roundup-admin``. When invoked, the location of the tracker instance
57+
must be specified.
5758

5859
roundup-xmlrpc-server -i ``/path/to/tracker``
5960

@@ -62,17 +63,23 @@ The default port is ``8000``. An alternative port can be specified with the
6263

6364
security consideration
6465
----------------------
65-
Note that the current ``roundup-xmlrpc-server`` implementation does not
66-
support SSL. This means that usernames and passwords will be passed in
67-
cleartext unless the server is being proxied behind another server (such as
68-
Apache or lighttpd) that provide SSL.
66+
Both the standalone and embedded roundup XML endpoints used the
67+
default python XML parser. This parser is know to have security
68+
issues. For details see: https://pypi.python.org/pypi/defusedxml/.
69+
You may wish to use the rest interface which doesn't have the same
70+
issues. Patches with tests to roundup to use defusedxml are welcome.
6971

72+
Note that the current ``roundup-xmlrpc-server`` implementation does
73+
not support SSL. This means that usernames and passwords will be
74+
passed in cleartext unless the server is being proxied behind another
75+
server (such as Apache or lighttpd) that provide SSL.
7076

7177
Client API
7278
----------
73-
The server currently implements four methods. Each method requires that the
74-
user provide a username and password in the HTTP authorization header in order
75-
to authenticate the request against the tracker.
79+
The server currently implements four methods. Each method requires
80+
that the user provide a username and password in the HTTP
81+
authorization header in order to authenticate the request against the
82+
tracker.
7683

7784
======= ====================================================================
7885
Command Description

0 commit comments

Comments
 (0)