fips203-ffi
| Crates.io | fips203-ffi |
| lib.rs | fips203-ffi |
| version | |
| source | src |
| created_at | 2024-05-25 18:05:48.275944+00 |
| updated_at | 2025-02-25 23:04:43.203601+00 |
| description | C shared library exposing FIPS 203: Module-Lattice-Based Key-Encapsulation Mechanism |
| homepage | |
| repository | https://github.com/integritychain/fips203 |
| max_upload_size | |
| id | 1252110 |
| Cargo.toml error: | TOML parse error at line 19, column 1 | 19 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
(integritychain)
documentation
https://docs.rs/fips203
README
C Shared Object for ML-KEM
This crate provides a shared object (dynamically-linked library) using standard C FFI ABI that provides a functional implementation of ML-KEM.
The goals of this implementation are:
- simplicity
- correctness
- caller deals only with serialized objects
- no library-specific memory management (caller manages all objects)
- no internal state held by the library between calls
- minimal symbol visibility
- stable API/ABI
security-related goals:
- constant-time operations
- clean library RAM (objects should be zeroed out of any library-allocated memory before function exit)
non-goals are:
- speed
- efficiency
- size
Outstanding work
- better internal error handling
- testing!
- reduce symbol visibility in shared object
Paths considered but discarded
-
Autogenerate stable C headers (e.g. with cbindgen); manually-crafted headers are probably fine, given the simplicity of the API/ABI
Quick start
$ cd ffi # this directory
$ cargo build
$ (cd tests && make)
$ cd python
$ python3
>>> from fips203 import ML_KEM_512
>>>
>>> (encapsulation_key, decapsulation_key) = ML_KEM_512.keygen()
>>> (ciphertext, shared_secret_1) = encapsulation_key.encaps()
>>> shared_secret_2 = decapsulation_key.decaps(ciphertext)
>>> assert(shared_secret_1 == shared_secret_2)