攔截|篡改|偽造.NET類庫中不限於public的類和方法

Dotnet9個人部落格發表於2023-09-23

大家好，我是沙漠盡頭的狼。

本文首發於Dotnet9，介紹使用Lib.Harmony庫攔截第三方.NET庫方法，達到不修改其原始碼並能實現修改方法邏輯、預期行為的效果，並且不限於只攔截public訪問修飾的類及方法，行文目錄：

  1. 什麼是方法攔截？
  2. 示例程式攔截
  3. 非public方法怎麼攔截？
  4. 總結

1. 什麼是方法攔截？

方法攔截是指在方法被呼叫之前或之後，透過插入自定義的程式碼來修改方法的行為。透過方法攔截，開發人員可以在不修改原始程式碼的情況下，對方法的輸入引數進行驗證、修改方法的返回值、記錄方法的呼叫日誌等操作。

本文使用Lib.Harmony庫實現第三方庫方法的攔截，關於該庫站長寫過[快學會這個技能-.NET API攔截技法](快學會這個技能-.NET API攔截技法 - Dotnet9)一文，大家可以再看看，但該篇文章未介紹非public類及方法如何攔截，本文會有所補充反過來 。

2. 示例程式攔截

2.1. 編寫取數字段落的程式

建立一個.NET類庫工程，比如叫TestDll，新增工具類TestTool：

namespace TestDll;

public class TestTool
{
    /// <summary>
    /// 帶數字的優美段落
    /// </summary>
    private readonly List<string> _sentences = new()
    {
        "一，是孤獨的象徵，寂寞的代言人， 它獨自站在詩句的起點，引人遐想。",
        "二，是相對的存在，對立的伴侶， 它們如影隨形，互相依存。",
        "三，是完美的數字，三角的穩定， 它給詩歌帶來了和諧的節奏。",
        "四，是平衡的象徵，四季的輪迴， 它讓詩歌的結構更加堅實。",
        "五，是生機勃勃的數字，五彩斑斕的花朵， 它們在詩歌中綻放出美麗的畫面。 ",
        "六，是平凡的數字，六邊形的形狀， 它們給詩歌帶來了一種穩定的感覺。",
        "七，是神秘的數字，七色的虹霓， 它們在詩歌中散發出神奇的光芒。",
        "八，是無限的數字，八方的宇宙， 它們讓詩歌的想象力無限延伸。",
        "九，是完美的數字，九曲的江河， 它們給詩歌帶來了一種流動的美感。 ",
        "十，是圓滿的數字，十全十美的象徵， 它們讓詩歌的結尾更加完美。"
    };

    /// <summary>
    /// 取對應數字的段落
    /// </summary>
    /// <param name="number"></param>
    /// <returns></returns>
    public string GetNumberSentence(int number)
    {
        var mo = number % _sentences.Count;

        // 個位為0，取最後一
        if (mo == 0)
        {
            mo = 10;
        }

        if (mo == 6)
        {
            mo = 1;
        }

        var sentencesIndex = mo - 1;
        return _sentences[sentencesIndex];
    }
}

上面的方法GetNumberSentence邏輯：傳入一個整型number引數，除10（集合_sentences項數）取模，返回10以內的數字美文段落，其中如果模為6會取數字1的段落（這是為了驗證攔截邏輯設計新增的）。

下面是寫的一個AvaloniaUI程式測試介面，UI不是本文重點，這裡就直接貼動圖和程式碼截圖了，文末也有原始碼連結：

2.2. 為什麼個位數字為6時，總是顯示數字1的段落呢？

分析上面的程式碼，我們想把mo == 6時讓mo = 1邏輯去掉，除了使用dnSpy這些反編譯工具修改程式碼，我們還可以使用Lib.Harmony（快學會這個技能-.NET API攔截技法 - Dotnet9）攔截GetNumberSentence方法。

  1. 安裝Lib.Harmony包
<PackageReference Include="Lib.Harmony" Version="2.3.0-prerelease.2" />
  1. 編寫攔截替換類

