From a7f15c8b21cb231fa9ca536487ddf6f1d4f539b2 Mon Sep 17 00:00:00 2001 From: Tal Davidi Date: Tue, 29 Nov 2022 15:20:21 -0800 Subject: [PATCH 1/2] Minor fixes to documentation Differential Revision: D41597612 fbshipit-source-id: c632b600de37f8c449c3ebc932d323198ca3e40c --- CONTRIBUTING.md | 2 +- docs/FBPCPComponents.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bdc5b263..999ba112 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to FBPCS +# Contributing to FBPCP We want to make contributing to this project as easy and transparent as possible. diff --git a/docs/FBPCPComponents.md b/docs/FBPCPComponents.md index 940f7eee..f8d7a5e3 100644 --- a/docs/FBPCPComponents.md +++ b/docs/FBPCPComponents.md @@ -1,5 +1,5 @@ ### Components: -Facebook Private Computation Service follows [MVCS(Model View Controller Service)](MVCS.md) design pattern. +Facebook Private Computation Platform follows [MVCS(Model View Controller Service)](MVCS.md) design pattern. ### Repository Repository is responsible for encapsulating database-like operations. In our design, we have MPC instance repositories for both Amazon S3 and local storage. The end point service will call MPC service to create an MPC instance and all the files and information related to this instance will be stored on Amazon S3 or local storage, depending on which repository the end point service is using. From d75b4b46172af881d40aaf5af543e7f804cc5a40 Mon Sep 17 00:00:00 2001 From: Tal Davidi Date: Tue, 29 Nov 2022 15:20:38 -0800 Subject: [PATCH 2/2] Remove Facebook from project name (#445) Summary: Pull Request resolved: https://github.com/facebookresearch/fbpcp/pull/445 We are doing this as a result of an open issue on our github https://github.com/facebookresearch/fbpcf/issues/415. I spoke to caseybeal and thayat who are ok with us just changing the name of the repositories and updating documentation with mentions of Facebook to Meta. - Removing mention of Facebook in the title of the project - Replacing Facebook -> Meta where relevant Differential Revision: D40161520 fbshipit-source-id: 873acbae5933c1c12a831c84511dae0e1ee8df27 --- CONTRIBUTING.md | 4 ++-- README.md | 6 +++--- docs/FBPCPComponents.md | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 999ba112..f358401c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to FBPCP +# Contributing to PCP We want to make contributing to this project as easy and transparent as possible. @@ -35,5 +35,5 @@ outlined on that page and do not file a public issue. * ... ## License -By contributing to FBPCS, you agree that your contributions will be licensed +By contributing to PCP, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree. diff --git a/README.md b/README.md index 5884c338..bb691042 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# FBPCP (Facebook Private Computation Platform) +# PCP (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). +PCP (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. [PCF](https://github.com/facebookresearch/fbpcf) (Private Computation Framework) is for scaling MPC computation up via threading, while PCP is for scaling MPC computation out via [Private Scaling](https://github.com/facebookresearch/fbpcp/blob/main/docs/PrivateScaling.md) architecture. PCP 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. @@ -60,7 +60,7 @@ python3.8 -m pip install fbpcp --upgrade ### [Other components](https://github.com/facebookresearch/fbpcp/blob/main/docs/FBPCPComponents.md) -## Join the FBPCP community +## Contributing to the 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. diff --git a/docs/FBPCPComponents.md b/docs/FBPCPComponents.md index f8d7a5e3..59f715e0 100644 --- a/docs/FBPCPComponents.md +++ b/docs/FBPCPComponents.md @@ -1,5 +1,5 @@ ### Components: -Facebook Private Computation Platform follows [MVCS(Model View Controller Service)](MVCS.md) design pattern. +Private Computation Platform follows [MVCS(Model View Controller Service)](MVCS.md) design pattern. ### Repository Repository is responsible for encapsulating database-like operations. In our design, we have MPC instance repositories for both Amazon S3 and local storage. The end point service will call MPC service to create an MPC instance and all the files and information related to this instance will be stored on Amazon S3 or local storage, depending on which repository the end point service is using. @@ -18,7 +18,7 @@ MPC Instance contains information about a MPC game. For example, MPC game name, Container Instance contains information about a container on an ECS cluster. For example, the instance id, ip address and container status. ### Service: -MPCService is the public interface that FBPCP provides. All other services are internal only so subject to changes. +MPCService is the public interface that PCP provides. All other services are internal only so subject to changes. Service holds all business logic and exposes internal APIs to controllers or other services within the same code base. Besides MPC Sevice, MPC Game Service and OneDocker Service: