Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
quackzar committed Apr 18, 2024
1 parent 93fda6b commit a2395e4
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 12 deletions.
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
<h1 align="center">Caring</h1>
<h2 align="center">is Secret Sharing</h2>
<div align="center">is Secret Sharing</div>

This is a library for performing secure multiparty computation by (mostly) secret sharing.
The aim of this is to provide datatypes and constructs to build larger MPC programs,
and be generic in the underlying protocols and settings a givens scheme can use.

Currently we are working with the following schemes:
Currently, we are working with the following schemes:
- Shamir Secret Sharing (complete)
- Feldman's Secret Sharing (lack. multiplication)
- Pedersen Secret Sharing (lack. addition + multiplication)
- Rep3 (addition)
- SPDZ (wip)
- SPDZ2k (todo)
*Note* that this is prototype software and not suited to be used in security critical applications as of yet.

*Note*: This is prototype software and not suited to be used in security critical applications as of yet.

## To Build
We use a few things that require nightly, so switch to that.
Expand All @@ -24,14 +25,8 @@ cargo build
## Subprojects

The base crate here is to provide a library with secret-sharing and other MPC functionality.
The project contains a sample of a consuming library [`weshare`](./weshare) provinding a subroutine for the securely computing a simple sum.
This is further used by [`ccare`](./ccare) and [`pycare`]('/pycare') for C and Python bindings respectively.

## Testing
Our testing is done by cargo test
```sh
cargo test
```
The project contains a sample of a consuming library [`wecare`](./wecare) provinding a subroutine for the securely computing a simple sum.
This is further used by [`ccare`](./ccare) and [`pycare`]('./pycare') for C and Python bindings respectively.


# Inspiration
Expand Down
2 changes: 1 addition & 1 deletion pycare/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h1 align="center">Caring for Python</h1>
<h2 align="center">Because we care about Python too!</h2>
<div align="center">Because we care about Python too!</div>

Python bindings to perform a MPC summation.
```py
Expand Down
File renamed without changes.

0 comments on commit a2395e4

Please sign in to comment.