Skip to content

fs: too strict range check on 'mode' parameter #20498

Closed
Closed
fs: too strict range check on 'mode' parameter#20498
Assignees
joyeecheung
Labels
confirmed-bugIssues and PRs for confirmed bugs.errorsIssues and PRs related to JavaScript errors originating in Node.js core.fsIssues and PRs related to file-system APIs and the fs module.

Description

@rubycon
rubycon
opened on May 3, 2018
  • Version: 10.0.0
  • Platform: MacOS 10.12.6 (Sierra)
  • Subsystem: fs

Since version 10, function like fs.chmod() or fs.mkdir() check if their mode parameter is below o777 throwing a RangeError exception if the condition isn't satisfied.
This requirement is too strict as the mode parameter can often be above o777 if it need to set the S_ISUID or S_ISGID bits.

Furthermore this range check break several node packages (e.g. graceful-fs used by over 1400 other packages) in a very common scenario:
A program wants to create a new file/directory with the same rights that a reference file/directory. Often the mode attribute of fs.Stats object is directly passed to fs.chmod() or fs.mkdir(). However the fs.Stats.mode is always above o777 (e.g. o100644) since it also contains the file type bits.

Classic POSIX version of chmod or mkdir seems to handle those kind a values without complaining by discarding the irrelevant bits instead of throwing an error. Why do Node need to be so brutal about it?

Activity

  1. arantes555 commented on May 3, 2018

    @arantes555
    arantes555
    on May 3, 2018

    Seeing the same issue here. Breaking graceful-fs actually breaks vinyl-fs, so it actually breaks gulp (yes, even gulp@4).

    In my case, I only see the issue when running on CI...

  2. joyeecheung commented on May 4, 2018

    @joyeecheung
    joyeecheung
    on May 4, 2018
    Member

    cc @targos @BridgeAR We discussed about unifying this check in #19973 (review) I am leaning towards masking off the relevant bits since that's what the underlying POSIX API usually does.

  3. joyeecheung
    added
    fsIssues and PRs related to file-system APIs and the fs module.
    errorsIssues and PRs related to JavaScript errors originating in Node.js core.
    on May 4, 2018

  4. joyeecheung commented on May 4, 2018

    @joyeecheung
    joyeecheung
    on May 4, 2018
    Member

    Also cc @jasnell the check is added in #17334

  5. joyeecheung
    self-assigned this
    on May 4, 2018

  6. jasnell commented on May 4, 2018

    @jasnell
    jasnell
    on May 4, 2018
    Member

    I'm good with masking off the bits and relaxing the check :)

  7. jasnell commented on May 4, 2018

    @jasnell
    jasnell
    on May 4, 2018
    Member

    Also, it's obvious we don't have good test coverage for this particular case so it would be good to expand that a bit.

  8. addaleax
    added
    confirmed-bugIssues and PRs for confirmed bugs.
    v10.x
    on May 4, 2018

  9. BridgeAR commented on May 4, 2018

    @BridgeAR
    BridgeAR
    on May 4, 2018
    Member

    I also agree that masking off seems the right thing to do.

  10. demurgos commented on May 6, 2018

    @demurgos
    demurgos
    on May 6, 2018
    Contributor

    Hi,
    I just wanted to mention that I also encountered this bug. It happens when I use Gulp (graceful-fs) on Gitlab CI:

    RangeError [ERR_OUT_OF_RANGE]: The value of "mode" is out of range. Received 33206
    at Object.fs.fchmod (fs.js:1024:11)
    at Object.fchmod (/builds/demurgos/node-devkit/node_modules/graceful-fs/polyfills.js:237:17)
    at mode (/builds/demurgos/node-devkit/node_modules/vinyl-fs/lib/file-operations.js:237:10)
    at onStat (/builds/demurgos/node-devkit/node_modules/vinyl-fs/lib/file-operations.js:227:14)
    at /builds/demurgos/node-devkit/node_modules/graceful-fs/polyfills.js:287:18
    at FSReqWrap.oncomplete (fs.js:150:5)

  11. alanonthegit commented on May 7, 2018

    @alanonthegit
    alanonthegit
    on May 7, 2018

    I'm having the same issue above with Gulp 4(graceful-fs) in my local build. What can I do to fix this?

  12. seeker5084 commented on May 8, 2018

    @seeker5084
    seeker5084
    on May 8, 2018

    same here.

  13. seeker5084 commented on May 10, 2018

    @seeker5084
    seeker5084
    on May 10, 2018

    graceful-fs's RangeError [ERR_OUT_OF_RANGE] solved by #20588.
    Great work. Thanks!

  14. 52 remaining items

  15. delagen commented on Jun 14, 2018

    @delagen
    delagen
    on Jun 14, 2018

    When it will be in master? 10.4.1 released but still
    RangeError [ERR_OUT_OF_RANGE]: The value of "mode" is out of range. Received 33206
    at Object.fs.fchmod (fs.js:1058:11)

  16. joyeecheung commented on Jun 14, 2018

    @joyeecheung
    joyeecheung
    on Jun 14, 2018
    Member

    @delagen It's on v10.x-staging now, should be available in the next release.

  17. delagen commented on Jun 14, 2018

    @delagen
    delagen
    on Jun 14, 2018

    @joyeecheung This was broken for about 7 releases of 10.x branch. Speed of fixes make me sad (

  18. bnoordhuis commented on Jun 14, 2018

    @bnoordhuis
    bnoordhuis
    on Jun 14, 2018
    Member

    Comments like yours make me sad. It adds nothing except another notification email to 100+ people.

  19. calebeby
    added a commit that references this issue on Jun 20, 2018

    Update Node.js to v10.5.0 (#194)

    ccda9df
  20. Xanewok
    added a commit that references this issue on Mar 28, 2019

    Bump Node.js to 10.5

    53b9b34
  21. ParthKolekar
    added a commit that references this issue on Oct 18, 2019

    Downgrade node to v8 to work around nodejs/node#20498

    9a4fa81
  22. sjarmak
    added a commit that references this issue on Jul 27, 2026

    lib: mask mode_t type of arguments with 0o777

    a18e130
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

confirmed-bugIssues and PRs for confirmed bugs.errorsIssues and PRs related to JavaScript errors originating in Node.js core.fsIssues and PRs related to file-system APIs and the fs module.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions