-
Notifications
You must be signed in to change notification settings - Fork 77
RFC adding third party Ed25519, HPKE, and CBOR libs #208
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
edb3a4a
Create additional_cypto_cbor_libs.md
JensenPaul 31edd1d
clarify note on transpiling
JensenPaul e78ffac
add usage details
JensenPaul cb6ff54
add example APIs
JensenPaul d236bb8
Update additional_cypto_cbor_libs.md
JensenPaul 606ed05
Update additional_cypto_cbor_libs.md
JensenPaul 4c0957d
use markdown link instead of footnotes
JensenPaul c3d0435
We also need Python HPKE & CBOR libraries
JensenPaul da4e514
Switch from CC0 licensed Ed25519 library to MIT licensed one.
JensenPaul File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# RFC 208: additional crypto and CBOR libraries | ||
|
||
## Summary | ||
|
||
Several new web APIs require additional cryptography and CBOR libraries to | ||
properly test. These libraries are to support cryptography and the CBOR | ||
protocols not otherwise supported in JavaScript or Python, namely Ed25519, | ||
HPKE, and CBOR. There are open source libraries commonly available that | ||
implement these protocols and have compatible licenses. This RFC proposes | ||
adding such libraries to the tools/ directory so that web-platform-tests may | ||
exercise and verify proper compatible implementations of these new web APIs. | ||
|
||
## Details | ||
|
||
We're proposing adding these libraries (or some very similar ones) to the | ||
tools/ directory: | ||
JensenPaul marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
An Ed25519 Python implementation: | ||
https://github.com/pyca/ed25519/blob/main/ed25519.py | ||
JensenPaul marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The Ed25519 library is intended to be used by test code running on wptserve that may receive an Ed25519 private key and message to sign that message, or a public key and signature to verify that signature. | ||
|
||
An HPKE JavaScript implementation: | ||
https://github.com/dajiaji/hpke-js | ||
JensenPaul marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
A CBOR JavaScript implementation: | ||
https://github.com/paroga/cbor-js/blob/master/cbor.js | ||
JensenPaul marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The HPKE and CBOR libraries are used by test code to decrypt and decode data coming from JavaScript APIs to verify their contents, and used by test code to encode and encrypt response data. | ||
|
||
## Risks | ||
|
||
Users of these libraries may need to update them from time to time if new | ||
functionality or fixes are required. This is likely not a big risk. | ||
|
||
The HPKE library proposed may require inclusion of some other dependent | ||
libraries and uses deno to build into a single JavaScript file. Perhaps | ||
it's simplest to commit the single transpiled JavaScript file. | ||
JensenPaul marked this conversation as resolved.
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.