1389025 - Editorial review for typos and grammar on Web_Crypto_API

Status: RESOLVED WONTFIX

(Developer Documentation Graveyard :: General, enhancement, P5)

Description

[ted.marynicz]

:: Developer Documentation Request

      Request Type: Correction
     Gecko Version: unspecified
 Technical Contact: 

:: Details

1. "A fundamental feature of this API is to allow the manipulation and storage of private and secret keys without the underlying bits of the key to be available to JavaScript."

Does "underlying bits" mean literally "bits" or does it mean "parts"?  Bits underlie all digital technology.

2. "key generation, the ability to create a cryptographically secure key, or key pair, without the use of base key, but using the available entropy of the local system."

Maybe "without the use of a base key"?

3. "When dealing with security, the whole system must be considered. In the case of the Web Crypto API, Web developers shouldn't consider only the security of the script, but the security of the connection to the server and the data this one may have in clear text. "

I don't understand that final part. "the data this one may have" Does "this one" refer to the server or something else - it is not clear. Is there a typo there? I can't suggest a correction.

4. "In order to avoid confusion, methods and properties of this interface are gone in browsers implementing the Web Crypto API"

"are gone in" could probably be better worded as "have been removed from".

5. "to verify that data has not been tampered by a third-party."

Would be better as "to verify that data has not been tampered with by a third-party."

Comment 1

[Eric Shepherd [:sheppy]]

Fortunately, MDN is a wiki and anyone can make changes to fix problems like these. For information on how to open an MDN account and make these changes (which I agree are all valid and needed corrections), see https://developer.mozilla.org/en-US/docs/MDN/Getting_started.

As for #3, I suspect the sentence is meant to end with something like "but the security of the connection to the server, because using Web Crypto over HTTP is not secure."

Comment 2

[ted.marynicz]

I realise it is a Wiki and have edited the other points earlier, but was hoping to elicit a reply from the original author on point 3. I have now incorporated your suggestion in to the article. Thanks.

Comment 3

[BMO Automation]

MDN Web Docs' bug reporting has now moved to GitHub. From now on, please file content bugs at https://github.com/mdn/sprints/issues/ and platform bugs at https://github.com/mdn/kuma/issues/.