| commit | da65978227059fdb4bfd47d58640b1af0468211c | [log] [tgz] |
|---|---|---|
| author | Kealan McCusker <kealanmccusker@gmail.com> | Wed Sep 25 10:53:17 2019 +0100 |
| committer | Kealan McCusker <kealanmccusker@gmail.com> | Wed Sep 25 10:53:17 2019 +0100 |
| tree | e65eb9630596a808a5375ccebc9b4671fbdc724b | |
| parent | a61d0f63beba7764e681baff205b9f6b5fe09371 [diff] |
update README
MCJS - Milagro Crypto JavaScript
MCJS is a standards compliant JavaScript cryptographic library with no external dependencies except for the random seed source.
MCJS supports the standards for RSA, ECDH, ECIES, ECDSA and M-PIN, AES-GCM encryption/decryption, SHA256, SHA384, SHA512 and SHA3 hash functions and a cryptographically secure random number generator. Furthermore we recently added New Hope, a post-quantum key exchange.
MCJS is Node.js compatible and browser compatible (see some examples below).
Node.js (maximum v8.0.0) and npm are required in order to build the library and run the tests. Install also the node.js modules required with the command
npm install
Run all the tests with the following command
npm test
To create the image execute;
docker build -t mcjs:builder .
To run the tests;
docker run --rm mcjs:builder
Suppose you want to implement ECDH with NIST256 elliptic curve. First you need to initialize the context:
var CTX = require("milagro-crypto-js");
var ctx = new CTX("NIST256");
then you can call the functions as follows:
ctx.ECDH.KEY_PAIR_GENERATE(...); ctx.ECDH.ECPSVDP_DH(...);
If you need to use more than one elliptic curve in the same script you only need to initialize two different contexts, for example
var ctx1 = new CTX("NIST256");
var ctx2 = new CTX("C25519");
The following is the list of all elliptic curves supported by MCJS
['ED25519', 'C25519', 'SECP256K1', 'NIST256', 'NIST384', 'BRAINPOOL', 'ANSSI', 'HIFIVE', 'GOLDILOCKS', 'C41417', 'NIST521', 'NUMS256W', 'NUMS256E', 'NUMS384W', 'NUMS384E', 'NUMS512W', 'NUMS512E', 'FP256BN', 'FP512BN', 'BN254', 'BN254CX', 'BLS383', 'BLS24', 'BLS48', 'BLS381', 'BLS461'];
This library supports also RSA encryption/decryption and RSA signature. The following is a quick example on how to use RSA. First initialize the context
var CTX = require("milagro-crypto-js");
var ctx = new CTX("RSA2048");
then you can call the RSA functions as follows:
ctx.RSA.ENCRYPT(...); ctx.RSA.DECRYPT(...);
The following is the list of all the RSA security level supported by MCJS
['RSA2048','RSA3072','RSA4096'];
MCJS supports SHA256, SHA384, SHA512, AES-GCM encryption and Marsaglia & Zaman random number generator. Those functions are contained in every context initialized with RSA or with an elliptic curve. If you want to create a context supporting only those general functions then initialize it with no parameter as follows:
var CTX = require("milagro-crypto-js");
var ctx = new CTX();
Node.js examples are provided - please see ./examples/node. Use the following command to run an example
node ./examples/node/example_ECC_NIST256.js
The library source code is browser compatible. The browser examples are located in ./examples/browser.
The tests can be run using Docker:
docker build -t mcjs:builder . docker run --rm mcjs:builder
The following people have contributed to milagro-crypto-js
Please add yourself here if you make or have made a contribution.
This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.
The Apache Software Foundation has classified this software as Export Commodity Control Number (ECCN) 5D002, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the “publicly available” Section 742.15(b) exemption (see the BIS Export Administration Regulations, Section 742.15(b)) for both object code and source code.
Apache Milagro is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.