Skip to content

buffer: add Buffer.harden() method #28439

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

Closed
ChALkeR wants to merge 9 commits into from
+117 −2
Closed

buffer: add Buffer.harden() method #28439

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e5d71cd
buffer: add Buffer.harden() method
ChALkeR Jun 26, 2019
cebb1d5
[squash] buffer: undo freezing Buffer.prototype
ChALkeR Jul 29, 2019
5a29ee6
[squash] buffer: add "strict" harden mode (default)
ChALkeR Jul 29, 2019
028b6ed
[squash] buffer: add more options (all enabled by default)
ChALkeR Jul 31, 2019
331a982
[squash] doc: add docs for Buffer.harden()
ChALkeR Jul 31, 2019
bd1b736
[squash] buffer: update a comment
ChALkeR Jul 31, 2019
9bc2bce
[squash] allow Buffer.harden() only in sync mode
ChALkeR Aug 2, 2019
97a956e
[squash] doc: label Buffer.harden as Experimental
ChALkeR Aug 21, 2019
587c8d0
[squash] Update doc/api/buffer.md
ChALkeR Aug 22, 2019
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
Prev Previous commit
Next Next commit
[squash] allow Buffer.harden() only in sync mode
  • Loading branch information
@ChALkeR
ChALkeR committed Aug 21, 2019
commit 9bc2bce00f3d80e7337314aa59966e64bf805857
5 changes: 3 additions & 2 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -954,8 +954,9 @@ This method has effect only of subsequent Buffer API usage, Buffer instances
created before `Buffer.harden()` is called are not affected.

Warning: for ecosystem compatibility and security reasons `Buffer.harden()` can
be called only once and only from the top-level application code. Attempting to
call it from a library in `node_modules` will throw.
be called only once and only from the top-level application code and only before
the first turn of the event loop. Attempting to call it asynchronously in
runtime or from a library in `node_modules` will throw.

By default, it enables mandratory zero fill, disables Buffer pooling, disables
deprecated unsafe Buffer API, freezes `Buffer` and `require('buffer')` objects.
Expand Down
6 changes: 6 additions & 0 deletions lib/buffer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,12 @@ Buffer.harden = function({
'Calling Buffer.harden() from dependencies is not supported.'
);
}
const perf_hooks = require('perf_hooks');
const stillSynchronous = perf_hooks.performance.nodeTiming.loopStart < 0;
if (!stillSynchronous) throw new ERR_ASSERTION(
'Buffer.harden() should be called only in synchronous mode, during app ' +
'startup. Calling Buffer.harden() asynchronously is not supported.'
);
Object.assign(hardened, {
applied: true,
zeroFill: Boolean(zeroFill),
Expand Down