Refactor @web5/crypto to replace Web Crypto CryptoKey with JWK

[frankhinek]

Summary

This PR primarily focuses on swapping the key format used in the @web5/crypto package from the Web Crypto API CryptoKey to JOSE JSON Web Key (JWK).

Context

The majority of cryptography usage across the @web5 packages deals with JOSE objects and operations. As a consequence, the use of CryptoKey introduces significant overhead and degraded developer experience due to the frequent need to convert to/from JWK. Using JWK as the key format for all public APIs in the @web5/crypto package will improve these and other related issues.

Note

All other packages in web5-js continue to depend on the prior version of the crypto package (v0.2.2). While this PR was unavoidably large, breaking up the refactor of downstream packages will occur in a future PR.

Changes

@web5/crypto

• Replace all use of CryptoKey and byte array key formats in public APIs with JSON Web Key (JWK).
• Add bytesToPrivateKey(), bytesToPublicKey(), privateKeyToBytes(), and privateKeyToBytes() to align with the API used in web5-kt.
• All generateKey() methods now return a private key in JWK format rather than a key pair to align with the API used in web5-kt.
• Begin adding test vectors in the format defined in sdk-development repo that can be contributed and then consumed by this SDK.
• Rewrote tests to ensure 100% test coverage for the @web5/crypto package.
• Significantly improved documentation and usage examples for all crypto-primitive implementations.
• While not addressed in this PR, small changes were made to make it easier for the upcoming refactor to a common key management / crypto API across web5-kt, web5-js, and web5-rs SDKs.
• Bump cryptography dependencies
  • @noble/ciphers from 0.1.4 to 0.4.0
  • @noble/curves from 1.1.0 to 1.2.0
  • @noble/hashes from 1.3.1 to 1.3.2

@web5/identity-agent

• Fixed incorrect dependencies in package.json that were causing build failures.

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[github-actions]

TBDocs Report

✅ No errors or warnings

@web5/api

• Project entry file: packages/api/src/index.ts

---

Updated @ 2023-11-28T14:17:44.712Z - Commit: b14cdb4

[codecov]

Codecov Report

Merging #318 (d6b444d) into main (c417ba0) will increase coverage by 0.99%.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #318      +/-   ##
==========================================
+ Coverage   90.78%   91.77%   +0.99%     
==========================================
  Files          74       73       -1     
  Lines       14090    15759    +1669     
  Branches     1390     1448      +58     
==========================================
+ Hits        12791    14463    +1672     
+ Misses       1273     1270       -3     
  Partials       26       26              

Components	Coverage Δ
api	96.68% <ø> (+0.22%)	⬆️
common	95.00% <ø> (ø)
credentials	94.32% <ø> (ø)
crypto	100.00% <100.00%> (ø)
dids	88.75% <ø> (ø)
agent	88.07% <ø> (ø)
identity-agent	56.81% <ø> (ø)
proxy-agent	58.43% <ø> (ø)
user-agent	55.22% <ø> (ø)