Clarify RPC auth & add basic usage info

This commit is contained in:
2025-05-03 20:25:19 -04:00
parent f4be53f615
commit 6c328ba772
+6 -2
View File
@@ -3,8 +3,9 @@ RCW is a cascading symmetric cryptography agent meant to be embedded within Go p
It encrypts all data with both AES256-GCM and ChaCha20-Poly1305.
Passphrases are securely cached for three minutes and RPC binary authentication is used to
ensure that only the binary responsible for caching the passphrase can retrieve it.
Passphrases are securely cached for three minutes and RPC authentication is used to
ensure that only the binary+user responsible for caching the passphrase can retrieve it.
This feature is supported on Linux, FreeBSD, MacOS, and Windows.
RCW also features a sanity check to ensure no data loss occurs due to a user entering the
incorrect passphrase during encryption.
@@ -16,3 +17,6 @@ Future versions may not be capable of decrypting the output of the current versi
>It is your responsibility to assess the security and stability of RCW and to ensure it meets your needs before using it.
>I am not responsible for any data loss or breaches of your information resulting from the use of RCW.
>RCW is a new project that is constantly being updated, and though safety and security are priorities, they cannot be guaranteed.
# Usage
For now, please reference [example.go](https://github.com/rwinkhart/randalls-cryptographic-wrappers/blob/main/example.go).