https://github.com/freedomofpress/signal-groups

python bindings to signal's zkgroup
https://github.com/freedomofpress/signal-groups

Last synced: 7 days ago
JSON representation

python bindings to signal's zkgroup

• Host: GitHub
• URL: https://github.com/freedomofpress/signal-groups
• Owner: freedomofpress
• License: gpl-3.0
• Created: 2021-02-24T17:12:27.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-14T00:05:10.000Z (almost 3 years ago)
• Last Synced: 2023-03-22T01:26:15.864Z (over 1 year ago)
• Language: Rust
• Homepage:
• Size: 90.8 KB
• Stars: 1
• Watchers: 6
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# signal-groups

[![CircleCI](https://circleci.com/gh/freedomofpress/signal-groups.svg?style=svg)](https://circleci.com/gh/freedomofpress/signal-groups)

Experimental Python bindings to Signal's v2 groups implementation [`zkgroup`](https://github.com/signalapp/zkgroup).

This project provides a Rust extension using [PyO3](https://pyo3.rs/) to define a `signal_groups` Python module.

See [here](https://cryptography.io/en/latest/limitations.html) for a fundamental limitation storing secrets in Python-allocated memory.

⚠️USE AT YOUR OWN RISK!⚠️

## Installation

To use the wheel distributions you do not need the Rust toolchain installed. To install, run:

```

pip install signal-groups

```

## Developer Getting Started

You will need both [Rust](https://rustup.rs/) and Python 3.7+ installed on your system.

To install the project in your virtualenv:

```sh

pip install -r requirements.txt

python setup.py develop

```

Then run the tests via `pytest -v tests/` to confirm all is working.

Tests are (mostly) ported to Python from the upstream crate.

You can use the tests as a reference for how to use the library (start with the integration tests).

When developing, simply run `python setup.py develop` as you make changes to rebuild the library.

This script will handle compilation on the Rust side.

# Building wheels

See instructions [here](https://github.com/PyO3/setuptools-rust#binary-wheels-on-linux). In brief:

```

docker pull quay.io/pypa/manylinux2014_x86_64

docker run --rm -v `pwd`:/io quay.io/pypa/manylinux2014_x86_64 /io/build-wheels.sh

```