mirror of
https://gitlab.alpinelinux.org/alpine/aports.git
synced 2026-01-29 12:31:35 +01:00
93 lines
3.6 KiB
Diff
93 lines
3.6 KiB
Diff
From 8eb64155ff26823542ccf0225b3d57b6ae36ea89 Mon Sep 17 00:00:00 2001
|
|
From: Dong-hee Na <donghee.na92@gmail.com>
|
|
Date: Tue, 1 Oct 2019 19:58:01 +0900
|
|
Subject: [PATCH] [2.7] bpo-38243: Escape the server title of DocXMLRPCServer
|
|
(GH-16447)
|
|
|
|
Escape the server title of DocXMLRPCServer.DocXMLRPCServer
|
|
when rendering the document page as HTML.
|
|
---
|
|
Lib/DocXMLRPCServer.py | 13 +++++++++++-
|
|
Lib/test/test_docxmlrpc.py | 20 +++++++++++++++++++
|
|
.../2019-09-25-13-21-09.bpo-38243.1pfz24.rst | 3 +++
|
|
3 files changed, 35 insertions(+), 1 deletion(-)
|
|
create mode 100644 Misc/NEWS.d/next/Security/2019-09-25-13-21-09.bpo-38243.1pfz24.rst
|
|
|
|
diff --git a/Lib/DocXMLRPCServer.py b/Lib/DocXMLRPCServer.py
|
|
index 4064ec2e48d4d..90b037dd35d6b 100644
|
|
--- a/Lib/DocXMLRPCServer.py
|
|
+++ b/Lib/DocXMLRPCServer.py
|
|
@@ -20,6 +20,16 @@
|
|
CGIXMLRPCRequestHandler,
|
|
resolve_dotted_attribute)
|
|
|
|
+
|
|
+def _html_escape_quote(s):
|
|
+ s = s.replace("&", "&") # Must be done first!
|
|
+ s = s.replace("<", "<")
|
|
+ s = s.replace(">", ">")
|
|
+ s = s.replace('"', """)
|
|
+ s = s.replace('\'', "'")
|
|
+ return s
|
|
+
|
|
+
|
|
class ServerHTMLDoc(pydoc.HTMLDoc):
|
|
"""Class used to generate pydoc HTML document for a server"""
|
|
|
|
@@ -210,7 +220,8 @@ def generate_html_documentation(self):
|
|
methods
|
|
)
|
|
|
|
- return documenter.page(self.server_title, documentation)
|
|
+ title = _html_escape_quote(self.server_title)
|
|
+ return documenter.page(title, documentation)
|
|
|
|
class DocXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
|
|
"""XML-RPC and documentation request handler class.
|
|
diff --git a/Lib/test/test_docxmlrpc.py b/Lib/test/test_docxmlrpc.py
|
|
index 4dff4159e2466..c45b892b8b3e7 100644
|
|
--- a/Lib/test/test_docxmlrpc.py
|
|
+++ b/Lib/test/test_docxmlrpc.py
|
|
@@ -1,5 +1,6 @@
|
|
from DocXMLRPCServer import DocXMLRPCServer
|
|
import httplib
|
|
+import re
|
|
import sys
|
|
from test import test_support
|
|
threading = test_support.import_module('threading')
|
|
@@ -176,6 +177,25 @@ def test_autolink_dotted_methods(self):
|
|
self.assertIn("""Try self.<strong>add</strong>, too.""",
|
|
response.read())
|
|
|
|
+ def test_server_title_escape(self):
|
|
+ """Test 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)
|
|
+
|
|
+
|
|
def test_main():
|
|
test_support.run_unittest(DocXMLRPCHTTPGETServer)
|
|
|
|
diff --git a/Misc/NEWS.d/next/Security/2019-09-25-13-21-09.bpo-38243.1pfz24.rst b/Misc/NEWS.d/next/Security/2019-09-25-13-21-09.bpo-38243.1pfz24.rst
|
|
new file mode 100644
|
|
index 0000000000000..8f02baed9ebe5
|
|
--- /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:`DocXMLRPCServer.DocXMLRPCServer`
|
|
+when rendering the document page as HTML.
|
|
+(Contributed by Dong-hee Na in :issue:`38243`.)
|