參考快學會這個技能-.NET API攔截技法 - Dotnet9新增如下攔截替換類：

  • 在攔截類上註冊需要攔截的原類型別、原方法名和引數資料型別
  • 可以先將原方法內程式碼複製到攔截替換方法Prefix內，對於原類中的屬性、欄位可透過反射獲取(比如_sentences集合)
  • 將mo == 6的程式碼註釋
using HarmonyLib;
using System.Reflection;
using TestDll;

namespace MultiVersionLibrary;

/// <summary>
/// HarmonyPatch特性關聯攔截的類及方法
/// </summary>
[HarmonyPatch(typeof(TestTool))]
[HarmonyPatch(nameof(TestTool.GetNumberSentence))]
[HarmonyPatch(new Type[] { typeof(int) })]
internal class HookGetNumberSentence
{
    /// <summary>
    /// GetNumberSentence攔截替換方法
    /// </summary>
    /// <param name="__instance">攔截的TestTool例項</param>
    /// <param name="number">GetNumberSentence方法同名引數定義，修改它達到方法引數篡改</param>
    /// <param name="__result">GetNumberSentence方法返回值，修改它達到方法值偽造</param>
    /// <returns></returns>
    public static bool Prefix(ref object __instance, int number, ref string __result)
    {
        try
        {
            //將原方法邏輯全部複製，然後做部分修改

            //1、_sentences是攔截類TestTool的私胡欄位，我們透過反射獲取值
            var sentences =
                __instance.GetType().GetField("_sentences", BindingFlags.NonPublic | BindingFlags.Instance)
                    ?.GetValue(__instance) as List<string>;
            if (sentences?.Any() != true)
            {
                __result = "啊，沒有優美句子嗎？";
                return true;
            }

            var mo = number % sentences.Count;

            // 個位為0，取最後一
            if (mo == 0)
            {
                mo = 10;
            }

            // 2、註釋我們認為有歧義的程式碼
            //if (mo == 6)
            //{
            //    mo = 1;
            //}

            var sentencesIndex = mo - 1;
            __result = sentences[sentencesIndex];

            return false;
        }
        catch (Exception ex)
        {
            return true;
        }
    }
}

別忘了在Program或App.xaml初始方法內註冊自動攔截類方法：

var harmony = new Harmony("https://dotnet9.com");
harmony.PatchAll(Assembly.GetExecutingAssembly());

重新執行主程式，輸入數字6時正常顯示數字6對應的段落了：

這樣就達到不修改第三庫原始碼的情況實現結果篡改了，站長使用.NET 8攔截會有異常，後改為 .NET 6 得以正常執行，異常資訊如下，可能是Lib.Harmony還不支援.NET 8吧：

HarmonyLib.HarmonyException:“Patching exception in method System.String TestDll.TestTool::GetNumberSentence(System.Int32 number)”

TypeInitializationException: The type initializer for 'MonoMod.Utils.DMDEmitDynamicMethodGenerator' threw an exception.

InvalidOperationException: Cannot find returnType fieeld on DynamicMethod

3. 非public方法怎麼攔截？

3.1. 修改數字段落獲取方法

還是修改TestTool類，另外增加GetNumberSentence2方法，在方法中新增一個數字驗證操作mo = new CalNumber().GetValidNumber(mo);，方法定義如下：

/// <summary>
/// 取對應數字的段落
/// </summary>
/// <param name="number"></param>
/// <returns></returns>
public string GetNumberSentence2(int number)
{
    var mo = number % _sentences.Count;

    // 個位為0，取最後一
    if (mo == 0)
    {
        mo = 10;
    }

    // 新增數字驗證方法
    mo = new CalNumber().GetValidNumber(mo);

    var sentencesIndex = mo - 1;
    return _sentences[sentencesIndex];
}

驗證方法定義如下：

  • CalNumber類和GetValidNumber方法用internal宣告，意為類或方法只能在當前工程內使用
internal class CalNumber
{
    internal int GetValidNumber(int number)
    {
        // 這裡可以加一些複雜的演算法程式碼
        if (number == 6)
        {
            number = 1;
        }

        return number;
    }
}

並在主工程呼叫數字獲取段落方法處改為：

public string? Number
{
    get { return _number; }
    set
    {
        _number = value;
        TryParse(_number, out var factNumber);

        // 換方法2了
        Message = _testTool.GetNumberSentence2(factNumber);
    }
}

