[Feature]: Trimmable DotNet Project

AsmResolver.sln

@@ -83,12 +83,17 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		LICENSE.md = LICENSE.md
 		README.md = README.md
 		Directory.Build.props = Directory.Build.props
+		appveyor.yml = appveyor.yml
 	EndProjectSection
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsmResolver.Symbols.Pdb", "src\AsmResolver.Symbols.Pdb\AsmResolver.Symbols.Pdb.csproj", "{9E311832-D0F2-42CA-84DD-9A91B88F0287}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsmResolver.Symbols.Pdb.Tests", "test\AsmResolver.Symbols.Pdb.Tests\AsmResolver.Symbols.Pdb.Tests.csproj", "{AAD604B6-ABE5-4DBC-A2D9-4EF8E815B2EE}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AsmResolver.DotNet.Dynamic.Tests", "test\AsmResolver.DotNet.Dynamic.Tests\AsmResolver.DotNet.Dynamic.Tests.csproj", "{C089D0AB-B428-4136-89CC-7974CB590513}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AsmResolver.DotNet.Dynamic", "src\AsmResolver.DotNet.Dynamic\AsmResolver.DotNet.Dynamic.csproj", "{62420213-67AD-40FC-B451-BD05C2437CE3}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -451,6 +456,30 @@ Global
 		{AAD604B6-ABE5-4DBC-A2D9-4EF8E815B2EE}.Release|x64.Build.0 = Release|Any CPU
 		{AAD604B6-ABE5-4DBC-A2D9-4EF8E815B2EE}.Release|x86.ActiveCfg = Release|Any CPU
 		{AAD604B6-ABE5-4DBC-A2D9-4EF8E815B2EE}.Release|x86.Build.0 = Release|Any CPU
