Skip to content
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

doc: improve Web Crypto headings related to ECC #41542

Closed

Conversation

tniessen
Copy link
Member

  • The heading "Elliptic curve key pairs" is much less specific than the code in the section with that title is. ECDSA is just one algorithm that uses elliptic curves. Unlike other crypto standards, Web Crypto does not represent ECC keys independent of the associated algorithm.
  • ED25519/ED448/X25519/X448 are not curves (the curve names are Curve25519 and Curve448), so remove the words "Elliptic curves" to avoid confusion. Again, these are specific algorithms.

@tniessen tniessen added doc Issues and PRs related to the documentations. webcrypto labels Jan 15, 2022
@nodejs-github-bot nodejs-github-bot added the crypto Issues and PRs related to the crypto subsystem. label Jan 15, 2022
@@ -48,7 +48,7 @@ async function generateAesKey(length = 256) {
}
```

#### Elliptic curve key pairs
#### ECDSA key pairs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer if the whole acronym was mentioned here. IIRC that's "Elliptic Curve Digital Signature Algorithm" but I am not sure.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could maybe use Elliptic Curve Digital Signature Algorithm (ECDSA), but it would make the heading very long and we also don't spell out slightly more commonly used acronyms (AES, RSA, HMAC, ...). Maybe we should add a sentence or two under each heading in a follow-up PR, explaining what algorithms the acronyms are referring to?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah or even just links to Wikipedia

@@ -66,7 +66,7 @@ async function generateEcKey(namedCurve = 'P-521') {
}
```

#### ED25519/ED448/X25519/X448 Elliptic curve key pairs
#### ED25519/ED448/X25519/X448 key pairs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if it would make sense to elaborate here but honestly if you don't know what ES25519 is before reading these docs it probably won't help and if you did it won't help either..

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@panva panva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works.

@tniessen
Copy link
Member Author

Landed in d0d8320, thanks for reviewing.

@tniessen tniessen closed this Jan 17, 2022
tniessen added a commit that referenced this pull request Jan 17, 2022
PR-URL: #41542
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Filip Skokan <[email protected]>
thedull pushed a commit to thedull/node that referenced this pull request Jan 18, 2022
PR-URL: nodejs#41542
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Filip Skokan <[email protected]>
BethGriggs pushed a commit that referenced this pull request Jan 25, 2022
PR-URL: #41542
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Filip Skokan <[email protected]>
Linkgoron pushed a commit to Linkgoron/node that referenced this pull request Jan 31, 2022
PR-URL: nodejs#41542
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Filip Skokan <[email protected]>
danielleadams pushed a commit that referenced this pull request Feb 26, 2022
PR-URL: #41542
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Filip Skokan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. webcrypto
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants