From 8b8a97c6aabe157543f30d4d913283c0f5b6b02f Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Mon, 14 Sep 2020 11:33:59 -0400 Subject: [PATCH] Add README note about key validity assertions at the FFI boundary --- lightning-c-bindings/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lightning-c-bindings/README.md b/lightning-c-bindings/README.md index 72426bdf3..0c221c7c6 100644 --- a/lightning-c-bindings/README.md +++ b/lightning-c-bindings/README.md @@ -218,6 +218,9 @@ These include: ... } LDKChannelKeys; ``` + * Private and public keys are asserted valid at the FFI boundary. Thus, before passing any + (untrusted) private or public key material across the boundary, ensure that they represent valid + (ie in-range) keys. **It is highly recommended that you test any code which relies on the C (or C++) bindings in valgrind, AddressSanitizer, MemorySanitizer, or other similar tools to ensure correctness.** -- 2.39.5