From bfb73e1fa27e630cdceeb0be7ba3710143ad63ef Mon Sep 17 00:00:00 2001 From: Cinorid Date: Thu, 8 Apr 2021 19:58:54 +0430 Subject: [PATCH] fix readme, increase version --- PrivateBox/PrivateBox.csproj | 2 +- README.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/PrivateBox/PrivateBox.csproj b/PrivateBox/PrivateBox.csproj index e3911df..16a6ecd 100644 --- a/PrivateBox/PrivateBox.csproj +++ b/PrivateBox/PrivateBox.csproj @@ -4,7 +4,7 @@ netstandard2.0 AuditDrivenCrypto PrivateBox - 0.3.1 + 0.3.1.1 Cinorid (AhmadReza Saghari) Cinorid C# (.NET Standard) implementation of the NodeJS private-box https://github.com/auditdrivencrypto/private-box diff --git a/README.md b/README.md index b40d484..175252a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ A format for encrypting a private message to many parties. ## API -### Encrypt (byte[] plaintext, recipients Array) +### Encrypt (byte[] plaintext, byte[][] recipients) Takes a `plaintext` Buffer of the message you want to encrypt, and an array of recipient public keys. @@ -21,7 +21,7 @@ between 89 and 287 bytes longer than the plaintext. Attempt to decrypt a PrivateBox message, using your secret key. If you where an intended recipient then the plaintext will be returned. -If it was not for you, then `undefined` will be returned. +If it was not for you, then `null` will be returned. ## Protocol @@ -75,7 +75,7 @@ public static byte[] Encrypt(byte[] msg, byte[][] recipients, int maxRecipients multiplies that with your secret key, then tests each possible recipient slot until it either decrypts a key or runs out of slots. If it runs out of slots, the message was not addressed to you, -so `undefined` is returned. Else, the message is found and the body +so `null` is returned. Else, the message is found and the body is decrypted. ``` c#