fix(sftp): pass original position to read() callback instead of internal cursorRead overflow cb position#1503
Open
jeffrson wants to merge 2 commits into
Open
fix(sftp): pass original position to read() callback instead of internal cursorRead overflow cb position#1503jeffrson wants to merge 2 commits into
jeffrson wants to merge 2 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1488
(I'm sorry - this is the same as #1489, but I had to change branches and so it was closed automatically by Github)
Problem
sftp.read(handle, buf, off, len, position, cb) passes the wrong value as the position argument to cb when len exceeds _maxReadLen. The internal field req.position is used both as a mutable cursor for sequential sub-reads and as the return value for the user callback — so the callback always receives the end-offset of the last sub-read instead of the original position.
Fix
Introduce req.origPosition to preserve the original value across sub-reads, analogous to the existing req.origOff pattern for the off argument.
Diff
off,
origOff: off,
...
cb: (err, data, nb) => {
...
});
Testing
Triggers reliably with any non-OpenSSH server and a read request > 31952 bytes
With OpenSSH servers the same bug occurs for requests > 260096 bytes (~254 KB)
Prior art
This was previously reported as part of #1171 (attached to a different bug). The PR also contains a test case demonstrating the failure.
And of course, as mentioned previously, it is the same as #1489