Merge pull request #125 from dorssel/fixes

dorssel · web-flow · commit b7a3640e7ddc · 2024-12-31T14:51:28.000+01:00
Small code improvements
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -45,7 +45,9 @@ SPDX-License-Identifier: MIT
     <!-- NuGet metadata -->
     <Title>$(Product)</Title>
     <Authors>$(Company)</Authors>
-    <Description>TODO</Description>
+    <Description>XMSS Library</Description>
+    <PackageProjectUrl>https://dorssel.github.io/dotnet-xmss/</PackageProjectUrl>
+    <PackageTags>cryptography signature post-quantum post-quantum-cryptography post-quantum-signature xmss rfc-8391 nist-sp-800-208</PackageTags>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <UseFullSemVerForNuGet>false</UseFullSemVerForNuGet>
@@ -55,7 +57,7 @@ SPDX-License-Identifier: MIT
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Dorssel.GitVersion.MsBuild" />
+    <PackageReference Include="Dorssel.GitVersion.MsBuild" PrivateAssets="all" />
   </ItemGroup>
 
   <Target Name="SetCopyright" AfterTargets="GetVersion">
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -7,11 +7,11 @@ SPDX-License-Identifier: MIT
 <Project>
   <ItemGroup>
     <!-- all -->
-    <PackageVersion Include="Dorssel.GitVersion.MsBuild" Version="1.1.0" PrivateAssets="all" />
+    <PackageVersion Include="Dorssel.GitVersion.MsBuild" Version="1.1.0" />
     <!-- example WebApp -->
     <PackageVersion Include="Blazored.LocalStorage" Version="4.5.0" />
     <PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly" Version="9.0.0" />
-    <PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly.DevServer" Version="9.0.0" PrivateAssets="all" />
+    <PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly.DevServer" Version="9.0.0" />
     <PackageVersion Include="Microsoft.FluentUI.AspNetCore.Components" Version="4.11.0" />
     <PackageVersion Include="Microsoft.FluentUI.AspNetCore.Components.Icons" Version="4.11.0" />
   </ItemGroup>
diff --git a/Xmss/Internal/OpaqueStructures.cs b/Xmss/Internal/OpaqueStructures.cs
@@ -7,7 +7,7 @@
 
 namespace Dorssel.Security.Cryptography.Internal;
 
-unsafe struct XmssSigningContext { }
+struct XmssSigningContext { }
 
 static partial class Defines
 {
@@ -22,7 +22,7 @@ static partial class UnsafeNativeMethods
     internal static unsafe partial void xmss_free_signing_context(XmssSigningContext* signing_context);
 }
 
-unsafe struct XmssInternalCache { }
+struct XmssInternalCache { }
 
 static partial class Defines
 {
@@ -50,7 +50,7 @@ internal static unsafe int XMSS_PUBLIC_KEY_GENERATION_CACHE_SIZE(int number_of_p
     }
 }
 
-unsafe struct XmssKeyContext { }
+struct XmssKeyContext { }
 
 static partial class Defines
 {
@@ -74,7 +74,7 @@ static partial class UnsafeNativeMethods
     internal static unsafe partial void xmss_free_key_context(XmssKeyContext* key_context);
 }
 
