Skip to content

Commit 1698cac

Browse files
vstinnerned-deily
authored andcommitted
bpo-38243, xmlrpc.server: Escape the server_title (GH-16373) (GH-16441)
Escape the server title of xmlrpc.server.DocXMLRPCServer when rendering the document page as HTML. (cherry picked from commit e8650a4)
1 parent f050163 commit 1698cac

File tree

3 files changed

+21
-1
lines changed

3 files changed

+21
-1
lines changed

Lib/test/test_docxmlrpc.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
from xmlrpc.server import DocXMLRPCServer
22
import http.client
3+
import re
34
import sys
45
from test import support
56
threading = support.import_module('threading')
@@ -193,6 +194,21 @@ def test_annotations(self):
193194
b'method_annotation</strong></a>(x: bytes)</dt></dl>'),
194195
response.read())
195196

197+
def test_server_title_escape(self):
198+
# bpo-38243: Ensure that the server title and documentation
199+
# are escaped for HTML.
200+
self.serv.set_server_title('test_title<script>')
201+
self.serv.set_server_documentation('test_documentation<script>')
202+
self.assertEqual('test_title<script>', self.serv.server_title)
203+
self.assertEqual('test_documentation<script>',
204+
self.serv.server_documentation)
205+
206+
generated = self.serv.generate_html_documentation()
207+
title = re.search(r'<title>(.+?)</title>', generated).group()
208+
documentation = re.search(r'<p><tt>(.+?)</tt></p>', generated).group()
209+
self.assertEqual('<title>Python: test_title&lt;script&gt;</title>', title)
210+
self.assertEqual('<p><tt>test_documentation&lt;script&gt;</tt></p>', documentation)
211+
196212

197213
if __name__ == '__main__':
198214
unittest.main()

Lib/xmlrpc/server.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ def export_add(self, x, y):
106106

107107
from xmlrpc.client import Fault, dumps, loads, gzip_encode, gzip_decode
108108
from http.server import BaseHTTPRequestHandler
109+
import html
109110
import http.server
110111
import socketserver
111112
import sys
@@ -904,7 +905,7 @@ def generate_html_documentation(self):
904905
methods
905906
)
906907

907-
return documenter.page(self.server_title, documentation)
908+
return documenter.page(html.escape(self.server_title), documentation)
908909

909910
class DocXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
910911
"""XML-RPC and documentation request handler class.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Escape the server title of :class:`xmlrpc.server.DocXMLRPCServer`
2+
when rendering the document page as HTML.
3+
(Contributed by Dong-hee Na in :issue:`38243`.)

0 commit comments

Comments
 (0)