Skip to content

Commit

Permalink
Merge pull request #91 from tomato42/doc-seeds
Browse files Browse the repository at this point in the history
mark the `ML_KEM.key_derive()` method as public and stable API
  • Loading branch information
GiacomoPope authored Jan 10, 2025
2 parents b8abab1 + 00468a7 commit 7b1c1b2
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,12 @@ To install dependencies, run `pip -r install requirements`.

### ML-KEM

There are three functions exposed on the `ML_KEM` class which are intended for
There are four functions exposed on the `ML_KEM` class which are intended for
use:

- `ML_KEM.keygen()`: generate a keypair `(ek, dk)`
- `ML_KEM.key_derive(seed)`: generate a keypair `(ek, dk)` from the provided
seed
- `ML_KEM.encaps(ek)`: generate a key and ciphertext pair `(key, ct)`
- `ML_KEM.decaps(dk, ct)`: generate the shared key `key`

Expand Down

0 comments on commit 7b1c1b2

Please sign in to comment.