saymrwulf/curve25519-dalek-source
1
0
Fork 0
mirror of https://github.com/saymrwulf/curve25519-dalek-source.git synced 2026-09-04 20:24:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add note on FFI to README.md

Browse source 
Closes #182.
This commit is contained in:
Henry de Valence 2018-08-03 11:00:29 -07:00
parent 839358aae6
commit 47d85103d3
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -147,6 +147,22 @@ cargo bench --no-default-features --features "std avx2_backend"
Performance is a secondary goal behind correctness, safety, and Performance is a secondary goal behind correctness, safety, and
clarity, but we aim to be competitive with other implementations. clarity, but we aim to be competitive with other implementations.
# FFI
Unfortunately, we have no plans to add FFI to `curve25519-dalek` directly. The
reason is that we use Rust features to provide an API that maintains safety
invariants, which are not possible to maintain across an FFI boundary. For
instance, as described in the _Safety_ section above, invalid points are
impossible to construct, and this would not be the case if we exposed point
operations over FFI.
However, `curve25519-dalek` is designed as a *mid-level* API, aimed at
implementing other, higher-level primitives. Instead of providing FFI at the
mid-level, our suggestion is to implement the higher-level primitive (a
signature, PAKE, ZKP, etc) in Rust, using `curve25519-dalek` as a dependency,
and have that crate provide a minimal, byte-buffer-oriented FFI specific to
that primitive.
# Contributing # Contributing
Please see [CONTRIBUTING.md][contributing]. Please see [CONTRIBUTING.md][contributing].