Merge pull request #62 from EasyAbp/encryptor-encrypt-method

Add `EncryptAsync` in `IWeChatNotificationEncryptor`
EasyAbp · Dec 24, 2022 · cb12487 · cb12487
2 parents 231f7d1 + 00c7696
commit cb12487
Show file tree

Hide file tree

Showing 7 changed files with 95 additions and 23 deletions.
diff --git a/common.props b/common.props
@@ -1,7 +1,7 @@
 <Project>
     <PropertyGroup>
         <LangVersion>latest</LangVersion>
-        <Version>2.0.0-rc.17</Version>
+        <Version>2.0.0-rc.18</Version>
         <NoWarn>$(NoWarn);CS1591</NoWarn>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
         <Authors>EasyAbp Team</Authors>

diff --git a/...ommon/EasyAbp.Abp.WeChat.Common/Infrastructure/Encryption/IWeChatNotificationEncryptor.cs b/...ommon/EasyAbp.Abp.WeChat.Common/Infrastructure/Encryption/IWeChatNotificationEncryptor.cs
@@ -5,6 +5,8 @@ namespace EasyAbp.Abp.WeChat.Common.Infrastructure.Encryption;
 
 public interface IWeChatNotificationEncryptor
 {
-    Task<TModel> DecryptPostDataAsync<TModel>(string token, string encodingAesKey, string appId,
-        string msgSignature, string timestamp, string notice, string postData) where TModel : ExtensibleObject, new();
+    Task<string> EncryptAsync(string token, string encodingAesKey, string appId, string xml);
+
+    Task<TModel> DecryptAsync<TModel>(string token, string encodingAesKey, string appId, string msgSignature,
+        string timestamp, string nonce, string encryptedXml) where TModel : ExtensibleObject, new();
 }
diff --git a/...Common/EasyAbp.Abp.WeChat.Common/Infrastructure/Encryption/WeChatNotificationEncryptor.cs b/...Common/EasyAbp.Abp.WeChat.Common/Infrastructure/Encryption/WeChatNotificationEncryptor.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
@@ -15,15 +16,36 @@ public class WeChatNotificationEncryptor : IWeChatNotificationEncryptor, ITransi
 {
     private readonly IJsonSerializer _jsonSerializer;
 
+    protected static readonly Random Random = new();
+
     public WeChatNotificationEncryptor(IJsonSerializer jsonSerializer)
     {
         _jsonSerializer = jsonSerializer;
     }
 
-    public virtual async Task<TModel> DecryptPostDataAsync<TModel>(string token, string encodingAesKey, string appId,
-        string msgSignature, string timestamp, string notice, string postData) where TModel : ExtensibleObject, new()
+    public virtual Task<string> EncryptAsync(string token, string encodingAesKey, string appId, string xml)
+    {
+        var crypt = new WXBizMsgCrypt(token, encodingAesKey, appId);
+
+        string encryptedXml = null;
+
+        var errCode = crypt.EncryptMsg(xml,
+            ((int)DateTime.UtcNow.Subtract(new DateTime(1970, 1, 1)).TotalSeconds).ToString(),
+            GenerateNonce(), ref encryptedXml);
+
+        if (errCode != 0)
+        {
+            throw new UserFriendlyException($"加密失败，错误码: {errCode}");
+        }
+
+        return Task.FromResult(encryptedXml);
+    }
+
+    public virtual Task<TModel> DecryptAsync<TModel>(string token, string encodingAesKey, string appId,
+        string msgSignature, string timestamp, string nonce, string encryptedXml)
+        where TModel : ExtensibleObject, new()
     {
-        if (postData == null)
+        if (encryptedXml == null)
         {
             throw new UserFriendlyException("没有找到加密内容");
         }
@@ -35,21 +57,20 @@ public WeChatNotificationEncryptor(IJsonSerializer jsonSerializer)
         var errCode = crypt.DecryptMsg(
             msgSignature,
             timestamp,
-            notice,
-            postData,
+            nonce,
+            encryptedXml,
             ref decryptXml);
 
         if (errCode != 0)
         {
-            throw new BusinessException($"解密失败，错误码: {errCode}");
+            throw new UserFriendlyException($"解密失败，错误码: {errCode}");
         }
 
         var doc = XDocument.Parse(decryptXml);
-        var node_cdata = doc.DescendantNodes().OfType<XCData>().ToList();
 
-        foreach (var node in node_cdata)
+        foreach (var node in doc.DescendantNodes().OfType<XCData>().ToList())
         {
-            node.Parent.Add(node.Value);
+            node.Parent!.Add(node.Value);
             node.Remove();
         }
 
@@ -63,6 +84,13 @@ public WeChatNotificationEncryptor(IJsonSerializer jsonSerializer)
             model.SetProperty(pair.Key, pair.Value);
         }
 
-        return model;
+        return Task.FromResult(model);
+    }
+
+    protected virtual string GenerateNonce()
+    {
+        const string chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
+
+        return new string(Enumerable.Repeat(chars, 32).Select(s => s[Random.Next(s.Length)]).ToArray());
     }
 }
