Skip to content

Commit

Permalink
bpo-38243, xmlrpc.server: Escape the server_title (GH-16373)
Browse files Browse the repository at this point in the history
Escape the server title of xmlrpc.server.DocXMLRPCServer
when rendering the document page as HTML.
(cherry picked from commit e8650a4)

Co-authored-by: Dong-hee Na <donghee.na92@gmail.com>
  • Loading branch information
miss-islington and corona10 committed Sep 27, 2019
1 parent 2c24f2c commit 39a0c75
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
16 changes: 16 additions & 0 deletions Lib/test/test_docxmlrpc.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from xmlrpc.server import DocXMLRPCServer
import http.client
import re
import sys
import threading
from test import support
Expand Down Expand Up @@ -193,6 +194,21 @@ def test_annotations(self):
b'method_annotation</strong></a>(x: bytes)</dt></dl>'),
response.read())

def test_server_title_escape(self):
# bpo-38243: Ensure that the server title and documentation
# are escaped for HTML.
self.serv.set_server_title('test_title<script>')
self.serv.set_server_documentation('test_documentation<script>')
self.assertEqual('test_title<script>', self.serv.server_title)
self.assertEqual('test_documentation<script>',
self.serv.server_documentation)

generated = self.serv.generate_html_documentation()
title = re.search(r'<title>(.+?)</title>', generated).group()
documentation = re.search(r'<p><tt>(.+?)</tt></p>', generated).group()
self.assertEqual('<title>Python: test_title&lt;script&gt;</title>', title)
self.assertEqual('<p><tt>test_documentation&lt;script&gt;</tt></p>', documentation)


if __name__ == '__main__':
unittest.main()
3 changes: 2 additions & 1 deletion Lib/xmlrpc/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ def export_add(self, x, y):
from http.server import BaseHTTPRequestHandler
from functools import partial
from inspect import signature
import html
import http.server
import socketserver
import sys
Expand Down Expand Up @@ -894,7 +895,7 @@ def generate_html_documentation(self):
methods
)

return documenter.page(self.server_title, documentation)
return documenter.page(html.escape(self.server_title), documentation)

class DocXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
"""XML-RPC and documentation request handler class.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Escape the server title of :class:`xmlrpc.server.DocXMLRPCServer`
when rendering the document page as HTML.
(Contributed by Dong-hee Na in :issue:`38243`.)

0 comments on commit 39a0c75

Please sign in to comment.