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.

Sign up for GitHub

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
wants to merge 1 commit into from
Closed

doc: improve Web Crypto headings related to ECC #41542

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/api/webcrypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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


```js
const { subtle } = require('crypto').webcrypto;
Expand All @@ -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.

#41542 (comment)


```js
const { subtle } = require('crypto').webcrypto;
Expand Down