YACL (Yet Another Common crypto Library)

Yacl is a C++ library that contains common cryptgraphy, network and io modules which other SecretFlow code depends on. The crypto modules in Yacl implement many state-of-art secure computation protocols, including primitives like OT, VOLE, TPRE, and tools like PRG, RO. Check the full list of Yacl's supported algorithms in ALGORITHMS.md.

Supported platforms: | Linux x86_64 | Linux aarch64 | macOS x86_64 | macOS Apple Silicon | Windows x86_64 | Windows WSL2 x86_64 | |--------------|---------------|----------------|---------------------|----------------|---------------------| | yes | yes | yes¹| yes | no | yes¹ |

1. Yacl has not been thoroughly tested on these platforms.

Repo Layout

• base: some basic types and utils in yacl.
• crypto: crypto algorithms without link.
• kernel: crypto kernel that includes link with (WIP) multi-thread support, i.e. OT, DPF.
• io: a simple streaming-based io library.
• link: a simple rpc-based MPI framework, providing the SPMD parallel programming capability.

Prerequisites

• bazel: .bazeliskrc sets the recommended version of bazel. We recommend to use the official bazelisk to manage bazel version.
• gcc >= 10.3
• cmake
• ninja/ninja-build
• Perl 5 with core modules (Required by OpenSSL)

Getting Started

Yacl uses the bazel build system, you may use the following codes to build and test yacl modules. For more guidelines about how to develop on yacl, please check the Getting Started Guide.

License

See LICENSE and NOTICE.md