swanky
provides a suite of rust libraries for doing secure computation.
bristol-fashion
: A parser for Bristol Fashion circuits.diet-mac-and-cheese
: A diet version of the Mac'n'Cheese protocolfancy-garbling
: A library for boolean and arithmetic garblingfancy-garbling-base-conversion
: Lookup tables useful for the fancy-garbling cratehumidor
: A test-bed for Ligero-like protocolsinferno
: An implementation of the Limbo zero knowledge proof protocolkeyed_arena
: Bump allocator which allows for random access to its allocationsmac-n-cheese-compiler
: A tool to compile a zero knowledge circuit to the mac n'cheese IRmac-n-cheese-event-log
: Utilities to define metrics for mac n'cheesemac-n-cheese-inspector
: A tool to inspect mac n'cheese IR filesmac-n-cheese-ir
: The definition of the mac n'cheese IRmac-n-cheese-runner
: A tool to proof mac n'cheese IR files in zero-knowledgemac-n-cheese-sieve-parser
: A parser for SIEVE IR (a zero knoweldge proof circuit format)mac-n-cheese-vole
: An implementation of Vector Oblivious Linear Evaluationmac-n-cheese-wire-map
: An implementation of a sparse arrayocelot
: A library for oblivious transfer protocolspopsicle
: A library for private set intersectionschmivitz
: A library for zero-knowledge protocols using VOLE-in-the-headscuttlebutt
: A library of useful multi-party computation utilitiessimple-arith-circuit
: Simple arithmetic circuit libraryswanky-channel
: A channel abstraction to let users avoid manual flushingswanky-field
: Definitions of the coreFiniteField
andFiniteRing
traitsswanky-field-binary
: Binary finite (extension) fieldsswanky-field-f61p
: An implementation ofGF(2^61-1)
swanky-field-ff-primes
: Finite field implementations for large prime fieldsswanky-field-fft
: FFT implementations for finite fieldsswanky-field-test
: Utilitites for testing correctness of finite field implementationsswanky-flatbuffer-build
: Tooling to automate compiling flatbuffer schemasswanky-party
: Support for types indexed by a party.swanky-serialization
: Traits and utilities for compact serialization into a canonical byte representationvectoreyes
: Cross-platform SIMD types and functionsweb-mac-n-cheese-wasm
: Web Mac'n'Cheese, the wasm partweb-mac-n-cheese-websocket
: Web Mac'n'Cheese, the websocket partzkv
: Zero knowledge proofs for verilog files generated using saw / abc
2024-02-09 Projection gates in arithmetic garbled circuits have a proven security vulnerability in their design. The issue affects the fancy-garbling library and its dependencies (including popsicle). We are currently investigating the impact this bug has on Arithmetic Garbling (CRT) in swanky.
swanky
is currently research software. Do not deploy it in production, or trust
it with sensitive data.
Please reach out to us at [email protected] if you're interested in using Swanky in a production setting.
The preferred way to use swanky
is to fork this monorepo, and add your code
to your fork. This approach makes it easy for your code to inherit the
configuration of the swanky
repo.
It is also possible to use swanky
as traditional Rust crates. The downside of
this approach is that you won't automatically get the configuration of the
swanky
repo. swanky
is only tested against the pinned rust version in the
repository and the pinned dependency versions.
To use a swanky
crate in your project, add the following line to the
[dependencies]
entry in Cargo.toml
:
<crate-name> = { git = "https://github.com/GaloisInc/swanky", rev = "xxxxxx" }
where <crate-name>
is one of the crates listed above and rev
is the
particular revision to use.
Note: As swanky
is currently considered prototype software, it is best to pin
a particular revision of swanky
, as there is no guarantee that future versions
of swanky
will maintain backwards compatibility.
It is also advisable to copy over swanky's .cargo/config
file, and to enable
LTO in your release builds (lto = true
in your Cargo.toml
file).
To compile Swanky, you should install and use Rust via rustup. The swanky repo will direct rustup to use the correct version of Rust.
The ./swanky
tool automates some tasks in the codebase. For example, ./swanky lint
will run the Swanky linting checks. In order to use this tool, you need to install the Nix package manager. You'll also need a python3 installation (no packages other than the standard library are required).
If you use swanky
in your academic paper, please cite it as follows:
@misc{swanky,
author = {{Galois, Inc.}},
title = {{swanky}: A suite of rust libraries for secure computation},
howpublished = {\url{https://github.com/GaloisInc/swanky}},
year = 2019,
}
MIT License
You can contact the swanky
team at [email protected]
.
This material is based upon work supported in part by ARO, SSC Pacific, IARPA and DARPA under Contract Nos. W911NF-15-C-0227, N66001-15-C-4070, 2019-1902070006, and HR001120C0085.
Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the ARO, SSC Pacific, IARPA and DARPA. Distribution Statement ``A'' (Approved for Public Release, Distribution Unlimited).
Copyright © 2019-2022 Galois, Inc.