Skip to content

Commit 70b7986

Browse files
committed
Add README note about key validity assertions at the FFI boundary
1 parent 937d1d8 commit 70b7986

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

lightning-c-bindings/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,9 @@ These include:
218218
...
219219
} LDKChannelKeys;
220220
```
221+
* Private and public keys are asserted valid at the FFI boundary. Thus, before passing any
222+
(untrusted) private or public key material across the boundary, ensure that they represent valid
223+
(ie in-range) keys.
221224
222225
**It is highly recommended that you test any code which relies on the C (or C++) bindings in
223226
valgrind, AddressSanitizer, MemorySanitizer, or other similar tools to ensure correctness.**

0 commit comments

Comments
 (0)