diff options
author | vnugent <public@vaughnnugent.com> | 2024-04-23 14:48:05 -0400 |
---|---|---|
committer | vnugent <public@vaughnnugent.com> | 2024-04-23 14:48:05 -0400 |
commit | 30e8dda6cbea86bdee6d5dfe48514385d3b9f81b (patch) | |
tree | 49a4e59a5e0bdf867e31168852d7299c6bb7c783 /README.md | |
parent | d09c6c1bd5da3e2d79351daeba304ca99976a726 (diff) |
refactor: Crypto dep redesign working on Windows
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 24 |
1 files changed, 11 insertions, 13 deletions
@@ -1,4 +1,4 @@ -# noscrypt +# noscrypt *A compact, C90 cross-platform, cryptography library built specifically for nostr* ## What is noscrypt? @@ -36,18 +36,16 @@ Testing is an will be important to a cryptography library, I take that responsib - Schnorr signatures are validated before the signing function returns - Carefully selected, widley used, tested, and audited dependencies -### Dependency choices -I carefully chose [mbedTls](https://github.com/Mbed-TLS/mbedtls) and [libsecp256k1](https://github.com/bitcoin-core/secp256k1) for the following reasons -- Modern, well tested and well trusted -- Fully open source and actively maintained -- Absolutely no runtime memory allocations -- Built for use in embedded applications -- Simple installations -- Great cross-platform build support - -### Future Goals -- Good support for embedded platforms that wish to implement nostr specific features (would be fun!) -- Over all better testing suite + +## Platform Support +| Arch | Support | Notes | Tested | +| ----- | ---------- | ------- | ------- | +| Windows | OpenSSL, Mbed-TLS, BCrypt | NT 6.1 + | ✅ | +| Linux | OpenSSL, Mbed-TLS | GCC only | ✅ | +| FreeBSD | OpenSSL, Mbed-TLS | GCC Only | | + +### Configuring libraries +Noscrypt now supports linking to multiple cryptographic libraries and expanded platform support. At built-time you may choose ## Packages and Docs GitHub is simply a mirror for my projects. Extended documentation, pre-compiled binaries and source code bundles are always available on my website, along with PGP signatures and checksums. |