<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[50856] External libraries: Improve attachment handling in PHPMailer</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/50856">50856</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/50856","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-05-12 22:29:51 +0000 (Wed, 12 May 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>External libraries: Improve attachment handling in PHPMailer
Props: audrasjb, ayeshrajans, desrosj, peterwilsoncc, xknown.
Partially merges <a href="https://core.trac.wordpress.org/changeset/50799">[50799]</a> to the 4.8 branch.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches48srcwpincludesclassphpmailerphp">branches/4.8/src/wp-includes/class-phpmailer.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches48">branches/4.8/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/4.8
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/4.8 2021-05-12 22:29:23 UTC (rev 50855)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/4.8 2021-05-12 22:29:51 UTC (rev 50856)
</ins><a id="branches48"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/4.8</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/4.9:42434,49653
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43684-43686,43836,43853,43988,43994,44014,44017,44047,45005,49523
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.5:49373-49379,49381
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:40872-40873,40879,40881,40883,40885,40892-40893,40896-40897,40901,40926-40927,40939,40941,40961,40990-40991,40995,41000,41009,41020,41022,41028,41035,41037,41047,41050,41070,41072,41086,41088,41094,41112,41115-41116,41132,41134,41136,41139,41141,41250-41251,41260,41294,41335,41386,41393,41395,41397-41398,41448,41457,41470,41483,41496,41636,41662,41712,41870,42056,42119-42120,42220,42258-42261,42424,42433,42460-42461,42463,42887,42892-42894,43320,43323,43511-43512,43977,44021,44048,44176,44219,44233,44728,44833,44842,44993,45067,45321,45445,45745,45762,45765,45783-45784,45800,45819,45885,45936,45971,45990,45997,46320,46404,46408-46409,46474-46478,46483,46485,46682,46893,46895,46996,46999,47225,47341,47404,47633-47635,47637-47638,47867-47869,47872-47873,47912,47947-47951,48121,48241,48338,48341,48705,49162,49168-49169,49175,49204,49227-49228,49244,49267,49335,49358,49360,49362,49369
,49371,49380,49382-49388,49548,49636,49781-49784,49786,49836,49876,49933,49937-49939,50017,50126,50176,50185,50192,50268,50285,50298,50379,50387,50413,50416,50432,50435-50436,50444,50446,50473-50474,50476,50479,50485-50487,50545,50579,50590,50717
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:40872-40873,40879,40881,40883,40885,40892-40893,40896-40897,40901,40926-40927,40939,40941,40961,40990-40991,40995,41000,41009,41020,41022,41028,41035,41037,41047,41050,41070,41072,41086,41088,41094,41112,41115-41116,41132,41134,41136,41139,41141,41250-41251,41260,41294,41335,41386,41393,41395,41397-41398,41448,41457,41470,41483,41496,41636,41662,41712,41870,42056,42119-42120,42220,42258-42261,42424,42433,42460-42461,42463,42887,42892-42894,43320,43323,43511-43512,43977,44021,44048,44176,44219,44233,44728,44833,44842,44993,45067,45321,45445,45745,45762,45765,45783-45784,45800,45819,45885,45936,45971,45990,45997,46320,46404,46408-46409,46474-46478,46483,46485,46682,46893,46895,46996,46999,47225,47341,47404,47633-47635,47637-47638,47867-47869,47872-47873,47912,47947-47951,48121,48241,48338,48341,48705,49162,49168-49169,49175,49204,49227-49228,49244,49267,49335,49358,49360,49362,49369
,49371,49380,49382-49388,49548,49636,49781-49784,49786,49836,49876,49933,49937-49939,50017,50126,50176,50185,50192,50268,50285,50298,50379,50387,50413,50416,50432,50435-50436,50444,50446,50473-50474,50476,50479,50485-50487,50545,50579,50590,50717,50799
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches48srcwpincludesclassphpmailerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.8/src/wp-includes/class-phpmailer.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.8/src/wp-includes/class-phpmailer.php 2021-05-12 22:29:23 UTC (rev 50855)
+++ branches/4.8/src/wp-includes/class-phpmailer.php 2021-05-12 22:29:51 UTC (rev 50856)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1294,9 +1294,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Sign with DKIM if enabled
</span><span class="cx" style="display: block; padding: 0 10px"> if (!empty($this->DKIM_domain)
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- && !empty($this->DKIM_selector)
- && (!empty($this->DKIM_private_string)
- || (!empty($this->DKIM_private) && file_exists($this->DKIM_private))
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ and !empty($this->DKIM_selector)
+ and (!empty($this->DKIM_private_string)
+ or (!empty($this->DKIM_private)
+ and self::isPermittedPath($this->DKIM_private)
+ and file_exists($this->DKIM_private)
+ )
</ins><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $header_dkim = $this->DKIM_Add(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1462,6 +1465,39 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Check whether a file path is of a permitted type.
+ * Used to reject URLs and phar files from functions that access local file paths,
+ * such as addAttachment.
+ * @param string $path A relative or absolute path to a file.
+ * @return bool
+ */
+ protected static function isPermittedPath($path)
+ {
+ //Matches scheme definition from https://tools.ietf.org/html/rfc3986#section-3.1
+ return !preg_match('#^[a-z][a-z\d+.-]*://#i', $path);
+ }
+
+ /**
+ * Check whether a file path is safe, accessible, and readable.
+ *
+ * @param string $path A relative or absolute path to a file
+ *
+ * @return bool
+ */
+ protected static function fileIsAccessible($path)
+ {
+ if (!self::isPermittedPath($path)) {
+ return false;
+ }
+ $readable = file_exists($path);
+ //If not a UNC path (expected to start with \\), check read permission, see #2069
+ if (strpos($path, '\\\\') !== 0) {
+ $readable = $readable && is_readable($path);
+ }
+ return $readable;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Send mail using the PHP mail() function.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $header The message headers
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $body The message body
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1784,7 +1820,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // There is no English translation file
</span><span class="cx" style="display: block; padding: 0 10px"> if ($langcode != 'en') {
</span><span class="cx" style="display: block; padding: 0 10px"> // Make sure language file path is readable
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if (!is_readable($lang_file)) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (!self::fileIsAccessible($lang_file)) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $foundlang = false;
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> // Overwrite language-specific strings.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2495,6 +2531,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Add an attachment from a path on the filesystem.
</span><span class="cx" style="display: block; padding: 0 10px"> * Never use a user-supplied path to a file!
</span><span class="cx" style="display: block; padding: 0 10px"> * Returns false if the file could not be found or read.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Explicitly *does not* support passing URLs; PHPMailer is not an HTTP client.
+ * If you need to do that, fetch the resource yourself and pass it in via a local file or string.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $path Path to the attachment.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $name Overrides the attachment name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $encoding File encoding (see $Encoding).
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2506,7 +2544,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function addAttachment($path, $name = '', $encoding = 'base64', $type = '', $disposition = 'attachment')
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="cx" style="display: block; padding: 0 10px"> try {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if (!@is_file($path)) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (!self::fileIsAccessible($path)) {
</ins><span class="cx" style="display: block; padding: 0 10px"> throw new phpmailerException($this->lang('file_access') . $path, self::STOP_CONTINUE);
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2687,7 +2725,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected function encodeFile($path, $encoding = 'base64')
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="cx" style="display: block; padding: 0 10px"> try {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if (!is_readable($path)) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (!self::fileIsAccessible($path)) {
</ins><span class="cx" style="display: block; padding: 0 10px"> throw new phpmailerException($this->lang('file_open') . $path, self::STOP_CONTINUE);
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $magic_quotes = get_magic_quotes_runtime();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3031,7 +3069,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function addEmbeddedImage($path, $cid, $name = '', $encoding = 'base64', $type = '', $disposition = 'inline')
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if (!@is_file($path)) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (!self::fileIsAccessible($path)) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->setError($this->lang('file_access') . $path);
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>