See the version list below for details.
NuGet\Install-Package SFTPServer -Version 1.3.1
dotnet add package SFTPServer --version 1.3.1
<PackageReference Include="SFTPServer" Version="1.3.1" />
paket add SFTPServer --version 1.3.1
#r "nuget: SFTPServer, 1.3.1"
// Install SFTPServer as a Cake Addin #addin nuget:?package=SFTPServer&version=1.3.1 // Install SFTPServer as a Cake Tool #tool nuget:?package=SFTPServer&version=1.3.1
This library is intended to be hosted in an SSH deamon; this can be done by editting the
sshd_config file (usually in
/etc/ssh/ or, for Windows, in
%PROGRAMDATA%\ssh) and pointing it to your own host executable.
sshd_config you'll find the
Subsystem entry which can be pointed to any executable:
# override default of no subsystems #Subsystem sftp sftp-server.exe #Subsystem sftp internal-sftp Subsystem sftp /path/to/your/sftphost.exe
The way SFTP works is that first an SSH connection is established; once that is done and a request is made for sftp, SSH will launch the configured executable under the connected user's account. All communication is done over
SFTPServer class takes 2
Streams and optionally an
ISFTPHandler on which the SFTP commands will be invoked. This package comes with a
DefaultSFTPHandler which provides basic I/O on the hosts's filesystem (based on a rootdirectory), but it should be pretty easy to implement your own
ISFTPHandler so you can, for example, implement a virtual filesystem.
SFTPHost project in this repository demonstrates how to simply build an executable that hosts an
SFTPServer instance. A new
SFTPServer is launched by the SSH service for each connection.
ISFTPHandler should be pretty straightforward, simply implement the
ISFTPHandler interface. Exceptions you might want to throw should, ideally, be inherited from the
HandlerException. This library comes with a few built-in exceptions in the
SFTP.Exceptions namespace. Exceptions that are not inherited from the
HandlerException will be returned to the client as
SSH_FX_FAILURE). For an example implementation you can have a look at the
Known issues and limitations
Note that this library only implements V3; higher versions are not supported. Clients connecting with a higher version will be negotiated down to V3.
SymLinkcommand has been implemented with the
targetpathswapped; We may or may not interpret the RFC incorrectly (Update: We didn't) or the clients which were used to test the
SymLinkcommand (WinSCP, Cyberduck and the 'native' sftp commandline executable) had the arguments swapped. The
ReadLinkmethods are only available from .Net 6.0 upwards.
DefaultSFTPHandlerDOES NOT take particular much care of path canonicalization or mitigations against path traversion. When used in an untrusted environment extra care should be taken to ensure safety.
DefaultSFTPHandlerDOES NOT make a noteworthy effort to return correct POSIX file permissions, nor does it support setting permissions.
Licensed under MIT license. See LICENSE for details.
|.NET||net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows|
|.NET Core||netcoreapp3.0 netcoreapp3.1|
This package is not used by any NuGet packages.
This package is not used by any popular GitHub repositories.