Node FTP Server forked and modified to be included with ShinobiCCTV.
fs module, so you can use any implementation,
npm install ftpd
sample/test.js
sample/test.js for a simple example. FtpServer accepts the following options:
getInitialCwd: Gets the initial working directory for the user. Called after user is authenticated.
function(username, [callback(err, path)])
js
getInitialCwd: function(connection) {
return "/" + connection.username;
}
`
- Usage with callback:
`js
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
`
- Typical cases where you would want/need the callback involve retrieving configurations from external datasources and suchlike.
- 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.
- Pattern: function(connection, [callback(err, rootPath)])
- Arguments:
- connection (object): the connection for which to get root
- callback (function, optional):
- Examples:
`js
getRoot: function() {
return process.cwd();
}
// The users will now enter at the '/' level, which is the directory passed to getInitialCwd.
`
- Usage with callback:
`js
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.
`
- Typical cases where you would want/need the callback involve retrieving configurations from external datasources and suchlike.
- Additionally, you may want to provide emulation of a path, for instance /users/(username)/ftproot.
##### File/handling Configurations
- useWriteFile: _(default: false)_
- If set to true, then files which the client uploads are buffered in memory and then written to disk using writeFile.
- If false, files are written using writeStream.
- useReadFile: _(default: false)_
- If set to true, then files which the client downloads are slurped using 'readFile'.
- If false, files are read using readStream.
- uploadMaxSlurpSize: _(default: unlimited)_
- Determines the maximum file size (in bytes) for which uploads are buffered in memory before being written to disk.
- Has an effect only if useWriteFile is set to true.
- If uploadMaxSlurpSize is not set, then there is no limit on buffer size.
- hideDotFiles: _(default: false)_
- Hides files beginning with a dot (UNIX hidden files) on LIST commands.
- maxStatsAtOnce: _(default: 5)_
- The maximum number of concurrent calls to fs.stat which will be
made when processing a LIST request.
- filenameSortFunc: _(default: localeCompare)_
- A function which can be used as the argument of an array's sort method. Used to sort filenames for directory listings.
See [https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array/sort] for more info.
- filenameSortMap: _(default: function (x) { return x.toUpperCase() })_
- A function which is applied to each filename before sorting.
- If set to false, filenames are unaltered.
- dontSortFilenames: _(default: false)_
- If this is set, then filenames are not sorted in responses to the LIST and NLST commands.
- noWildcards: _(default: false)_
- If set to true, then LIST and NLST treat the characters ? and * as literals instead of as wildcards.
##### Command configuration
- allowedCommands: _(default: undefined)_
- List of strings, the server will respond to only commands contained in this list, all other commands will result in a 502 unimplemented error.
##### Connectivity settings
- tlsOptions: _(default: undefined)_
- If this is set, the server will allow explicit TLS authentication.
- Value should be a dictionary which is suitable as the options argument of tls.createServer.
- tlsOnly: _(default: false)_
- If this is set to true, and tlsOptions is 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?)_
- Integer, specifies the lower-bound port (min port) for creating PASV connections
- pasvPortRangeEnd: _(default: random?)_
- Integer, specifies the upper-bound port (max port) for creating PASV connections
Filesystem Abstraction
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:pass event which is given pass, success and
failure arguments. On successful login, success should 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 fs
module.
The following must be implemented:
- unlink
- readdir
- mkdir
- open
- close
- rmdir
- rename
- stat →
- specific object properties: { mode, isDirectory(), size, mtime }
- if useWriteFile option is not set or is false
- createWriteStream: _Returns a writable stream, requiring:_
- events: 'open', 'error', 'finish'
- functions: 'write', 'end'
- properties: 'bytesWritten'
- if useWriteFile option is set to 'true'
- writeFile
- if useReadFile option is not set or is false
- createReadStream: _Returns a readable stream, requiring:_
- events: 'error', 'data', 'end'
- functions: 'destroy'
- if useReadFile option is set to 'true'
- readFile
FtpServer has listen and close methods which behave as expected. It
emits close and error` events.