README
¶
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 | - | - | - |
XMSS signing state
An XMSS one-time signature index must never be used to sign different messages with the same private key. Persist the signing index and coordinate its use across every process or object holding that key.
Copying an XmssFast object, including copy assignment, duplicates its private
key and current index. The objects advance independently. Never sign different
messages at the same index through an original and its copy. Prefer moving the
object when transferring signing ownership. Restoring the same seed into another
signer also requires coordinating the index; it does not create a new key.
Best practice is to keep signature consumption under user control, with the calling application maintaining an independent, persistent record of consumed OTS indices for each private key. Use that record to coordinate signing across all instances and processes, including after restoring a seed. Do not rely solely on a signer object's internal index to determine which signatures have already been consumed.
The user or calling application controls when an index is marked as consumed. For example, an application may reserve and mark an index as consumed as soon as the user presses "sign", before attempting to sign, regardless of whether signing succeeds or fails.
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 gcc@13
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:
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.
Directories