https://github.com/secretflow/yacl

YACL (Yet Another Common crypto library) is a C++ library that contains cryptography, network and io modules which other SecretFlow code depends on.
https://github.com/secretflow/yacl

crypto cryptography cryptography-library dpf gm lpn oblivious-transfer ot psi psu secure-computation svole vole

Last synced: 3 months ago
JSON representation

YACL (Yet Another Common crypto library) is a C++ library that contains cryptography, network and io modules which other SecretFlow code depends on.

• Host: GitHub
• URL: https://github.com/secretflow/yacl
• Owner: secretflow
• License: apache-2.0
• Created: 2022-07-02T02:35:14.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-02T11:15:56.000Z (3 months ago)
• Last Synced: 2024-08-02T12:48:01.824Z (3 months ago)
• Topics: crypto, cryptography, cryptography-library, dpf, gm, lpn, oblivious-transfer, ot, psi, psu, secure-computation, svole, vole
• Language: C++
• Homepage:
• Size: 4.56 MB
• Stars: 70
• Watchers: 6
• Forks: 61
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# YACL (Yet Another Common crypto Library)

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/secretflow/yacl/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/secretflow/yacl/tree/main)

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/secretflow/yacl/badge)](https://securityscorecards.dev/viewer/?uri=github.com/secretflow/yacl)

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](ALGORITHMS.md).

Supported platforms:

| Linux x86_64 | Linux aarch64 | macOS x86_64   | macOS Apple Silicon | Windows x86_64 | Windows WSL2 x86_64 |

|--------------|---------------|----------------|---------------------|----------------|---------------------|

| yes          | yes           | yes1| yes                 | no             | yes1     |

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

## Repo Layout

- [base](yacl/base/): some basic types and utils in yacl.

- [crypto](yacl/crypto/): **crypto algorithms** without [link](yacl/link/).

- [kernel](yacl/kernel/): **crypto kernel** that includes [link](yacl/link/) with multi-thread support, i.e. OT, DPF.

- [io](yacl/io/): a simple streaming-based io library.

- [link](yacl/link/): a simple rpc-based MPI framework, providing the [SPMD](https://en.wikipedia.org/wiki/SPMD) parallel programming capability.

## Prerequisites

- **bazel**: [.bazelversion](.bazelversion) file describes the recommended version of bazel. We recommend to use the official [bazelisk](https://github.com/bazelbuild/bazelisk?tab=readme-ov-file#installation) to manage bazel version.

- **gcc >= 10.3**

- **[cmake](https://cmake.org/getting-started/)**

- **[ninja/ninja-build](https://ninja-build.org/)**

- **Perl 5 with core modules** (Required by [OpenSSL](https://github.com/openssl/openssl/blob/master/INSTALL.md#prerequisites))

## Getting Started

Yacl uses the [bazel](https://bazel.build/) build system, you may use the following codes to build and test yacl modules. For more guidelines about how to **do crypto research on Yacl**, **use Yacl's shipped crypto tools**, or **integrate Yacl into your system**, please check the [Getting Started Guide](GETTING_STARTED.md).

## License

See [LICENSE](LICENSE) and [NOTICE.md](NOTICE.md)