12 releases (4 breaking)
0.5.0 | Aug 28, 2024 |
---|---|
0.4.0 | Jul 29, 2024 |
0.3.0 | Jun 5, 2024 |
0.2.0 | Jan 23, 2024 |
0.1.2 | Jul 27, 2022 |
#64 in Programming languages
90 downloads per month
Used in 3 crates
(via tandem_garble_interop)
395KB
9K
SLoC
Garble Language
Garble is a simple programming language for Secure Multi-Party Computation with Garbled Circuits. The circuits generated by Garble specify a function, with each input coming from a different party and the output computed collaboratively by all parties in a way that no party learns another party's input. Garble is statically typed, low-level, purely functional and uses a syntax heavily inspired by Rust.
All programs written in Garble are deliberately Turing-incomplete (only supporting bounded recursion), guaranteeing that they can be compiled to circuits using only AND
, XOR
and NOT
gates (without any kind of stateful latches or registers). Here's an example of solving the Millionaire's Problem in Garble:
// A function for solving Yao's Millionaires' problem:
enum Richest {
IsA,
IsB,
Tie,
}
pub fn main(a: u64, b: u64) -> Richest {
if a > b {
Richest::IsA
} else if b > a {
Richest::IsB
} else {
Richest::Tie
}
}
For more examples, see the Language Tour.
How to Use Garble
The circuits generated by Garble are meant to be executed using a cryptographically secure MPC engine, which is not provided by this crate. Garble is agnostic about the details of the MPC engine and assumes only that the engine executes Garbled Circuits with support for AND
, XOR
and NOT
gates. For local development and testing, Garble supports a direct and unencrypted evaluation of a generated circuit, with all inputs supplied by the local user.
To execute the Millionaire's problem example, first install the garble
utility, checkout the repository to get the example programs, then run the function inside the repository directory:
$ cargo install garble_lang --features="bin"
$ git clone git@github.com:sine-fdn/garble-lang.git
$ cd garble-lang
$ garble run garble_examples/millionaires.garble.rs --function=main 10000000 10000
Richest::IsA
$ garble run garble_examples/millionaires.garble.rs --function=main 100 5000000
Richest::IsB
$ garble run garble_examples/millionaires.garble.rs --function=main 1000 1000
Richest::Tie
You can also type-check a program without running it by using garble check
followed by the file name.
You might need to wrap input or metadata in single quotes if they contain whitespace.
Architecture of this Repository
The Garble compiler is relatively straightforward and turns a program &str
into a circuit::Circuit
(or aborts with a scan/parse/type error). The different steps and their modules are as follows (with steps 1-4 happening during compile time, step 5 during run time):
scan.rs
splits a program&str
into atoken::Token
sequence.parse.rs
parses atoken::Token
sequence into an untypedast::Program
.check.rs
type-checks an untypedast::Program
, returning a typedast::Program
.compile.rs
converts a well-typedast::Program
into acircuit::Circuit
.eval.rs
executes acircuit::Circuit
with locally supplied inputs.
Dependencies
~0–320KB