From 24911c7d3a7cfdec00fa0c9c48abd8d9156e49d7 Mon Sep 17 00:00:00 2001 From: Cedric Sirianni Date: Wed, 18 Oct 2023 17:54:44 -0400 Subject: [PATCH 01/10] ci: rename conventional commit action --- .github/workflows/{main.yml => commits.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{main.yml => commits.yml} (100%) diff --git a/.github/workflows/main.yml b/.github/workflows/commits.yml similarity index 100% rename from .github/workflows/main.yml rename to .github/workflows/commits.yml From 8e1f425bd97f4338ecae9fbe335d85881645578d Mon Sep 17 00:00:00 2001 From: Cedric Sirianni Date: Wed, 18 Oct 2023 17:55:03 -0400 Subject: [PATCH 02/10] docs: update READMEs with instructions --- README.md | 22 +++++++++++++++++++++- backend/README.md | 2 +- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4c5c163..13ffcf8 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ -# private-data-lookup \ No newline at end of file +# Private Data Lookup + +[![commit messages](https://github.com/csirianni/private-data-lookup/actions/workflows/commits.yml/badge.svg)](https://github.com/csirianni/movie-recommender/actions/workflows/commits.yml) + +## Overview + +## Instructions + +It's necessary to configure the `/frontend` and `/backend` folders initially. See the respective `README.md`s for more information. + +In order to run the frontend, `cd` into `/frontend` and run + +```console +yarn dev +``` + +In order to run the backend, `cd` into the `/backend` and run + +```console +./build/backend +``` diff --git a/backend/README.md b/backend/README.md index 159cd9a..e5164dc 100644 --- a/backend/README.md +++ b/backend/README.md @@ -9,7 +9,7 @@ brew install conan cmake conan install . --output-folder=build --build=missing ``` -Set up the `/build/` folder: +Set up the `/build` folder: ```bash mkdir build && cd build From bc0ebf4acd54fe2b7ae07dbc0b00ac7719c24152 Mon Sep 17 00:00:00 2001 From: Cedric Sirianni Date: Wed, 18 Oct 2023 17:56:14 -0400 Subject: [PATCH 03/10] docs: fix path in action badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 13ffcf8..0de0df1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Private Data Lookup -[![commit messages](https://github.com/csirianni/private-data-lookup/actions/workflows/commits.yml/badge.svg)](https://github.com/csirianni/movie-recommender/actions/workflows/commits.yml) +[![commit messages](https://github.com/csirianni/private-data-lookup/actions/workflows/commits.yml/badge.svg)](https://github.com/csirianni/private-data-lookup/actions/workflows/commits.yml) ## Overview From 8af62292366aa63ecf7ce7b1a871c691eb3dcd4a Mon Sep 17 00:00:00 2001 From: Cedric Sirianni Date: Wed, 18 Oct 2023 18:00:41 -0400 Subject: [PATCH 04/10] fix: use GitHub badge generator --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0de0df1..499eefe 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Private Data Lookup -[![commit messages](https://github.com/csirianni/private-data-lookup/actions/workflows/commits.yml/badge.svg)](https://github.com/csirianni/private-data-lookup/actions/workflows/commits.yml) +[![Conventional Commits](https://github.com/csirianni/private-data-lookup/actions/workflows/commits.yml/badge.svg)](https://github.com/csirianni/private-data-lookup/actions/workflows/commits.yml) ## Overview From bd84bfd63b00172f3bf3e7b2aa408455ab14e5fd Mon Sep 17 00:00:00 2001 From: Cedric Sirianni Date: Wed, 18 Oct 2023 18:37:12 -0400 Subject: [PATCH 05/10] docs: improve instructions --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 499eefe..cf27e1e 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,24 @@ ## Instructions -It's necessary to configure the `/frontend` and `/backend` folders initially. See the respective `README.md`s for more information. +It's necessary to configure the `/frontend` and `/backend` folders initially. See the respective `README.md`s for more information. After configuration, you can run the application using the following commands. -In order to run the frontend, `cd` into `/frontend` and run +To run the frontend, `cd` into `/frontend` and run ```console yarn dev ``` -In order to run the backend, `cd` into the `/backend` and run +To run the backend, `cd` into the `/backend` and compile the executable: ```console -./build/backend +mkdir build && cd build +cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release +cmake --build . +``` + +Then, you can simply run + +```console +./backend ``` From 7739fb6f2a76af2e0ab445e5b8c070b3dd303457 Mon Sep 17 00:00:00 2001 From: Cedric Sirianni Date: Wed, 18 Oct 2023 18:58:26 -0400 Subject: [PATCH 06/10] docs: add overview --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index cf27e1e..d05cc18 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,13 @@ ## Overview +Private Data Lookup (PDL) is a web application that allows users to privately query a server-side data set of breached passwords during account creation. PDL is based on a secure multiparty computation mechanism called Private Set Intersection where two parties holdings sets (of credentials) can compute the intersection of the two sets without revealing their sets to the counterpart. The result is better *application security* by encouraging the use of stronger passwords and better *user privacy* by minimizing the information revealed to the server in the password precheck process. + +This project is inspired by some excellent work at Meta and Google: + +- [How Meta is improving password security and preserving privacy](https://engineering.fb.com/2023/08/08/security/how-meta-is-improving-password-security-and-preserving-privacy/) +- [Data Breaches, Phishing, or Malware?: Understanding the Risks of Stolen Credentials](https://dl.acm.org/doi/10.1145/3133956.3134067). + ## Instructions It's necessary to configure the `/frontend` and `/backend` folders initially. See the respective `README.md`s for more information. After configuration, you can run the application using the following commands. From 1f81b17b0d7b8b5c7b8cc696b0281368240c21d9 Mon Sep 17 00:00:00 2001 From: Cedric Sirianni Date: Wed, 18 Oct 2023 19:00:27 -0400 Subject: [PATCH 07/10] docs: use blockquote --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d05cc18..dbc576f 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,10 @@ Private Data Lookup (PDL) is a web application that allows users to privately query a server-side data set of breached passwords during account creation. PDL is based on a secure multiparty computation mechanism called Private Set Intersection where two parties holdings sets (of credentials) can compute the intersection of the two sets without revealing their sets to the counterpart. The result is better *application security* by encouraging the use of stronger passwords and better *user privacy* by minimizing the information revealed to the server in the password precheck process. -This project is inspired by some excellent work at Meta and Google: - -- [How Meta is improving password security and preserving privacy](https://engineering.fb.com/2023/08/08/security/how-meta-is-improving-password-security-and-preserving-privacy/) -- [Data Breaches, Phishing, or Malware?: Understanding the Risks of Stolen Credentials](https://dl.acm.org/doi/10.1145/3133956.3134067). +> This project is inspired by some excellent work at Meta and Google: +> +> - [How Meta is improving password security and preserving privacy](https://engineering.fb.com/2023/08/08/security/how-meta-is-improving-password-security-and-preserving-privacy/) +> - [Data Breaches, Phishing, or Malware?: Understanding the Risks of Stolen Credentials](https://dl.acm.org/doi/10.1145/3133956.3134067). ## Instructions From 58a6fffbd0d449cbfb148d2fdd9a87116eca1497 Mon Sep 17 00:00:00 2001 From: Cedric Sirianni Date: Wed, 18 Oct 2023 19:01:55 -0400 Subject: [PATCH 08/10] docs: remove italics --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dbc576f..cb58269 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ## Overview -Private Data Lookup (PDL) is a web application that allows users to privately query a server-side data set of breached passwords during account creation. PDL is based on a secure multiparty computation mechanism called Private Set Intersection where two parties holdings sets (of credentials) can compute the intersection of the two sets without revealing their sets to the counterpart. The result is better *application security* by encouraging the use of stronger passwords and better *user privacy* by minimizing the information revealed to the server in the password precheck process. +Private Data Lookup (PDL) is a web application that allows users to privately query a server-side data set of breached passwords during account creation. PDL is based on a secure multiparty computation mechanism called Private Set Intersection where two parties holdings sets (of credentials) can compute the intersection of the two sets without revealing their sets to the counterpart. The result is better application security by encouraging the use of stronger passwords and better user privacy by minimizing the information revealed to the server in the password precheck process. > This project is inspired by some excellent work at Meta and Google: > From 4b7d787942b4e516f3e5e9263887c27c5dc785cf Mon Sep 17 00:00:00 2001 From: Cedric Sirianni Date: Wed, 18 Oct 2023 19:03:08 -0400 Subject: [PATCH 09/10] docs: fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cb58269..087989c 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ To run the frontend, `cd` into `/frontend` and run yarn dev ``` -To run the backend, `cd` into the `/backend` and compile the executable: +To run the backend, `cd` into the `/backend` and compile the program: ```console mkdir build && cd build From 1ca1e947bbfbba461b8efe7bac04ea4cf00cde3a Mon Sep 17 00:00:00 2001 From: Cedric Sirianni Date: Wed, 18 Oct 2023 19:05:50 -0400 Subject: [PATCH 10/10] docs: remove period --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 087989c..270ce3a 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Private Data Lookup (PDL) is a web application that allows users to privately qu > This project is inspired by some excellent work at Meta and Google: > > - [How Meta is improving password security and preserving privacy](https://engineering.fb.com/2023/08/08/security/how-meta-is-improving-password-security-and-preserving-privacy/) -> - [Data Breaches, Phishing, or Malware?: Understanding the Risks of Stolen Credentials](https://dl.acm.org/doi/10.1145/3133956.3134067). +> - [Data Breaches, Phishing, or Malware?: Understanding the Risks of Stolen Credentials](https://dl.acm.org/doi/10.1145/3133956.3134067) ## Instructions