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

Update

Browse Source
This commit is contained in:
Thorsten Sommer 2020-01-07 12:58:35 +01:00
parent d1305e606c
commit 2403386569
1 changed files with 56 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
Ed25519/Ed25519.xml
View File

@ -9,7 +9,7 @@
Extracts the public key out of the given private key. The private key must be valid, i.e. must consist of 32 bytes. Extracts the public key out of the given private key. The private key must be valid, i.e. must consist of 32 bytes.
</summary> </summary>
<param name="privateKey">The private key.</param> <param name="privateKey">The private key.</param>
<returns>The corresponding public key.</returns> <returns>The corresponding public key. Returns an empty ReadOnlySpan, when the private key's length is incorrect.</returns>
</member> </member>
<member name="M:Ed25519.Extensions.ExtractPublicKey(System.Span{System.Byte})"> <member name="M:Ed25519.Extensions.ExtractPublicKey(System.Span{System.Byte})">
<summary> <summary>
@ -18,6 +18,13 @@
<param name="privateKey">The private key.</param> <param name="privateKey">The private key.</param>
<returns>The corresponding public key.</returns> <returns>The corresponding public key.</returns>
</member> </member>
<member name="M:Ed25519.Extensions.ExtractPublicKeyAsync(System.Byte[])">
<summary>
Extracts the public key out of the given private key. The private key must be valid, i.e. must consist of 32 bytes.
</summary>
<param name="privateKey">The private key.</param>
<returns>The corresponding public key. Returns null, when the private key's length is incorrect.</returns>
</member>
<member name="M:Ed25519.Extensions.WriteKey(System.ReadOnlySpan{System.Byte},System.String)"> <member name="M:Ed25519.Extensions.WriteKey(System.ReadOnlySpan{System.Byte},System.String)">
<summary> <summary>
Writes a given key to a file. Writes a given key to a file.
@ -25,6 +32,13 @@
<param name="key">The chosen key</param> <param name="key">The chosen key</param>
<param name="filename">The desired file</param> <param name="filename">The desired file</param>
</member> </member>
<member name="M:Ed25519.Extensions.WriteKeyAsync(System.Byte[],System.String)">
<summary>
Writes a given key to a file.
</summary>
<param name="key">The chosen key</param>
<param name="filename">The desired file</param>
</member>
<member name="M:Ed25519.Extensions.DecryptPrivateKey(System.ReadOnlySpan{System.Byte},System.String)"> <member name="M:Ed25519.Extensions.DecryptPrivateKey(System.ReadOnlySpan{System.Byte},System.String)">
<summary> <summary>
Decrypts an encrypted private key. Decrypts an encrypted private key.
@ -33,6 +47,14 @@
<param name="password">The matching password.</param> <param name="password">The matching password.</param>
<returns>The decrypted private key.</returns> <returns>The decrypted private key.</returns>
</member> </member>
<member name="M:Ed25519.Extensions.DecryptPrivateKeyAsync(System.Byte[],System.String)">
<summary>
Decrypts an encrypted private key.
</summary>
<param name="privateKey">The encrypted private key.</param>
<param name="password">The matching password.</param>
<returns>The decrypted private key.</returns>
</member>
<member name="M:Ed25519.Signer.GeneratePrivateKey(System.String)"> <member name="M:Ed25519.Signer.GeneratePrivateKey(System.String)">
<summary> <summary>
Generates a random private key. Generates a random private key.
@ -40,12 +62,26 @@
<param name="password">An optional password to encrypt the key.</param> <param name="password">An optional password to encrypt the key.</param>
<returns>The private key.</returns> <returns>The private key.</returns>
</member> </member>
<member name="M:Ed25519.Signer.GeneratePrivateKeyAsync(System.String)">
<summary>
Generates a random private key.
</summary>
<param name="password">An optional password to encrypt the key.</param>
<returns>The private key.</returns>
</member>
<member name="M:Ed25519.Signer.LoadKey(System.String)"> <member name="M:Ed25519.Signer.LoadKey(System.String)">
<summary> <summary>
Loads a key (public or private key) from a file. Loads a key (public or private key) from a file.
</summary> </summary>
<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 an empty ReadOnlySpan, when the file does not exist.</returns>
</member>
<member name="M:Ed25519.Signer.LoadKeyAsync(System.String)">
<summary>
Loads a key (public or private key) from a file.
</summary>
<param name="filename">The entire path to the corresponding file.</param>
<returns>The desired key. Returns null, when the file does not exist.</returns>
</member> </member>
<member name="M:Ed25519.Signer.Sign(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})"> <member name="M:Ed25519.Signer.Sign(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})">
<summary> <summary>
@ -56,6 +92,15 @@
<param name="publicKey">The corresponding public key.</param> <param name="publicKey">The corresponding public key.</param>
<returns>The derived signature. It's length is always 64 bytes!</returns> <returns>The derived signature. It's length is always 64 bytes!</returns>
</member> </member>
<member name="M:Ed25519.Signer.SignAsync(System.Byte[],System.Byte[],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 64 bytes.</returns>
</member>
<member name="M:Ed25519.Signer.Validate(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})"> <member name="M:Ed25519.Signer.Validate(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})">
<summary> <summary>
Validates a given signature by means of the given public key. Validates a given signature by means of the given public key.
@ -65,5 +110,14 @@
<param name="publicKey">The used public key.</param> <param name="publicKey">The used public key.</param>
<returns>Returns true when the combination of signature + message is valid.</returns> <returns>Returns true when the combination of signature + message is valid.</returns>
</member> </member>
<member name="M:Ed25519.Signer.ValidateAsync(System.Byte[],System.Byte[],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>