<!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>[50854] 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/50854">50854</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/50854","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:28:34 +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 5.0 branch.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches50srcwpincludesclassphpmailerphp">branches/5.0/src/wp-includes/class-phpmailer.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches50">branches/5.0/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/5.0
</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/5.0 2021-05-12 22:28:04 UTC (rev 50853)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/5.0 2021-05-12 22:28:34 UTC (rev 50854)
</ins><a id="branches50"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/5.0</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.8:42204
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/4.9:43557,43622,44991
</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:42132,42134,42136,42138,42140,42144,42146,42148,42150,42152-42153,42155,42157,42159,42161,42163,42169,42171,42173,42175,42177,42181,42183,42185,42187,42189,42191,42193,42199,42203,42210,42214,42220,42222,42226,42242,42244,42247,42250-42251,42256-42261,42350,42354,42358,42362,42364-42368,42374,42388,42390,42401,42405,42417,42421,42423-42425,42430,42432-42433,42437,42441,42443-42444,42446-42447,42449,42451,42453,42457,42459,42462,42491,42521,42529,42531,42533,42536,42538,42541,42543,42545,42549,42566,42568,42570,42572,42574,42576,42579,42581-42582,42584-42585,42587-42588,42590,42592,42594-42595,42598-42599,42602,42604,42606,42611-42613,42615,42617,42624-42625,42639,42642,42648,42652-42653,42665,42676,42687,42695,42697,42701-42702,42711,42713,42719,42722,42726,42728,42733,42739-42740,42744,42758,42772,42791-42792,42801,42807,42812,42814-42815,42817-42819,42823,42830,42837,42839,42841
,42844,42851-42852,42860,42862,42864,42878-42879,42881,42888-42889,42892-42894,42930,42964-42965,42967,42971-42972,42977-42978,42980-42982,42985-42987,42989,42992,42994-42995,42998-42999,43001-43004,43007-43008,43011-43012,43014-43015,43025,43027,43030,43032,43034,43036,43039,43042,43044-43049,43051-43063,43065,43081,43085,43087-43089,43091,43104,43116,43118,43120-43121,43123,43125-43126,43131-43132,43135,43137,43139,43145-43148,43150,43154-43155,43158,43160,43162,43166,43168,43170,43172,43175,43180-43181,43183-43185,43189,43191,43193,43195,43197,43199,43201,43203,43206,43208,43210-43212,43216,43218,43220,43222-43223,43226,43228,43230,43232,43234,43236,43238,43242-43243,43245-43246,43248-43251,43256,43259-43260,43263,43265,43267,43269,43274-43275,43278-43279,43282,43284,43286,43290,43293,43299,43303-43304,43313,43315,43317,43331,43337,43343,43350,43353,43356,43361-43363,43365,43367,43370-43371,43373-43376,43379,43388,43390,43435,43437,43439-43440,43446-43447,43451,43454,43457,43460,
43462-43467,43469,43471,43475,43477-43478,43480,43486,43491,43493,43495,43499,43504,43506,43508,43511-43513,43518,43525,43527,43529,43531,43541,43550,43559,43561,43565,43567,43574,43578,43580,43584-43586,43589,43593,43597,43599,43601,43604-43605,43609,43636,43638,43645,43647,43653,43658-43659,43664,43673,44021,44048,44233,44322,44338,44368-44371,44376-44382,44389,44391,44398-44399,44402-44403,44406,44408,44418,44432,44435,44437-44439,44441-44442,44728,44833,44842,44993,45067,45321,45745,45762,45765,45783-45784,45800,45819,45826,45885,45936,45971,45990,45997,46320,46403-46404,46408-46409,46474-46478,46483,46485,46682,46893-46896,46996,46999,47225,47341,47404,47633-47638,47867-47869,47872-47873,47912,47948-47951,47984,48121,48241,48338,48341,48705,49162,49168-49169,49175,49204,49227-49228,49244,49335,49358,49360,49362,49369,49371,49380,49382-49388,49548,49636,49781-49784,49786,49836,49876,49933,49937-49940,49983,49989,50017,50126,50176,50185,50192,50267-50268,50285,50298,50379,50387,5
0413,50416,50432,50435-50436,50444,50446,50473-50474,50476,50479,50485-50487,50545,50579,50590,50598,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:42132,42134,42136,42138,42140,42144,42146,42148,42150,42152-42153,42155,42157,42159,42161,42163,42169,42171,42173,42175,42177,42181,42183,42185,42187,42189,42191,42193,42199,42203,42210,42214,42220,42222,42226,42242,42244,42247,42250-42251,42256-42261,42350,42354,42358,42362,42364-42368,42374,42388,42390,42401,42405,42417,42421,42423-42425,42430,42432-42433,42437,42441,42443-42444,42446-42447,42449,42451,42453,42457,42459,42462,42491,42521,42529,42531,42533,42536,42538,42541,42543,42545,42549,42566,42568,42570,42572,42574,42576,42579,42581-42582,42584-42585,42587-42588,42590,42592,42594-42595,42598-42599,42602,42604,42606,42611-42613,42615,42617,42624-42625,42639,42642,42648,42652-42653,42665,42676,42687,42695,42697,42701-42702,42711,42713,42719,42722,42726,42728,42733,42739-42740,42744,42758,42772,42791-42792,42801,42807,42812,42814-42815,42817-42819,42823,42830,42837,42839,42841
,42844,42851-42852,42860,42862,42864,42878-42879,42881,42888-42889,42892-42894,42930,42964-42965,42967,42971-42972,42977-42978,42980-42982,42985-42987,42989,42992,42994-42995,42998-42999,43001-43004,43007-43008,43011-43012,43014-43015,43025,43027,43030,43032,43034,43036,43039,43042,43044-43049,43051-43063,43065,43081,43085,43087-43089,43091,43104,43116,43118,43120-43121,43123,43125-43126,43131-43132,43135,43137,43139,43145-43148,43150,43154-43155,43158,43160,43162,43166,43168,43170,43172,43175,43180-43181,43183-43185,43189,43191,43193,43195,43197,43199,43201,43203,43206,43208,43210-43212,43216,43218,43220,43222-43223,43226,43228,43230,43232,43234,43236,43238,43242-43243,43245-43246,43248-43251,43256,43259-43260,43263,43265,43267,43269,43274-43275,43278-43279,43282,43284,43286,43290,43293,43299,43303-43304,43313,43315,43317,43331,43337,43343,43350,43353,43356,43361-43363,43365,43367,43370-43371,43373-43376,43379,43388,43390,43435,43437,43439-43440,43446-43447,43451,43454,43457,43460,
43462-43467,43469,43471,43475,43477-43478,43480,43486,43491,43493,43495,43499,43504,43506,43508,43511-43513,43518,43525,43527,43529,43531,43541,43550,43559,43561,43565,43567,43574,43578,43580,43584-43586,43589,43593,43597,43599,43601,43604-43605,43609,43636,43638,43645,43647,43653,43658-43659,43664,43673,44021,44048,44233,44322,44338,44368-44371,44376-44382,44389,44391,44398-44399,44402-44403,44406,44408,44418,44432,44435,44437-44439,44441-44442,44728,44833,44842,44993,45067,45321,45745,45762,45765,45783-45784,45800,45819,45826,45885,45936,45971,45990,45997,46320,46403-46404,46408-46409,46474-46478,46483,46485,46682,46893-46896,46996,46999,47225,47341,47404,47633-47638,47867-47869,47872-47873,47912,47948-47951,47984,48121,48241,48338,48341,48705,49162,49168-49169,49175,49204,49227-49228,49244,49335,49358,49360,49362,49369,49371,49380,49382-49388,49548,49636,49781-49784,49786,49836,49876,49933,49937-49940,49983,49989,50017,50126,50176,50185,50192,50267-50268,50285,50298,50379,50387,5
0413,50416,50432,50435-50436,50444,50446,50473-50474,50476,50479,50485-50487,50545,50579,50590,50598,50717,50799
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches50srcwpincludesclassphpmailerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/wp-includes/class-phpmailer.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-includes/class-phpmailer.php 2021-05-12 22:28:04 UTC (rev 50853)
+++ branches/5.0/src/wp-includes/class-phpmailer.php 2021-05-12 22:28:34 UTC (rev 50854)
</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>