Skip to content

Commit

Permalink
fix readme, increase version
Browse files Browse the repository at this point in the history
  • Loading branch information
Cinorid committed Apr 8, 2021
1 parent bb9801e commit bfb73e1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion PrivateBox/PrivateBox.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<TargetFramework>netstandard2.0</TargetFramework>
<RootNamespace>AuditDrivenCrypto</RootNamespace>
<Product>PrivateBox</Product>
<Version>0.3.1</Version>
<Version>0.3.1.1</Version>
<Authors>Cinorid (AhmadReza Saghari)</Authors>
<Company>Cinorid</Company>
<Description>C# (.NET Standard) implementation of the NodeJS private-box https://github.com/auditdrivencrypto/private-box</Description>
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A format for encrypting a private message to many parties.

## API

### Encrypt (byte[] plaintext, recipients Array<curve25519_pk>)
### Encrypt (byte[] plaintext, byte[][] recipients)

Takes a `plaintext` Buffer of the message you want to encrypt,
and an array of recipient public keys.
Expand All @@ -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

Expand Down Expand Up @@ -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#
Expand Down

0 comments on commit bfb73e1

Please sign in to comment.