FTP Server in Node
This is a simple but very configurable FTP server. Notable features include:
fsmodule, so you can use any implementation, even on a per-user basis. This makes it possible for each user to have his/her own virtual file system, isolated from that of the system or other users.
npm install ftpd
See example code in
test.js
host is a string representation of the IP address clients use to connect to the FTP server. It's imperative that this actually reflects the remote IP the clients use to access the server, as this IP will be used in the establishment of PASV data connections. If this IP is not the one clients use to connect, you will see some strange behavior from the client side (hangs).
See
test.jsfor a simple example.
FtpServeraccepts the following options:
Both these need to be set - there are no defaults.
getInitialCwd: Gets the initial working directory for the user. Called after user is authenticated. This path is relative to the root directory. The user may escape their initial cwd.
function(username, [callback(err, path)])
Examples:
getInitialCwd: function(connection) { return "/" + connection.username; }
getInitialCwd: function(connection, callback) { var userDir = '/' + connection.username; fs.exists(userDir, function(exists) { if (exists) { callback(null, userDir); } else { fs.mkDir(userDir, function(err) { callback(err, userDir); }); } }); } // If the directory exists, callback immediately with that directory // If not, create the directory and callback possible error + directory
getRoot: Gets the root directory for the user. This directory has the path '/' from the point of view of the user. The user is not able to escape this directory.
function(connection, [callback(err, rootPath)])
Examples:
getRoot: function() { return process.cwd(); } // The users will now enter at the '/' level, which is the directory passed to getInitialCwd.
getRoot: function(connection, callback) { var rootPath = process.cwd() + '/' + connection.username; fs.exists(rootPath, function(exists) { if (exists) { callback(null, rootPath); } else { fs.mkDir(userDir, function(err) { if (err) { callback(null, '/'); // default to root } else { callback(err, rootPath); } }); } }); } // If the subdir exists, callback immediately with relative path to that directory // If not, create the directory, and callback relative path to the directory // Stupidly, instead of failing, we apparently want 'worst case' scenario to allow relative root.
useWriteFile: (default: false)
true, then files which the client uploads are buffered in memory and then written to disk using
writeFile.
false, files are written using writeStream.
useReadFile: (default: false)
true, then files which the client downloads are slurped using 'readFile'.
false, files are read using readStream.
uploadMaxSlurpSize: (default: unlimited)
useWriteFileis set to
true.
uploadMaxSlurpSizeis not set, then there is no limit on buffer size.
hideDotFiles: (default: false)
LISTcommands.
maxStatsAtOnce: (default: 5)
fs.statwhich will be made when processing a
LISTrequest.
filenameSortFunc: (default:
localeCompare)
sortmethod. Used to sort filenames for directory listings.
filenameSortMap: (default:
function (x) { return x.toUpperCase() })
false, filenames are unaltered.
dontSortFilenames: (default: false)
LISTand
NLSTcommands.
noWildcards: (default: false)
true, then
LISTand
NLSTtreat the characters
?and
*as literals instead of as wildcards.
allowedCommands: (default: undefined)
tlsOptions: (default: undefined)
optionsargument of
tls.createServer.
tlsOnly: (default: false)
true, and
tlsOptionsis also set, then the server will not allow logins over non-secure connections.
allowUnauthorizedTls: ?? I obviously set this to true when tlsOnly is on -someone needs to update this.
pasvPortRangeStart: (default: random?)
pasvPortRangeEnd: (default: random?)
Filesystem abstraction makes it possible to create an FTP server which interacts directly with a database rather than the actual filesystem.
The server raises a
command:passevent which is given
pass,
successand
failurearguments. On successful login,
successshould be called with a username argument. It may also optionally be given a second argument, which should be an object providing an implementation of the API for Node's
fsmodule.
The following must be implemented:
unlink
readdir
mkdir
open
close
rmdir
rename
stat→
{ mode, isDirectory(), size, mtime }
useWriteFileoption is not set or is false
createWriteStream: Returns a writable stream, requiring:
useWriteFileoption is set to 'true'
writeFile
useReadFileoption is not set or is false
createReadStream: Returns a readable stream, requiring:
useReadFileoption is set to 'true'
readFile
FtpServerhas
listenand
closemethods which behave as expected. It emits
closeand
errorevents.