![Maintenance Mode](https://img.shields.io/badge/maintenance%20mode-%E2%9C%94%EF%B8%8F-red)
**THIS PROJECT IS CURRENTLY IN MAINTENANCE MODE. Only critical bug patches will be applied; no new features will be added.**
---
# FBPCP (Facebook Private Computation Platform)
[Secure multi-party computation](https://en.wikipedia.org/wiki/Secure_multi-party_computation) (also known as secure computation, multi-party computation (MPC), or privacy-preserving computation) is a subfield of cryptography with the goal of creating methods for parties to jointly compute a function over their inputs while keeping those inputs private.
FBPCP (Facebook Private Computation Platform) is a secure, privacy safe and scalable architecture to deploy MPC (Multi Party Computation) applications in a distributed way on virtual private clouds. [FBPCF](https://github.com/facebookresearch/fbpcf) (Facebook Private Computation Framework) is for scaling MPC computation up via threading, while FBPCP is for scaling MPC computation out via [Private Scaling](https://github.com/facebookresearch/fbpcp/blob/main/docs/PrivateScaling.md) architecture. FBPCP consists of various services, interfaces that enable various private measurement solutions, e.g. [Private Lift](https://github.com/facebookresearch/fbpcf/blob/master/docs/PrivateLift.md).
[Private Scaling](https://github.com/facebookresearch/fbpcp/blob/main/docs/PrivateScaling.md) resembles the map/reduce architecture and is secure against a semi-honest adversary who tries to learn the inputs of the computation. The goal is to secure the intermediate output of each shard to prevent potential privacy leak.
## Installation Requirements:
### Prerequisites for working on Ubuntu 18.04:
* An AWS account (Access Key ID, Secret Access Key) to use AWS SDK (boto3 API) in FBPCP
* python >= 3.8
* python3-pip
## Installing prerequisites on Ubuntu 18.04:
* python3.8
```sh
sudo apt-get install -y python3.8
```
* python3-pip
```sh
sudo apt-get install -y python3-pip
```
## Installing fbpcp
```sh
python3.8 -m pip install 'git+https://github.com/facebookresearch/fbpcp.git'
# (add --user if you don't have permission)
# Or, to install it from a local clone:
git clone https://github.com/facebookresearch/fbpcp.git
python3.8 -m pip install -e fbpcp
# (add --user if you don't have permission)
# Or, to install it from Pypi
python3.8 -m pip install fbpcp
```
## Upgrading fbpcp
* To latest version in github main branch
```sh
python3.8 -m pip uninstall fbpcp
# uninstall fbpcp first
python3.8 -m pip install 'git+https://github.com/facebookresearch/fbpcp.git'
# (add --user if you don't have permission)
# re-install fbpcp from github repository
```
* To latest version in Pypi
```sh
python3.8 -m pip install fbpcp --upgrade
```
## Architecture
<img src="https://github.com/facebookresearch/fbpcp/blob/main/docs/PCPArch.jpg?raw=true" alt="Figure 1: Architecture of FBPCP" width="50%" height="50%">
### Services:
* MPCService is the public interface that provides APIs to distribute a MPC application with large dataset to multiple MPC workers on cloud.
### [Other components](https://github.com/facebookresearch/fbpcp/blob/main/docs/FBPCPComponents.md)
## Join the FBPCP community
* Website: https://github.com/facebookresearch/fbpcp
* See the [CONTRIBUTING](https://github.com/facebookresearch/fbpcp/blob/main/CONTRIBUTING.md) file for how to help out.
## License
FBPCP is [MIT](https://github.com/facebookresearch/fbpcp/blob/main/LICENSE) licensed, as found in the LICENSE file.
Raw data
{
"_id": null,
"home_page": "https://github.com/facebookresearch/fbpcp",
"name": "fbpcp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Facebook",
"author_email": "researchtool-help@fb.com",
"download_url": "https://files.pythonhosted.org/packages/ff/6a/0c554c45f92b1e9f883e51b0f72eee6f8988abcc932d38c74913edda7a39/fbpcp-0.6.4.tar.gz",
"platform": null,
"description": "![Maintenance Mode](https://img.shields.io/badge/maintenance%20mode-%E2%9C%94%EF%B8%8F-red)\n**THIS PROJECT IS CURRENTLY IN MAINTENANCE MODE. Only critical bug patches will be applied; no new features will be added.**\n\n---\n\n# FBPCP (Facebook Private Computation Platform)\n[Secure multi-party computation](https://en.wikipedia.org/wiki/Secure_multi-party_computation) (also known as secure computation, multi-party computation (MPC), or privacy-preserving computation) is a subfield of cryptography with the goal of creating methods for parties to jointly compute a function over their inputs while keeping those inputs private.\n\nFBPCP (Facebook Private Computation Platform) is a secure, privacy safe and scalable architecture to deploy MPC (Multi Party Computation) applications in a distributed way on virtual private clouds. [FBPCF](https://github.com/facebookresearch/fbpcf) (Facebook Private Computation Framework) is for scaling MPC computation up via threading, while FBPCP is for scaling MPC computation out via [Private Scaling](https://github.com/facebookresearch/fbpcp/blob/main/docs/PrivateScaling.md) architecture. FBPCP consists of various services, interfaces that enable various private measurement solutions, e.g. [Private Lift](https://github.com/facebookresearch/fbpcf/blob/master/docs/PrivateLift.md).\n\n[Private Scaling](https://github.com/facebookresearch/fbpcp/blob/main/docs/PrivateScaling.md) resembles the map/reduce architecture and is secure against a semi-honest adversary who tries to learn the inputs of the computation. The goal is to secure the intermediate output of each shard to prevent potential privacy leak.\n\n## Installation Requirements:\n### Prerequisites for working on Ubuntu 18.04:\n* An AWS account (Access Key ID, Secret Access Key) to use AWS SDK (boto3 API) in FBPCP\n* python >= 3.8\n* python3-pip\n\n## Installing prerequisites on Ubuntu 18.04:\n* python3.8\n```sh\nsudo apt-get install -y python3.8\n```\n* python3-pip\n```sh\nsudo apt-get install -y python3-pip\n```\n## Installing fbpcp\n```sh\npython3.8 -m pip install 'git+https://github.com/facebookresearch/fbpcp.git'\n# (add --user if you don't have permission)\n\n# Or, to install it from a local clone:\ngit clone https://github.com/facebookresearch/fbpcp.git\npython3.8 -m pip install -e fbpcp\n# (add --user if you don't have permission)\n\n# Or, to install it from Pypi\npython3.8 -m pip install fbpcp\n```\n\n## Upgrading fbpcp\n* To latest version in github main branch\n```sh\npython3.8 -m pip uninstall fbpcp\n# uninstall fbpcp first\n\npython3.8 -m pip install 'git+https://github.com/facebookresearch/fbpcp.git'\n# (add --user if you don't have permission)\n# re-install fbpcp from github repository\n```\n\n* To latest version in Pypi\n```sh\npython3.8 -m pip install fbpcp --upgrade\n```\n\n## Architecture\n<img src=\"https://github.com/facebookresearch/fbpcp/blob/main/docs/PCPArch.jpg?raw=true\" alt=\"Figure 1: Architecture of FBPCP\" width=\"50%\" height=\"50%\">\n\n### Services:\n\n* MPCService is the public interface that provides APIs to distribute a MPC application with large dataset to multiple MPC workers on cloud.\n\n\n### [Other components](https://github.com/facebookresearch/fbpcp/blob/main/docs/FBPCPComponents.md)\n\n## Join the FBPCP community\n* Website: https://github.com/facebookresearch/fbpcp\n* See the [CONTRIBUTING](https://github.com/facebookresearch/fbpcp/blob/main/CONTRIBUTING.md) file for how to help out.\n\n## License\nFBPCP is [MIT](https://github.com/facebookresearch/fbpcp/blob/main/LICENSE) licensed, as found in the LICENSE file.\n",
"bugtrack_url": null,
"license": null,
"summary": "Facebook Private Computation Platform",
"version": "0.6.4",
"project_urls": {
"Homepage": "https://github.com/facebookresearch/fbpcp"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fafec539ea660cdf1b1ca7bc3d7d5b0be5f620efd8931aeca9dec2be58eab842",
"md5": "12a056852437923419dec16e652e9413",
"sha256": "f93a8ad59c8109f15cc5466fced2f7e1651664652cebfa26af1401ecc8d39f74"
},
"downloads": -1,
"filename": "fbpcp-0.6.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "12a056852437923419dec16e652e9413",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 116085,
"upload_time": "2024-06-18T23:26:37",
"upload_time_iso_8601": "2024-06-18T23:26:37.754661Z",
"url": "https://files.pythonhosted.org/packages/fa/fe/c539ea660cdf1b1ca7bc3d7d5b0be5f620efd8931aeca9dec2be58eab842/fbpcp-0.6.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ff6a0c554c45f92b1e9f883e51b0f72eee6f8988abcc932d38c74913edda7a39",
"md5": "06464f9eefe7d63694a94ac4f3b39d26",
"sha256": "b3210aa411933af52e385092a624940a31a184f9797665f6702b8ba4a10400f7"
},
"downloads": -1,
"filename": "fbpcp-0.6.4.tar.gz",
"has_sig": false,
"md5_digest": "06464f9eefe7d63694a94ac4f3b39d26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 60977,
"upload_time": "2024-06-18T23:26:43",
"upload_time_iso_8601": "2024-06-18T23:26:43.429083Z",
"url": "https://files.pythonhosted.org/packages/ff/6a/0c554c45f92b1e9f883e51b0f72eee6f8988abcc932d38c74913edda7a39/fbpcp-0.6.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-18 23:26:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "facebookresearch",
"github_project": "fbpcp",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fbpcp"
}