https://github.com/cloudflare/privacypass-config

Development and deployment CLI for Cloudflare Privacy Pass implementation
https://github.com/cloudflare/privacypass-config

authentication cli cryptography privacy-pass token typescript

Last synced: 3 months ago
JSON representation

Development and deployment CLI for Cloudflare Privacy Pass implementation

• Host: GitHub
• URL: https://github.com/cloudflare/privacypass-config
• Owner: cloudflare
• License: other
• Created: 2024-01-02T19:12:32.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-10-01T16:32:57.000Z (3 months ago)
• Last Synced: 2024-10-04T21:41:28.612Z (3 months ago)
• Topics: authentication, cli, cryptography, privacy-pass, token, typescript
• Language: TypeScript
• Homepage:
• Size: 41 KB
• Stars: 4
• Watchers: 11
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# privacypass-config

This service allows you to start a Privacy Pass stack locally: an attester, an origin, and an issuer. It leverages Cloudflare repositories.

## Quick start

With node.js 20+

* Install

```shell

npm install

```

* Develop

```shell

npm run start -- dev --config ./examples/git.config.yaml

```

* Deploy

```shell

npm run start -- deploy --config ./examples/git.config.yaml --service issuer

```

* Test end-to-end (only support issuer)

```shell

npm run start -- test --config ./examples/testE2E.config.yaml --service issuer

```

## Config

Example config files are available in [./examples](./examples). You need to place one in the root folder with the name `config.yaml`. For instance, `cp examples/git.config.yaml config.yaml`.

The configuration can be a file, a url, or a git. In the case of a file or a git, the local port can be specified.

```yaml

services:

  attester:

    git: "https://github.com/cloudflare/privacypass-attester"

    port: "8788"

  issuer:

  	url: "https://pp-issuer-public.research.cloudflare.com"

  origin:

  	file: "./privacypass-origin"

  	port: "8789"

config:

  directory: "dist"

```

## Features

* Load the above yaml configuration

* Clone repos if they don't exist

* Start services on their respective port. This imply configuring them if needed (issuer needs a key rotation at start)

## Next features

* Started privacypass-browser-extension in a headless browser