]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-127712: Fix `secure` argument of `logging.handlers.SMTPHandler` (GH-127726)
authors-hamann <10639154+s-hamann@users.noreply.github.com>
Mon, 10 Feb 2025 12:34:27 +0000 (12:34 +0000)
committerGitHub <noreply@github.com>
Mon, 10 Feb 2025 12:34:27 +0000 (12:34 +0000)
GH-127712: Fix `secure` argument of `logging.handlers.SMTPHandler`

Python 3.12 removed support for the `keyfile` and `certfile` parameters
in `smtplib.SMTP.starttls()`, requiring a `ssl.SSLContext` instead.
`SMTPHandler` now creates a context from the `secure` tuple and passes
that to `starttls`.

Lib/logging/handlers.py
Misc/NEWS.d/next/Library/2024-12-07-20-33-43.gh-issue-127712.Uzsij4.rst [new file with mode: 0644]

index 017c9ab409b7bcb421945b1909c7045bede86e59..9abadbf5cdd1dffab31a97c4f4ae4021124bbec7 100644 (file)
@@ -1043,7 +1043,8 @@ class SMTPHandler(logging.Handler):
         only be used when authentication credentials are supplied. The tuple
         will be either an empty tuple, or a single-value tuple with the name
         of a keyfile, or a 2-value tuple with the names of the keyfile and
-        certificate file. (This tuple is passed to the `starttls` method).
+        certificate file. (This tuple is passed to the
+        `ssl.SSLContext.load_cert_chain` method).
         A timeout in seconds can be specified for the SMTP connection (the
         default is one second).
         """
@@ -1096,8 +1097,23 @@ class SMTPHandler(logging.Handler):
             msg.set_content(self.format(record))
             if self.username:
                 if self.secure is not None:
+                    import ssl
+
+                    try:
+                        keyfile = self.secure[0]
+                    except IndexError:
+                        keyfile = None
+
+                    try:
+                        certfile = self.secure[1]
+                    except IndexError:
+                        certfile = None
+
+                    context = ssl._create_stdlib_context(
+                        certfile=certfile, keyfile=keyfile
+                    )
                     smtp.ehlo()
-                    smtp.starttls(*self.secure)
+                    smtp.starttls(context=context)
                     smtp.ehlo()
                 smtp.login(self.username, self.password)
             smtp.send_message(msg)
diff --git a/Misc/NEWS.d/next/Library/2024-12-07-20-33-43.gh-issue-127712.Uzsij4.rst b/Misc/NEWS.d/next/Library/2024-12-07-20-33-43.gh-issue-127712.Uzsij4.rst
new file mode 100644 (file)
index 0000000..40450cd
--- /dev/null
@@ -0,0 +1 @@
+Fix handling of the ``secure`` argument of :class:`logging.handlers.SMTPHandler`.