diff --git a/PrivateBox/PrivateBox.cs b/PrivateBox/PrivateBox.cs index 532b029..0398e06 100644 --- a/PrivateBox/PrivateBox.cs +++ b/PrivateBox/PrivateBox.cs @@ -116,8 +116,13 @@ public static byte[] Multibox(string msg, List recipients, int maxRecipi var _msg = Encoding.UTF8.GetBytes(msg); return Multibox(_msg, recipients.ToArray(), maxRecipients); } - + /// + /// Takes a 'plaintext' Buffer of the message you want to encrypt, + /// and an array of recipient public keys. + /// Returns a message that is encrypted to all recipients + /// and openable by them with 'PrivateBox.MultiboxOpen'. + /// The 'recipients' must be between 1 and 7 items long. /// same as Multibox /// /// @@ -131,6 +136,11 @@ public static byte[] Encrypt(byte[] msg, byte[][] recipients, int maxRecipients } /// + /// Takes a 'plaintext' Buffer of the message you want to encrypt, + /// and an array of recipient public keys. + /// Returns a message that is encrypted to all recipients + /// and openable by them with 'PrivateBox.MultiboxOpen'. + /// The 'recipients' must be between 1 and 7 items long. /// same as Multibox /// /// @@ -143,6 +153,11 @@ public static byte[] Encrypt(byte[] msg, List recipients, int maxRecipie } /// + /// Takes a 'plaintext' Buffer of the message you want to encrypt and encode it to UTF8 bytes array, + /// and an array of recipient public keys. + /// Returns a message that is encrypted to all recipients + /// and openable by them with 'PrivateBox.MultiboxOpen'. + /// The 'recipients' must be between 1 and 7 items long. /// same as Multibox /// /// @@ -155,6 +170,11 @@ public static byte[] Encrypt(string msg, byte[][] recipients, int maxRecipients } /// + /// Takes a 'plaintext' Buffer of the message you want to encrypt and encode it to UTF8 bytes array, + /// and an array of recipient public keys. + /// Returns a message that is encrypted to all recipients + /// and openable by them with 'PrivateBox.MultiboxOpen'. + /// The 'recipients' must be between 1 and 7 items long. /// same as Multibox /// /// @@ -165,9 +185,9 @@ public static byte[] Encrypt(string msg, List recipients, int maxRecipie { return Multibox(msg, recipients, maxRecipients); } - + /// - /// + /// MultiboxOpenKey /// /// /// @@ -208,7 +228,7 @@ public static byte[] MultiboxOpenKey(byte[] cypherText, byte[] secretKey, int ma } /// - /// + /// MultiboxOpenBody /// /// /// @@ -245,6 +265,9 @@ public static byte[] MultiboxOpen(byte[] cypherText, byte[] secretKey, int maxRe } /// + /// Attempt to decrypt a private-box message, using your secret key. + /// If you where an intended recipient then the plaintext will be returned. + /// If it was not for you, then 'null' will be returned. /// same as MultiboxOpen /// /// diff --git a/PrivateBox/PrivateBox.csproj b/PrivateBox/PrivateBox.csproj index 16a6ecd..3e29c62 100644 --- a/PrivateBox/PrivateBox.csproj +++ b/PrivateBox/PrivateBox.csproj @@ -4,7 +4,7 @@ netstandard2.0 AuditDrivenCrypto PrivateBox - 0.3.1.1 + 0.3.1.2 Cinorid (AhmadReza Saghari) Cinorid C# (.NET Standard) implementation of the NodeJS private-box https://github.com/auditdrivencrypto/private-box diff --git a/Tests/Tests.cs b/Tests/Test_PrivateBox.cs similarity index 98% rename from Tests/Tests.cs rename to Tests/Test_PrivateBox.cs index b55aa07..893584f 100644 --- a/Tests/Tests.cs +++ b/Tests/Test_PrivateBox.cs @@ -5,7 +5,7 @@ namespace AuditDrivenCrypto.Tests { - public class Tests + public class Test_PrivateBox { KeyPair alice; KeyPair bob; diff --git a/Tests/Tests.csproj b/Tests/Tests.csproj index 390101b..590115d 100644 --- a/Tests/Tests.csproj +++ b/Tests/Tests.csproj @@ -5,9 +5,11 @@ false - SSB.Keys.Tests + AuditDrivenCrypto.Tests true + + AutoGeneratedProgram