Add `webauthn-pcd` package #134

rrrliu · 2023-04-05T16:49:52Z

Closes #114

Demo:

Screen.Recording.2023-04-23.at.11.51.38.PM.mov

ichub

it would also be great if you could pipe this all the way through consumer-client to show it working end-to-end!

packages/webauthn-pcd/README.md

packages/webauthn-pcd/src/WebAuthnPCD.ts

ichub

getting very close, I'm excited for this one!

ichub · 2023-04-27T15:02:38Z

README.md

@@ -123,6 +123,7 @@ Some of these packages are used to share development configuration between the d
 - [`@pcd/semaphore-group-pcd`](packages/semaphore-group-pcd): a pcd which wraps the [Semaphore](https://semaphore.appliedzkp.org/docs/introduction) protocol, which allows PCD-consuming applications to consume and generate Semaphore proofs.
 - [`@pcd/semaphore-identity-pcd`](packages/semaphore-identity-pcd): a 'self-evident' PCD, representing the public and private components of a Semaphore identity
 - [`@pcd/semaphore-signature-pcd`](packages/semaphore-signature-pcd): like `@pcd/semaphore-group-pcd`, but with a more specific purpose of using the semaphore protocol to 'sign' a particular string message on behalf of a particular revealed commitment id.
+- [`@pcd/webauthn-pcd`](packages/webauthn-pcd): a pcd that can be used to attest to a valid attestatinos from [WebAuthn](https://webauthn.guide/) hardware devices, such as facial scanners, fingerprints, Yubikeys, and more.


there's a typo here: attestatinos

also maybe a better description could be something like 'a pcd that can be used to make claims about WebAuthn attestations ...'

ichub · 2023-04-27T15:02:57Z

apps/consumer-client/package.json

@@ -16,8 +16,11 @@
    "@pcd/pcd-types": "0.4.2",
    "@pcd/semaphore-group-pcd": "0.4.2",
    "@pcd/semaphore-identity-pcd": "0.4.2",
+    "@pcd/webauthn-pcd": "*",


change this to use the actual package version

ichub · 2023-04-27T15:03:42Z

apps/consumer-client/pages/examples/add-pcd.tsx

@@ -149,3 +160,55 @@ async function addIdentityPCD() {

  sendPassportRequest(url);
 }
+
+async function addWebAuthnPCD() {


verbosely commenting this function and each step may be nice

ichub · 2023-04-27T15:04:05Z

apps/consumer-client/pages/examples/webauthn-proof.tsx

@@ -0,0 +1 @@
+export default function Page() {}


delete this file

ichub · 2023-04-27T15:04:13Z

apps/passport-client/package.json

@@ -19,6 +19,7 @@
    "@pcd/pcd-types": "0.4.2",
    "@pcd/semaphore-group-pcd": "0.4.2",
    "@pcd/semaphore-identity-pcd": "0.4.2",
+    "@pcd/webauthn-pcd": "*",


use the correct package version

ichub · 2023-04-27T15:09:22Z

packages/webauthn-pcd/package.json

+    "@types/expect": "^24.3.0",
+    "@types/json-bigint": "^1.0.1",
+    "@types/mocha": "^10.0.1",
+    "@types/sinon": "^10.0.14",


as a consequence of the problem described in the above comment, @types/ packages and typescript itself should be a dependency rather than a dev dependency.

ichub · 2023-04-27T15:09:47Z

packages/webauthn-pcd/src/CardBody.tsx

+      <p>
+        This PCD represents a signature proof in the context of a WebAuthn
+        credential. In other words, this is a ZK proof that a particular
+        credential keypair signed a particular challenge.
+      </p>


ichub · 2023-04-27T15:11:52Z

packages/webauthn-pcd/src/WebAuthnPCD.ts

+  /**
+   * The WebAuthn credential information associated with this PCD.
+   * Storing bytes as Base64 encoded string to ensure serializability.
+   */


One thing to note is that in order for a PCD to be serializable, the claim an proof don't actually have to be trivially serializable - since serializing and deserializing them is taken care of the correspondingly named functions.

ichub · 2023-04-27T15:12:31Z

packages/webauthn-pcd/src/WebAuthnPCD.ts

+  name: WebAuthnPCDTypeName,
+  prove,
+  verify,
+  serialize,
+  deserialize,
+  renderCardBody: WebAuthnCardBody,
+  getDisplayOptions,


ichub · 2023-04-27T15:13:35Z

packages/webauthn-pcd/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "@pcd/tsconfig/server.json",


I think this should extend @pcd/tsconfig/ts-library.json instead

ichub · 2023-04-27T15:14:08Z

Also, you should rebase to fix merge conflicts.

ichub · 2023-05-05T09:26:11Z

I'm getting a test failure on this PR. Please make sure to run all three of

yarn build
yarn lint
yarn test

Before submitting a PR

@pcd/webauthn-pcd:test: cache bypass, force executing 89243b224146e66d
@pcd/webauthn-pcd:test: $ ts-mocha --exit test/**/*.spec.ts
@pcd/webauthn-pcd:test: (node:64099) ExperimentalWarning: Custom ESM Loaders is an experimental feature and might change at any time
@pcd/webauthn-pcd:test: (Use `node --trace-warnings ...` to show where the warning was created)
@pcd/webauthn-pcd:test:
@pcd/webauthn-pcd:test: Error [ERR_REQUIRE_ESM]: require() of ES Module /Users/ivanchub/Projects/zupass/node_modules/@simplewebauthn/browser/dist/bundle/index.js from /Users/ivanchub/Projects/zupass/packages/webauthn-pcd/test/WebAuthnPCD.spec.ts not supported.
@pcd/webauthn-pcd:test: Instead change the require of index.js in /Users/ivanchub/Projects/zupass/packages/webauthn-pcd/test/WebAuthnPCD.spec.ts to a dynamic import() which is available in all CommonJS modules.
@pcd/webauthn-pcd:test:     at require.extensions.<computed> [as .js] (/Users/ivanchub/Projects/zupass/node_modules/ts-node/dist/index.js:851:20)
@pcd/webauthn-pcd:test:     at Object.<anonymous> (/Users/ivanchub/Projects/zupass/packages/webauthn-pcd/test/WebAuthnPCD.spec.ts:54:36)
@pcd/webauthn-pcd:test:     at m._compile (/Users/ivanchub/Projects/zupass/node_modules/ts-mocha/node_modules/ts-node/dist/index.js:327:29)
@pcd/webauthn-pcd:test:     at m._compile (/Users/ivanchub/Projects/zupass/node_modules/ts-node/dist/index.js:857:29)
@pcd/webauthn-pcd:test:     at require.extensions.<computed> (/Users/ivanchub/Projects/zupass/node_modules/ts-node/dist/index.js:859:16)
@pcd/webauthn-pcd:test:     at require.extensions.<computed> [as .ts] (/Users/ivanchub/Projects/zupass/node_modules/ts-mocha/node_modules/ts-node/dist/index.js:329:16)
@pcd/webauthn-pcd:test: error Command failed with exit code 1.

rrrliu · 2023-05-11T06:55:08Z

I'm getting a test failure on this PR. Please make sure to run all three of

yarn build
yarn lint
yarn test

Before submitting a PR

@pcd/webauthn-pcd:test: cache bypass, force executing 89243b224146e66d
@pcd/webauthn-pcd:test: $ ts-mocha --exit test/**/*.spec.ts
@pcd/webauthn-pcd:test: (node:64099) ExperimentalWarning: Custom ESM Loaders is an experimental feature and might change at any time
@pcd/webauthn-pcd:test: (Use `node --trace-warnings ...` to show where the warning was created)
@pcd/webauthn-pcd:test:
@pcd/webauthn-pcd:test: Error [ERR_REQUIRE_ESM]: require() of ES Module /Users/ivanchub/Projects/zupass/node_modules/@simplewebauthn/browser/dist/bundle/index.js from /Users/ivanchub/Projects/zupass/packages/webauthn-pcd/test/WebAuthnPCD.spec.ts not supported.
@pcd/webauthn-pcd:test: Instead change the require of index.js in /Users/ivanchub/Projects/zupass/packages/webauthn-pcd/test/WebAuthnPCD.spec.ts to a dynamic import() which is available in all CommonJS modules.
@pcd/webauthn-pcd:test:     at require.extensions.<computed> [as .js] (/Users/ivanchub/Projects/zupass/node_modules/ts-node/dist/index.js:851:20)
@pcd/webauthn-pcd:test:     at Object.<anonymous> (/Users/ivanchub/Projects/zupass/packages/webauthn-pcd/test/WebAuthnPCD.spec.ts:54:36)
@pcd/webauthn-pcd:test:     at m._compile (/Users/ivanchub/Projects/zupass/node_modules/ts-mocha/node_modules/ts-node/dist/index.js:327:29)
@pcd/webauthn-pcd:test:     at m._compile (/Users/ivanchub/Projects/zupass/node_modules/ts-node/dist/index.js:857:29)
@pcd/webauthn-pcd:test:     at require.extensions.<computed> (/Users/ivanchub/Projects/zupass/node_modules/ts-node/dist/index.js:859:16)
@pcd/webauthn-pcd:test:     at require.extensions.<computed> [as .ts] (/Users/ivanchub/Projects/zupass/node_modules/ts-mocha/node_modules/ts-node/dist/index.js:329:16)
@pcd/webauthn-pcd:test: error Command failed with exit code 1.

Sorry should be fixed now! Ended up using jest over mocha because mocha had issues with using / mocking ESM libraries (e.g. @simplewebauthn/browser) -- hope that's all good. Build and lint also pass.

ichub

I think this is good now!!! Finally :D

ichub reviewed Apr 5, 2023

View reviewed changes

packages/webauthn-pcd/README.md Outdated Show resolved Hide resolved

packages/webauthn-pcd/src/WebAuthnPCD.ts Outdated Show resolved Hide resolved

packages/webauthn-pcd/src/WebAuthnPCD.ts Outdated Show resolved Hide resolved

ichub marked this pull request as draft April 5, 2023 17:39

rrrliu force-pushed the rrrliu/webauthn-pcd branch 2 times, most recently from 45ea552 to d0fccda Compare April 26, 2023 07:26

rrrliu changed the title ~~[wip] Add webauthn-pcd package~~ Add webauthn-pcd package Apr 26, 2023

rrrliu marked this pull request as ready for review April 26, 2023 07:26

rrrliu requested a review from ichub April 26, 2023 07:26

ichub reviewed Apr 27, 2023

View reviewed changes

rrrliu force-pushed the rrrliu/webauthn-pcd branch from 059ab37 to a3f4db4 Compare April 30, 2023 23:48

rrrliu requested a review from ichub May 4, 2023 16:20

rrrliu added 12 commits May 9, 2023 00:37

add webauthn-pcd package

9852c24

pr comments

188f82b

proving example consumer-client

bf3c826

tests

3a2c7aa

remove jest

c08d29e

update lockfiles

deaaf3b

pr comments

8898f68

readme fixes

8a4ff88

comments

ac49c88

fix build

764a9f1

use jest

287e940

versions

51ece36

rrrliu force-pushed the rrrliu/webauthn-pcd branch from ef09b6e to 51ece36 Compare May 9, 2023 09:02

remove unnecessary mocha and sinon

1a7d636

rrrliu added 2 commits May 16, 2023 15:15

Merge branch 'main' into rrrliu/webauthn-pcd

8f826b8

fix build

ce86b1b

ichub approved these changes May 17, 2023

View reviewed changes

ichub merged commit 5d8b398 into proofcarryingdata:main May 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `webauthn-pcd` package #134

Add `webauthn-pcd` package #134

rrrliu commented Apr 5, 2023 •

edited

Loading

ichub left a comment

ichub left a comment

ichub Apr 27, 2023

ichub Apr 27, 2023

ichub Apr 27, 2023

ichub Apr 27, 2023

ichub Apr 27, 2023

ichub Apr 27, 2023

ichub Apr 27, 2023

ichub Apr 27, 2023

ichub Apr 27, 2023

ichub Apr 27, 2023

ichub commented Apr 27, 2023

ichub commented May 5, 2023 •

edited

Loading

rrrliu commented May 11, 2023

ichub left a comment

Add webauthn-pcd package #134

Add webauthn-pcd package #134

Conversation

rrrliu commented Apr 5, 2023 • edited Loading

ichub left a comment

Choose a reason for hiding this comment

ichub left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ichub commented Apr 27, 2023

ichub commented May 5, 2023 • edited Loading

rrrliu commented May 11, 2023

ichub left a comment

Choose a reason for hiding this comment

Add `webauthn-pcd` package #134

Add `webauthn-pcd` package #134

rrrliu commented Apr 5, 2023 •

edited

Loading

ichub commented May 5, 2023 •

edited

Loading