X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fmime.php;h=e6781752d284b618f5efac14ca0bf700aac1b96d;hp=9e4f00a95f276db0ffd4bcb2e70820cd8cd38c4a;hb=154dda4a691d83662e2f201da1584e160de10507;hpb=0493ed1186b2b5393e29facef012b1a028e8e52d diff --git a/functions/mime.php b/functions/mime.php index 9e4f00a9..e6781752 100644 --- a/functions/mime.php +++ b/functions/mime.php @@ -3,21 +3,41 @@ /** * mime.php * - * Copyright (c) 1999-2005 The SquirrelMail Project Team - * Licensed under the GNU GPL. For full terms see the file COPYING. - * * This contains the functions necessary to detect and decode MIME * messages. * + * @copyright © 1999-2007 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License * @version $Id$ * @package squirrelmail */ -/** The typical includes... */ -require_once(SM_PATH . 'functions/imap.php'); -require_once(SM_PATH . 'functions/attachment_common.php'); -/** add sqm_baseuri()*/ -include_once(SM_PATH . 'functions/display_messages.php'); +/** + * dependency information + functions dependency + mime_structure + class/mime/Message.class.php + Message::parseStructure + functions/page_header.php + displayPageHeader + functions/display_messages.php + plain_error_message + mime_fetch_body + functions/imap_general.php + sqimap_run_command + mime_print_body_lines + + + +functions/imap.php +functions/attachment_common.php +functions/display_messages.php + +magicHtml => url_parser +translateText => url_parser + +*/ + /* -------------------------------------------------------------------------- */ /* MIME DECODING */ @@ -37,20 +57,20 @@ function mime_structure ($bodystructure, $flags=array()) { $read = trim(substr ($read, 0, -1)); $i = 0; $msg = Message::parseStructure($read,$i); + if (!is_object($msg)) { - include_once(SM_PATH . 'functions/display_messages.php'); global $color, $mailbox; - /* removed urldecode because $_GET is auto urldecoded ??? */ displayPageHeader( $color, $mailbox ); $errormessage = _("SquirrelMail could not decode the bodystructure of the message"); $errormessage .= '
'._("The bodystructure provided by your IMAP server:").'

'; $errormessage .= '
' . htmlspecialchars($read) . '
'; - plain_error_message( $errormessage, $color ); + plain_error_message( $errormessage ); echo ''; exit; } if (count($flags)) { foreach ($flags as $flag) { +//FIXME: please document why it is we have to check the first char of the flag but we then go ahead and do a full string comparison anyway. Is this a speed enhancement? If not, let's keep it simple and just compare the full string and forget the switch block. $char = strtoupper($flag{1}); switch ($char) { case 'S': @@ -127,6 +147,8 @@ function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) { // } } else if (ereg('"([^"]*)"', $topline, $regs)) { $ret = $regs[1]; + } else if ((stristr($topline, 'nil') !== false) && (empty($wholemessage))) { + $ret = $wholemessage; } else { global $where, $what, $mailbox, $passed_id, $startMessage; $par = 'mailbox=' . urlencode($mailbox) . '&passed_id=' . $passed_id; @@ -159,7 +181,7 @@ function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) { return $ret; } -function mime_print_body_lines ($imap_stream, $id, $ent_id=1, $encoding, $rStream='php://stdout') { +function mime_print_body_lines ($imap_stream, $id, $ent_id=1, $encoding, $rStream='php://stdout', $force_crlf='') { /* Don't kill the connection if the browser is over a dialup * and it would take over 30 seconds to download it. @@ -181,9 +203,9 @@ function mime_print_body_lines ($imap_stream, $id, $ent_id=1, $encoding, $rStrea } else { $body = mime_fetch_body ($imap_stream, $id, $ent_id); if (is_resource($rStream)) { - fputs($rStream,decodeBody($body,$encoding)); + fputs($rStream,decodeBody($body, $encoding, $force_crlf)); } else { - echo decodeBody($body, $encoding); + echo decodeBody($body, $encoding, $force_crlf); } } @@ -265,7 +287,7 @@ function translateText(&$body, $wrap_at, $charset) { global $where, $what; /* from searching */ global $color; /* color theme */ - require_once(SM_PATH . 'functions/url_parser.php'); + // require_once(SM_PATH . 'functions/url_parser.php'); $body_ary = explode("\n", $body); for ($i=0; $i < count($body_ary); $i++) { @@ -294,15 +316,9 @@ function translateText(&$body, $wrap_at, $charset) { } if ($quotes % 2) { - if (!isset($color[13])) { - $color[13] = '#800000'; - } - $line = '' . $line . ''; + $line = '' . $line . ''; } elseif ($quotes) { - if (!isset($color[14])) { - $color[14] = '#FF0000'; - } - $line = '' . $line . ''; + $line = '' . $line . ''; } $body_ary[$i] = $line; @@ -326,23 +342,25 @@ function translateText(&$body, $wrap_at, $charset) { * @param string $ent_num (since 1.3.0) message part id * @param integer $id (since 1.3.0) message id * @param string $mailbox (since 1.3.0) imap folder name - * @param boolean $clean (since 1.5.1) Do not output stuff that's irrelevant for the printable version. * @return string html formated message text */ -function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $mailbox='INBOX', $clean=FALSE) { +function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $mailbox='INBOX') { /* This if statement checks for the entity to show as the * primary message. To add more of them, just put them in the * order that is their priority. */ global $startMessage, $languages, $squirrelmail_language, - $show_html_default, $sort, $has_unsafe_images, $passed_ent_id, $use_iframe,$iframe_height; + $show_html_default, $sort, $has_unsafe_images, $passed_ent_id, + $use_iframe, $iframe_height, $download_and_unsafe_link, + $download_href, $unsafe_image_toggle_href, $unsafe_image_toggle_text, + $oTemplate, $nbsp; // workaround for not updated config.php if (! isset($use_iframe)) $use_iframe = false; - if( !sqgetGlobalVar('view_unsafe_images', $view_unsafe_images, SQ_GET) ) { - $view_unsafe_images = false; - } + // If there's no "view_unsafe_images" variable in the URL, turn unsafe + // images off by default. + sqgetGlobalVar('view_unsafe_images', $view_unsafe_images, SQ_GET, FALSE); $body = ''; $urlmailbox = urlencode($mailbox); @@ -358,8 +376,9 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma $body = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode',$body); } } - $hookResults = do_hook("message_body", $body); - $body = $hookResults[1]; + + /* As of 1.5.2, $body is passed (and modified) by reference */ + do_hook('message_body', $body); /* If there are other types that shouldn't be formatted, add * them here. @@ -381,14 +400,14 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma $body = trim($body); translateText($body, $wrap_at, $body_message->header->getParameter('charset')); - } elseif ($use_iframe && ! $clean) { - // $clean is used to remove iframe in printable view. - + } elseif ($use_iframe) { /** * If we don't add html message between iframe tags, * we must detect unsafe images and modify $has_unsafe_images. */ - $html_body = magicHTML($body, $id, $message, $mailbox); + $html_body = magicHTML($body, $id, $message, $mailbox); + // Convert character set in order to display html mails in different character set + $html_body = charset_decode($body_message->header->getParameter('charset'),$html_body,false,true); // creating iframe url $iframeurl=sqm_baseuri().'src/view_html.php?' @@ -397,35 +416,23 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma . '&ent_id=' . $ent_num . '&view_unsafe_images=' . (int) $view_unsafe_images; - // adding warning message - $body = html_tag('div',_("Viewing HTML formatted email"),'center'); + global $oTemplate; + $oTemplate->assign('iframe_url', $iframeurl); + $oTemplate->assign('iframe_height', $iframe_height); + $oTemplate->assign('html_body', $html_body); - /** - * height can't be set to 100%, because it does not work as expected when - * iframe is inside the table. Browsers do not create full height objects - * even when iframe is not nested. Maybe there is some way to get full size - * with CSS. Tested in firefox 1.02 and opera 7.53 - * - * width="100%" does not work as expected, when table width is not set (automatic) - * - * tokul: I think \n"; + $body = $oTemplate->fetch('read_html_iframe.tpl'); } else { // old way of html rendering + /** + * convert character set. charset_decode does not remove html special chars + * applied by magicHTML functions and does not sanitize them second time if + * fourth argument is true. + */ + $charset = $body_message->header->getParameter('charset'); + if (!empty($charset)) { + $body = charset_decode($charset,$body,false,true); + } $body = magicHTML($body, $id, $message, $mailbox); } } else { @@ -433,19 +440,37 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma $body_message->header->getParameter('charset')); } - // if this is the clean display (i.e. printer friendly), stop here. - if ( $clean ) { - return $body; - } + /* + * Previously the links for downloading and unsafe images were printed + * under the mail. By putting the links in a global variable we can + * print it in the toolbar where it belongs. Since the original code was + * in this place it's left here. It might be possible to move it to some + * other place if that makes sense. The possibility to do so has not + * been evaluated yet. + */ + // Initialize the global variable to an empty string. + // FIXME: To have $download_and_unsafe_link as a global variable might not be needed since the use of separate variables ($download_href, $unsafe_image_toggle_href, and $unsafe_image_toggle_text) for the templates was introduced. + $download_and_unsafe_link = ''; + + // Prepare and build a link for downloading the mail. $link = 'passed_id=' . $id . '&ent_id='.$ent_num. '&mailbox=' . $urlmailbox .'&sort=' . $sort . '&startMessage=' . $startMessage . '&show_more=0'; if (isset($passed_ent_id)) { $link .= '&passed_ent_id='.$passed_ent_id; } - $body .= '
' . _("Download this as a file") . ''; + $download_href = SM_PATH . 'src/download.php?absolute_dl=true&' . $link; + + // Always add the link for downloading the mail as a file to the global + // variable. + $download_and_unsafe_link .= "$nbsp|$nbsp" + . create_hyperlink($download_href, _("Download this as a file")); + + // Find out the right text to use in the link depending on the + // circumstances. If the unsafe images are displayed the link should + // hide them, if they aren't displayed the link should only appear if + // the mail really contains unsafe images. if ($view_unsafe_images) { $text = _("Hide Unsafe Images"); } else { @@ -456,51 +481,48 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma $text = ''; } } + + // Only create a link for unsafe images if there's need for one. If so: + // add it to the global variable. if($text != '') { - $body .= ' | ' . $text . ''; + $unsafe_image_toggle_href = SM_PATH . 'src/read_body.php?'.$link; + $unsafe_image_toggle_text = $text; + $download_and_unsafe_link .= "$nbsp|$nbsp" + . create_hyperlink($unsafe_image_toggle_href, $text); } - $body .= '

' . "\n"; } return $body; } /** - * Displays attachment links and information - * - * Since 1.3.0 function is not included in formatBody() call. - * - * Since 1.0.2 uses attachment $type0/$type1 hook. - * Since 1.2.5 uses attachment $type0/* hook. - * Since 1.5.0 uses attachments_bottom hook. + * Generate attachments array for passing to templates. * + * @since 1.5.2 * @param object $message SquirrelMail message object * @param array $exclude_id message parts that are not attachments. * @param string $mailbox mailbox name * @param integer $id message id - * @return string html formated attachment information. */ -function formatAttachments($message, $exclude_id, $mailbox, $id) { - global $where, $what, $startMessage, $color, $passed_ent_id; +function buildAttachmentArray($message, $exclude_id, $mailbox, $id) { + global $where, $what, $startMessage, $color, $passed_ent_id, $base_uri; $att_ar = $message->getAttachments($exclude_id); - - if (!count($att_ar)) return ''; - - $attachments = ''; - $urlMailbox = urlencode($mailbox); + $attachments = array(); foreach ($att_ar as $att) { $ent = $att->entity_id; $header = $att->header; $type0 = strtolower($header->type0); $type1 = strtolower($header->type1); $name = ''; + $links = array(); $links['download link']['text'] = _("Download"); - $links['download link']['href'] = sqm_baseuri() . + $links['download link']['href'] = $base_uri . "src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&ent_id=$ent"; + if ($type0 =='message' && $type1 == 'rfc822') { - $default_page = sqm_baseuri() . 'src/read_body.php'; + $default_page = $base_uri . 'src/read_body.php'; $rfc822_header = $att->rfc822_header; $filename = $rfc822_header->subject; if (trim( $filename ) == '') { @@ -509,12 +531,19 @@ function formatAttachments($message, $exclude_id, $mailbox, $id) { $from_o = $rfc822_header->from; if (is_object($from_o)) { $from_name = decodeHeader($from_o->getAddress(false)); + } elseif (is_array($from_o) && count($from_o) && is_object($from_o[0])) { + // something weird happens when a digest message is opened and you return to the digest + // now the from object is part of an array. Probably the parseHeader call overwrites the info + // retrieved from the bodystructure in a different way. We need to fix this later. + // possible starting point, do not fetch header we already have and inspect how + // the rfc822_header object behaves. + $from_name = decodeHeader($from_o[0]->getAddress(false)); } else { $from_name = _("Unknown sender"); } - $description = $from_name; + $description = _("From").': '.$from_name; } else { - $default_page = sqm_baseuri() . 'src/download.php'; + $default_page = $base_uri . 'src/download.php'; $filename = $att->getFilename(); if ($header->description) { $description = decodeHeader($header->description); @@ -535,53 +564,105 @@ function formatAttachments($message, $exclude_id, $mailbox, $id) { if ($where && $what) { $defaultlink .= '&where='. urlencode($where).'&what='.urlencode($what); } + // IE does make use of mime content sniffing. Forcing a download + // prohibit execution of XSS inside an application/octet-stream attachment + if ($type0 == 'application' && $type1 == 'octet-stream') { + $defaultlink .= '&absolute_dl=true'; + } /* This executes the attachment hook with a specific MIME-type. * If that doesn't have results, it tries if there's a rule - * for a more generic type. + * for a more generic type. Finally, a hook for ALL attachment + * types is run as well. */ - $hookresults = do_hook("attachment $type0/$type1", $links, - $startMessage, $id, $urlMailbox, $ent, $defaultlink, - $display_filename, $where, $what); - if(count($hookresults[1]) <= 1) { - $hookresults = do_hook("attachment $type0/*", $links, - $startMessage, $id, $urlMailbox, $ent, $defaultlink, - $display_filename, $where, $what); + // First remember the default link. + $defaultlink_orig = $defaultlink; + + /* The API for this hook has changed as of 1.5.2 so that all plugin + arguments are passed in an array instead of each their own plugin + argument, and arguments are passed by reference, so instead of + returning any changes, changes should simply be made to the original + arguments themselves. */ + $temp = array(&$links, &$startMessage, &$id, &$urlMailbox, &$ent, + &$defaultlink, &$display_filename, &$where, &$what); + do_hook("attachment $type0/$type1", $temp); + if(count($links) <= 1 && $defaultlink == $defaultlink_orig) { + /* The API for this hook has changed as of 1.5.2 so that all plugin + arguments are passed in an array instead of each their own plugin + argument, and arguments are passed by reference, so instead of + returning any changes, changes should simply be made to the original + arguments themselves. */ + $temp = array(&$links, &$startMessage, &$id, &$urlMailbox, &$ent, + &$defaultlink, &$display_filename, &$where, &$what); + do_hook("attachment $type0/*", $temp); } - - $links = $hookresults[1]; - $defaultlink = $hookresults[6]; - - $attachments .= '' . - ''.decodeHeader($display_filename).' ' . - '' . show_readable_size($header->size) . - '  ' . - '[ '.htmlspecialchars($type0).'/'.htmlspecialchars($type1).' ] ' . - ''; - $attachments .= '' . $description . ''; - $attachments .= ' '; - - $skipspaces = 1; + /* The API for this hook has changed as of 1.5.2 so that all plugin + arguments are passed in an array instead of each their own plugin + argument, and arguments are passed by reference, so instead of + returning any changes, changes should simply be made to the original + arguments themselves. */ + $temp = array(&$links, &$startMessage, &$id, &$urlMailbox, &$ent, + &$defaultlink, &$display_filename, &$where, &$what); + // Do not let a generic plugin change the default link if a more + // specialized one already did it... + if ($defaultlink != $defaultlink_orig) { + $dummy = ''; + $temp[5] = &$dummy; + } + do_hook("attachment */*", $temp); + + $this_attachment = array(); + $this_attachment['Name'] = decodeHeader($display_filename); + $this_attachment['Description'] = $description; + $this_attachment['DefaultHREF'] = $defaultlink; + $this_attachment['DownloadHREF'] = $links['download link']['href']; + $this_attachment['ViewHREF'] = isset($links['attachment_common']) ? $links['attachment_common']['href'] : ''; + $this_attachment['Size'] = $header->size; + $this_attachment['ContentType'] = htmlspecialchars($type0 .'/'. $type1); + $this_attachment['OtherLinks'] = array(); foreach ($links as $val) { - if ($skipspaces) { - $skipspaces = 0; - } else { - $attachments .= '  |  '; - } - $attachments .= '' - . (isset($val['text']) && !empty($val['text']) ? $val['text'] : '') - . (isset($val['extra']) && !empty($val['extra']) ? $val['extra'] : '') - . ''; + if ($val['text']==_("Download") || $val['text'] == _("View")) + continue; + if (empty($val['text']) && empty($val['extra'])) + continue; + + $temp = array(); + $temp['HREF'] = $val['href']; + $temp['Text'] = (empty($val['text']) ? '' : $val['text']) . (empty($val['extra']) ? '' : $val['extra']); + $this_attachment['OtherLinks'][] = $temp; } + $attachments[] = $this_attachment; + unset($links); - $attachments .= "\n"; } - $attachmentadd = do_hook_function('attachments_bottom',$attachments); - if ($attachmentadd != '') - $attachments = $attachmentadd; + return $attachments; } +/** + * Displays attachment links and information + * + * Since 1.3.0 function is not included in formatBody() call. + * + * Since 1.0.2 uses attachment $type0/$type1 hook. + * Since 1.2.5 uses attachment $type0/* hook. + * Since 1.5.0 uses attachments_bottom hook. + * Since 1.5.2 uses templates and does *not* return a value. + * + * @param object $message SquirrelMail message object + * @param array $exclude_id message parts that are not attachments. + * @param string $mailbox mailbox name + * @param integer $id message id + */ +function formatAttachments($message, $exclude_id, $mailbox, $id) { + global $oTemplate; + + $attach = buildAttachmentArray($message, $exclude_id, $mailbox, $id); + + $oTemplate->assign('attachments', $attach); + $oTemplate->display('read_attachments.tpl'); +} + function sqimap_base64_decode(&$string) { // Base64 encoded data goes in pairs of 4 bytes. To achieve on the @@ -606,52 +687,96 @@ function sqimap_base64_decode(&$string) { return $sStringRem; } +/** + * Decodes encoded string (usually message body) + * + * This function decodes a string (usually the message body) + * depending on the encoding type. Currently quoted-printable + * and base64 encodings are supported. + * + * The decode_body hook was added to this function in 1.4.2/1.5.0. + * The $force_crlf parameter was added in 1.5.2. + * + * @param string $string The encoded string + * @param string $encoding used encoding + * @param string $force_crlf Whether or not to force CRLF or LF + * line endings (or to leave as is). + * If given as "LF", line endings will + * all be converted to LF; if "CRLF", + * line endings will all be converted + * to CRLF. If given as an empty value, + * the global $default_force_crlf will + * be consulted (it can be specified in + * config/config_local.php). Otherwise, + * any other value will cause the string + * to be left alone. Note that this will + * be overridden to "LF" if not using at + * least PHP version 4.3.0. (OPTIONAL; + * default is empty - consult global + * default value) + * + * @return string The decoded string + * + * @since 1.0 + * + */ +function decodeBody($string, $encoding, $force_crlf='') { + + global $force_crlf_default; + if (empty($force_crlf)) $force_crlf = $force_crlf_default; + $force_crlf = strtoupper($force_crlf); -/* This function decodes the body depending on the encoding type. */ -function decodeBody($body, $encoding) { - global $show_html_default; + // must force line endings to LF due to broken + // quoted_printable_decode() in PHP versions + // before 4.3.0 (see below) + // + if (!check_php_version(4, 3, 0) || $force_crlf == 'LF') + $string = str_replace("\r\n", "\n", $string); + else if ($force_crlf == 'CRLF') + $string = str_replace("\n", "\r\n", $string); - $body = str_replace("\r\n", "\n", $body); $encoding = strtolower($encoding); - $encoding_handler = do_hook_function('decode_body', $encoding); + $encoding_handler = do_hook('decode_body', $encoding); - // plugins get first shot at decoding the body + // plugins get first shot at decoding the string // if (!empty($encoding_handler) && function_exists($encoding_handler)) { - $body = $encoding_handler('decode', $body); + $string = $encoding_handler('decode', $string); - } else if ($encoding == 'quoted-printable' || + } elseif ($encoding == 'quoted-printable' || $encoding == 'quoted_printable') { - $body = quoted_printable_decode($body); - while (ereg("=\n", $body)) { - $body = ereg_replace ("=\n", '', $body); - } + // quoted_printable_decode() function is broken in older + // php versions. Text with \r\n decoding was fixed only + // in php 4.3.0. Minimal code requirement is PHP 4.0.4+ + // and the above call to: str_replace("\r\n", "\n", $string); + // + $string = quoted_printable_decode($string); - } else if ($encoding == 'base64') { - $body = base64_decode($body); + } elseif ($encoding == 'base64') { + $string = base64_decode($string); } // All other encodings are returned raw. - return $body; + return $string; } /** * Decodes headers * - * This functions decode strings that is encoded according to + * This function decodes strings that are encoded according to * RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text). * Patched by Christian Schmidt 23/03/2002 * * @param string $string header string that has to be made readable * @param boolean $utfencode change message in order to be readable on user's charset. defaults to true - * @param boolean $htmlsave preserve spaces and sanitize html special characters. defaults to true + * @param boolean $htmlsafe preserve spaces and sanitize html special characters. defaults to true * @param boolean $decide decide if string can be utfencoded. defaults to false * @return string decoded header string */ -function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { +function decodeHeader ($string, $utfencode=true,$htmlsafe=true,$decide=false) { global $languages, $squirrelmail_language,$default_charset; if (is_array($string)) { $string = implode("\n", $string); @@ -683,7 +808,7 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { while ($match = preg_match('/^(.*)=\?([^?]*)\?(Q|B)\?([^?]*)\?=(.*)$/Ui',$chunk,$res)) { /* if the last chunk isn't an encoded string then put back the space, otherwise don't */ if ($iLastMatch !== $j) { - if ($htmlsave) { + if ($htmlsafe) { $ret .= ' '; } else { $ret .= ' '; @@ -691,7 +816,7 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { } $iLastMatch = $i; $j = $i; - if ($htmlsave) { + if ($htmlsafe) { $ret .= htmlspecialchars($res[1]); } else { $ret .= $res[1]; @@ -714,13 +839,13 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { /* convert string to different charset, * if functions asks for it (usually in compose) */ - $ret .= charset_convert($res[2],$replace,$default_charset); + $ret .= charset_convert($res[2],$replace,$default_charset,$htmlsafe); } else { // convert string to html codes in order to display it $ret .= charset_decode($res[2],$replace); } } else { - if ($htmlsave) { + if ($htmlsafe) { $replace = htmlspecialchars($replace); } $ret.= $replace; @@ -735,13 +860,13 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { /* convert string to different charset, * if functions asks for it (usually in compose) */ - $replace = charset_convert($res[2], $replace,$default_charset); + $replace = charset_convert($res[2], $replace,$default_charset,$htmlsafe); } else { // convert string to html codes in order to display it $replace = charset_decode($res[2], $replace); } } else { - if ($htmlsave) { + if ($htmlsafe) { $replace = htmlspecialchars($replace); } } @@ -754,14 +879,14 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { $encoded = true; } if (!$encoded) { - if ($htmlsave) { + if ($htmlsafe) { $ret .= ' '; } else { $ret .= ' '; } } - if (!$encoded && $htmlsave) { + if (!$encoded && $htmlsafe) { $ret .= htmlspecialchars($chunk); } else { $ret .= $chunk; @@ -770,7 +895,7 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { } /* remove the first added space */ if ($ret) { - if ($htmlsave) { + if ($htmlsafe) { $ret = substr($ret,5); } else { $ret = substr($ret,1); @@ -781,14 +906,22 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { } /** - * Encodes header as quoted-printable + * Encodes header + * + * Function uses XTRA_CODE _encodeheader function, if such function exists. * - * Encode a string according to RFC 1522 for use in headers if it - * contains 8-bit characters or anything that looks like it should - * be encoded. + * Function uses Q encoding by default and encodes a string according to RFC + * 1522 for use in headers if it contains 8-bit characters or anything that + * looks like it should be encoded. + * + * Function switches to B encoding and encodeHeaderBase64() function, if + * string is 8bit and multibyte character set supported by mbstring extension + * is used. It can cause E_USER_NOTICE errors, if interface is used with + * multibyte character set unsupported by mbstring extension. * * @param string $string header string, that has to be encoded * @return string quoted-printable encoded string + * @todo make $mb_charsets system wide constant */ function encodeHeader ($string) { global $default_charset, $languages, $squirrelmail_language; @@ -798,6 +931,19 @@ function encodeHeader ($string) { return call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_encodeheader', $string); } + // Use B encoding for multibyte charsets + $mb_charsets = array('utf-8','big5','gb2313','euc-kr'); + if (in_array($default_charset,$mb_charsets) && + in_array($default_charset,sq_mb_list_encodings()) && + sq_is8bit($string)) { + return encodeHeaderBase64($string,$default_charset); + } elseif (in_array($default_charset,$mb_charsets) && + sq_is8bit($string) && + ! in_array($default_charset,sq_mb_list_encodings())) { + // Add E_USER_NOTICE error here (can cause 'Cannot add header information' warning in compose.php) + // trigger_error('encodeHeader: Multibyte character set unsupported by mbstring extension.',E_USER_NOTICE); + } + // Encode only if the string contains 8-bit characters or =? $j = strlen($string); $max_l = 75 - strlen($default_charset) - 7; @@ -911,6 +1057,100 @@ function encodeHeader ($string) { return $string; } +/** + * Encodes string according to rfc2047 B encoding header formating rules + * + * It is recommended way to encode headers with character sets that store + * symbols in more than one byte. + * + * Function requires mbstring support. If required mbstring functions are missing, + * function returns false and sets E_USER_WARNING level error message. + * + * Minimal requirements - php 4.0.6 with mbstring extension. Please note, + * that mbstring functions will generate E_WARNING errors, if unsupported + * character set is used. mb_encode_mimeheader function provided by php + * mbstring extension is not used in order to get better control of header + * encoding. + * + * Used php code functions - function_exists(), trigger_error(), strlen() + * (is used with charset names and base64 strings). Used php mbstring + * functions - mb_strlen and mb_substr. + * + * Related documents: rfc 2045 (BASE64 encoding), rfc 2047 (mime header + * encoding), rfc 2822 (header folding) + * + * @param string $string header string that must be encoded + * @param string $charset character set. Must be supported by mbstring extension. + * Use sq_mb_list_encodings() to detect supported charsets. + * @return string string encoded according to rfc2047 B encoding formating rules + * @since 1.5.1 + * @todo First header line can be wrapped to $iMaxLength - $HeaderFieldLength - 1 + * @todo Do we want to control max length of header? + * @todo Do we want to control EOL (end-of-line) marker? + * @todo Do we want to translate error message? + */ +function encodeHeaderBase64($string,$charset) { + /** + * Check mbstring function requirements. + */ + if (! function_exists('mb_strlen') || + ! function_exists('mb_substr')) { + // set E_USER_WARNING + trigger_error('encodeHeaderBase64: Required mbstring functions are missing.',E_USER_WARNING); + // return false + return false; + } + + // initial return array + $aRet = array(); + + /** + * header length = 75 symbols max (same as in encodeHeader) + * remove $charset length + * remove =? ? ?= (5 chars) + * remove 2 more chars (\r\n ?) + */ + $iMaxLength = 75 - strlen($charset) - 7; + + // set first character position + $iStartCharNum = 0; + + // loop through all characters. count characters and not bytes. + for ($iCharNum=1; $iCharNum<=mb_strlen($string,$charset); $iCharNum++) { + // encode string from starting character to current character. + $encoded_string = base64_encode(mb_substr($string,$iStartCharNum,$iCharNum-$iStartCharNum,$charset)); + + // Check encoded string length + if(strlen($encoded_string)>$iMaxLength) { + // if string exceeds max length, reduce number of encoded characters and add encoded string part to array + $aRet[] = base64_encode(mb_substr($string,$iStartCharNum,$iCharNum-$iStartCharNum-1,$charset)); + + // set new starting character + $iStartCharNum = $iCharNum-1; + + // encode last char (in case it is last character in string) + $encoded_string = base64_encode(mb_substr($string,$iStartCharNum,$iCharNum-$iStartCharNum,$charset)); + } // if string is shorter than max length - add next character + } + + // add last encoded string to array + $aRet[] = $encoded_string; + + // set initial return string + $sRet = ''; + + // loop through encoded strings + foreach($aRet as $string) { + // TODO: Do we want to control EOL (end-of-line) marker + if ($sRet!='') $sRet.= " "; + + // add header tags and encoded string to return string + $sRet.= '=?'.$charset.'?B?'.$string.'?='; + } + + return $sRet; +} + /* This function trys to locate the entity_id of a specific mime element */ function find_ent_id($id, $message) { for ($i = 0, $ret = ''; $ret == '' && $i < count($message->entities); $i++) { @@ -966,6 +1206,11 @@ function sq_defang(&$attvalue){ return; } $m = false; + // before deent, translate the dangerous unicode characters and ... to safe values + // otherwise the regular expressions do not match. + + + do { $m = false; $m = $m || sq_deent($attvalue, '/\�*(\d+);*/s'); @@ -991,6 +1236,83 @@ function sq_unspace(&$attvalue){ } } +/** + * Translate all dangerous Unicode or Shift_JIS characters which are accepted by + * IE as regular characters. + * + * @param attvalue The attribute value before dangerous characters are translated. + * @return attvalue Nothing, modifies a reference value. + * @author Marc Groot Koerkamp. + */ +function sq_fixIE_idiocy(&$attvalue) { + // remove NUL + $attvalue = str_replace("\0", "", $attvalue); + // remove comments + $attvalue = preg_replace("/(\/\*.*?\*\/)/","",$attvalue); + + // IE has the evil habit of accepting every possible value for the attribute expression. + // The table below contains characters which are parsed by IE if they are used in the "expression" + // attribute value. + $aDangerousCharsReplacementTable = array( + array('ʟ', 'ʟ' ,/* L UNICODE IPA Extension */ + 'ʀ', 'ʀ' ,/* R UNICODE IPA Extension */ + 'ɴ', 'ɴ' ,/* N UNICODE IPA Extension */ + 'Ｅ', 'Ｅ' ,/* Unicode FULLWIDTH LATIN CAPITAL LETTER E */ + 'ｅ', 'ｅ' ,/* Unicode FULLWIDTH LATIN SMALL LETTER E */ + 'Ｘ', 'Ｘ',/* Unicode FULLWIDTH LATIN CAPITAL LETTER X */ + 'ｘ', 'ｘ',/* Unicode FULLWIDTH LATIN SMALL LETTER X */ + 'Ｐ', 'Ｐ',/* Unicode FULLWIDTH LATIN CAPITAL LETTER P */ + 'ｐ', 'ｐ',/* Unicode FULLWIDTH LATIN SMALL LETTER P */ + 'Ｒ', 'Ｒ',/* Unicode FULLWIDTH LATIN CAPITAL LETTER R */ + 'ｒ', 'ｒ',/* Unicode FULLWIDTH LATIN SMALL LETTER R */ + 'Ｓ', 'Ｓ',/* Unicode FULLWIDTH LATIN CAPITAL LETTER S */ + 'ｓ', 'ｓ',/* Unicode FULLWIDTH LATIN SMALL LETTER S */ + 'Ｉ', 'Ｉ',/* Unicode FULLWIDTH LATIN CAPITAL LETTER I */ + 'ｉ', 'ｉ',/* Unicode FULLWIDTH LATIN SMALL LETTER I */ + 'Ｏ', 'Ｏ',/* Unicode FULLWIDTH LATIN CAPITAL LETTER O */ + 'ｏ', 'ｏ',/* Unicode FULLWIDTH LATIN SMALL LETTER O */ + 'Ｎ', 'Ｎ',/* Unicode FULLWIDTH LATIN CAPITAL LETTER N */ + 'ｎ', 'ｎ',/* Unicode FULLWIDTH LATIN SMALL LETTER N */ + 'Ｌ', 'Ｌ',/* Unicode FULLWIDTH LATIN CAPITAL LETTER L */ + 'ｌ', 'ｌ',/* Unicode FULLWIDTH LATIN SMALL LETTER L */ + 'Ｕ', 'Ｕ',/* Unicode FULLWIDTH LATIN CAPITAL LETTER U */ + 'ｕ', 'ｕ',/* Unicode FULLWIDTH LATIN SMALL LETTER U */ + 'ⁿ', 'ⁿ' ,/* Unicode SUPERSCRIPT LATIN SMALL LETTER N */ + "\xEF\xBC\xA5", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER E */ // in unicode this is some Chinese char range + "\xEF\xBD\x85", /* Shift JIS FULLWIDTH LATIN SMALL LETTER E */ + "\xEF\xBC\xB8", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER X */ + "\xEF\xBD\x98", /* Shift JIS FULLWIDTH LATIN SMALL LETTER X */ + "\xEF\xBC\xB0", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER P */ + "\xEF\xBD\x90", /* Shift JIS FULLWIDTH LATIN SMALL LETTER P */ + "\xEF\xBC\xB2", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER R */ + "\xEF\xBD\x92", /* Shift JIS FULLWIDTH LATIN SMALL LETTER R */ + "\xEF\xBC\xB3", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER S */ + "\xEF\xBD\x93", /* Shift JIS FULLWIDTH LATIN SMALL LETTER S */ + "\xEF\xBC\xA9", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER I */ + "\xEF\xBD\x89", /* Shift JIS FULLWIDTH LATIN SMALL LETTER I */ + "\xEF\xBC\xAF", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER O */ + "\xEF\xBD\x8F", /* Shift JIS FULLWIDTH LATIN SMALL LETTER O */ + "\xEF\xBC\xAE", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER N */ + "\xEF\xBD\x8E", /* Shift JIS FULLWIDTH LATIN SMALL LETTER N */ + "\xEF\xBC\xAC", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER L */ + "\xEF\xBD\x8C", /* Shift JIS FULLWIDTH LATIN SMALL LETTER L */ + "\xEF\xBC\xB5", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER U */ + "\xEF\xBD\x95", /* Shift JIS FULLWIDTH LATIN SMALL LETTER U */ + "\xE2\x81\xBF", /* Shift JIS FULLWIDTH SUPERSCRIPT N */ + "\xCA\x9F", /* L UNICODE IPA Extension */ + "\xCA\x80", /* R UNICODE IPA Extension */ + "\xC9\xB4"), /* N UNICODE IPA Extension */ + array('l', 'l', 'r','r','n','n', + 'E','E','e','e','X','X','x','x','P','P','p','p','R','R','r','r','S','S','s','s','I','I', + 'i','i','O','O','o','o','N','N','n','n','L','L','l','l','U','U','u','u','n','n', + 'E','e','X','x','P','p','R','r','S','s','I','i','O','o','N','n','L','l','U','u','n','l','r','n')); + $attvalue = str_replace($aDangerousCharsReplacementTable[0],$aDangerousCharsReplacementTable[1],$attvalue); + + // Escapes are useful for special characters like "{}[]()'&. In other cases they are + // used for XSS. + $attvalue = preg_replace("/(\\\\)([a-zA-Z]{1})/",'$2',$attvalue); +} + /** * This function returns the final tag out of the tag name, an array * of attributes, and the type of the tag. This function is called by @@ -1404,6 +1726,8 @@ function sq_getnxtag($body, $offset){ function sq_deent(&$attvalue, $regex, $hex=false){ $me = 'sq_deent'; $ret_match = false; + // remove comments + //$attvalue = preg_replace("/(\/\*.*\*\/)/","",$attvalue); preg_match_all($regex, $attvalue, $matches); if (is_array($matches) && sizeof($matches[0]) > 0){ $repl = Array(); @@ -1457,10 +1781,23 @@ function sq_fixatts($tagname, } } } + /** + * Workaround for IE quirks + */ + sq_fixIE_idiocy($attvalue); + /** * Remove any backslashes, entities, and extraneous whitespace. */ + + $oldattvalue = $attvalue; sq_defang($attvalue); + if ($attname == 'style' && $attvalue !== $oldattvalue) { + // entities are used in the attribute value. In 99% of the cases it's there as XSS + // i.e.
+ $attvalue = "idiocy"; + $attary{$attname} = $attvalue; + } sq_unspace($attvalue); /** @@ -1483,38 +1820,34 @@ function sq_fixatts($tagname, preg_replace($valmatch, $valrepl, $attvalue); if ($newvalue != $attvalue){ $attary{$attname} = $newvalue; + $attvalue = $newvalue; } } } } } - - /** - * Replace empty src tags with the blank image. src is only used - * for frames, images, and image inputs. Doing a replace should - * not affect them working as should be, however it will stop - * IE from being kicked off when src for img tags are not set - */ - if (($attname == 'src') && ($attvalue == '""')) { - $attary{$attname} = '"' . SM_PATH . 'images/blank.png"'; - } - - /** - * Turn cid: urls into http-friendly ones. - */ - if (preg_match("/^[\'\"]\s*cid:/si", $attvalue)){ - $attary{$attname} = sq_cid2http($message, $id, $attvalue, $mailbox); + if ($attname == 'style') { + if (preg_match('/[\0-\37\200-\377]+/',$attvalue)) { + // 8bit and control characters in style attribute values can be used for XSS, remove them + $attary{$attname} = '"disallowed character"'; + } + preg_match_all("/url\s*\((.+)\)/si",$attvalue,$aMatch); + if (count($aMatch)) { + foreach($aMatch[1] as $sMatch) { + // url value + $urlvalue = $sMatch; + sq_fix_url($attname, $urlvalue, $message, $id, $mailbox,"'"); + $attary{$attname} = str_replace($sMatch,$urlvalue,$attvalue); + } + } } - /** - * "Hack" fix for Outlook using propriatary outbind:// protocol in img tags. - * One day MS might actually make it match something useful, for now, falling - * back to using cid2http, so we can grab the blank.png. + * Use white list based filtering on attributes which can contain url's */ - if (preg_match("/^[\'\"]\s*outbind:\/\//si", $attvalue)) { - $attary{$attname} = sq_cid2http($message, $id, $attvalue, $mailbox); + else if ($attname == 'href' || $attname == 'src' || $attname == 'background') { + sq_fix_url($attname, $attvalue, $message, $id, $mailbox); + $attary{$attname} = $attvalue; } - } /** * See if we need to append any attributes to this tag. @@ -1527,6 +1860,157 @@ function sq_fixatts($tagname, return $attary; } +/** + * This function filters url's + * + * @param $attvalue String with attribute value to filter + * @param $message message object + * @param $id message id + * @param $mailbox mailbox + * @param $sQuote quoting characters around url's + */ +function sq_fix_url($attname, &$attvalue, $message, $id, $mailbox,$sQuote = '"') { + $attvalue = trim($attvalue); + if ($attvalue && ($attvalue[0] =='"'|| $attvalue[0] == "'")) { + // remove the double quotes + $sQuote = $attvalue[0]; + $attvalue = trim(substr($attvalue,1,-1)); + } + + // If there's no "view_unsafe_images" variable in the URL, turn unsafe + // images off by default. + sqgetGlobalVar('view_unsafe_images', $view_unsafe_images, SQ_GET, FALSE); + + $secremoveimg = '../images/' . _("sec_remove_eng.png"); + + /** + * Replace empty src tags with the blank image. src is only used + * for frames, images, and image inputs. Doing a replace should + * not affect them working as should be, however it will stop + * IE from being kicked off when src for img tags are not set + */ + if ($attvalue == '') { + $attvalue = '"' . SM_PATH . 'images/blank.png"'; + } else { + // first, disallow 8 bit characters and control characters + if (preg_match('/[\0-\37\200-\377]+/',$attvalue)) { + switch ($attname) { + case 'href': + $attvalue = $sQuote . 'http://invalid-stuff-detected.example.com' . $sQuote; + break; + default: + $attvalue = $sQuote . SM_PATH . 'images/blank.png'. $sQuote; + break; + } + } else { + $aUrl = parse_url($attvalue); + if (isset($aUrl['scheme'])) { + switch(strtolower($aUrl['scheme'])) { + case 'mailto': + case 'http': + case 'https': + case 'ftp': + if ($attname != 'href') { + if ($view_unsafe_images == false) { + $attvalue = $sQuote . $secremoveimg . $sQuote; + } else { + if (isset($aUrl['path'])) { + + // No one has been able to show that image URIs + // can be exploited, so for now, no restrictions + // are made at all. If this proves to be a problem, + // the commented-out code below can be of help. + // (One consideration is that I see nothing in this + // function that specifically says that we will + // only ever arrive here when inspecting an image + // tag, although that does seem to be the end + // result - e.g.,