theqrl / qrllib Goto Github PK

View Code? Open in Web Editor NEW

44.0 12.0 27.0 1.29 MB

QRL core library

License: MIT License

CMake 3.63% C++ 25.92% Python 19.09% Shell 0.47% C 10.59% Go 4.84% SWIG 0.78% Starlark 0.36% Rust 34.32%

xmss qrl

qrllib's Introduction

QRL Core Library

WARNING: This is work in progress, changes might not be backward compatible.

This library currently exposes the following functionality:

XMSS, XMSS_fast
Shake128, Shake256, SHA2_256
Hashchain seeds, etc.
Helpers: seed generation, address generation, mnemonics

Platform support

	Linux	OSX 10.12	Windows 10
Python 3	✅	✅	🌱
Webassembly (JS)	✅	✅	✅
Golang	🌱	-	-
Java	-	-	-

Installing

Ubuntu

sudo apt -y install swig3.0 python3-dev build-essential cmake ninja-build pkg-config
pip3 install pyqrllib

OSX

If you dont have brew yet, we think you should :) Install brew following the instructions here: https://brew.sh/

Now install some dependencies

brew install cmake python3 swig
pip3 install pyqrllib

Windows

TBD

Raspbian

sudo apt -y install swig3.0 python3-dev build-essential cmake ninja-build
sudo pip3 install -U setuptools
sudo pip3 install -U pyqrllib

Miscellaneous

Golang and Java wrappers are currently experimental (By default they are disabled in cmake)

brew install go --cross-compile-common

Development

Emscripten

In order to compile the webassembly and run node.js tests you first need to install CircleCI CLI:

https://circleci.com/docs/2.0/local-cli/#installing-the-circleci-local-cli-on-macos-and-linux-distros

Then run the following command

circleci build --job build_emscripten

This will compile and test the webassembly. Output files will be copied over to tests/js/tmp

You can then run node.js locally using npm.

License

This library is distributed under the MIT software license, see the accompanying file LICENSE or http://www.opensource.org/licenses/mit-license.php.

Some of the code is based on the xmss-reference implementation that has been released in the public domain by their respective authors.

Most of third party code has been included as git submodules for future reference.

qrllib's People

Contributors

Stargazers

Watchers

qrllib's Issues

Change Travis configuration to deploy packages to testpypi

To avoid problematic releases, we need to use testpypi and have an staging period before making public releases.

Unify address validation

Improve validation in the node and ensure other components have access to the same validation.
Ideally move down to QRL Helper
Opening the same issue in qrllib

QRL: theQRL/QRL#935

xmss-alt function names

Some function names in the xmss-alt code can be confusing. An example is core_hash_SHA2 where the implementation at the moment is using shake128/shake256 instead of SHA2

Align with recent changes in reference code

Windows native support

The library is currently not supported in Windows. The xmss reference code requires access to /dev/urandom plus there are some incompatibilities with Microsoft compiler.

For the moment, only the webassembly is supported. We are currently working on improving the code base to support a native Windows version.

Improve SWIG exception handling(use %exception)

Improve the way exception handling is done with SWIG. The following link provides more information:
http://www.swig.org/Doc3.0/SWIGDocumentation.html#Customization_exception

Descriptor SignatureType will always return 0

Descriptor signature type will always return 0 no matters, whatever the value of the signature type is.
https://github.com/theQRL/qrllib/blob/master/src/qrl/qrlDescriptor.h#L68

The code in that line should be following
auto signatureType = static_cast<eSignatureType>((bytes[0] >> 4) & 0x0F);

This issue is not critical as we are using XMSS which has signature type 0.

Write mocha tests for webassembly

webassembly exceptions

Exceptions thrown in C++ are received as numbers in javascript

This issue describes a similar situation:
emscripten-core/emscripten#6330

We need some way of exposing the reason of the exception to javascript

Expose function in jswrapper to get address from public key

Currently there is no way to get a Q address from the public key in the js api wrapper. This is required for ledger integration.

Unnecessary parameters for Dilithium sign_open

Dilithium crypto_sign_open expected to return only message but consumes size equivalent to message length and signature length. Thus extract_signature is not possible. sign_open must only be used as a bool to verify the signature and the extract_message and extract_signature must be used on the signature_message returned by sign function, instead of sign_open.

Move to CircleCI

cmake

There is an issue with cmake, which causes builds to fail where newer versions of cmake are installed.

   /usr/local/Cellar/cmake/3.12.4/bin/cmake -E copy_if_different /private/var/folders/qw/clgh44rs0sq31x0v5srt0h6c0000gn/T/pip-install-9yy1mrqo/pyqrllib/pyqrllib/dilithium.py
    CMake Error: cmake version 3.12.4

This causes specific issues on OSX (which can be fixed with https://gist.github.com/jplomas/dcda0958ae5c0249913e513b967e4299 after following our documented instructions).

Incorrect value by Dilithium extract_message & extract_signature

extract_message & extract_signature functions doesn't work as expected and returns incorrect value.

extract_message should be replaced to

std::vector<uint8_t> Dilithium::extract_message(std::vector<uint8_t> &message_output)
{
    return std::vector<uint8_t>(message_output.begin() + CRYPTO_BYTES, message_output.end());
}

extract_signature should be replaced to

std::vector<uint8_t> Dilithium::extract_signature(std::vector<uint8_t> &message_output)
{
    return std::vector<uint8_t>(message_output.begin(), message_output.begin() + CRYPTO_BYTES);
}