Kunlun: A Modern Crypto Library

Overview

I give a C++ wrapper for OpenSSL, making it handy to use, without worrying about the cumbersome memory management and memorizing the complex interfaces. Based on this wrapper, I am going to build an efficient and modular crypto library.

Design Philosophy

Provide a set of neat interfaces for big integer and ec group operations, with the hope that the code is as succinct as paper description. Kunlun supports multithreading via OpenMP. So far, the library is not stable. It will keep evolving.

Issues

OpenSSL does not support pre-computation for customized generator.
bn_ctx is not thread-safe, so in many places it is hard to apply the SIMD parallel optimization.
A dirty trick is to make openssl-based programs parallizable is to set bn_ctx = nullptr. This trick works for some cases but not all, and only beats the single-thread programs when THREAD_NUM is much larger than 1.

If the above two issues get solved, the performance of Kunlun will be better.

To do list (impossible missions for me)

PRF
garbled circuit
secret sharing
zk-SNARK
add class for Zn and ECPoint/BigInt vector
wrap _m128i as class?
silient OT
overload << >> for serialization

Specifications

OS: MAC OS x64, Linux x64
Language: C++
Requires: OpenSSL, OpenMP

Install Depedent Libaraies

On MACOS

download the latest OpenSSL from the website, to support curve25519, modify crypto/ec/curve25519.c line 211: remove "static", then compile it:

  $ ./Configure darwin64-x86_64-cc shared enable-ec_nistp_64_gcc_128 no-ssl2 no-ssl3 no-comp --openssldir=/usr/local/ssl/macos-x86_64
  $ make depend
  $ sudo make install

test if the function x25519_scalar_mulx is available

  $ cd /usr/local/lib
  $ nm libcrypto.a | grep x25519_scalar_mulx

install OpenMP

  $ brew install libomp

On Linux

install OpenSSL 3.0 do the same modification as in MACOS, then compile it according to

  https://wiki.openssl.org/index.php/Compilation_and_Installation#Linux

install OpenMP

  $ sudo apt install libomp-dev

Code Structure

README.md
CmakeLists.txt: cmake file
/build
/include
- std.inc: standard header files
- openssl.inc: openssl header files
- global.hpp: define global variables for kunlun lib as well as error information
- kunlun.hpp: include all necessary files to write a cryptographic program
/utility: dependent files
- bit_operation.hpp
- routines.hpp: related routine algorithms
- print.hpp: print info for debug
- murmurhash3.hpp: add fast non-cryptographic hash
- polymul.hpp: naive poly mul
- serialization.hpp: overload serialization for uint and string type data
/crypto: C++ wrapper for OpenSSL
- setup.hpp: initialize crypto environments, including big number, elliptic curves, and aes
- ec_group.hpp: initialize ec group environment, define compressed-point on-off, precomputation on-off
- ec_point.hpp: class for EC_POINT
- bigint.hpp: class for BIGNUM, also include initialization of big num
- hash.hpp: all kinds of cryptographic hash functions
- aes.hpp: implement AES using SSE, as well as initialization of aes
- prg.hpp: implement PRG associated algorithms
- prp.hpp: implement PRP using AES
- block.hpp: __m128i related algorithms (necessary for exploiting SSE)
/pke: public key encryption schemes
- twisted_elgamal.hpp
- elgamal.hpp
- calculate_dlog.hpp
/signature
- schnorr.hpp
- accountable_ring_signature.hpp: implement accountable ring signature
/commitment
- pedersen.hpp: multi-element Pedersen commitment
/gadgets
- range_proof.hpp: two useful gadgets for proving encrypted values lie in the right range
/cryptocurrency
- adcp.hpp: the adcp system
/netio
- stream_channel.hpp: basic network socket functionality
mpc
- /ot
  - naor_pinkas_ot.hpp: one base OT
  - iknp_ote.hpp: IKNP OT extension
- /oprf
  - ote_oprf: OTE-based OPRF
  - ddh_oprf: DDH-based (permuted)-OPRF
- /rpmt
  - cwprf_mqrpmt.hpp: mq-RPMT from commutative weak PRF
- /pso
  - mqrpmt_psi.hpp: set intersection
  - mqrpmt_psi_card.hpp: intersection cardinality
  - mqrpmt_psi_card_sum.hpp: intersection sum and cardinality
  - mqrpmt_psu.hpp: union
  - mqrpmt_private_id.hpp: private-id protocol based on OTE-based OPRF and cwPRF-based mqRPMT
zkp
- /nizk: associated sigma protocol for twisted elgamal; obtained via Fiat-Shamir transform
  - nizk_plaintext_equality.hpp: NIZKPoK for twisted ElGamal plaintext equality in 3-recipient mode
  - nizk_plaintext_knowledge.hpp: NIZKPoK for twisted ElGamal plaintext and randomness knowledge
  - nizk_dlog_equality.hpp: NIZKPoK for discrete logarithm equality
  - nizk_dlog_knowledge.hpp: Schnorr protocol for dlog
  - nizk_enc_relation.hpp: prove one-out-of-n ciphertexts is encryption of 0
- /bulletproofs
  - bullet_proof.hpp: the aggregating logarithmic size bulletproofs
  - innerproduct_proof.hpp: the inner product argument (used by Bulletproof to shrink the proof size)
/filter
- bloom_filter.hpp
- cuckoo_filter.hpp
/docs: the manual of all codes

Compile and Run

  $ mkdir build && cd build
  $ cmake ..
  $ make
  $ ./test_xxx

Multi-threads Support

Kunlun supports multithread by leveraging openmp. Since OpenSSL is not thread-safe, I slightly hack the code to work around using the following facts about bn_ctx:

bn_ctx is necessary for most big number operations, but not necessary for elliptic curve crypto operations.
bn_ctx can improve the performance
one can set bn_ctx = nullptr for thread safety when dealing with ECC operations
one could still use the original bn_ctx in single thread setting

The global setting for multi-thread support lies at "include/global.hpp" line 21-22 algorithms in ec_point.hpp will be complied according to this setting
For multi-thread

#define PARALLEL
const static size_t thread_count = 8; // maximum thread count

For single-thread

//#define PARALLEL
const static size_t thread_count = 1; // maximum thread count

Evolution and Updates Log

20210827: post the initial version, mainly consists of wrapper class for BIGNUM* and EC_Point*
20210925: shift twisted elgamal, sigma protocols, bulletproofs, and adcp to Kunlun
20211011: feed my first grammar sugar "namespace" to Kunlun, add OT primitive
20220319: add private set operation and re-org many places
20220329: speeding Shanks DLOG algorithm and add ElGamal PKE and Schnorr SIG
20220605: greatly improve the multi-thread support (simplify the code and unify the interface)

License

This library is licensed under the MIT License.

Acknowledgement

We deeply thank Weiran Liu for many helpful discussions on the development of this library. Here we strongly recommend the efficient and easy-to-use MPC library for Java developed by his team. I thank my deer senior apprentice Prof. Zhi Guan for professional help.

Tips

thread vector is more efficient than thread array: I don't know the reason why
add mutex to lock bn_ctx will severely harm the performance of multi thread
void* type pointer allow you to determine the exact type later and provide a unified interface

How to test the speed of socket communication?

install iperf3 via the following command

brew install iperf3

open it in two terminals (perhaps on two computers)

iperf3 -s
iperf3 -c [IP Address of first Mac]

See more information via https://www.macobserver.com/tmo/answers/how-to-test-speed-home-network-iperf

moonflowersl / kunlun Goto Github PK

kunlun's Introduction