aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJ08nY2024-12-01 13:56:04 +0100
committerJ08nY2024-12-01 13:56:04 +0100
commit23c460dff96f57a4fa480ab6426700b0be384f12 (patch)
tree81a61274f2279556eb09547190e2baa41d0b89f1 /README.md
parent2e3b816158447a963af903afe5259f3d82097aa3 (diff)
downloadecgen-23c460dff96f57a4fa480ab6426700b0be384f12.tar.gz
ecgen-23c460dff96f57a4fa480ab6426700b0be384f12.tar.zst
ecgen-23c460dff96f57a4fa480ab6426700b0be384f12.zip
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index eeeab77..f4f1e8a 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,7 @@ Tool for generating Elliptic curve domain parameters.
- `-s / --ansi[=SEED]` Generate a curve from `SEED` (ANSI X9.62 verifiable procedure).
- `-b / --brainpool[=SEED]`Generate a curve using the Brainpool verifiably pseudorandom algorithm from the original paper.
- `--brainpool-rfc[=SEED]` Generate a curve using the Brainpool verifiably pseudorandom algorithm as per RFC 5639.
+ - `-F / --family=FAMILY` Generate a pairing friendly curve from a curve family (e.g. "BN", "BLS12", "BLS24").
- `--nums` Generate a curve using the NUMS procedure (as per draft-black-numscurves-02).
- `--twist` Generate a twist of a given curve.
@@ -203,7 +204,7 @@ for Doxygen.
### Generation methods
-Four different EC curve parameters generation methods are implemented.
+Five different EC curve parameters generation methods are implemented.
[Efficient Algorithms for Generating Elliptic Curves over Finite Fields Suitable for Use in Cryptography - [Baier]](https://www.cdc.informatik.tu-darmstadt.de/reports/reports/harald_baier.diss.pdf)
@@ -258,6 +259,11 @@ Four different EC curve parameters generation methods are implemented.
- [Elliptic curves over F_p suitable for cryptosystems - [Miyaji]](https://dspace.jaist.ac.jp/dspace/bitstream/10119/4464/1/73-61.pdf)
- TODO: Extend with [Generating Anomalous Elliptic Curves - [Leprevost, Monnerat, Varrette, Vaydenay]](https://www.monnerat.info/publications/anomalous.pdf)
+#### Curve families
+
+ - Generates pairing friendly curves.
+ - Used with the `-F / --family` option. Select from BN, BLS12 or BLS24 currently.
+
### Build
ecgen can be built using Make or CMake. ecgen uses git submodules for testing at: