• Stars
    star
    187
  • Rank 199,172 (Top 5 %)
  • Language
    TypeScript
  • License
    Apache License 2.0
  • Created almost 3 years ago
  • Updated 6 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Proves knowledge of an ECDSA-P256 signature under one of many public keys that are stored in a list.

NPM NPM DOI

NPM

zkp-ecdsa: A Typescript Implementation of ZKAttest

ZKAttest proofs knowledge of an ECDSA-P256 signature under one of many public keys that are stored in a list without revealing which public key was used to sign the message.

Usage Development Cite This Future Work

Usage

Ready to use ZKAttest proofs, follow this short guideline.

Step 1

Suppose you already have a signature of a message using ECDSA (P-256). Otherwise, create signature as follows:

// Message to be signed.
const msg = new TextEncoder().encode('kilroy was here');

// Generate a keypair for signing.
const keyPair = await crypto.subtle.generateKey(
    { name: 'ECDSA', namedCurve: 'P-256' },
    true, [ 'sign', 'verify'],
);

// Sign a message as usual.
const signature = new Uint8Array(
    await crypto.subtle.sign(
        { name: 'ECDSA', hash: 'SHA-256' },
        keyPair.privateKey, msg,
    )
);

Step 2

Then, insert your public key in a ring of keys. This allows to hide your public key behind the ring of keys. (In this example, assume the list was generated with valid keys).

import { keyToInt } from '@cloudflare/zkp-ecdsa'

// Add the public key to an existing ring of keys,
const listKeys = [BigInt(4), BigInt(5), BigInt(6), BigInt(7), BigInt(8)];
listKeys.unshift(await keyToInt(keyPair.publicKey));

Step 3

Now, create a ZKAttest proof of knowledge showing that

  • the signature was generated using the private key, AND
  • the public key is in the ring.

This proof does not reveal which public key was used during signing.

import { generateParamsList, proveSignatureList } from '@cloudflare/zkp-ecdsa'

// Create a zero-knowledge proof about the signature.
const params = generateParamsList();
const msgHash = new Uint8Array(await crypto.subtle.digest('SHA-256', msg));
const zkAttestProof = await proveSignatureList(
    params,
    msgHash,
    signature,
    keyPair.publicKey,
    0, // position of the public key in the list.
    listKeys
);

Step 4

After this, everyone can verify the proof is valid, which means the message was signed by the holder of an ECDSA key pair, but without identifying exactly which one of the keys in the ring was used to produce the proof. Do not disclose the original signature as it is already embedded inside the proof.

import { verifySignatureList } from '@cloudflare/zkp-ecdsa'
// Verify that zero-knowledge proof is valid.
const valid = await verifySignatureList(params, msgHash, listKeys, zkAttestProof)
console.assert(valid == true)

That's all.


Citation

This software library is part of the article "ZKAttest: Ring and Group Signatures for Existing ECDSA Keys" published at Selected Areas in Cryptography (SAC 2021) authored by Armando Faz Hernández, Watson Ladd, and Deepak Maram.

A copy of this paper can be downloaded at research.cloudflare.com or at the IACR ePrint 2021/1183.

To cite this library, use one of the following formats and update the version and date you accessed to this project.

APA Style

Faz-Hernández, A., Ladd, W., Maram, D. (2021). ZKAttest: Ring and Group Signatures for Existing ECDSA Keys. In: AlTawy, R., Hülsing, A. (eds) Selected Areas in Cryptography. SAC 2021. Available at https://github.com/cloudflare/zkp-ecdsa. v0.2.5 Accessed Nov 2022.

BibTex Source

@inproceedings{zkattest,
  doi       = {10.1007/978-3-030-99277-4_4},
  title     = {ZKAttest: Ring and Group Signatures for Existing ECDSA Keys},
  author    = {Faz-Hernández, Armando and Ladd, Watson and Maram, Deepak},
  booktitle = {Selected Areas in Cryptography},
  editor    = {AlTawy, Riham and Hülsing, Andreas},
  publisher = {Springer International Publishing},
  address   = {Cham},
  isbn      = {978-3-030-99277-4},
  pages     = {68--83},
  month     = {oct},
  year      = {2021},
  note      = {Available at \url{https://github.com/cloudflare/zkp-ecdsa}.
               v0.2.5 Accessed Nov 2022},
}

CFF Style

Find attached a CITATION.cff file.


Development

Task NPM scripts
Installing $ npm ci
Building $ npm run build
Unit Tests $ npm run test
Benchmarking $ npm run bench
Flamegraph Profile $ npm run flame
Code Linting $ npm run lint
Code Formating $ npm run format
Bundling Library $ npm run bundle

Future Work

  • Accelerate proof verification.
  • Implement the proof in other programming languages.
  • Remove dependency on native Bignum.

License

The project is licensed under the Apache 2.0 License

More Repositories

1

quiche

🥧 Savoury implementation of the QUIC transport protocol and HTTP/3
Rust
8,654
star
2

cfssl

CFSSL: Cloudflare's PKI and TLS toolkit
Go
8,049
star
3

cloudflared

Cloudflare Tunnel client (formerly Argo Tunnel)
Go
5,870
star
4

boringtun

Userspace WireGuard® Implementation in Rust
Rust
5,768
star
5

workerd

The JavaScript / Wasm runtime that powers Cloudflare Workers
C++
5,680
star
6

flan

A pretty sweet vulnerability scanner
Python
3,910
star
7

miniflare

🔥 Fully-local simulator for Cloudflare Workers. For the latest version, see https://github.com/cloudflare/workers-sdk/tree/main/packages/miniflare.
TypeScript
3,656
star
8

wrangler-legacy

🤠 Home to Wrangler v1 (deprecated)
Rust
3,233
star
9

cloudflare-docs

Cloudflare’s documentation
CSS
2,578
star
10

tableflip

Graceful process restarts in Go
Go
2,549
star
11

workers-rs

Write Cloudflare Workers in 100% Rust via WebAssembly
Rust
2,182
star
12

workers-sdk

⛅️ Home to Wrangler, the CLI for Cloudflare Workers®
TypeScript
2,047
star
13

wildebeest

Wildebeest is an ActivityPub and Mastodon-compatible server
TypeScript
2,026
star
14

gokey

A simple vaultless password manager in Go
Go
1,836
star
15

ebpf_exporter

Prometheus exporter for custom eBPF metrics
C
1,639
star
16

lol-html

Low output latency streaming HTML parser/rewriter with CSS selector-based API
Rust
1,388
star
17

redoctober

Go server for two-man rule style file encryption and decryption.
Go
1,373
star
18

cf-ui

💎 Cloudflare UI Framework
JavaScript
1,297
star
19

sslconfig

Cloudflare's Internet facing SSL configuration
1,287
star
20

cloudflare-go

Go library for the Cloudflare v4 API
Go
1,246
star
21

foundations

Cloudflare's Rust service foundations library.
Rust
1,163
star
22

hellogopher

Hellogopher: "just clone and make" your conventional Go project
Makefile
1,153
star
23

production-saas

(WIP) Example SaaS application built in public on the Cloudflare stack!
TypeScript
1,099
star
24

bpftools

BPF Tools - packet analyst toolkit
Python
1,087
star
25

cloudflare-blog

Cloudflare Blog code samples
C
1,065
star
26

wrangler-action

🧙‍♀️ easily deploy cloudflare workers applications using wrangler and github actions
TypeScript
993
star
27

templates

A collection of starter templates and examples for Cloudflare Workers and Pages
JavaScript
979
star
28

circl

CIRCL: Cloudflare Interoperable Reusable Cryptographic Library
Go
970
star
29

wirefilter

An execution engine for Wireshark-like filters
Rust
913
star
30

pingora

A library for building fast, reliable and evolvable network services.
Rust
896
star
31

next-on-pages

CLI to build and develop Next.js apps for Cloudflare Pages
TypeScript
845
star
32

utahfs

UtahFS is an encrypted storage system that provides a user-friendly FUSE drive backed by cloud storage.
Go
805
star
33

cf-terraforming

A command line utility to facilitate terraforming your existing Cloudflare resources.
Go
793
star
34

workers-chat-demo

JavaScript
779
star
35

pint

Prometheus rule linter/validator
Go
772
star
36

Stout

A reliable static website deploy tool
Go
749
star
37

goflow

The high-scalability sFlow/NetFlow/IPFIX collector used internally at Cloudflare.
Go
729
star
38

unsee

Alert dashboard for Prometheus Alertmanager
Go
710
star
39

terraform-provider-cloudflare

Cloudflare Terraform Provider
Go
704
star
40

mitmengine

A MITM (monster-in-the-middle) detection tool. Used to build MALCOLM:
Go
690
star
41

workers-graphql-server

🔥Lightning-fast, globally distributed Apollo GraphQL server, deployed at the edge using Cloudflare Workers
JavaScript
635
star
42

react-gateway

Render React DOM into a new context (aka "Portal")
JavaScript
569
star
43

xdpcap

tcpdump like XDP packet capture
Go
567
star
44

cloudflare-php

PHP library for the Cloudflare v4 API
PHP
566
star
45

ahocorasick

A Golang implementation of the Aho-Corasick string matching algorithm
Go
541
star
46

lua-resty-logger-socket

Raw-socket-based Logger Library for Nginx (based on ngx_lua)
Perl
477
star
47

nginx-google-oauth

Lua module to add Google OAuth to nginx
Lua
425
star
48

gokeyless

Go implementation of the keyless protocol
Go
420
star
49

worker-typescript-template

ʕ •́؈•̀) TypeScript template for Cloudflare Workers
TypeScript
416
star
50

