doc,crypto: cleanup unlinked and self method references webcrypto.md · nodejs/node@5bfdc7e

@@ -653,7 +653,7 @@ added: v15.0.0

653653

* Type: {boolean}

654654655655

When `true`, the {CryptoKey} can be extracted using either

656-

`subtleCrypto.exportKey()` or `subtleCrypto.wrapKey()`.

656+

[`subtle.exportKey()`][] or [`subtle.wrapKey()`][].

657657658658

Read-only.

659659

@@ -845,7 +845,7 @@ changes:

845845

* Returns: {Promise} Fulfills with an {ArrayBuffer} upon success.

846846847847

Using the method and parameters specified in `algorithm` and the keying

848-

material provided by `key`, `subtle.decrypt()` attempts to decipher the

848+

material provided by `key`, this method attempts to decipher the

849849

provided `data`. If successful, the returned promise will be resolved with

850850

an {ArrayBuffer} containing the plaintext result.

851851

@@ -887,7 +887,7 @@ changes:

887887

<!--lint enable maximum-line-length remark-lint-->

888888889889

Using the method and parameters specified in `algorithm` and the keying

890-

material provided by `baseKey`, `subtle.deriveBits()` attempts to generate

890+

material provided by `baseKey`, this method attempts to generate

891891

`length` bits.

892892893893

When `length` is not provided or `null` the maximum number of bits for a given

@@ -929,12 +929,12 @@ changes:

929929

<!--lint enable maximum-line-length remark-lint-->

930930931931

Using the method and parameters specified in `algorithm`, and the keying

932-

material provided by `baseKey`, `subtle.deriveKey()` attempts to generate

932+

material provided by `baseKey`, this method attempts to generate

933933

a new {CryptoKey} based on the method and parameters in `derivedKeyAlgorithm`.

934934935-

Calling `subtle.deriveKey()` is equivalent to calling `subtle.deriveBits()` to

935+

Calling this method is equivalent to calling [`subtle.deriveBits()`][] to

936936

generate raw keying material, then passing the result into the

937-

`subtle.importKey()` method using the `deriveKeyAlgorithm`, `extractable`, and

937+

[`subtle.importKey()`][] method using the `deriveKeyAlgorithm`, `extractable`, and

938938

`keyUsages` parameters as input.

939939940940

The algorithms currently supported include:

@@ -962,7 +962,7 @@ changes:

962962

* `data` {ArrayBuffer|TypedArray|DataView|Buffer}

963963

* Returns: {Promise} Fulfills with an {ArrayBuffer} upon success.

964964965-

Using the method identified by `algorithm`, `subtle.digest()` attempts to

965+

Using the method identified by `algorithm`, this method attempts to

966966

generate a digest of `data`. If successful, the returned promise is resolved

967967

with an {ArrayBuffer} containing the computed digest.

968968

@@ -1039,7 +1039,7 @@ changes:

10391039

* Returns: {Promise} Fulfills with an {ArrayBuffer} upon success.

1040104010411041

Using the method and parameters specified by `algorithm` and the keying

1042-

material provided by `key`, `subtle.encrypt()` attempts to encipher `data`.

1042+

material provided by `key`, this method attempts to encipher `data`.

10431043

If successful, the returned promise is resolved with an {ArrayBuffer}

10441044

containing the encrypted result.

10451045

@@ -1229,7 +1229,7 @@ changes:

12291229

* `keyUsages` {string\[]} See [Key usages][].

12301230

* Returns: {Promise} Fulfills with a {CryptoKey} upon success.

123112311232-

The `subtle.importKey()` method attempts to interpret the provided `keyData`

1232+

The [`subtle.importKey()`][] method attempts to interpret the provided `keyData`

12331233

as the given `format` to create a {CryptoKey} instance using the provided

12341234

`algorithm`, `extractable`, and `keyUsages` arguments. If the import is

12351235

successful, the returned promise will be resolved with the created {CryptoKey}.

@@ -1290,7 +1290,7 @@ changes:

12901290

<!--lint enable maximum-line-length remark-lint-->

1291129112921292

Using the method and parameters given by `algorithm` and the keying material

1293-

provided by `key`, `subtle.sign()` attempts to generate a cryptographic

1293+

provided by `key`, this method attempts to generate a cryptographic

12941294

signature of `data`. If successful, the returned promise is resolved with

12951295

an {ArrayBuffer} containing the generated signature.

12961296

@@ -1336,11 +1336,11 @@ changes:

13361336

* Returns: {Promise} Fulfills with a {CryptoKey} upon success.

1337133713381338

In cryptography, "wrapping a key" refers to exporting and then encrypting the

1339-

keying material. The `subtle.unwrapKey()` method attempts to decrypt a wrapped

1339+

keying material. This method attempts to decrypt a wrapped

13401340

key and create a {CryptoKey} instance. It is equivalent to calling

1341-

`subtle.decrypt()` first on the encrypted key data (using the `wrappedKey`,

1341+

[`subtle.decrypt()`][] first on the encrypted key data (using the `wrappedKey`,

13421342

`unwrapAlgo`, and `unwrappingKey` arguments as input) then passing the results

1343-

in to the `subtle.importKey()` method using the `unwrappedKeyAlgo`,

1343+

to the [`subtle.importKey()`][] method using the `unwrappedKeyAlgo`,

13441344

`extractable`, and `keyUsages` arguments as inputs. If successful, the returned

13451345

promise is resolved with a {CryptoKey} object.

13461346

@@ -1405,7 +1405,7 @@ changes:

14051405

<!--lint enable maximum-line-length remark-lint-->

1406140614071407

Using the method and parameters given in `algorithm` and the keying material

1408-

provided by `key`, `subtle.verify()` attempts to verify that `signature` is

1408+

provided by `key`, this method attempts to verify that `signature` is

14091409

a valid cryptographic signature of `data`. The returned promise is resolved

14101410

with either `true` or `false`.

14111411

@@ -1446,12 +1446,12 @@ changes:

14461446

<!--lint enable maximum-line-length remark-lint-->

1447144714481448

In cryptography, "wrapping a key" refers to exporting and then encrypting the

1449-

keying material. The `subtle.wrapKey()` method exports the keying material into

1449+

keying material. This method exports the keying material into

14501450

the format identified by `format`, then encrypts it using the method and

14511451

parameters specified by `wrapAlgo` and the keying material provided by

1452-

`wrappingKey`. It is the equivalent to calling `subtle.exportKey()` using

1452+

`wrappingKey`. It is the equivalent to calling [`subtle.exportKey()`][] using

14531453

`format` and `key` as the arguments, then passing the result to the

1454-

`subtle.encrypt()` method using `wrappingKey` and `wrapAlgo` as inputs. If

1454+

[`subtle.encrypt()`][] method using `wrappingKey` and `wrapAlgo` as inputs. If

14551455

successful, the returned promise will be resolved with an {ArrayBuffer}

14561456

containing the encrypted key data.

14571457