Port of TweetNaCl / NaCl to C#. Public domain.
The primary goal of this project is to produce a translation of TweetNaCl to C# which is as close as possible to the original C implementation, plus a thin layer of idiomatic high-level API on top of it.
There are two versions, you can use either of them:
-
TweetNaclSharp.Naclis the port of TweetNaCl with minimum differences from the original + high-level API. -
TweetNaclSharp.NaclFastis likeTweetNaclSharp.Nacl, but with some functions replaced with faster versions.
You can install TweetNaclSharp via NuGet:
package manager:
$ PM> Install-Package TweetNaclSharp
NET CLI:
$ dotnet add package TweetNaclSharp
You can find usage examples in our wiki.
All API functions accept and return bytes as byte[]s. If you need to
encode or decode strings, use functions from
TweetNaclSharp.NaclUtil or one of the more robust codec
packages.
Implements x25519-xsalsa20-poly1305.
Generates a new random key pair for box and returns it as an object with
PublicKey and SecretKey members:
{
PublicKey: ..., // byte[] with 32-byte public key
SecretKey: ... // byte[] with 32-byte secret key
}
Returns a key pair for box with public key corresponding to the given secret key.
Encrypts and authenticates message using peer's public key, our secret key, and the given nonce, which must be unique for each distinct message for a key pair.
Returns an encrypted and authenticated message, which is
TweetNaclSharp.Nacl.BoxOverheadLength longer than the original message.
Authenticates and decrypts the given box with peer's public key, our secret key, and the given nonce.
Returns the original message, or null if authentication fails.
Returns a precomputed shared key which can be used in TweetNaclSharp.Nacl.BoxAfter and
TweetNaclSharp.Nacl.BoxOpenAfter.
Same as TweetNaclSharp.Nacl.Box, but uses a shared key precomputed with TweetNaclSharp.Nacl.BoxBefore.
Same as TweetNaclSharp.Nacl.BoxOpen, but uses a shared key precomputed with TweetNaclSharp.Nacl.BoxBefore.
Length of public key in bytes.
Length of secret key in bytes.
Length of precomputed shared key in bytes.
Length of nonce in bytes.
Length of overhead added to box compared to original message.
Implements xsalsa20-poly1305.
Encrypts and authenticates message using the key and the nonce. The nonce must be unique for each distinct message for this key.
Returns an encrypted and authenticated message, which is
TweetNaclSharp.Nacl.SecretboxOverheadLength longer than the original message.
Authenticates and decrypts the given secret box using the key and the nonce.
Returns the original message, or null if authentication fails.
Length of key in bytes.
Length of nonce in bytes.
Length of overhead added to secret box compared to original message.
Implements x25519.
Multiplies an integer n by a group element p and returns the resulting
group element.
Multiplies an integer n by a standard group element and returns the resulting
group element.
Length of scalar in bytes.
Length of group element in bytes.
Implements ed25519.
Generates new random key pair for signing and returns it as an object with
PublicKey and SecretKey members:
{
PublicKey: ..., // byte[] with 32-byte public key
SecretKey: ... // byte[] with 64-byte secret key
}
Returns a signing key pair with public key corresponding to the given
64-byte secret key. The secret key must have been generated by
TweetNaclSharp.Nacl.SignKeyPair or TweetNaclSharp.Nacl.SignKeyPairFromSeed.
Returns a new signing key pair generated deterministically from a 32-byte seed.
The seed must contain enough entropy to be secure. This method is not
recommended for general use: instead, use TweetNaclSharp.Nacl.SignKeyPair to generate a new
key pair from a random seed.
Signs the message using the secret key and returns a signed message.
Verifies the signed message and returns the message without signature.
Returns null if verification failed.
Signs the message using the secret key and returns a signature.
Verifies the signature for the message and returns true if verification
succeeded or false if it failed.
Length of signing public key in bytes.
Length of signing secret key in bytes.
Length of seed for TweetNaclSharp.Nacl.SignKeyPairFromSeed in bytes.
Length of signature in bytes.
Implements SHA-512.
Returns SHA-512 hash of the message.
Length of hash in bytes.
Returns a byte[] of the given length containing random bytes of
cryptographic quality.
Implementation note
TweetNaclSharp uses the following methods to generate random bytes, it runs on:
System.Security.Cryptography.RandomNumberGenerator(standard)
If you somehow have a cryptographically-strong source of entropy
(not Random!), and you know what you are doing, you can plug it into
TweetNaclSharp like this:
TweetNaclSharp.Nacl.SetPRNG((byte[] x, int n) => {
// ... copy n random bytes into x ...
});
Note that TweetNaclSharp.Nacl.SetPRNG completely replaces internal random byte generator
with the one provided.
Compares x and y in constant time and returns true if their lengths are
non-zero and equal, and their contents are equal.
Returns false if either of the arguments has zero length, or arguments have
different lengths, or their contents differ.
TweetNaclSharp supports:
- Net 6
Make sure to rebuild projects every time you change code for testing.
To run tests:
$ dotnet test