golibs

Various small golang libraries
Go
402
star
51

stpyv8

Python 3 and JavaScript interoperability. Successor To PyV8 (https://github.com/flier/pyv8)
C++
388
star
52

sandbox

Simple Linux seccomp rules without writing any code
C
385
star
53

mmap-sync

Rust library for concurrent data access, using memory-mapped files, zero-copy deserialization, and wait-free synchronization.
Rust
380
star
54

speedtest

Component to perform network speed tests against Cloudflare's edge network
JavaScript
371
star
55

mmproxy

mmproxy, the magical PROXY protocol gateway
C
370
star
56

pages-action

JavaScript
355
star
57

rustwasm-worker-template

A template for kick starting a Cloudflare Worker project using workers-rs. Write your Cloudflare Worker entirely in Rust!
Rust
350
star
58

workers-types

TypeScript type definitions for authoring Cloudflare Workers.
TypeScript
350
star
59

cobweb

COBOL to WebAssembly compiler
COBOL
345
star
60

cloudflare-ingress-controller

A Kubernetes ingress controller for Cloudflare's Argo Tunnels
Go
344
star
61

lua-resty-cookie

Lua library for HTTP cookie manipulations for OpenResty/ngx_lua
Perl
340
star
62

svg-hush

Make it safe to serve untrusted SVG files
Rust
333
star
63

boring

BoringSSL bindings for the Rust programming language.
Rust
330
star
64

node-cloudflare

Node.js API for Client API
JavaScript
319
star
65

cfweb3

JavaScript
309
star
66

workerskv.gui

(WIP) A cross-platform Desktop application for exploring Workers KV Namespace data
Svelte
307
star
67

JSON.is

Open-source documentation for common JSON formats.
JavaScript
302
star
68

sqlalchemy-clickhouse

Python
299
star
69

cloudflare.github.io

Cloudflare ❤️ Open Source
CSS
298
star
70

json-schema-tools

Packages for working with JSON Schema and JSON Hyper-Schema
JavaScript
296
star
71

chatgpt-plugin

Build ChatGPT plugins with Cloudflare's Developer Platform 🤖
JavaScript
290
star
72

tls-tris

crypto/tls, now with 100% more 1.3. THE API IS NOT STABLE AND DOCUMENTATION IS NOT GUARANTEED.
Go
283
star
73

gortr

The RPKI-to-Router server used at Cloudflare
Go
283
star
74

react-modal2

💭 Simple modal component for React.
JavaScript
279
star
75

doom-wasm

Chocolate Doom WebAssembly port with WebSockets support
C
273
star
76

keyless

Cloudflare's Keyless SSL Server Reference Implementation
C
272
star
77

isbgpsafeyet.com

Is BGP safe yet?
HTML
262
star
78

go

Go with Cloudflare experimental patches
Go
260
star
79

dog

Durable Object Groups
TypeScript
255
star
80

kv-asset-handler

Routes requests to KV assets
TypeScript
244
star
81

mod_cloudflare

C
243
star
82

tubular

BSD socket API on steroids
C
242
star
83

semver_bash

Semantic Versioning in Bash
Shell
238
star
84

cloudflare-rs

Rust library for the Cloudflare v4 API
Rust
236
star
85

cfssl_trust

CFSSL's CA trust store repository
Go
226
star
86

doca

A CLI tool that scaffolds API documentation based on JSON HyperSchemas.
JavaScript
224
star
87

pmtud

Path MTU daemon - broadcast lost ICMP packets on ECMP networks
C
218
star
88

alertmanager2es

Receives HTTP webhook notifications from AlertManager and inserts them into an Elasticsearch index for searching and analysis
Go
218
star
89

itty-router-openapi

OpenAPI 3 and 3.1 schema generator and validator for Cloudflare Workers
TypeScript
218
star
90

origin-ca-issuer

Go
216
star
91

worker-template-router

JavaScript
216
star
92

cloudflare-docs-engine

A documentation engine built on Gatsby, powering Cloudflare’s docs https://github.com/cloudflare/cloudflare-docs
JavaScript
215
star
93

python-worker-hello-world

Python hello world for Cloudflare Workers
JavaScript
209
star
94

saffron

The cron parser powering Cron Triggers on Cloudflare Workers
Rust
207
star
95

Cloudflare-WordPress

A Cloudflare plugin for WordPress
PHP
204
star
96

certmgr

Automated certificate management using a CFSSL CA.
Go
202
star
97

collapsify

Collapsify inlines all the resources of a page into a single document
JavaScript
200
star
98

worker-speedtest-template

JavaScript
195
star
99

har-sanitizer

TypeScript
192
star
100

shellflip

Graceful process restarts in Rust
Rust
183
star