Initial commit

fbshipit-source-id: 74dc8f588c5e538878da878b0c0fcaedce6924e0

CODE_OF_CONDUCT.md

@@ -0,0 +1,80 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+This Code of Conduct also applies outside the project spaces when there is a
+reasonable belief that an individual's behavior may have a negative impact on
+the project or its community.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <[email protected]>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing to acs
+We want to make contributing to this project as easy and transparent as
+possible.
+
+## Pull Requests
+We actively welcome your pull requests.
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. If you haven't already, complete the Contributor License Agreement ("CLA").
+
+## Contributor License Agreement ("CLA")
+In order to accept your pull request, we need you to submit a CLA. You only need
+to do this once to work on any of Facebook's open source projects.
+
+Complete your CLA here: <https://code.facebook.com/cla>
+
+## Issues
+We use GitHub issues to track public bugs. Please ensure your description is
+clear and has sufficient instructions to be able to reproduce the issue.
+
+Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
+disclosure of security bugs. In those cases, please go through the process
+outlined on that page and do not file a public issue.
+
+## License
+By contributing to acs, you agree that your contributions will be licensed
+under the LICENSE file in the root directory of this source tree.

Dockerfile

@@ -0,0 +1,16 @@
+ARG UBUNTU_VERSION
+
+FROM ubuntu:${UBUNTU_VERSION}
+
+WORKDIR /root
+RUN apt-get update && \
+ apt-get install -y libthrift-0.16.0 thrift-compiler g++ \
+ libboost-dev libthrift-dev libsodium-dev make
+
+COPY . .
+
+RUN make all
+
+ENV PATH="${WORKDIR}:${PATH}"
+
+CMD ["server"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,79 @@
+CC = gcc
+CFLAGS = -O2 -I.
+CXX = g++
+CXX_FLAGS = -O2 --std=c++17 -I.
+CXX_LIBS = -lthrift -lsodium
+
+########################################
+
+THRIFT_PATH = gen-cpp
+_THRIFT_OBJS = service_types.o SimpleAnonCredService.o
+THRIFT_OBJS = $(foreach n, $(_THRIFT_OBJS), $(THRIFT_PATH)/$(n))
+
+########################################
+
+CURVE_PATH = lib/curve
+VOPRF_PATH = lib/voprf
+KDF_PATH = lib/kdf
+DLEQPROOF_PATH = lib/dleqproof
+
+_CURVE_OBJS = curve_ristretto.o
+_VOPRF_OBJS = voprf_mul_twohashdh.o voprf_twohashdh.o
+_KDF_OBJS = kdf_sdhi.o
+_DLEQPROOF_OBJS = dleqproof.o
+
+
+CRYPTO_OBJS = $(foreach n, $(_CURVE_OBJS), $(CURVE_PATH)/$(n)) \
+ $(foreach n, $(_VOPRF_OBJS), $(VOPRF_PATH)/$(n)) \
+ $(foreach n, $(_KDF_OBJS), $(KDF_PATH)/$(n)) \
+ $(foreach n, $(_DLEQPROOF_OBJS), $(DLEQPROOF_PATH)/$(n))
+
+########################################
+
+SERVER_PATH = demo
+_SERVER_OBJS = SimpleAnonCredServiceHandler.o
+SERVER_OBJS = $(foreach n, $(_SERVER_OBJS), $(SERVER_PATH)/$(n))
+SERVER_TARGET = server
+
+CLIENT_PATH = demo
+_CLIENT_OBJS = SimpleAnonCredClient.o
+CLIENT_OBJS = $(foreach n, $(_CLIENT_OBJS), $(CLIENT_PATH)/$(n))
+CLIENT_TARGET = client
+
+UTIL_PATH = demo
+_UTIL_OBJS = SimpleAnonCredUtils.o
+UTIL_OBJS = $(foreach n, $(_UTIL_OBJS), $(UTIL_PATH)/$(n))
+
+########################################
+
+all: thrift $(SERVER_TARGET) $(CLIENT_TARGET)
+
+thrift: service.thrift
+ thrift --gen cpp $<
+
+$(SERVER_TARGET): $(CRYPTO_OBJS) $(THRIFT_OBJS) $(UTIL_OBJS) $(SERVER_OBJS) $(SERVER_PATH)/SimpleAnonCredServer.cpp
+ $(CXX) $(CXX_FLAGS) $^ -o $@ $(CXX_LIBS)
+
+$(CLIENT_TARGET): $(CRYPTO_OBJS) $(THRIFT_OBJS) $(UTIL_OBJS) $(CLIENT_OBJS) $(CLIENT_PATH)/SimpleAnonCredClientDemo.cpp
+ $(CXX) $(CXX_FLAGS) $^ -o $@ $(CXX_LIBS)
+
+$(CURVE_PATH)/%.o: $(CURVE_PATH)/%.c
+ $(CC) $(CFLAGS) -c -o $@ $<
+
+$(VOPRF_PATH)/%.o: $(VOPRF_PATH)/%.c
+ $(CC) $(CFLAGS) -c -o $@ $<
+
+$(KDF_PATH)/%.o: $(KDF_PATH)/%.c
+ $(CC) $(CFLAGS) -c -o $@ $<
+
+$(DLEQPROOF_PATH)/%.o: $(DLEQPROOF_PATH)/%.c
+ $(CC) $(CFLAGS) -c -o $@ $<
+
+%.o: %.cpp
+ $(CXX) $(CXX_FLAGS) -c -o $@ $<
+
+.PHONY: clean
+clean:
+ rm -f $(CRYPTO_OBJS) $(THRIFT_OBJS)
+ rm -f $(SERVER_OBJS) $(CLIENT_OBJS) $(UTIL_OBJS)
+ rm -rf $(THRIFT_PATH)

README.md

@@ -0,0 +1,31 @@
+# Anonymous Credentials Service
+Anonymous Credentials Service (ACS) is a highly available, multitenant service that allows clients to authenticate in a de-identified manner. It enhances privacy and security while also being compute-conscious.
+
+[How Meta enables de-identified authentication at scale](https://engineering.fb.com/2022/03/30/security/de-identified-authentication-at-scale)
+
+## ACS library
+The Anonymous Credentials Service is built on top of VOPRFs (verifiable oblivious pseudorandom functions), blind signatures, and key derivation functions. A portable and extensible C library is provided in [`lib/`](lib/). See docstring or SimpleAnonCredService for examples.
+
+[libsodium](https://doc.libsodium.org/) is the only dependency for ACS library.
+
+## SimpleAnonCredService
+We have implemented a SimpleAnonCredService (server + client) in C++ for demonstration. The service is built with Apache Thrift 0.16. We run a protocol as follows:
+- (1) Client downloads primary public key from server. This primary public key is for validation of public key in step (2).
+- (2) Client gets public key for provided "attributes". The "attributes" can be any list of strings (e.g. use case names, date) that allowed by server.
+- (3) Client generates a token, blinds the token, sends the token to server. After autentication check, server signs the token and sends back to client. Client unblinds the signed token and verified with public key and proof.
+- (4) Client redeems the token. Server validates the secret and proceeds to business logic if the validation successes.
+
+Note that (1) is optional if the client does not need public key validation.
+
+## Build
+Dependencies: [libsodium](https://doc.libsodium.org/) and [Apache Thrift 0.16](https://thrift.apache.org/). To build, just run `make` in the root of repo.
+
+## Docker
+It might be easier to just try the service with Docker.
+
+- Create an ACS docker image: `docker build -t acs . --build-arg UBUNTU_VERSION=22.04`
+- Create a container with a running server: `docker run --rm --init --name acs-container acs`
+- Create a client in the same container and connect to the server: `docker exec acs-container client`
+
+## License
+ACS is MIT licensed, as found in the LICENSE file.