Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daviddesmet/NaCl.Core
🔑 NaCl.Core, a cryptography library for .NET
https://github.com/daviddesmet/NaCl.Core
chacha20-poly1305 dotnet dotnet-core netstandard poly1305 xchacha20-poly1305
Last synced: about 2 months ago
JSON representation
🔑 NaCl.Core, a cryptography library for .NET
- Host: GitHub
- URL: https://github.com/daviddesmet/NaCl.Core
- Owner: daviddesmet
- License: mit
- Created: 2018-06-01T14:11:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T12:26:51.000Z (about 1 year ago)
- Last Synced: 2024-07-05T02:07:32.745Z (3 months ago)
- Topics: chacha20-poly1305, dotnet, dotnet-core, netstandard, poly1305, xchacha20-poly1305
- Language: C#
- Homepage:
- Size: 516 KB
- Stars: 69
- Watchers: 4
- Forks: 7
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-csharp - NaCl.Core - A managed-only cryptography library for .NET which provides modern cryptographic primitives. (Cryptography)
- awsome-dotnet - NaCl.Core - A managed-only cryptography library for .NET which provides modern cryptographic primitives. (Cryptography)
- awesome-dotnet - NaCl.Core - A managed-only cryptography library for .NET which provides modern cryptographic primitives. (Cryptography)
README
# NaCl.Core, a cryptography library for .NET
[](https://dev.azure.com/idaviddesmet/NaCl.Core/_build/latest?definitionId=3&branchName=master)
[](https://github.com/daviddesmet/NaCl.Core/actions)
[](https://ci.appveyor.com/project/idaviddesmet/nacl-core)
[](https://github.com/daviddesmet/NaCl.Core/issues)
## Introduction
**NaCl.Core** is a managed-only cryptography library for [.NET](https://dot.net) which provides modern cryptographic _primitives_.
#### Currently supported:
| Crypto | Description |
|--------|-------------|
| **Salsa20** | A high-speed stream cipher part of the family of 256-bit stream ciphers designed in 2005 and submitted to [eSTREAM](https://www.ecrypt.eu.org/stream/salsa20pf.html), the ECRYPT Stream Cipher Project |
| **ChaCha20** | A high-speed stream cipher based on Salsa20 |
| **XChaCha20** | Based on ChaCha20 IETF with extended nonce (192-bit instead of 96-bit) |
| **Poly1305** | A state-of-the-art secret-key message-authentication code (MAC) based on [RFC8439](https://tools.ietf.org/html/rfc8439) |
| **ChaCha20Poly1305** | An Authenticated Encryption with Associated Data (AEAD) algorithm; IETF variant as defined in [RFC8439](https://tools.ietf.org/html/rfc8439) and in its predecessor [RFC7539](https://tools.ietf.org/html/rfc7539) |
| **XChaCha20Poly1305** | A variant of ChaCha20-Poly1305 that utilizes the XChaCha20 construction in place of ChaCha20; as defined in the [RFC Draft](https://tools.ietf.org/html/draft-arciszewski-xchacha-03) |
## Installation
[](https://www.nuget.org/packages/NaCl.Core/)
[](https://dev.azure.com/idaviddesmet/NaCl.Core/_packaging?_a=feed&feed=NaCl.Core-CI)
Install the NaCl.Core NuGet package from the .NET CLI using:
```
dotnet add package NaCl.Core
```
or from the NuGet package manager:
```
Install-Package NaCl.Core
```
Or alternatively, you can add the NaCl.Core package from within Visual Studio's NuGet package manager.
Daily NuGet builds of the project are also available in the [Azure Artifacts](https://dev.azure.com/idaviddesmet/NaCl.Core/_packaging?_a=feed&feed=NaCl.Core-CI) feed:
> [https://pkgs.dev.azure.com/idaviddesmet/NaCl.Core/_packaging/NaCl.Core-CI/nuget/v3/index.json](https://pkgs.dev.azure.com/idaviddesmet/NaCl.Core/_packaging/NaCl.Core-CI/nuget/v3/index.json)
## Usage
[](https://www.nuget.org/packages/NaCl.Core/)
#### Symmetric Key Encryption
```csharp
// Create the primitive
var aead = new ChaCha20Poly1305(key);
// Use the primitive to encrypt a plaintext
aead.Encrypt(nonce, plaintext, ciphertext, tag, aad);
// ... or to decrypt a ciphertext
aead.Decrypt(nonce, ciphertext, tag, plaintext, aad);
```
#### MAC (Message Authentication Code)
```csharp
// Use the primitive to compute a tag
Poly1305.ComputeMac(key, data, tag);
// ... or to verify a tag
Poly1305.VerifyMac(key, data, tag);
```
## Test Coverage
[](https://dev.azure.com/idaviddesmet/NaCl.Core/_build/latest?definitionId=3)
[](https://dev.azure.com/idaviddesmet/NaCl.Core/_build/latest?definitionId=3)
[](https://codecov.io/gh/daviddesmet/NaCl.Core)
- Includes the mandatory RFC [test vectors](https://github.com/daviddesmet/NaCl.Core/tree/master/test/NaCl.Core.Tests).
- [Project Wycheproof](https://github.com/google/wycheproof) by members of Google Security Team, for testing against known attacks (when applicable).
## Learn More
[](https://github.com/daviddesmet/NaCl.Core/blob/master/LICENSE)
- [ChaCha, a variant of Salsa20](http://cr.yp.to/chacha/chacha-20080128.pdf) by Daniel J. Bernstein.
- [The Poly1305-AES message-authentication code](http://cr.yp.to/mac/poly1305-20050329.pdf) by Daniel J. Bernstein.
- [ChaCha20 and Poly1305 for IETF Protocols](https://tools.ietf.org/html/rfc8439) RFC.
- [Salsa20](https://cr.yp.to/snuffle.html), also known as Snuffle 2005, uses the [Salsa20 core](https://cr.yp.to/salsa20.html) to encrypt data.
- [XSalsa20](https://cr.yp.to/snuffle/xsalsa-20110204.pdf), an extended-nonce Salsa20 variant used in [NaCl](https://nacl.cr.yp.to).
- [XChaCha20-Poly1305](https://tools.ietf.org/html/draft-arciszewski-xchacha-02), an extended-nonce ChaCha20-Poly1305 IETF variant.