python / python/cpython

Incorrect decoding of preamble in email parser

未關閉
#118,718 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

stdlib topic-email type-bug
主要語言
Python
星號
77.2k
分支
35.9k
PR 合併指標
PR 指標待擷取

描述

Bug report

Bug description:

Method: email.message_from_binary_file()

It seems we've found an issue with the email.parser module when parsing raw binary MIME message where the preamble contains UTF-8 encoded data

When using the .as_string() method on the returned message, the unicode data will contain invalid UTF-8 characters ("surrogates not allowed")
The problem does not occur when using the email.message_from_string() method

I've made a somewhat minimal example (from the MIME RFC) exposing the issue.
Here "préamble" is decoded as "pr\udcc3\udca9amble"


import io
import email
import email.policy

CONTENTS = """
From: Nathaniel Borenstein <nsb@bellcore.com>
To: Ned Freed <ned@innosoft.com>
Subject: Sample message
MIME-Version: 1.0
Content-type: multipart/mixed; boundary="i-am-boundary"

This is the préamble.  It is to be ignored, though it
is a handy place for mail composers to include an
explanatory note to non-MIME compliant readers.

--i-am-boundary
Content-type: text/plain; charset=us-ascii

This is explicitly typed plain ASCII text.
It DOES end with a linebreak.

--i-am-boundary
Content-type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit

This should be correctly encapsulated: Un petit café ?

--i-am-boundary--
This is the epilogue.  It is also to be ignored.

""".lstrip()
CONTENTS_BYTES = io.BytesIO(CONTENTS.encode())

# Does not have an impact on the result
POLICY = email.policy.default.clone(utf8=True)


def show_message(msg):
    # Parts are correctly decoded in all cases
    for i, part in enumerate(msg.iter_parts(), 1):
        print(f'MIME PART {i}:')
        as_string = part.as_string()
        as_bytes = as_string.encode()
        print(as_string)

    as_string = msg.as_string()

    # When source was bytes, the unicode result of as_string is incorrect
    as_bytes = as_string.encode()
    print(as_string)


msg_from_binary = email.message_from_binary_file(CONTENTS_BYTES, policy=POLICY)
show_message(msg_from_binary)
# UnicodeEncodeError: 'utf-8' codec can't encode characters in position 192-193: surrogates not allowed

# Using the unicode representation is OK
#msg_from_string = email.message_from_string(CONTENTS, EmailMessage)
#show_message(msg_from_string)

I've tried adding a charset and content-transfer-encoding: 8bit in the headers, with the same result (I do not know if this is actually valid)

Looking at the current code it seems that BytesParser always uses the ASCII encoding with errors='surrogateescape'

CPython versions tested on:

3.11, CPython main branch

Operating systems tested on:

Linux

Linked PRs
  • gh-134384

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從 issue 中最小的二進位 MIME 範例開始,檢查 Lib/email/parser.py 第 95-103 行附近的程式碼,比較二進位檔案解析與字串解析。查看連結的 PR gh-134384 以了解目前的工作。完成的標誌是:轉譯解析後的訊息時,preamble 中的 UTF-8 資料不再變成代理字元。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
backend
Issue 類型
缺陷
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
描述清楚
新手友好度
20/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。