# miracl_core

**Repository Path**: daimaxiaozi/miracl_core

## Basic Information

- **Project Name**: miracl_core
- **Description**: fork from https://github.com/miracl/core.git
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2021-03-24
- **Last Updated**: 2025-03-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# The MIRACL Core Cryptographic Library

[![Build Status](https://travis-ci.org/miracl/core.svg?branch=master)](https://travis-ci.org/miracl/core)

The original contribution to the Apache Milagro Cryptographic Library (AMCL)
has now been extended and is being re-released as MIRACL Core.


MIRACL Core is a multi-lingual and architecturally agnostic Cryptographic
library that supports elliptic curve cryptography, pairing-friendly curve
cryptography, RSA, AES symmetric encryption and hash functions. All code
is entirely in the supported high-level languages. No assembly language
and no third party code is required - these libraries are completely self-
contained. MIRACL Core was designed from the ground up with side-channel
attack resistance in mind. Multiple curves can be supported in a single
application. Read the PDF manual for more details.

MIRACL Core is currently available in the C, C++, Go, Rust, Python, Java, 
Javascript and Swift programming languages. Via code translators it
can be easily translated to other languages (like wasm and C#). It is
particularly suitable for smaller devices, and those supported by the 
Arduino infrastructure.

MIRACL Core features several improvements over AMCL. 

MIRACL Core features:-

- NEW easy to use and flexible Threshold Secret Sharing module added (see share.c, share.cpp, SHARE.java etc.) 
- NEW example program to track test vectors from https://datatracker.ietf.org/doc/draft-irtf-cfrg-hash-to-curve/
- NEW curves (SM2, BN462, BLS48581, C13318, JUBJUB, X448, SECP160R1, C1174, BLS48286, TWEEDLEDUM, TWEEDLEDEE)
- Support for precomputation for pairings (see BLS API)
- Performance and security improvements
- New HMAC message authentication module (KDFs, HMAC, HKDF_Extract/Expand, XOF_Expand, XMD_Expand)
- Improved side-channel resistance
- Deterministic hashing to curve points map2point (Elligator, SVDW, SSWU)
- Point compression in G2
- Demonstrated support for low-powered IoT processor nodes (ARM Cortex-M0/M4, MIPS32, RISC-V, ESP32)
- Emerging-standards-compliant implementation of BLS signature
- Emerging-standards-compliant implementation of HPKE (Hybrid Public Key Encryption) 
- Emerging-standards-compliant implementation of deterministic Hash-To-Curve
- An updated manual

Read the user manual MIRACL_Core.pdf for more details

Doxygen generated documentation for the C version of the library can be
created by simply executing doxygen inside of the C directory. A Doxygen 
generated manual refman.pdf can also be found there. The C++ code is 
probably the best commented.

Install Python 3 and suitable compilers for each language of interest to you.
Python 3 scripts are used to build the libraries from the command line for
each of the supported languages. If using windows, set a command alias via

    DOSKEY python3 = py $*

For a quick start, try out the Python version of the library, and run its
example program.

-------------------------------------------

# Contributors

The following people have contributed to the MIRACL Core library

- Mike Scott
- Kealan McCusker
- Alessandro Budroni
- Samuele Andreoli