https://github.com/hyperledger-archives/ursa
Hyperledger Ursa (a shared cryptographic library) has moved to end-of-life status, with the components of Ursa still in use moved to their relevant Hyperledger projects (AnonCreds, Indy, Aries and Iroha).
https://github.com/hyperledger-archives/ursa
Last synced: 8 months ago
JSON representation
Hyperledger Ursa (a shared cryptographic library) has moved to end-of-life status, with the components of Ursa still in use moved to their relevant Hyperledger projects (AnonCreds, Indy, Aries and Iroha).
- Host: GitHub
- URL: https://github.com/hyperledger-archives/ursa
- Owner: hyperledger-archives
- License: apache-2.0
- Archived: true
- Created: 2018-11-19T22:03:24.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-01-24T20:45:39.000Z (over 2 years ago)
- Last Synced: 2024-11-08T06:11:48.739Z (over 1 year ago)
- Language: Rust
- Homepage: https://wiki.hyperledger.org/display/ursa
- Size: 4.77 MB
- Stars: 323
- Watchers: 43
- Forks: 142
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# HYPERLEDGER URSA
[Hyperledger Ursa was moved to EOL at the TOC meeting on 27 APR 2023.](https://toc.hyperledger.org/meeting-minutes/2023/2023-04-27-TOC-meeting-record.html)
The components of Ursa that are still in active use are moved to their respective projects where they will continue to be maintained, including:
- CL Signatures to AnonCreds
- BBS+ Signatures to Aries
- BLS Signatures to Indy
The published Ursa crates remain available for those projects already using them.
- [Introduction](#introduction)
- [Features](#features)
- [Libursa](#Libursa)
- [Libzmix](#libzmix)
- [Dependencies](#dependencies)
- [Building from source](#building-from-source)
- [Contributing](#contributing)
# Introduction
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.
# Features
The major artifacts of Ursa are:
- C-callable library interface
- Rust crate
Ursa is divided into two sub libraries: libursa and libzmix.
## Libursa
Designed for cryptographic primitives like simple digital signatures, encryption
schemes, and key exchange.
### Supported Signatures
- ECDSA
- Secp256k1
- EdDSA
- Ed25519 (Curve25519 in Twisted Edwards Form)
- Boneh Lynn Shacham (BLS) Signature
- Any Pairing friendly curves
- Camenisch Lysyanskaya
- RSA based
- Shamir Secret Sharing
### Supported Key Agreement
- ECDH
- Secp256k1
- X25519 (Curve25519 in Montgomery Form)
### Symmetric Encryption
- AES-CBC
- AES-GCM
- XCHACHA20-POLY1305
## Libzmix
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.
### Supported Zero Knowledge Proof capabilities
- Signature Proofs of Knowledge
- Bulletproofs
- Range proofs
- Set Membership
### Supported Signatures
- Boneh Boyen Shacham (BBS+)
- Any Pairing friendly curves
- Pointcheval Saunders
- Any pairing friendly curves
- Groth
- Any Pairing friendly curves
# Dependencies
Ursa uses the following external dependencies:
- [openssl 1.1.0j or greater](https://www.openssl.org/source/openssl-1.1.0j.tar.gz) (Written in C)
- [libsecp256k1](https://github.com/bitcoin-core/secp256k1) (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.
# Building from Source
Please see the following document for platform-specific installations [here](docs/build-environment.md).
## Libursa
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:
```bash
cargo build --release
```
Run the following commands to build in portable mode:
```bash
cargo build --release --no-default-features --features=portable
```
If you wish to take advantage of assembly level features, you can build
Ursa using the nightly compiler of rust.
```bash
cargo build --release --no-default-features --features=asm
```
The 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)
## Packaging
Libursa can be packaged for debian builds using [cargo-deb](https://github.com/mmstick/cargo-deb).
To create a debian package, run the following command with cargo-deb installed
`cargo deb -p ursa`
### Libursa Documentation
Libursa API documentation is now available as rust doc in code. See:
* C API
- [BLS](./libursa/src/ffi/bls.rs)
- [CL](./libursa/src/ffi/cl/)
* Rust API
- [BLS](./libursa/src/bls/mod.rs)
- [CL](./libursa/src/cl)
## Libzmix
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:
```bash
cargo build --release
```
Run the following commands to build in portable mode:
```bash
cargo build --release --no-default-features --features=portable
```
If you wish to take advantage of assembly level features, you can build
ZMix using the nightly compiler of rust.
```bash
cargo build --release --no-default-features --features=asm
```
The 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)
# Contributing
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](https://chat.hyperledger.org) 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](https://wiki.hyperledger.org/display/ursa/Meeting+Agendas+and+Notes).
Major modifications to ursa are submitted as RFCs to the [Ursa RFC
repo](https://github.com/hyperledger/ursa-rfcs).
For more details on contributing see [CONTRIBUTING](CONTRIBUTING.md)