Support for Ed(X)25519

[olegbespalov]

What?

Even though original WebCrypto API doesn't include support of the Curve25519, but many of webcrypto implementation does w3c/webcrypto#362

Even WebPlatfrom test suit tests this support, which led us to patch https://github.com/grafana/k6/blob/master/internal/js/modules/k6/webcrypto/tests/wpt-patches/WebCryptoAPI__generateKey__failures.js.patch

Draft can be found https://wicg.github.io/webcrypto-secure-curves/

From the Golang's perspective, support also looks good since we have packages:

• https://pkg.go.dev/crypto/[email protected]
• https://pkg.go.dev/golang.org/x/[email protected]/curve25519

Why?

Seems like support of this Curve25519 is demanded, so having it in k6 makes k6's implementation more attractive and useful for customers.

[McMastS]

Hey @olegbespalov! I'd like to take this issue on, I'll hopefully have a draft PR up by the end of the weekend.

[olegbespalov]

Hey @McMastS !

Sure, go ahead, thanks for doing that!

Just in case, I've updated the description to reflect the actual path (we've got back-merged extensions code to k6).

• https://github.com/grafana/k6/blob/master/internal/js/modules/k6/webcrypto/tests/wpt-patches/WebCryptoAPI__generateKey__failures.js.patch

Don't hesitate to ask if you need any help or want to discuss something!

P.S. I've assigned you to the issue for now just to highlight that the issue has activity.

Cheers!

[McMastS]

Hey @olegbespalov! I've uncommented the X25519 and Ed25519 lines in that test but I can't actually get the go test to fail locally.

My allTestVectors now looks like this in internal/js/modules/k6/webcrypto/tests/wpt/WebCryptoAPI/generateKey/successes.js:

    var allTestVectors = [ // Parameters that should work for generateKey
        {name: "AES-CTR",  resultType: CryptoKey, usages: ["encrypt", "decrypt", "wrapKey", "unwrapKey"], mandatoryUsages: []},
        {name: "AES-CBC",  resultType: CryptoKey, usages: ["encrypt", "decrypt", "wrapKey", "unwrapKey"], mandatoryUsages: []},
        {name: "AES-GCM",  resultType: CryptoKey, usages: ["encrypt", "decrypt", "wrapKey", "unwrapKey"], mandatoryUsages: []},
        // {name: "AES-KW",   resultType: CryptoKey, usages: ["wrapKey", "unwrapKey"], mandatoryUsages: []},
        {name: "HMAC",     resultType: CryptoKey, usages: ["sign", "verify"], mandatoryUsages: []},
        {name: "RSASSA-PKCS1-v1_5", resultType: "CryptoKeyPair", usages: ["sign", "verify"], mandatoryUsages: ["sign"]},
        {name: "RSA-PSS",  resultType: "CryptoKeyPair", usages: ["sign", "verify"], mandatoryUsages: ["sign"]},
        {name: "RSA-OAEP", resultType: "CryptoKeyPair", usages: ["encrypt", "decrypt", "wrapKey", "unwrapKey"], mandatoryUsages: ["decrypt", "unwrapKey"]},
        {name: "ECDSA",    resultType: "CryptoKeyPair", usages: ["sign", "verify"], mandatoryUsages: ["sign"]},
        {name: "ECDH",     resultType: "CryptoKeyPair", usages: ["deriveKey", "deriveBits"], mandatoryUsages: ["deriveKey", "deriveBits"]},
        {name: "Ed25519",  resultType: "CryptoKeyPair", usages: ["sign", "verify"], mandatoryUsages: ["sign", "wrapKey"]},
        // {name: "Ed448",    resultType: "CryptoKeyPair", usages: ["sign", "verify"], mandatoryUsages: ["sign"]},
        {name: "X25519",   resultType: "CryptoKeyPair", usages: ["deriveKey", "deriveBits"], mandatoryUsages: ["deriveKey", "deriveBits"]},
        // {name: "X448",     resultType: "CryptoKeyPair", usages: ["deriveKey", "deriveBits"], mandatoryUsages: ["deriveKey", "deriveBits"]},
    ];

The go test passes in about 20 seconds so it is running something, and if I throw an error on line 64 of that same file then the test "passes" in less than a second so it's definitely getting cut short. Is there any Sobek setup or something I'm missing to get these tests to propagate the JS error to the Go test?

[olegbespalov]

@McMastS you're absolutely right 🤔 If I uncomment these lines locally, the tests currently pass without any failures.

But the simple script like:

import { crypto } from "k6/experimental/webcrypto";

export default async function () {
  const key = await crypto.subtle.generateKey(
    {
      name: "Ed25519"
    },
    true,
    ["sign", "verify"]
  );

  console.log(JSON.stringify(key));
}

Fails with the:

ERRO[0000] Uncaught (in promise) NotSupportedError: algorithm "ED25519" doesn't support (in implementation) operation "generateKey"  executor=per-vu-iterations scenario=default

It's probably some degradation (maybe in the tests happened), but I need to check deeper, why it so, and I've opened a separated issue for a better visibility of the problem.

In theory, the work on this issue still could be continued since the key generation test case is simple enough, but doesn't actually check if the functionality there. But there are tests in internal/js/modules/k6/webcrypto/tests/wpt/WebCryptoAPI/sign_verify with entrypoint eddsa_curve25519.https.any.js that could help validate implementation.

[McMastS]

Thanks for looking into it! Good to know I wasn't going crazy hahaha. I'll keep working on it without those tests and verify with manual Javascript scripts for now.