Dotnet/Ed25519
Dotnet/Ed25519
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added missing documentation

Browse Source
This commit is contained in:
Thorsten Sommer 2020-01-07 11:16:35 +01:00
parent 50baff4f89
commit b5f780343b
2 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Ed25519/Ed25519.xml
View File

@ -47,5 +47,23 @@
<param name="filename">The entire path to the corresponding file.</param> <param name="filename">The entire path to the corresponding file.</param>
<returns>The desired key.</returns> <returns>The desired key.</returns>
</member> </member>
<member name="M:Ed25519.Signer.Sign(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})">
<summary>
Signs a message with the given private and public keys.
</summary>
<param name="message">The message to sign.</param>
<param name="privateKey">The desired private key.</param>
<param name="publicKey">The corresponding public key.</param>
<returns>The derived signature. It's length is always 64 bytes!</returns>
</member>
<member name="M:Ed25519.Signer.Validate(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})">
<summary>
Validates a given signature by means of the given public key.
</summary>
<param name="signature">The signature to validate.</param>
<param name="message">The corresponding message.</param>
<param name="publicKey">The used public key.</param>
<returns>Returns true when the combination of signature + message is valid.</returns>
</member>
</members> </members>
</doc> </doc>

14
Ed25519/Signer.cs
View File

@ -41,6 +41,13 @@ namespace Ed25519
/// <returns>The desired key.</returns> /// <returns>The desired key.</returns>
public static ReadOnlySpan<byte> LoadKey(string filename) => !File.Exists(filename) ? ReadOnlySpan<byte>.Empty : File.ReadAllBytes(filename); public static ReadOnlySpan<byte> LoadKey(string filename) => !File.Exists(filename) ? ReadOnlySpan<byte>.Empty : File.ReadAllBytes(filename);
/// <summary>
/// Signs a message with the given private and public keys.
/// </summary>
/// <param name="message">The message to sign.</param>
/// <param name="privateKey">The desired private key.</param>
/// <param name="publicKey">The corresponding public key.</param>
/// <returns>The derived signature. It's length is always 64 bytes!</returns>
public static ReadOnlySpan<byte> Sign(ReadOnlySpan<byte> message, ReadOnlySpan<byte> privateKey, ReadOnlySpan<byte> publicKey) public static ReadOnlySpan<byte> Sign(ReadOnlySpan<byte> message, ReadOnlySpan<byte> privateKey, ReadOnlySpan<byte> publicKey)
{ {
if(privateKey.Length != Constants.BIT_LENGTH / 8) if(privateKey.Length != Constants.BIT_LENGTH / 8)
@ -94,6 +101,13 @@ namespace Ed25519
} }
} }
/// <summary>
/// Validates a given signature by means of the given public key.
/// </summary>
/// <param name="signature">The signature to validate.</param>
/// <param name="message">The corresponding message.</param>
/// <param name="publicKey">The used public key.</param>
/// <returns>Returns true when the combination of signature + message is valid.</returns>
public static bool Validate(ReadOnlySpan<byte> signature, ReadOnlySpan<byte> message, ReadOnlySpan<byte> publicKey) public static bool Validate(ReadOnlySpan<byte> signature, ReadOnlySpan<byte> message, ReadOnlySpan<byte> publicKey)
{ {
if (signature.Length != Constants.BIT_LENGTH / 4) if (signature.Length != Constants.BIT_LENGTH / 4)