-unsafe struct XmssKeyGenerationContext { }
+struct XmssKeyGenerationContext { }
 
 static partial class Defines
 {
diff --git a/Xmss/Internal/Structures.cs b/Xmss/Internal/Structures.cs
@@ -7,10 +7,10 @@
 
 namespace Dorssel.Security.Cryptography.Internal;
 
-unsafe struct XmssPrivateKeyStatelessBlob
+struct XmssPrivateKeyStatelessBlob
 {
     internal nuint data_size;
-    internal byte* data // originally: uint8_t[]
+    internal unsafe byte* data // originally: uint8_t[]
     {
         get
         {
@@ -28,10 +28,10 @@ static partial class Defines
         + sizeof(XmssValue256) + 4 + 4 + 4 + 4 + XMSS_PRIVATE_KEY_STATELESS_PART_SIZE;
 }
 
-unsafe struct XmssPrivateKeyStatefulBlob
+struct XmssPrivateKeyStatefulBlob
 {
     internal nuint data_size;
-    internal byte* data // originally: uint8_t[]
+    internal unsafe byte* data // originally: uint8_t[]
     {
         get
         {
@@ -49,10 +49,10 @@ static partial class Defines
         + 4 + 4 + 4 + 4 + sizeof(XmssValue256) + (2 * XMSS_PRIVATE_KEY_STATEFUL_PART_SIZE);
 }
 
-unsafe struct XmssPublicKeyInternalBlob
+struct XmssPublicKeyInternalBlob
 {
     internal nuint data_size;
-    internal byte* data // originally: uint8_t[]
+    internal unsafe byte* data // originally: uint8_t[]
     {
         get
         {
@@ -85,12 +85,12 @@ static partial class Defines
     internal static readonly unsafe int XMSS_PUBLIC_KEY_SIZE = sizeof(XmssPublicKey);
 }
 
-unsafe struct XmssSignature
+struct XmssSignature
 {
     internal uint leaf_index; // big-endian
     internal XmssValue256 random_bytes;
-    internal fixed byte wots_signature[67 * 32]; // originally: XmssValue256[67]
-    internal XmssValue256* authentication_path // originally: XmssValue256[]
+    internal unsafe fixed byte wots_signature[67 * 32]; // originally: XmssValue256[67]
+    internal unsafe XmssValue256* authentication_path // originally: XmssValue256[]
     {
         get
         {
@@ -102,10 +102,10 @@ unsafe struct XmssSignature
     }
 }
 
-unsafe struct XmssSignatureBlob
+struct XmssSignatureBlob
 {
     internal nuint data_size;
-    internal byte* data // originally: uint8_t[]
+    internal unsafe byte* data // originally: uint8_t[]
     {
         get
         {
@@ -143,10 +143,10 @@ internal static unsafe int XMSS_SIGNATURE_BLOB_SIZE(XmssParameterSetOID param_se
 }
 
 [StructLayout(LayoutKind.Explicit)]
-unsafe struct XmssVerificationContext
+struct XmssVerificationContext
 {
     [FieldOffset(0)]
-    internal fixed byte data[Defines.XMSS_VERIFICATION_CONTEXT_SIZE];
+    internal unsafe fixed byte data[Defines.XMSS_VERIFICATION_CONTEXT_SIZE];
 
     [FieldOffset(0)]
     internal ulong alignment;
diff --git a/Xmss/Internal/Types.cs b/Xmss/Internal/Types.cs
@@ -80,25 +80,25 @@ enum XmssCacheType : int
     XMSS_CACHE_TOP = XmssDistantValues.XMSS_DISTANT_VALUE_3
 }
 
-unsafe struct XmssValue256
+struct XmssValue256
 {
-    internal fixed byte data[32];
+    internal unsafe fixed byte data[32];
 }
 
 static partial class Defines
 {
     internal const int XMSS_VALUE_256_WORDS = 8;
 }
 
-unsafe struct XmssNativeValue256
+struct XmssNativeValue256
 {
-    internal fixed uint data[Defines.XMSS_VALUE_256_WORDS];
+    internal unsafe fixed uint data[Defines.XMSS_VALUE_256_WORDS];
 }
 
-unsafe struct XmssBuffer
+struct XmssBuffer
 {
     internal nuint data_size;
-    internal byte* data;
+    internal unsafe byte* data;
 }
 
 unsafe delegate void* XmssReallocFunction(void* ptr, nuint size);
diff --git a/Xmss/InteropServices/CriticalXmssHandle.cs b/Xmss/InteropServices/CriticalXmssHandle.cs
@@ -8,7 +8,7 @@ namespace Dorssel.Security.Cryptography.InteropServices;
 
 abstract class CriticalXmssHandle<T> : CriticalHandle where T : unmanaged
 {
-    private protected unsafe CriticalXmssHandle()
+    private protected CriticalXmssHandle()
         : base(0)
     {
     }
diff --git a/libc/libc.c b/libc/libc.c
@@ -53,7 +53,7 @@ int memcmp(const void *s1, const void *s2, size_t n) {
 }
 
 NOEXPORT
-void *memcpy(void * restrict s1, const void * restrict s2, size_t n) {
+void *memcpy(void * restrict s1, const void * restrict s2, size_t n) {  // DevSkim: ignore DS121708
     unsigned char *dst = s1;
     const unsigned char *src = s2;
     for (; n; n--) {

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`
`8`	`8`	`namespace Dorssel.Security.Cryptography.Internal;`
`9`	`9`
`10`		`-unsafe struct XmssSigningContext { }`
	`10`	`+struct XmssSigningContext { }`
`11`	`11`
`12`	`12`	`static partial class Defines`
`13`	`13`	`{`
`@@ -22,7 +22,7 @@ static partial class UnsafeNativeMethods`
`22`	`22`	`internal static unsafe partial void xmss_free_signing_context(XmssSigningContext* signing_context);`
`23`	`23`	`}`
`24`	`24`
`25`		`-unsafe struct XmssInternalCache { }`
	`25`	`+struct XmssInternalCache { }`
`26`	`26`
`27`	`27`	`static partial class Defines`
`28`	`28`	`{`
`@@ -50,7 +50,7 @@ internal static unsafe int XMSS_PUBLIC_KEY_GENERATION_CACHE_SIZE(int number_of_p`
`50`	`50`	`}`
`51`	`51`	`}`
`52`	`52`
`53`		`-unsafe struct XmssKeyContext { }`
	`53`	`+struct XmssKeyContext { }`
`54`	`54`
`55`	`55`	`static partial class Defines`
`56`	`56`	`{`
`@@ -74,7 +74,7 @@ static partial class UnsafeNativeMethods`
`74`	`74`	`internal static unsafe partial void xmss_free_key_context(XmssKeyContext* key_context);`
`75`	`75`	`}`
`76`	`76`
`77`		`-unsafe struct XmssKeyGenerationContext { }`
	`77`	`+struct XmssKeyGenerationContext { }`
`78`	`78`
`79`	`79`	`static partial class Defines`
`80`	`80`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,10 +7,10 @@`
`7`	`7`
`8`	`8`	`namespace Dorssel.Security.Cryptography.Internal;`
`9`	`9`
`10`		`-unsafe struct XmssPrivateKeyStatelessBlob`
	`10`	`+struct XmssPrivateKeyStatelessBlob`
`11`	`11`	`{`
`12`	`12`	`internal nuint data_size;`
`13`		`- internal byte* data // originally: uint8_t[]`
	`13`	`+ internal unsafe byte* data // originally: uint8_t[]`
`14`	`14`	`{`
`15`	`15`	`get`
`16`	`16`	`{`
`@@ -28,10 +28,10 @@ static partial class Defines`
`28`	`28`	`+ sizeof(XmssValue256) + 4 + 4 + 4 + 4 + XMSS_PRIVATE_KEY_STATELESS_PART_SIZE;`
`29`	`29`	`}`
`30`	`30`
`31`		`-unsafe struct XmssPrivateKeyStatefulBlob`
	`31`	`+struct XmssPrivateKeyStatefulBlob`
`32`	`32`	`{`
`33`	`33`	`internal nuint data_size;`
`34`		`- internal byte* data // originally: uint8_t[]`
	`34`	`+ internal unsafe byte* data // originally: uint8_t[]`
`35`	`35`	`{`
`36`	`36`	`get`
`37`	`37`	`{`
`@@ -49,10 +49,10 @@ static partial class Defines`
`49`	`49`	`+ 4 + 4 + 4 + 4 + sizeof(XmssValue256) + (2 * XMSS_PRIVATE_KEY_STATEFUL_PART_SIZE);`
`50`	`50`	`}`
`51`	`51`
`52`		`-unsafe struct XmssPublicKeyInternalBlob`
	`52`	`+struct XmssPublicKeyInternalBlob`
`53`	`53`	`{`
`54`	`54`	`internal nuint data_size;`
`55`		`- internal byte* data // originally: uint8_t[]`
	`55`	`+ internal unsafe byte* data // originally: uint8_t[]`
`56`	`56`	`{`
`57`	`57`	`get`
`58`	`58`	`{`
`@@ -85,12 +85,12 @@ static partial class Defines`
`85`	`85`	`internal static readonly unsafe int XMSS_PUBLIC_KEY_SIZE = sizeof(XmssPublicKey);`
`86`	`86`	`}`
`87`	`87`
`88`		`-unsafe struct XmssSignature`
	`88`	`+struct XmssSignature`
`89`	`89`	`{`
`90`	`90`	`internal uint leaf_index; // big-endian`
`91`	`91`	`internal XmssValue256 random_bytes;`
`92`		`- internal fixed byte wots_signature[67 * 32]; // originally: XmssValue256[67]`
`93`		`- internal XmssValue256* authentication_path // originally: XmssValue256[]`
	`92`	`+ internal unsafe fixed byte wots_signature[67 * 32]; // originally: XmssValue256[67]`
	`93`	`+ internal unsafe XmssValue256* authentication_path // originally: XmssValue256[]`
`94`	`94`	`{`
`95`	`95`	`get`
`96`	`96`	`{`
`@@ -102,10 +102,10 @@ unsafe struct XmssSignature`
`102`	`102`	`}`
`103`	`103`	`}`
`104`	`104`
`105`		`-unsafe struct XmssSignatureBlob`
	`105`	`+struct XmssSignatureBlob`
`106`	`106`	`{`
`107`	`107`	`internal nuint data_size;`
`108`		`- internal byte* data // originally: uint8_t[]`
	`108`	`+ internal unsafe byte* data // originally: uint8_t[]`
`109`	`109`	`{`
`110`	`110`	`get`
`111`	`111`	`{`
`@@ -143,10 +143,10 @@ internal static unsafe int XMSS_SIGNATURE_BLOB_SIZE(XmssParameterSetOID param_se`
`143`	`143`	`}`
`144`	`144`
`145`	`145`	`[StructLayout(LayoutKind.Explicit)]`
`146`		`-unsafe struct XmssVerificationContext`
	`146`	`+struct XmssVerificationContext`
`147`	`147`	`{`
`148`	`148`	`[FieldOffset(0)]`
`149`		`- internal fixed byte data[Defines.XMSS_VERIFICATION_CONTEXT_SIZE];`
	`149`	`+ internal unsafe fixed byte data[Defines.XMSS_VERIFICATION_CONTEXT_SIZE];`
`150`	`150`
`151`	`151`	`[FieldOffset(0)]`
`152`	`152`	`internal ulong alignment;`
Original file line number	Diff line number	Diff line change
`@@ -80,25 +80,25 @@ enum XmssCacheType : int`
`80`	`80`	`XMSS_CACHE_TOP = XmssDistantValues.XMSS_DISTANT_VALUE_3`
`81`	`81`	`}`
`82`	`82`
`83`		`-unsafe struct XmssValue256`
	`83`	`+struct XmssValue256`
`84`	`84`	`{`
`85`		`- internal fixed byte data[32];`
	`85`	`+ internal unsafe fixed byte data[32];`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`static partial class Defines`
`89`	`89`	`{`
`90`	`90`	`internal const int XMSS_VALUE_256_WORDS = 8;`
`91`	`91`	`}`
`92`	`92`
`93`		`-unsafe struct XmssNativeValue256`
	`93`	`+struct XmssNativeValue256`
`94`	`94`	`{`
`95`		`- internal fixed uint data[Defines.XMSS_VALUE_256_WORDS];`
	`95`	`+ internal unsafe fixed uint data[Defines.XMSS_VALUE_256_WORDS];`
`96`	`96`	`}`
`97`	`97`
`98`		`-unsafe struct XmssBuffer`
	`98`	`+struct XmssBuffer`
`99`	`99`	`{`
`100`	`100`	`internal nuint data_size;`
`101`		`- internal byte* data;`
	`101`	`+ internal unsafe byte* data;`
`102`	`102`	`}`
`103`	`103`
`104`	`104`	`unsafe delegate void* XmssReallocFunction(void* ptr, nuint size);`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ namespace Dorssel.Security.Cryptography.InteropServices;`
`8`	`8`
`9`	`9`	`abstract class CriticalXmssHandle<T> : CriticalHandle where T : unmanaged`
`10`	`10`	`{`
`11`		`- private protected unsafe CriticalXmssHandle()`
	`11`	`+ private protected CriticalXmssHandle()`
`12`	`12`	`: base(0)`
`13`	`13`	`{`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ int memcmp(const void s1, const void s2, size_t n) {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`NOEXPORT`
`56`		`-void memcpy(void restrict s1, const void * restrict s2, size_t n) {`
	`56`	`+void memcpy(void restrict s1, const void * restrict s2, size_t n) { // DevSkim: ignore DS121708`
`57`	`57`	`unsigned char *dst = s1;`
`58`	`58`	`const unsigned char *src = s2;`
`59`	`59`	`for (; n; n--) {`