doc,crypto: add null length to crypto.subtle.deriveBits · nodejs/node@70f5502 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 633
• Pull requests 755
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 70f5502

Browse filesBrowse the repository at this point in the historyBrowse files

panva

authored and

danielleadams

committed

doc,crypto: add null length to crypto.subtle.deriveBits

PR-URL: #44876 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

1 parent daf3152 commit 70f5502
Copy full SHA for 70f5502

1 file changed

+12-4Lines changed: 12 additions & 4 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • webcrypto.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/webcrypto.md‎

Copy file name to clipboardExpand all lines: doc/api/webcrypto.md

+12-4Lines changed: 12 additions & 4 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -562,16 +562,24 @@ changes:
562	562
563	563	* `algorithm`: {AlgorithmIdentifier|EcdhKeyDeriveParams|HkdfParams|Pbkdf2Params}
564	564	* `baseKey`: {CryptoKey}
565		- * `length`: {number}
	565	+ * `length`: {number|null}
566	566	* Returns: {Promise} containing {ArrayBuffer}
567	567
568	568	<!--lint enable maximum-line-length remark-lint-->
569	569
570	570	Using the method and parameters specified in `algorithm` and the keying
571	571	material provided by `baseKey`, `subtle.deriveBits()` attempts to generate
572		- `length` bits. The Node.js implementation requires that `length` is a
573		- multiple of `8`. If successful, the returned promise will be resolved with
574		- an {ArrayBuffer} containing the generated data.
	572	+ `length` bits.
	573	+
	574	+ The Node.js implementation requires that when `length` is a
	575	+ number it must be multiple of `8`.
	576	+
	577	+ When `length` is `null` the maximum number of bits for a given algorithm is
	578	+ generated. This is allowed for the `'ECDH'`, `'X25519'`[^1], and `'X448'`[^1]
	579	+ algorithms.
	580	+
	581	+ If successful, the returned promise will be resolved with an {ArrayBuffer}
	582	+ containing the generated data.
575	583
576	584	The algorithms currently supported include:
577	585

0 commit comments

Comments

0 (0)