refactor: add @cloudflare/voprf-ts/facade and pass crypto as arg everywhere #49

sublimator · 2023-10-10T13:41:33Z

Supercedes #44

Pass Around Crypto As Arg Everywhere

Oprf.Group -> hash(...) doesn't belong here! and WebCrypto doesn't support shake256
Oprf.Crypto -> circular dependencies!
CryptoImpl.provider -> better, but ick, a global?
Explicit optional provider passing (crypto?: CryptoProvider) -> tests failing, where??
Required (crypto: CryptoProvider)-> fixed, but damn that's verbose and breaks api
--> !!CryptoProvider via...Rest syntax -> nice, can configure Rest as [CryptoProvider] or [CryptoProvider?]!! <---
But why? -> Can make sure passing around the provider everywhere
But why? -> Oprf.withConfig({provider: CryptoNoble) and old Oprf work in same process
So what? -> In any case ...

Toggle this setting here and try the npm run examples in both modes
Fails to build when it's required - added to ci

@cloudflare/voprf-ts/facade, backwards compat impl of #46

Named imports for examples

Uses tsx to execute examples/bench which supports runtime compilerOptions.paths to provide more readily modifiable examples.

Breaking changes

Minimum changes needed for: cloudflare/privacypass-ts#15
Also see: Port to facade

diff --git a/src/priv_verif_token.ts b/src/priv_verif_token.ts
index 08c95c9..8809078 100644
--- a/src/priv_verif_token.ts
+++ b/src/priv_verif_token.ts
@@ -9,7 +9,6 @@ import {
     VOPRFClient,
     VOPRFServer,
     generateKeyPair,
-    type DLEQParams,
     type Group,
     type SuiteID,
     type HashID,
@@ -31,7 +30,6 @@ export interface VOPRFExtraParams {
     Ns: number;
     Nk: number;
     hash: HashID;
-    dleqParams: DLEQParams;
 }
 
 const VOPRF_SUITE = Oprf.Suite.P384_SHA384;
@@ -44,12 +42,6 @@ const VOPRF_EXTRA_PARAMS: VOPRFExtraParams = {
     Ns: VOPRF_GROUP.scalarSize(),
     Nk: Oprf.getOprfSize(VOPRF_SUITE),
     hash: VOPRF_HASH,
-    dleqParams: {
-        gg: VOPRF_GROUP,
-        hashID: VOPRF_HASH,
-        hash: Oprf.Crypto.hash,
-        dst: '',
-    },
 } as const;
 
 // Token Type Entry Update:
@@ -82,6 +74,7 @@ export class TokenRequest2 {
     //   } TokenRequest;
 
     tokenType: number;
+
     constructor(
         public readonly truncatedTokenKeyId: number,
         public readonly blindedMsg: Uint8Array,
@@ -257,7 +250,7 @@ export class Client2 {
             throw new Error('no token request was created yet');
         }
 
-        const proof = DLEQProof.deserialize(VOPRF.dleqParams, tokRes.evaluateProof);
+        const proof = DLEQProof.deserialize(VOPRF.group.id, tokRes.evaluateProof);
         const evaluateMsg = VOPRF.group.desElt(tokRes.evaluateMsg);
         const evaluation = new Evaluation(Oprf.Mode.VOPRF, [evaluateMsg], proof);
         const [authenticator] = await this.finData.vClient.finalize(

TODO

Full document Security.md that summarizes the current status of both back-ends (@armfazh)

src/facade/types.ts

sublimator · 2023-10-12T01:51:54Z

package.json

+    "examples": "tsx examples/index.ts",
+    "examples:facade": "tsx examples/facade/index.ts",
+    "lint": "eslint .",
+    "bench": "tsx bench/index.ts",


using tsx for examples/bench - CI does build:others

sublimator · 2023-10-12T01:56:48Z

examples/tsconfig.json

-    ],
+    "compilerOptions": {
+        "paths": {
+            "@cloudflare/voprf-ts": ["../src/index.js"],


makes examples easily copy/pastable - execute via tsx to support the paths at runtime

sublimator · 2023-10-12T02:00:20Z

src/sjcl/index.js

-        return sjcl;
-    });
-}
+// if(typeof module !== 'undefined' && module.exports){


this seems unneeded - was done to stop tsx complaining

sublimator · 2023-10-12T02:13:49Z

src/groupTypes.ts

@@ -98,6 +87,8 @@ export interface Group extends SerializationHelpers {
 }

 export interface GroupCons {
-    fromID(id: GroupID): Group
+    get(id: GroupID): Group


idempotent/get/cached semantics

src/facade/impl.ts

sublimator · 2023-10-13T02:25:42Z

On mobile - I guess using assert means you need a bundler / polyfill

sublimator · 2023-10-14T06:41:31Z

src/facade/types.ts

+// OPRF protocol only specifies encodings for these elements
+export type OPRFElement = Elt | Scalar | DLEQProof
+
+// So we only encode elements, and leave packet encoding to application layer


Key point. Codec class and Server/Client wrappers wouldn't be needed if serialize() serialized objects to objects of same shape, where leaf nodes were Uint8Array(Uint8Array|DLEQProof|Elt|Scalar) | number (ModeID). This would be a more versatile format for a low level library where applications may include elements in their own packet formats.

Ideally it would be possible to only need the facade to implement the privacy pass protocol or similar, so any packets that are going on the wire, will just be an object of serialized elements.

FinalizeData keeps the "wet" EvaluationRequest, so it doesn't need to pointlessly dehydrate/decode serialized blinded Elts.

armfazh

lgtm, could you please squash the commits

sublimator · 2023-12-22T06:08:26Z

@armfazh

Nice! Beginning to feel a lot like xmas!

sublimator · 2024-01-15T04:37:31Z

@thibmeu @armfazh

Bump? :)

thibmeu · 2024-01-15T07:52:30Z

Merging now. It should be part of a future release. Thanks for the change @sublimator, and @armfazh for the review!

sublimator · 2024-01-15T07:54:25Z

Awesome :)

sublimator · 2024-01-15T10:58:13Z

And indeed, thank you @armfazh

sublimator commented Oct 11, 2023

View reviewed changes

src/facade/types.ts Outdated Show resolved Hide resolved

sublimator mentioned this pull request Oct 11, 2023

Refactor to avoid use of global #46

Closed

sublimator changed the title ~~refactor: crypto provider arg optionality switch~~ refactor: add @cloudflare/voprf-ts/facade and pass crypto as arg everywhere Oct 12, 2023

sublimator commented Oct 12, 2023

View reviewed changes

sublimator marked this pull request as ready for review October 12, 2023 02:49

armfazh reviewed Oct 13, 2023

View reviewed changes

src/facade/impl.ts Outdated Show resolved Hide resolved

sublimator closed this Oct 13, 2023

sublimator reopened this Oct 14, 2023

sublimator commented Oct 14, 2023

View reviewed changes

armfazh approved these changes Dec 21, 2023

View reviewed changes

feat: @cloudflare/voprf-ts/facade using CryptoProvider

53881f1

sublimator force-pushed the nd-switch-flipping-2023-10-10 branch from c6f1f3f to 53881f1 Compare December 22, 2023 06:06

thibmeu merged commit 492e8b7 into cloudflare:main Jan 15, 2024
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: add @cloudflare/voprf-ts/facade and pass crypto as arg everywhere #49

refactor: add @cloudflare/voprf-ts/facade and pass crypto as arg everywhere #49

sublimator commented Oct 10, 2023 •

edited

Loading

sublimator Oct 12, 2023 •

edited

Loading

sublimator Oct 12, 2023 •

edited

Loading

sublimator Oct 12, 2023

sublimator Oct 12, 2023

sublimator commented Oct 13, 2023 via email

sublimator Oct 14, 2023 •

edited

Loading

armfazh left a comment

sublimator commented Dec 22, 2023

sublimator commented Jan 15, 2024

thibmeu commented Jan 15, 2024 •

edited

Loading

sublimator commented Jan 15, 2024

sublimator commented Jan 15, 2024

refactor: add @cloudflare/voprf-ts/facade and pass crypto as arg everywhere #49

refactor: add @cloudflare/voprf-ts/facade and pass crypto as arg everywhere #49

Conversation

sublimator commented Oct 10, 2023 • edited Loading

Pass Around Crypto As Arg Everywhere

@cloudflare/voprf-ts/facade, backwards compat impl of #46

Named imports for examples

Breaking changes

TODO

sublimator Oct 12, 2023 • edited Loading

Choose a reason for hiding this comment

sublimator Oct 12, 2023 • edited Loading

Choose a reason for hiding this comment

sublimator Oct 12, 2023

Choose a reason for hiding this comment

sublimator Oct 12, 2023

Choose a reason for hiding this comment

sublimator commented Oct 13, 2023 via email

sublimator Oct 14, 2023 • edited Loading

Choose a reason for hiding this comment

armfazh left a comment

Choose a reason for hiding this comment

sublimator commented Dec 22, 2023

sublimator commented Jan 15, 2024

thibmeu commented Jan 15, 2024 • edited Loading

sublimator commented Jan 15, 2024

sublimator commented Jan 15, 2024

sublimator commented Oct 10, 2023 •

edited

Loading

sublimator Oct 12, 2023 •

edited

Loading

sublimator Oct 12, 2023 •

edited

Loading

sublimator Oct 14, 2023 •

edited

Loading

thibmeu commented Jan 15, 2024 •

edited

Loading