+		{C089D0AB-B428-4136-89CC-7974CB590513}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C089D0AB-B428-4136-89CC-7974CB590513}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C089D0AB-B428-4136-89CC-7974CB590513}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{C089D0AB-B428-4136-89CC-7974CB590513}.Debug|x64.Build.0 = Debug|Any CPU
+		{C089D0AB-B428-4136-89CC-7974CB590513}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{C089D0AB-B428-4136-89CC-7974CB590513}.Debug|x86.Build.0 = Debug|Any CPU
+		{C089D0AB-B428-4136-89CC-7974CB590513}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C089D0AB-B428-4136-89CC-7974CB590513}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C089D0AB-B428-4136-89CC-7974CB590513}.Release|x64.ActiveCfg = Release|Any CPU
+		{C089D0AB-B428-4136-89CC-7974CB590513}.Release|x64.Build.0 = Release|Any CPU
+		{C089D0AB-B428-4136-89CC-7974CB590513}.Release|x86.ActiveCfg = Release|Any CPU
+		{C089D0AB-B428-4136-89CC-7974CB590513}.Release|x86.Build.0 = Release|Any CPU
+		{62420213-67AD-40FC-B451-BD05C2437CE3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{62420213-67AD-40FC-B451-BD05C2437CE3}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{62420213-67AD-40FC-B451-BD05C2437CE3}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{62420213-67AD-40FC-B451-BD05C2437CE3}.Debug|x64.Build.0 = Debug|Any CPU
+		{62420213-67AD-40FC-B451-BD05C2437CE3}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{62420213-67AD-40FC-B451-BD05C2437CE3}.Debug|x86.Build.0 = Debug|Any CPU
+		{62420213-67AD-40FC-B451-BD05C2437CE3}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{62420213-67AD-40FC-B451-BD05C2437CE3}.Release|Any CPU.Build.0 = Release|Any CPU
+		{62420213-67AD-40FC-B451-BD05C2437CE3}.Release|x64.ActiveCfg = Release|Any CPU
+		{62420213-67AD-40FC-B451-BD05C2437CE3}.Release|x64.Build.0 = Release|Any CPU
+		{62420213-67AD-40FC-B451-BD05C2437CE3}.Release|x86.ActiveCfg = Release|Any CPU
+		{62420213-67AD-40FC-B451-BD05C2437CE3}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -490,6 +519,8 @@ Global
 		{2D1DF5DA-7367-4490-B3F0-B996348E150B} = {B3AF102B-ABE1-41B2-AE48-C40702F45AB0}
 		{9E311832-D0F2-42CA-84DD-9A91B88F0287} = {34A95168-A162-4F6A-803B-B6F221FE9EA6}
 		{AAD604B6-ABE5-4DBC-A2D9-4EF8E815B2EE} = {786C1732-8C96-45DD-97BB-639C9AA7F45B}
+		{C089D0AB-B428-4136-89CC-7974CB590513} = {786C1732-8C96-45DD-97BB-639C9AA7F45B}
+		{62420213-67AD-40FC-B451-BD05C2437CE3} = {34A95168-A162-4F6A-803B-B6F221FE9EA6}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {3302AC79-6D23-4E7D-8C5F-C0C7261044D0}

README.md

@@ -1,5 +1,4 @@
-AsmResolver
-===========
+# AsmResolver
 
  [![Master branch build status](https://img.shields.io/appveyor/ci/Washi1337/AsmResolver/master.svg)](https://ci.appveyor.com/project/Washi1337/asmresolver/branch/master)
  [![Nuget feed](https://img.shields.io/nuget/v/AsmResolver.svg)](https://www.nuget.org/packages/AsmResolver/)
@@ -12,8 +11,44 @@ AsmResolver is a PE inspection library allowing .NET programmers to read, modify
 AsmResolver is released under the MIT license.
 
 
-Binaries
---------
+## Features
+
+AsmResolver has a lot of features. Below a non-exhaustive list:
+
+- [x] Create, read and write PE files
+  - [x] Inspect and update PE headers.
+  - [x] Create, read and write sections.
+- [x] Create, read and write various data directories
+  - [x] Debug Directory (CodeView)
+  - [x] .NET Directory
+    - [x] CIL assembler and disassemblers
+    - [x] Metadata Directory (tables, strings, user-strings, blobs, GUIDs)
+    - [x] Resources Directory
+    - [x] Strong Name Signing
+    - [x] VTable Fixup Directory
+  - [x] Exception Directory (AMD64)
+  - [x] Export Directory
+  - [x] Import Directory
+  - [x] Base Relocation Directory
+  - [x] TLS Directory
+  - [x] Win32 Resources Directory
+- [x] Fully mutable object model for .NET modules that is similar to System.Reflection
+  - [x] Strong type-system with many useful factory methods for quickly constructing new metadata.
+  - [x] Full metadata importing and cloning (useful for injecting metadata into another assembly)
+  - [x] .NET Framework 2.0+, .NET Core and .NET 5+ binary file support.
+  - [x] Infer memory layout of types statically.
+  - [x] Create, read and write managed resource sets (`.resources` files)
+  - [x] Create new method bodies containing native code.
+  - [x] Highly configurable reader and writer options and custom error handling for both.
+  - [x] Rich support for AppHost and SingleFileHost bundled files.
+
+
+## Documentation
+
+Check out the [wiki](https://asmresolver.readthedocs.org/) for guides and information on how to use the library.
+
+
+## Binaries
 
 Stable builds:
 
@@ -30,13 +65,7 @@ Nightly builds:
 | development | [![Development branch build status](https://img.shields.io/appveyor/ci/Washi1337/AsmResolver/development.svg)](https://ci.appveyor.com/project/Washi1337/asmresolver/branch/development)
 
 
-Documentation
--------------
-Check out the [wiki](https://asmresolver.readthedocs.org/) for guides and information on how to use the library.
-
-
-Compiling
----------
+## Compiling
 
 The solution can be build using the .NET SDK or an IDE that works with the .NET SDK (such as Visual Studio and JetBrains Rider). The main packages target .NET Standard 2.0, and the xUnit test projects target .NET Core 3.1.
 
@@ -51,20 +80,18 @@ To run all tests, simply run:
 $ dotnet test
 ```
 
+## Contributing
 
-Contributing
-------------
 See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on general workflow and code style.
 
 
-Found a bug or have questions?
-------------------------------
+## Found a bug or have questions?
+
 Please use the [issue tracker](https://github.com/Washi1337/AsmResolver/issues). Try to be as descriptive as possible.
 
 You can also join the [Discord](https://discord.gg/Y7DTBkbhJJ) to engage more directly with the community.
 
-Acknowledgements
-----------------
+## Acknowledgements
 
 AsmResolver started out as a hobby project, but has grown into a community project with various contributors. Without these people, AsmResolver would not have been where it is today!
 
@@ -73,4 +100,3 @@ AsmResolver started out as a hobby project, but has grown into a community proje
 - Another big thank you to all the people that suggested new features, provided feedback on the API design, have done extensive testing, and/or reported bugs on the [issue board](https://github.com/Washi1337/AsmResolver/issues), by e-mail, or through DMs.
 
 If you feel you have been under-represented in these acknowledgements, feel free to contact me.
-

appveyor.yml

@@ -4,7 +4,7 @@
       - master
 
   image: Visual Studio 2022
-  version: 4.11.0-master-build.{build}
+  version: 4.11.2-master-build.{build}
   configuration: Release
 
   skip_commits:
@@ -23,7 +23,7 @@
   deploy:
     provider: NuGet
     api_key:
-      secure: DCeHUu0aAsOjRnoi2DpcuXpj0apD7dxHzglSamP7LGzcZjhIvTBi1ONnjIa7L2zm
+      secure: L3fXsS7umzD8zwAvTsdGxOg/E6tQ4IR4MfwBAcO8elE7ZwjZ8HO8UPwjiWbp4RMw
     skip_symbols: false
     artifact: /.*\.nupkg/
 

docs/peimage/tls.rst

@@ -6,7 +6,7 @@ Executables that use multiple threads might require static (non-stack) memory th
 All code relevant to the TLS data directory of a PE resides in the following namespace:
 
 .. code-block:: csharp
-    
+
     using AsmResolver.PE.Tls;
 
 
@@ -21,7 +21,7 @@ The PE file format defines a segment of memory within the TLS data directory tha
 
 
 .. code-block:: csharp
-    
+
     var indexSegment = new DataSegment(new byte[8]);
 
     var directory = new TlsDirectory
@@ -48,24 +48,20 @@ Next to static initialization data, it is also possible to specify a list of fun
 Creating new TLS directories
 ----------------------------
 
-Since the TLS data directory stores its data using virtual addresses (VA) rather than relative virtual addresses (RVA), AsmResolver requires the image base as well as the pointer size. This is done through the ``ImageBase`` and ``Is32Bit`` properties. By default, the following values are assumed:
+Adding a new TLS directory to an image can be done using the parameterless constructor of the ``TlsDirectory`` class:
 
 .. code-block:: csharp
 
-    var directory = new TlsDirectory();
-    directory.ImageBase = 0x00400000;
-    directory.Is32Bit = true;
-
-
-Typically, you should make sure they are in sync with the values found in the file and optional header of the final PE file. Upon reading from an existing PE file, these two properties are initialized to the values stored in these two headers.
+    var tlsDirectory = new TlsDirectory();
+    image.TlsDirectory = tlsDirectory;
 
-When building a relocatable PE file, you might also need to add base address relocations to the VAs inside the TLS directory. To quickly get all the base relocations required, use the ``GetRequiredBaseRelocations`` method:
+A TLS directory references all its sub segments using virtual addresses (VA) rather than relative addresses (RVA). This means that constructing a relocatable PE image with a TLS directory requires base relocation entries to be registered that let the Windows PE loader rebase all virtual addresses used in the directory when necessary. To quickly register all the required base relocations, you can call the ``GetRequiredBaseRelocations`` method and add all returned entries to the base relocation directory of the PE image:
 
 .. code-block:: csharp
 
     using AsmResolver.PE.Relocations;
 
     IPEImage image = ...;
 
-    foreach (var relocation in image.TlsDirectory.GetRequiredBaseRelocations())
-        image.Relocations.Add(relocation);
+    foreach (var relocation in tlsDirectory.GetRequiredBaseRelocations())
+        image.Relocations.Add(relocation);

src/AsmResolver.DotNet.Dynamic/AsmResolver.DotNet.Dynamic.csproj

@@ -0,0 +1,32 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <Title>AsmResolver.DotNet.Dynamic</Title>
+        <Description>Dynamic method support for the AsmResolver executable file inspection toolsuite.</Description>
+        <PackageTags>exe pe directories imports exports resources dotnet cil inspection manipulation assembly disassembly dynamic</PackageTags>
+        <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+        <NoWarn>1701;1702;NU5105</NoWarn>
+        <TargetFrameworks>net6.0;netcoreapp3.1;netstandard2.0</TargetFrameworks>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+    <PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
+      <DocumentationFile>bin\Debug\AsmResolver.DotNet.xml</DocumentationFile>
+    </PropertyGroup>
+
+    <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
+      <DocumentationFile>bin\Release\AsmResolver.DotNet.xml</DocumentationFile>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\AsmResolver.DotNet\AsmResolver.DotNet.csproj" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Nullable" Version="1.3.1">
+          <PrivateAssets>all</PrivateAssets>
+          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
+    </ItemGroup>
+
+</Project>

src/AsmResolver.DotNet/Code/Cil/DynamicCilOperandResolver.cs → src/AsmResolver.DotNet.Dynamic/DynamicCilOperandResolver.cs

@@ -1,13 +1,14 @@
 using System;
 using System.Collections.Generic;
 using System.Reflection;
+using AsmResolver.DotNet.Code.Cil;
 using AsmResolver.DotNet.Serialized;
 using AsmResolver.DotNet.Signatures;
 using AsmResolver.IO;
 using AsmResolver.PE.DotNet.Cil;
 using AsmResolver.PE.DotNet.Metadata.Tables;
 
-namespace AsmResolver.DotNet.Code.Cil
+namespace AsmResolver.DotNet.Dynamic
 {
     /// <summary>
     /// Provides an implementation of <see cref="ICilOperandResolver"/> that resolves operands based on
@@ -34,13 +35,13 @@ public DynamicCilOperandResolver(SerializedModuleDefinition contextModule, CilMe
             switch (token.Table)
             {
                 case TableIndex.TypeDef:
-                    object? type = _tokens[(int) token.Rid];
+                    object? type = _tokens[(int)token.Rid];
                     if (type is RuntimeTypeHandle runtimeTypeHandle)
                         return _importer.ImportType(Type.GetTypeFromHandle(runtimeTypeHandle));
                     break;
 
                 case TableIndex.Field:
-                    object? field = _tokens[(int) token.Rid];
+                    object? field = _tokens[(int)token.Rid];
 
                     if (field is null)
                         return null;
@@ -61,7 +62,7 @@ public DynamicCilOperandResolver(SerializedModuleDefinition contextModule, CilMe
 
                 case TableIndex.Method:
                 case TableIndex.MemberRef:
-                    object? obj = _tokens[(int) token.Rid];
+                    object? obj = _tokens[(int)token.Rid];
 
                     if (obj is null)
                         return null;
@@ -94,7 +95,7 @@ public DynamicCilOperandResolver(SerializedModuleDefinition contextModule, CilMe
                     break;
 
                 case TableIndex.StandAloneSig:
-                    var reader = ByteArrayDataSource.CreateReader((byte[]) _tokens[(int) token.Rid]!);
+                    var reader = ByteArrayDataSource.CreateReader((byte[])_tokens[(int)token.Rid]!);
                     return CallingConventionSignature.FromReader(new BlobReadContext(_readerContext), ref reader);
             }
 
@@ -104,7 +105,7 @@ public DynamicCilOperandResolver(SerializedModuleDefinition contextModule, CilMe
         /// <inheritdoc />
         public override object? ResolveString(MetadataToken token)
         {
-            return _tokens[(int) token.Rid] as string;
+            return _tokens[(int)token.Rid] as string;
         }
     }
 }