hyperledger/indy-crypto

Name: indy-crypto

Owner: Hyperledger

Description: null

Created: 2017-08-31 16:59:14.0

Updated: 2018-05-15 09:03:21.0

Pushed: 2018-05-17 18:33:53.0

Homepage: null

Size: 2356

Language: Rust

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Before you Continue

If you haven't done so already, please visit the main resource for all things “Indy” to get acquainted with the code base, helpful resources, and up-to-date information: Hyperledger Wiki-Indy.

Indy Crypto

This is the shared crypto libirary for Hyperledger Indy components.

Hyperledger Indy provides a distributed-ledger-based foundation for self-sovereign identity.

The major artifacts of the Indy Crypto are:

• ?-callable library interface
• Rust ?rate
• Python wrapper

All bugs, stories, and backlog for this project are managed through Hyperledger's Jira in project IS (note that regular Indy tickets are in the INDY project instead…). Also, join us on Jira's Rocket.Chat at #indy-sdk to discuss.

Building Indy Crypto

1. Install Rust and rustup (https://www.rust-lang.org/install.html).

2. Checkout and build the library:

   clone https://github.com/hyperledger/indy-crypto.git
   /indy-crypto/libindy-crypto
   o build
   .
   

3. Run tests

   ibindy-crypto
   o test
   

   Note: By default cargo build produce debug artifacts with a large amount of run-time checks. It's good for development, but this build can be in 100+ times slower for some math calculation. If you would like to analyse CPU performance of libindy-crypto for your use case, you have to use release artifacts (cargo build --release).

Windows build dependency

System OpenSSL library is required.

• Download the prebuilt dependencies here
• Extract them into the folder C:\BIN\x64

  It really doesn't matter where you put these as long as you remember where so you can set the environment variables to this path

• Point path to this directory using environment variables:
• set INDY_CRYPTO_PREBUILT_DEPS_DIR=C:\BIN\x64
• set OPENSSL_DIR=C:\BIN\x64

API Documentation

API documentation is now available as rust doc in code. See:

• C API
  • BLS
  • CL
• Rust API
  • BLS
  • CL

Wrappers documentation

• Python

Binaries

Note: Binaries creation is in progress now!!!

Builded binaries can be downloaded from https://repo.sovrin.org:

• sdk/lib/apt/xenial/{master,stable,rc} - Ubuntu deb packages
• windows/libindy_crypto/{master,stable,rc} - Windows zip-archive with all required DLLs (include libindy itself) and headers
• ios/libindy_crypto/stable/ - Pods for iOS
• rhel/libindy_crypto/{master,stable,rc} - RHEL rpms

Also Ubundu deb packages can be installed from APT repository:

key adv --keyserver keyserver.ubuntu.com --recv-keys 68DB5E88
 add-apt-repository "deb https://repo.sovrin.org/sdk/deb xenial stable"
 apt-get update
 apt-get install -y libindy-crypto