记录一次.Net框架Bug发现和提交过程:SmtpClient一处代码编写错误导致异步发送邮件时DeliveryFormat配置项无法正确工作,.Net Framework和.Net Core均受影响

问题已经发到了开发者社区
https://developercommunity.visualstudio.com/content/problem/381046/smtpclient%E4%B8%80%E5%A4%84%E4%BB%A3%E7%A0%81%E7%BC%96%E5%86%99%E9%94%99%E8%AF%AF%E5%AF%BC%E8%87%B4%E5%BC%82%E6%AD%A5%E5%8F%91%E9%80%81%E9%82%AE%E4%BB%B6%E6%97%B6deliveryformat%E9%85%8D%E7%BD%AE%E9%A1%B9%E6%97%A0%E6%B3%95%E6%AD%A3%E7%A1%AE%E5%B7%A5%E4%BD%9C.html

涉及到的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;
    }
    ...
}

产生的现象

SendMailCallbackSmtpClient.SendAsyncSendMailAsync会调用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(),但有唯一的一处例外:

[此处忽略,见上文]

SendMailCallbackSmtpClient.SendAsyncSendMailAsync会调用SendAsync)调用的,so,异步操作已经完全不受我们设置的DeliveryFormat参数控制了,中文转不转码完全看对方邮件服务器心情!!!函数中的ServerSupportsEai应该换成统一的IsUnicodeSupported,Bug就解决。

但,我们没法去改这个地方,那么上Hook吧,把SmtpClient.ServerSupportsEaiHook一下,如果是SendMailCallback调用的就return IsUnicodeSupported()

但,DotNetDetour库可以Hook String.Length属性,但没法HookSmtpClient.ServerSupportsEai属性,不知道啥原因。最后调试烦了放弃了。

结尾使用SmtpClient.Send没有这种问题,就把异步操作全部换成了同步,代码还少了不少。Bug修理完毕,给outlook、QQ、网易发英文、中文邮件都能通过DKIM签名验证。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343

推荐阅读更多精彩内容