輸入6時又返回1的段落了：

問題來了：internal方法怎麼攔截？

我們不直接註釋程式碼mo = new CalNumber().GetValidNumber(mo);，萬一驗證方法非常重要，我們只是需要修改其中部分邏輯，總體原邏輯不應該改變。

3.2. internal方法怎麼攔截？

新增攔截類HookGetValidNumber，現在不能再在類上新增特性了（[HarmonyPatch(typeof(CalNumber))]），因為CalNumber不是public訪問修飾，跨工程無法直接使用，語法不支援：

特性用不上，那就手工註冊需要攔截的方法，這是本文的重點，程式碼在下面，簡單提一下：

  • 手工註冊程式碼和自動註冊宣告特性類似，只是換個寫法；
  • 攔截替換方法需要使用HarmonyMethod方法包裝；
  • harmony.Patch(hookMethod, replaceHarmonyMethod);用於關聯被攔截方法與替換方法
/// <summary>
/// 手工註冊關聯被攔截方法與替換方法
/// </summary>
public static void StartHook()
{
    var harmony = new Harmony("https://dotnet9.com");
    var hookClassType = typeof(TestTool).Assembly.GetType("TestDll.CalNumber");
    var hookMethod = hookClassType!.GetMethod("GetValidNumber", BindingFlags.NonPublic | BindingFlags.Instance,
        new[] { typeof(int) });
    var replaceMethod = typeof(HookGetValidNumber).GetMethod(nameof(Prefix));
    var replaceHarmonyMethod = new HarmonyMethod(replaceMethod);
    harmony.Patch(hookMethod, replaceHarmonyMethod);
}

替換方法定義如下：

  • Prefix方法命名這裡不加限制，只要和上面手工註冊（var replaceMethod = typeof(HookGetValidNumber).GetMethod(nameof(Prefix));）相同即可：
  • 數字等於6，修改偽造結果為8
/// <summary>
/// GetNumberSentence攔截替換方法
/// </summary>
/// <param name="__instance">攔截的TestTool例項</param>
/// <param name="number">GetNumberSentence方法同名引數定義，修改它達到方法引數篡改</param>
/// <param name="__result">GetNumberSentence方法返回值，修改它達到方法值偽造</param>
/// <returns></returns>
public static bool Prefix(ref object __instance, int number, ref int __result)
{
    //將原方法邏輯全部複製，然後做部分修改

    // 這裡可以加一些複雜的演算法程式碼
    if (number == 6)
    {
        number = 8;
    }

    __result = number;

    return false;
}

最後在原自動註冊程式碼下，再加一行手工註冊程式碼就OK，打完收工：

// 1、自動註冊攔截類：攔截類上新增被攔截類和方法特性
var harmony = new Harmony("https://dotnet9.com");
harmony.PatchAll(Assembly.GetExecutingAssembly());

// 2、自動註冊攔截類，構造被攔截類和方法資訊進行攔截
HookGetValidNumber.StartHook();

執行效果如下，輸入6顯示數字8段落：

4. 總結

  • 技術交流加群請新增站長微訊號：dotnet9com
  • 文中示例程式碼：MultiVersionLibrary

使用Lib.Harmony庫攔截註冊有兩種方式的用處如下：

  1. 自動註冊：
    • 透過在攔截類上使用特性關聯被攔截類和方法定義，可以實現自動註冊攔截邏輯。這種方式適用於需要攔截的類和方法比較多的情況，可以減少手動註冊的工作量，提高開發效率。
    • 自動註冊通常只能關聯public類或方法，因為IDE會根據程式碼的可見性進行過濾和提示。
  2. 手工註冊：
    • 透過程式碼構造被攔截類和方法定義進行手工註冊，可以更加靈活地控制攔截邏輯。這種方式適用於需要對攔截邏輯進行定製化處理的情況，可以根據具體需求選擇需要攔截的類和方法，並對攔截邏輯進行精細化配置。
    • 手工註冊更加靈活，可以攔截包括internal在內的各種類和方法。手工註冊可以透過編寫程式碼來實現對非public類和方法的關聯，但需要注意的是，這樣做可能會增加程式碼的複雜性和維護成本。

相關文章