diff --git a/.../ThirdPartyPlatform/RequestHandling/ReleaseTestWeChatThirdPartyPlatformAppEventHandler.cs b/.../ThirdPartyPlatform/RequestHandling/ReleaseTestWeChatThirdPartyPlatformAppEventHandler.cs
@@ -1,9 +1,12 @@
 using System;
 using System.Net.Http;
 using System.Threading.Tasks;
+using EasyAbp.Abp.WeChat.Common.Infrastructure.Encryption;
+using EasyAbp.Abp.WeChat.Common.Infrastructure.Options;
 using EasyAbp.Abp.WeChat.Common.Infrastructure.Services;
 using EasyAbp.Abp.WeChat.Common.Models;
 using EasyAbp.Abp.WeChat.OpenPlatform.RequestHandling.Dtos;
+using EasyAbp.Abp.WeChat.OpenPlatform.ThirdPartyPlatform.Options;
 using EasyAbp.Abp.WeChat.OpenPlatform.ThirdPartyPlatform.Services;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
@@ -18,6 +21,7 @@ public class ReleaseTestWeChatThirdPartyPlatformAppEventHandler : IWeChatThirdPa
 {
     private readonly IServiceProvider _serviceProvider;
     private readonly ILogger<ReleaseTestWeChatThirdPartyPlatformAppEventHandler> _logger;
+
     public virtual string MsgType => "text";
     public int Priority => -10000;
 
@@ -34,7 +38,7 @@ public class ReleaseTestWeChatThirdPartyPlatformAppEventHandler : IWeChatThirdPa
     {
         if (ReleaseTestConsts.OfficialAppIds.Contains(authorizerAppId))
         {
-            return await HandleOfficialReleaseTestAsync(componentAppId, model);
+            return await HandleOfficialReleaseTestAsync(componentAppId, authorizerAppId, model);
         }
 
         if (ReleaseTestConsts.MiniProgramsAppIds.Contains(authorizerAppId))
@@ -46,20 +50,31 @@ public class ReleaseTestWeChatThirdPartyPlatformAppEventHandler : IWeChatThirdPa
     }
 
     protected virtual async Task<AppEventHandlingResult> HandleOfficialReleaseTestAsync(string componentAppId,
-        WeChatAppEventModel model)
+        string authorizerAppId, WeChatAppEventModel model)
     {
         var content = model.GetProperty<string>("Content");
 
         if (content == "TESTCOMPONENT_MSG_TYPE_TEXT")
         {
-            return new AppEventHandlingResult(true, null,
+            var xml =
                 $"<xml>"
                 + $"<ToUserName><![CDATA[{model.FromUserName}]]></ToUserName>"
                 + $"<FromUserName><![CDATA[{model.ToUserName}]]></FromUserName>"
                 + $"<CreateTime>{(int)DateTime.UtcNow.Subtract(new DateTime(1970, 1, 1)).TotalSeconds}</CreateTime>"
                 + $"<MsgType><![CDATA[text]]></MsgType>"
                 + $"<Content><![CDATA[TESTCOMPONENT_MSG_TYPE_TEXT_callback]]></Content>"
-                + $"</xml>");
+                + $"</xml>";
+
+            var encryptor = _serviceProvider.GetRequiredService<IWeChatNotificationEncryptor>();
+            var optionsProvider = _serviceProvider
+                .GetRequiredService<IAbpWeChatOptionsProvider<AbpWeChatThirdPartyPlatformOptions>>();
+
+            var options = await optionsProvider.GetAsync(componentAppId);
+
+            var encryptedXml =
+                await encryptor.EncryptAsync(options.Token, options.EncodingAesKey, authorizerAppId, xml);
+
+            return new AppEventHandlingResult(true, null, encryptedXml);
         }
 
         if (!content.StartsWith("QUERY_AUTH_CODE:"))

diff --git a/...ThirdPartyPlatform/RequestHandling/WeChatThirdPartyPlatformEventRequestHandlingService.cs b/...ThirdPartyPlatform/RequestHandling/WeChatThirdPartyPlatformEventRequestHandlingService.cs
@@ -94,7 +94,7 @@ public virtual async Task<AppEventHandlingResult> NotifyAppAsync(NotifyAppInput
     protected virtual async Task<T> DecryptMsgAsync<T>(AbpWeChatThirdPartyPlatformOptions options,
         WeChatEventRequestModel request) where T : ExtensibleObject, new()
     {
-        return await _weChatNotificationEncryptor.DecryptPostDataAsync<T>(
+        return await _weChatNotificationEncryptor.DecryptAsync<T>(
             options.Token,
             options.EncodingAesKey,
             options.AppId,

diff --git a/...EasyAbp.Abp.WeChat.OpenPlatform.Tests/ThirdPartyPlatform/ReleaseTestEventHandlingTests.cs b/...EasyAbp.Abp.WeChat.OpenPlatform.Tests/ThirdPartyPlatform/ReleaseTestEventHandlingTests.cs
@@ -29,8 +29,7 @@ public async Task Should_Handle_Release_Test_Official_User_Message()
             await handler.HandleAsync(AbpWeChatOpenPlatformTestsConsts.AppId, OfficialAuthorizerAppId, eventModel);
 
         result.Success.ShouldBeTrue();
-        result.SpecifiedResponseContent.ShouldContain(
-            "<Content><![CDATA[TESTCOMPONENT_MSG_TYPE_TEXT_callback]]></Content>");
+        result.SpecifiedResponseContent.ShouldStartWith("<xml><Encrypt><![CDATA[");
     }
 
     [Fact]

diff --git a/...syAbp.Abp.WeChat.OpenPlatform.Tests/ThirdPartyPlatform/WeChatNotificationEncryptorTest.cs b/...syAbp.Abp.WeChat.OpenPlatform.Tests/ThirdPartyPlatform/WeChatNotificationEncryptorTest.cs
@@ -10,18 +10,46 @@ namespace EasyAbp.Abp.WeChat.OpenPlatform.Tests.ThirdPartyPlatform;
 public class WeChatNotificationEncryptorTest : AbpWeChatOpenPlatformTestBase
 {
     [Fact]
-    public async Task Should_Decrypt_PostData()
+    public async Task Should_Encrypt_Xml()
     {
         var encryptor = GetRequiredService<IWeChatNotificationEncryptor>();
-
+
+        var options = new AbpWeChatThirdPartyPlatformOptions
+        {
+            Token = AbpWeChatOpenPlatformTestsConsts.Token,
+            AppId = AbpWeChatOpenPlatformTestsConsts.AppId,
+            EncodingAesKey = AbpWeChatOpenPlatformTestsConsts.EncodingAesKey
+        };
+
+        var encryptedXml = await encryptor.EncryptAsync(
+            options.Token,
+            options.EncodingAesKey,
+            options.AppId,
+            "<xml><ToUserName><![CDATA[wx5823bf96d3bd56c7]]></ToUserName>" +
+            "<FromUserName><![CDATA[mycreate]]></FromUserName>" +
+            "<CreateTime>1409659813</CreateTime>" +
+            "<MsgType><![CDATA[text]]></MsgType>" +
+            "<Content><![CDATA[hello]]></Content>" +
+            "<MsgId>4561255354251345929</MsgId>" +
+            "<AgentID>218</AgentID>" +
+            "</xml>");
+
+        encryptedXml.ShouldStartWith("<xml><Encrypt><![CDATA[");
+    }
+
+    [Fact]
+    public async Task Should_Decrypt_Xml()
+    {
+        var encryptor = GetRequiredService<IWeChatNotificationEncryptor>();
+
         var options = new AbpWeChatThirdPartyPlatformOptions
         {
             Token = AbpWeChatOpenPlatformTestsConsts.Token,
             AppId = AbpWeChatOpenPlatformTestsConsts.AppId,
             EncodingAesKey = AbpWeChatOpenPlatformTestsConsts.EncodingAesKey
         };
 
-        var model = await encryptor.DecryptPostDataAsync<WeChatAppEventModel>(
+        var model = await encryptor.DecryptAsync<WeChatAppEventModel>(
             options.Token,
             options.EncodingAesKey,
             options.AppId,