Enhance send to stream special files safely#308
Open
godwincod3s wants to merge 6 commits into
Open
Conversation
Added an opt‑in flag to send (the module Express uses under the hood). This way, developers can explicitly allow streaming of special files like /proc/*, The option defaults to false and returns zero-size files as before.
Since developers would want a easier way to access the /proc file on linux systems.
usage:
app.get('/download', (req, res) => {
res.download('/proc/meminfo', 'meminfo.txt', {
allowSpecialFiles: true // new opt‑in flag
});
});
Spins up a tiny HTTP server using send.
First test: with { allowSpecialFiles: true }, /proc/meminfo streams correctly and contains "MemTotal".
Second test: without the flag, the response is empty (current behavior).
Added documentation for allowSpecialFiles configuration.
Corrected the spelling of 'default' and clarified its meaning.
Moved 'allowSpecialFiles' section to a more appropriate location in the README.
Add support for special file handling option also added the default value for the allowSpecialFiles option.
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.
Add allowSpecialFiles option to support streaming pseudo‑files (e.g. /proc).
Summary
This PR introduces a new opt‑in option, allowSpecialFiles, to the send module. It addresses the issue where attempting to download pseudo‑files (e.g. /proc/meminfo on Linux) results in empty responses because fs.stat reports a size of 0.
Problem
Solution
Usage Example
Security Considerations
Tests Added