Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
node-sftp-server
Advanced tools
A simple interface to be able to implement an SFTP Server using Node.js. Based on excellent work by @mscdex - ssh2 and ssh2-streams. Without which none of this would be possible.
In all cases, this library will only ever perform a subset of what can be accomplished with ssh2. If there's something more advanced you need to do and this library won't support it, that one is probably the one to look at. And certainly pull requests would be welcome, too!
The easiest way to get the hang of this library is probably to look at the
server_example.js
to start with, until this documentation gets more fully
fleshed-out.
var SFTPServer=require('node-sftp-server');
var myserver=new SFTPServer("path_to_private_key_file");
This returns a new SFTPServer()
object, which is an EventEmitter. If the private
key is not specified, the constructor will try to use ssh_host_rsa_key
.
.listen(portnumber)
Listens for an SFTP client to connect to the server on this port.
connect
- passes along a simple context object which has -
You can call .reject()
to reject the connection, or call .accept(callback)
to work with the new connection. The callback will be passed a Session object
as its parameter.
end
- emitted when the user disconnects from the server.
This object is passed to you when you call .accept(callback)
- your callback
should expect to be passed a session object as a parameter. The session object
is an EventEmitter as well.
.on("realpath",path,callback)
- the server wants to determine the 'real' path
for some user. For instance, if a user, when they log in, is immediately deposited
into /home/<username>/
- you could implement that here. Invoke the callback
with the calculated path - e.g. callback("/home/"+username)
. TODO - Error
management here!
.on("stat",path,statkind,statresponder)
- on any of STAT, LSTAT, or FSTAT
requests (the type will be passed in "statkind"). Return the status using
statresponder({mode: , uid:, gid: size: atime:, mtime: })
. Or use any of the
error methods in ##Error Callbacks below
.on("readdir",path,directory_emitter)
- on a directory listing attempt, the
directory_emitter will keep emitting dir
messages with a responder
as a
parameter, allowing you to respond with responder.file(filename)
to return
a file entry in the directory, or responder.end()
if the directory listing
is complete.
.on("readfile",path,writable_stream)
- the client is attempting to read a file
from the server - place or pipe the contents of the file into the writable_stream
.
.on("writefile",path,readable_stream)
- the client is attempting to write a
file to the server - the readable_stream
corresponds to the actual file. You
may .pipe()
that into a writable stream of your own, or use it directly.
.on("delete",path,callback)
- the client wishes to delete a file. Respond with
callback.ok()
or callback.fail()
or any of the other error types
Many of the session events pass some kind of 'responder' or 'callback' object as a parameter. Those typically will have several error conditions that you can use to refuse the request -
responder.fail()
- general failure?responder.nofile()
- no such file or directoryresponder.denied()
- access deniedresponder.bad_message()
- protocol error; bad message (unusual)responder.unsupported()
- operation not supportedresponder.ok()
- successFAQs
Node.js SFTP Server bindings to implement your own SFTP Server
The npm package node-sftp-server receives a total of 777 weekly downloads. As such, node-sftp-server popularity was classified as not popular.
We found that node-sftp-server demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.