SmtpClient一處代碼編寫錯誤導致異步發送郵件時DeliveryFormat配置項無法正確工作,異步操作已經完全不受我們設置屬性控制了,UTF-8內容(如中文)轉不轉碼完全看對方郵件服務器心情!
涉及到的Github倉庫:
https://github.com/xiangyuecn/DKIM-Smtp-csharp
.Net開發者社區富文本編輯器太難用了,還是簡書的編輯器好用,然后掘金的版面好看,最后還是喜歡cnblog里面可以修改版面css。
盡瞎說大實話。
重新碼一份好看的。
出問題的地方
出現問題的函數:
//https://source.dot.net/#System.Net.Mail/System/Net/Mail/SmtpClient.cs,966
//https://referencesource.microsoft.com/#System/net/System/Net/mail/SmtpClient.cs,892
void SendMailCallback(IAsyncResult result) {
...
//注意這個ServerSupportsEai,這個位置是allowUnicode參數
message.BeginSend(writer, DeliveryMethod != SmtpDeliveryMethod.Network,
ServerSupportsEai, new AsyncCallback(SendMessageCallback), result.AsyncState);
...
}
ServerSupportsEai所在位置為allowUnicode參數。SmtpClient中所有涉及到allowUnicode參數的地方,賦值都為IsUnicodeSupported()返回值。但唯一這一處是例外。
我們看看IsUnicodeSupported函數:
//https://referencesource.microsoft.com/#System/net/System/Net/mail/SmtpClient.cs,382
private bool IsUnicodeSupported() {
if (DeliveryMethod == SmtpDeliveryMethod.Network) {
//注意看這里的ServerSupportsEai和SmtpDeliveryFormat
return (ServerSupportsEai && (DeliveryFormat == SmtpDeliveryFormat.International));
}
else {
return (DeliveryFormat == SmtpDeliveryFormat.International);
}
}
DeliveryFormat我們可以賦值,我們來找找ServerSupportsEai是在哪里取值的:
//https://referencesource.microsoft.com/#System/net/System/Net/mail/smtpconnection.cs,280
internal void ParseExtensions(string[] extensions) {
...
//如果服務器支持SMTPUTF8,那么ServerSupportsEai=true
else if (String.Compare(extension, 0, "SMTPUTF8", 0, 8, StringComparison.OrdinalIgnoreCase) == 0) {
((SmtpPooledStream)pooledStream).serverSupportsEai = true;
}
...
}
產生的現象
SendMailCallback是SmtpClient.SendAsync(SendMailAsync會調用SendAsync)調用的,so,異步操作已經完全不受我們設置的DeliveryFormat參數控制了,UTF-8內容(如中文)轉不轉碼完全看對方郵件服務器心情!!!
SmtpClient對象DeliveryFormat屬性賦值為SmtpDeliveryFormat.SevenBit,要求郵件使用 7 位 ASCII 的傳遞格式,並且用異步方法來發送;本來Subject、附件文件名等里面的UTF-8內容(如中文)將會被轉碼;但如果郵件服務器EHLO返回了SMTPUTF8,那么SmtpClient對象將會將UTF-8內容不轉碼直接發送出去!導致發送出去的數據內容和預期的數據內容不一致!!!
同步方法Send不受此影響。
解決辦法
SendMailCallback函數中的ServerSupportsEai應該換成統一的IsUnicodeSupported,Bug就解決。
受影響版本
- .Net Framework 4.5 - 4.7.2(最新版),估計是全系列
- .Net Core 看最新版也是受此影響
一次.Net框架Bug的發現記錄
DKIM簽名功能寫好后測試了很多個郵箱,都能通過驗證。但隔一天測試卻發現沒有一個郵箱通過驗證,並且下載下來的郵件源碼body部分和本地額外保存的一份有很大出入,表現在郵件主題、附件文件名,本地是Base64編碼,下載下來的是中文漢字。
首先發現問題的是outlook郵箱,他們家會告訴你DKIM簽名是否正確,本地直接發送郵件沒有一個通過簽名驗證的,但通過郵箱服務器發送卻都是好的。對比直發和服務器發的郵件源碼區別,發現郵箱服務器的沒有中文,直發的里面中文的地方全是中文。
看樣子中文部分有問題,然后試着把郵件里面的中文全部換成英文,發送,又可以了!想了一下昨天測試好像全部是英文,因為郵件內容寫了一次基本上就不會改了。
到了這時候,感覺還以為是outlook服務器進行了什么處理,難道郵箱服務器發郵件用的協議和我們用Smtp協議發郵件的協議有出入?但並沒有找到什么相關的資料。然后測試了QQ郵箱、網易yeah.net,並且抓了一下包看了一下,發現切換SmtpClient.DeliveryFormat參數,使用SevenBit(此值為默認值)(中文會被編碼)QQ郵箱沒問題,網易有問題;使用International(中文不編碼)QQ郵箱有問題,網易反倒沒問題。
抓包發現使用SevenBit時,中文部分給QQ郵箱發送的是Base64編碼,給網易發送的是中文內容,本地保存的是Base64編碼(和簽名時使用到的郵件內容一致);使用International時正好相反。簽名的數據和發送的數據不一致,導致了不管怎么改這個參數,都有一個是錯的。
為什么會這樣?查閱.Net源碼,一路看編碼部分,發現基本上每個涉及到字符編碼、發送的地方都會傳入allowUnicode參數,所有allowUnicode = SmtpClient.IsUnicodeSupported(),但有唯一的一處例外:
[此處忽略,見上文]
SendMailCallback是SmtpClient.SendAsync(SendMailAsync會調用SendAsync)調用的,so,異步操作已經完全不受我們設置的DeliveryFormat參數控制了,中文轉不轉碼完全看對方郵件服務器心情!!!函數中的ServerSupportsEai應該換成統一的IsUnicodeSupported,Bug就解決。
但,我們沒法去改這個地方,那么上Hook吧,把SmtpClient.ServerSupportsEaiHook一下,如果是SendMailCallback調用的就return IsUnicodeSupported()。
但,DotNetDetour庫可以Hook String.Length屬性,但沒法HookSmtpClient.ServerSupportsEai屬性,不知道啥原因。最后調試煩了放棄了。
結尾使用SmtpClient.Send沒有這種問題,就把異步操作全部換成了同步,代碼還少了不少。Bug修理完畢,給outlook、QQ、網易發英文、中文郵件都能通過DKIM簽名驗證。
