Incorrect decoding of preamble in email parser
まだ誰も着手していません。
- 主要言語
- 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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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