DotNetCore.SKIT.FlurlHttpCl.../docs/WechatTenpayV3/Basic_EventSignatureVerification.md
2024-11-21 12:19:46 +08:00

73 lines
3.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## 如何验证回调通知事件签名?
---
> 请先自行阅读:
>
> [《微信支付开发者文档 - 开发指南:签名验证》](https://pay.weixin.qq.com/wiki/doc/apiv3/wechatpay/wechatpay4_1.shtml)
>
> [《微信支付官方公告 - 关于新商户调用接口验签方式变更通知》](https://developers.weixin.qq.com/community/pay/doc/0002c6a7cf438818df52145b863c01)
---
### 重要须知:
请在开发过程中注意区分**商户证书**和**平台证书**
- **商户证书**用于生成请求的签名,需要通过微信商户后台申请并下载,并在构建客户端配置项时指定(即 `WechatTenpayClientOptions` 对象中的商户证书序列号和商户公钥两个参数);
- **平台证书**用于验证响应或回调的签名,需要在程序运行时实时通过接口动态获取(即 `QueryCertificatesAsync` 方法,注意证书内容需要解密)。
如果你在开发过程出现验签不通过的情况,请先检查是否混淆了这两个证书。
🔥 另2024 年 10 月后新注册的微信商户已不再提供平台证书,取而代之的是平台公钥。但二者的验签流程基本相同。更多内容请见本章的《适配微信支付新商户的平台公钥认证方式》一节。
关于证书的更多注意事项,请参阅[《微信支付开发者文档 - 常见问题:证书相关》](https://pay.weixin.qq.com/wiki/doc/apiv3/wechatpay/wechatpay7_0.shtml)
---
### 验签流程
验证回调通知事件签名的方法与验证响应签名的类似,请参阅本文档[《基础用法 - 如何验证响应签名?》](./Basic_ResponseSignatureVerification.md)的有关章节。
同样地,你既可以利用本库提供的 `RSAUtility` 工具类自行进行签名验证,也可以通过 `CertificateManager` 尝试自动完成签名验证:
```csharp
bool ret = client.VerifyEventSignature(
webhookTimestamp: "微信回调通知中的 Wechatpay-Timestamp 标头",
webhookNonce: "微信回调通知中的 Wechatpay-Nonce 标头",
webhookBody: "微信回调通知中请求正文",
webhookSignature: "微信回调通知中的 Wechatpay-Signature 标头",
webhookSerialNumber: "微信回调通知中的 Wechatpay-Serial 标头"
);
```
> ⚠️ 【重要说明】
>
> 对于使用基于平台证书认证的旧商户,使用该扩展方法前需先下载好平台证书,并存入全局的 `CertificateManager`。有关 `CertificateManager` 的更多介绍,请阅读下方《通过 `CertificateManager` 管理平台证书信息》这一小节。
>
> 对于使用基于平台公钥认证的新商户,使用该扩展方法前需预先添加好平台公钥,并存入全局的 `PublicKeyManager`。有关 `PublicKeyManager` 的更多介绍,请阅读下方《适配微信支付新商户的平台公钥认证方式》这一小节。
---
### 调试验签错误:
由于 `VerifyEventSignature()` 方法内部会 `try-catch` 捕获所有异常,并直接返回 `false`。为方便开发者在调试阶段排查验签的错误信息,你可以在验证回调通知事件签名时指定返回值类型为 `ErroredResult` 而非 `Boolean`,该返回值中包含了一些异常的原因和相关堆栈信息。
```csharp
ErroredResult res = client.VerifyEventSignature(timestamp, nonce, body, signature, serialNumber);
if (!res.Result)
{
Console.WriteLine(res.Error);
}
```
---
### 通过 `CertificateManager` 管理平台证书信息:
请参阅本文档[《基础用法 - 如何加密请求中的敏感数据?》](./Basic_RequestSensitiveDataEncryption.md)下的同名章节。
### 适配微信支付新商户的平台公钥认证方式
请参阅本文档[《基础用法 - 如何加密请求中的敏感数据?》](./Basic_RequestSensitiveDataEncryption.md)下的同名章节。