CSSUDII/CSSUDII.Sodium
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README

Browse Source
This commit is contained in:
Lucas Petrino
2025-03-18 12:54:14 +13:00
parent 93108d7032
commit 4b78d0619b
14 changed files with 2 additions and 3304 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -1,14 +1,3 @@
# SpaceWizards.Sodium [![Nuget](https://img.shields.io/nuget/v/SpaceWizards.Sodium)](https://www.nuget.org/packages/SpaceWizards.Sodium/)
# CSSUDII.Sodium
A .NET [libsodium](https://libsodium.gitbook.io/doc/) binding that doesn't suck. Actually exposes the native API so you don't have to cry yourself to sleep in unnecessary allocations or OOP nonsense.
Currently depends on the ["libsodium" NuGet package](https://www.nuget.org/packages/libsodium/) provided by [Sodium.Core](https://github.com/ektrah/libsodium-core) for the native library. They say you shouldn't depend on it directly but I am too lazy to compile them myself so deal with it.
# API Shape
There is a low-level API in `SpaceWizards.Sodium.Interop`. This is a raw P/Invoke binding, hope you like pointers.
The high-level API in `SpaceWizards.Sodium` generally has two variants: span with return code, or `byte[]` with exceptions. Note that the former still throws exceptions if you pass spans that are too small, but otherwise failing return codes from libsodium are passed through so you can handle them. This is just what I decided to settle on to keep API size down.
Also, if it wasn't obvious, the only API wrapped is the ones I needed at the moment. PRs welcome I guess.
.NET 8 [libsodium](https://libsodium.gitbook.io/doc/) bindings.