Feature/assembly strongname (#262)

* added strong name signing using publicsign

* version prefix

* private key assembly signing, friend assemblies shared public key prop

* changed signassembly condition

* conditional signing, only sign when netstandard target build

* simplified conditional signing, fixed tests for netcore3.1 net5 targets

* reverted strong name

* Update src/_SignAssembly.targets

Co-authored-by: Shane Krueger <[email protected]>

* removed conditional assembly signing, now also sign net6

* added condition so it is possible to override SignAssembly if ever needed

Co-authored-by: Anders Laub <[email protected]>
Co-authored-by: Shane Krueger <[email protected]>

Author: anderslaub

src/Directory.Build.props

@@ -23,6 +23,14 @@
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
     <PackageReadmeFile Condition="'$(IsPackable)' == 'true'">README.md</PackageReadmeFile>
+
+    <!--
+      Strong name signing of netstandard assemblies for better cross-runtime compatibility
+
+        Ref: https://docs.microsoft.com/en-us/dotnet/core/compatibility/core-libraries/6.0/strong-name-signing-exceptions#recommended-action
+     -->
+    <SignAssembly>true</SignAssembly>
+    <CustomBeforeMicrosoftCommonTargets>$(MSBuildThisFileDirectory)_SignAssembly.targets</CustomBeforeMicrosoftCommonTargets>
   </PropertyGroup>
 
   <ItemGroup Condition="'$(IsPackable)' == 'true'">

src/GraphQLParser.sln

@@ -15,9 +15,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		..\.gitignore = ..\.gitignore
 		Directory.Build.props = Directory.Build.props
 		Directory.Build.targets = Directory.Build.targets
+		graphql.snk = graphql.snk
 		..\LICENSE.md = ..\LICENSE.md
 		..\assets\logo.64x64.png = ..\assets\logo.64x64.png
+		public.snk = public.snk
 		..\README.md = ..\README.md
+		_SignAssembly.targets = _SignAssembly.targets
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "GraphQLParser.ApiTests", "GraphQLParser.ApiTests\GraphQLParser.ApiTests.csproj", "{6F01D881-DEA2-4259-977B-FF56DD366592}"

src/GraphQLParser/GraphQLParser.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <Description>Library containing lexer and parser for GraphQL syntax</Description>
@@ -7,6 +7,7 @@
     <TargetFrameworks>netstandard2.0;netstandard2.1;net6</TargetFrameworks>
     <PackageId>GraphQL-Parser</PackageId>
     <PackageTags>GraphQL;json;api;parser</PackageTags>
+    <_FriendAssembliesPublicKey>PublicKey=0024000004800000940000000602000000240000525341310004000001000100352162dbf27be78fc45136884b8f324aa9f1dfc928c96c24704bf1df1a8779b2f26c760ed8321eca5b95ea6bd9bb60cd025b300f73bd1f4ae1ee6e281f85c527fa013ab5cb2c3fc7a1cbef7f9bf0c9014152e6a21f6e0ac6a371f8b45c6d7139c9119df9eeecf1cf59063545bb7c07437b1bc12be2c57d108d72d6c27176fbb8</_FriendAssembliesPublicKey>
   </PropertyGroup>
 
   <ItemGroup>
@@ -15,7 +16,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <InternalsVisibleTo Include="$(MSBuildProjectName).Tests;$(MSBuildProjectName).Benchmarks"/>
+    <InternalsVisibleTo Condition="'$(SignAssembly)' == 'true'" Include="$(MSBuildProjectName).Tests, $(_FriendAssembliesPublicKey);$(MSBuildProjectName).Benchmarks, $(_FriendAssembliesPublicKey)"/>
+    <InternalsVisibleTo Condition="'$(SignAssembly)' != 'true'" Include="$(MSBuildProjectName).Tests;$(MSBuildProjectName).Benchmarks"/>
   </ItemGroup>
 
 </Project>

src/_SignAssembly.targets

@@ -0,0 +1,32 @@
+<Project>
+  <!--
+      Strong name signing of netstandard assemblies for better cross-runtime compatibility.
+      
+        Ref: https://docs.microsoft.com/en-us/dotnet/core/compatibility/core-libraries/6.0/strong-name-signing-exceptions#recommended-action
+     -->
+
+  <PropertyGroup Condition="'$(SignAssembly)' == 'true'">
+    <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)graphql.snk</AssemblyOriginatorKeyFile>
+    <PublicKeyToken>e6238258560628ee</PublicKeyToken>
+  </PropertyGroup>
+
+
+  <!--
+    Workaround for: https://github.com/Microsoft/msbuild/issues/1490 (lack of support for public-signing satellites)
+    Delay-signs the satellite assemblies when main assembly is public-signed.
+    
+    Ref: https://github.com/dotnet/project-system/blob/main/eng/imports/StrongName.targets
+  -->
+  <Target Name="PrepareToDelaySignSatelliteAssemblies" BeforeTargets="GenerateSatelliteAssemblies" Condition="'$(MSBuildRuntimeType)' != 'Core' and '$(SignAssembly)' == 'true'">
+    <PropertyGroup>
+      <_DelaySignMainAssembly>$(DelaySign)</_DelaySignMainAssembly>
+      <DelaySign Condition="'$(PublicSign)' == 'true'">true</DelaySign>
+    </PropertyGroup>
+  </Target>
+
+  <Target Name="CleanupAfterDelaySigningSatelliteAssemblies" AfterTargets="GenerateSatelliteAssemblies" Condition="'$(MSBuildRuntimeType)' != 'Core' and '$(SignAssembly)' == 'true'">
+    <PropertyGroup>
+      <DelaySign>$(_DelaySignMainAssembly)</DelaySign>
+    </PropertyGroup>
+  </Target>
+</Project>