miracl

README

Description

Namespaces are used to separate different curves.

So for example to support both ED25519 and the NIST P256 curves, one could import into a particular module both "miracl/core/ed25519" and "miracl/core/nist256"

Separate ROM files provide the constants required for each curve. Some files (BIG.go, FP.go, ECP.go) also specify certain constants that must be set for the particular curve.

TODO:

• Finish tests
  • Add 32-bit specific code from generated content with 32 bit build flags
  • Possibly add anti-32-bit build flags to 64 bit files?
  • GOOS=linux GOARCH=386 go test -v -bench=. ./...
• Include 32-bit files

Installation and Testing

Note: The MIRACL library for Go must be downloaded from the github repository and configured locally before use. Therefore it cannot simply be specified as a requirement and fetched directly from its github repository into a project.

Assumes version 1.16+ of Go

Create a directory in any suitable location

mkdir miracl
cd miracl
go mod init miracl

Copy in all files from the go/ directory of the MIRACL core repository.

To build the library and see it in action, execute the python3 script config32.py or config64.py (depending on whether you want a 32 or 64-bit build), and select the curves that you wish to support.

---

To create a 64-bit library

python3 config64.py

Then select options 1, 3, 7, 28, 30, 37, 38 and 41 (these are fixed for the example program provided). Select 0 to exit.

Run the ECC test program by executing

go run TestECC.go

Run the MPIN test program by executing

go run TestMPIN.go

The correct PIN is 1234

Run another test program by executing

go run TestBLS.go

Next run the Benchmark program by executing

go run BenchtestALL.go

Finally

go run TestNHS.go

---

Alternatively building and testing can be combined via

python3 configXX.py test

where XX can be 32 or 64

Note that this builds the library for ALL of the options. Executables of the above test programs are created, and can be "go run" immediately.

---

NEW: support for emerging Hash To Curve standard. See https://datatracker.ietf.org/doc/draft-irtf-cfrg-hash-to-curve/

Create 32 or 64-bit library selecting curves 1, 2, 3, 7, 17 and 31 (ED25519, C25519, NIST256, GOLDILOCKS, SECP256K1 and BLS12381)

go run TestHTP.go

Test program runs through test vectors from the draft standard.

---

NEW: Experimental support for emerging HPKE (Hybrid Public Key Encryption) standard. See https://datatracker.ietf.org/doc/draft-irtf-cfrg-hpke/

New HPKE.go api file

• Supports KEM_IDs for X25519, X448, P256 and P521
• Supports HDF_IDs for SHA256/512
• Supports AEAD_IDs for AES-GCM-128/256 only

Create 32 or 64-bit library selecting curves 2 and 10 (C25519 and P521)

go run TestHPKE.go

Test program runs through test vectors for all modes 0-3.

Documentation

Overview

}

	mpin_BN254(rng)
	mpin_BLS12383(rng)
	mpin_BLS24479(rng)
	mpin_BLS48556(rng)
}