Ursa was created because people in the Hyperledger community realized that it would save time and effort and improve security if we all collaborated on our cryptographic code. Since cryptographic APIs are relatively straightforward to define, it would be possible for many different projects to utilize the same code without too much difficulty.
First and foremost, we hope in the long run that Ursa provides open-source blockchain developers with reliable, secure, easy-to-use, and pluggable cryptographic implementations.
The major artifacts of Ursa are:
- C-callable library interface
- Rust crate
Ursa is divided into two sub libraries: libursa and libzmix.
Designed for cryptographic primitives like simple digital signatures, encryption schemes, and key exchange.
A generic way to create zero-knowledge proofs, proving statements about multiple cryptographic building blocks, containing signatures, commitments, and verifiable encryption. Libzmix uses many of the building blocks found in Libursa.
Ursa and zmix use the following external dependencies:
- libsodium 1.0.16 (Written in C)
- openssl 1.1.0j or newer (Written in C)
- libsecp256k1 (Written in C)
These dependencies are used when building in the default secure mode. These libraries are widely known. There is a goal to be able to compile Ursa from rust only code for portability reasons like generating web assemblies without the worry of compatibility issues from C code. For this reason, Ursa can be compiled with portable mode which replaces any external libraries with rust compatible code. Ursa developers take care when choosing suitable replacements that are cryptographically safe to use but may not have been audited and vetted in a similar manner to these external libraries. Ursa consumers should note this when using portable mode for their applications.
Libursa and Libzmix rely on libsodium for the default secure mode. Please see the following document for specific platform installations here.
Libursa uses the rustc compiler with cargo. Go into the libursa folder where the Cargo.toml lives. Run the following commands to get the default secure mode:
cargo build --releaseRun the following commands to build in portable mode:
cargo build --release --no-default-features --features=portableThe resulting artifact(s) can be found in the target/release folder. They include:
libursa.so (Linux)
libursa.dylib (Mac OS X)
libursa.a (Linux, Mac OS X)
libursa.dll (Windows)
libursa.lib (Windows)
Libursa can be packaged for debian builds using cargo-deb. To create a debian package, run the following command with cargo-deb installed
cargo deb -p ursa
Libursa API documentation is now available as rust doc in code. See:
Libzmix uses the rustc compiler with cargo. Go into the libzmix folder where the Cargo.toml lives. Run the following commands to get the default secure mode:
cargo build --releaseRun the following commands to build in portable mode:
cargo build --release --no-default-features --features=portableThe resulting artifact(s) can be found in the target/release folder. They include:
libzmix.so (Linux)
libzmix.dylib (Mac OS X)
libzmix.a (Linux, Mac OS X)
libzmix.dll (Windows)
libzmix.lib (Windows)
All bugs, stories, and backlog for this project are managed through Hyperledger's Jira in project IS (note that regular Ursa tickets are in the URSA project).
Also, join us on Hyperledger Rocket.Chat at #ursa to discuss.
The ursa group also meets biweekly on Wednesday's at 7 AM PST at https://zoom.us/my/hyperledger.community. The meeting notes are available here.
Major modifications to ursa are submitted as RFCs to the Ursa RFC repo.
For more details on contributing see the Community section of the Ursa project docs:
Install sphinx:
pip3 install -U Sphinx
Build the project docs:
cd docs/
make html