You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
74 lines
3.0 KiB
74 lines
3.0 KiB
From 39a0c7555530e31c6941a78da19b6a5b61170687 Mon Sep 17 00:00:00 2001
|
|
From: "Miss Islington (bot)"
|
|
<31488909+miss-islington@users.noreply.github.com>
|
|
Date: Fri, 27 Sep 2019 13:18:14 -0700
|
|
Subject: [PATCH] bpo-38243, xmlrpc.server: Escape the server_title (GH-16373)
|
|
|
|
Escape the server title of xmlrpc.server.DocXMLRPCServer
|
|
when rendering the document page as HTML.
|
|
(cherry picked from commit e8650a4f8c7fb76f570d4ca9c1fbe44e91c8dfaa)
|
|
|
|
Co-authored-by: Dong-hee Na <donghee.na92@gmail.com>
|
|
---
|
|
Lib/test/test_docxmlrpc.py | 16 ++++++++++++++++
|
|
Lib/xmlrpc/server.py | 3 ++-
|
|
.../2019-09-25-13-21-09.bpo-38243.1pfz24.rst | 3 +++
|
|
3 files changed, 21 insertions(+), 1 deletion(-)
|
|
create mode 100644 Misc/NEWS.d/next/Security/2019-09-25-13-21-09.bpo-38243.1pfz24.rst
|
|
|
|
--- a/Lib/test/test_docxmlrpc.py
|
|
+++ b/Lib/test/test_docxmlrpc.py
|
|
@@ -1,5 +1,6 @@
|
|
from xmlrpc.server import DocXMLRPCServer
|
|
import http.client
|
|
+import re
|
|
import sys
|
|
import threading
|
|
from test import support
|
|
@@ -193,6 +194,21 @@ class DocXMLRPCHTTPGETServer(unittest.Te
|
|
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<script></title>', title)
|
|
+ self.assertEqual('<p><tt>test_documentation<script></tt></p>', documentation)
|
|
+
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|
|
--- a/Lib/xmlrpc/server.py
|
|
+++ b/Lib/xmlrpc/server.py
|
|
@@ -108,6 +108,7 @@ from xmlrpc.client import Fault, dumps,
|
|
from http.server import BaseHTTPRequestHandler
|
|
from functools import partial
|
|
from inspect import signature
|
|
+import html
|
|
import http.server
|
|
import socketserver
|
|
import sys
|
|
@@ -894,7 +895,7 @@ class XMLRPCDocGenerator:
|
|
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.
|
|
--- /dev/null
|
|
+++ b/Misc/NEWS.d/next/Security/2019-09-25-13-21-09.bpo-38243.1pfz24.rst
|
|
@@ -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`.)
|