Skip to content

feat: add followSymlinks option to restrict symlink traversal #310

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

Open
MD-Mushfiqur123 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add followSymlinks option to restrict symlink traversal #310

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 24 additions & 2 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,10 @@ function SendStream (req, path, options) {
this._root = opts.root
? resolve(opts.root)
: null

this._followSymlinks = opts.followSymlinks !== undefined
? Boolean(opts.followSymlinks)
: true
}

/**
Expand Down Expand Up @@ -601,6 +605,20 @@ SendStream.prototype.sendFile = function sendFile (path) {
var i = 0
var self = this

function checkSymlinks (p, stat, cb) {
if (!self._followSymlinks && self._root) {
fs.realpath(p, function onrealpath (err, resolvedPath) {
if (err) return self.onStatError(err)
if (resolvedPath.indexOf(self._root) !== 0) {
return self.error(403)
}
cb(p, stat)
})
} else {
cb(p, stat)
}
}

debug('stat "%s"', path)
fs.stat(path, function onstat (err, stat) {
var pathEndsWithSep = path[path.length - 1] === sep
Expand All @@ -612,7 +630,9 @@ SendStream.prototype.sendFile = function sendFile (path) {
if (stat.isDirectory()) return self.redirect(path)
if (pathEndsWithSep) return self.error(404)
self.emit('file', path, stat)
self.send(path, stat)
checkSymlinks(path, stat, function (p, st) {
self.send(p, st)
})
})

function next (err) {
Expand All @@ -629,7 +649,9 @@ SendStream.prototype.sendFile = function sendFile (path) {
if (err) return next(err)
if (stat.isDirectory()) return next()
self.emit('file', p, stat)
self.send(p, stat)
checkSymlinks(p, stat, function (resolvedPath, st) {
self.send(resolvedPath, st)
})
})
}
}
Expand Down