Green End SFTP Server
=====================
This is an SFTP server supporting up to protocol version 6. It is
possible to use it as a drop-in replacement for the OpenSSH server.
Requirements
------------
This software runs under Linux, Mac OS X and FreeBSD. It may work
on other UNIX platforms.
Installation
------------
The general procedure is:
./configure
make # builds software and runs tests
make install # probably as root
See INSTALL for generic instructions. Local configure options include:
--enable-reversed-symlink
Some (but annoyingly not all) SFTP clients get the arguments to
the symlink operation the wrong way round. This option
reverses the server's interpretation of the arguments so that
such clients can be made to work (while breaking correctly
written clients).
--enable-warnings-as-errors
Enable treatment of warnings-as-errors. Developers should use
this but end users probably don't care.
You will need iconv and readline libraries.
It's best to run 'make check' before installing, but this requires
Python (see http://www.python.org/) and the Paramiko SSH module
(see http://www.lag.net/paramiko/) to be installed.
Status
------
This server is currently experimental and still under development.
Don't trust your critical data to it. The code has an extensive and
growing test suite (invoke 'make check' to run it) but bugs may yet
remain.
The code is written to be secure against malicious clients but not
currently tested against malicious clients. In the typical usage
pattern for an SFTP server this is academic: why bother exploiting a
SFTP server bug when you can log in as the same user?
However it is also possible to arrange for the SFTP server to run on
a security boundary, for instance listening directly on a TCP port
or running under a login that is only allowed to run the SFTP
server.
Until such time as the test suite is expanded to include actively
hostile clients, it is not recommended that this server be used in
such configurations without some additional form of protection
against malicious use.
Online Resources
----------------
Mailing lists:
http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
- discussion of the server (and others), bug reports, etc
http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
- announcements of new versions
Home page:
http://www.greenend.org.uk/rjk/sftpserver
To get the latest source (to within 24 hours):
git clone git://github.com/ewxrjk/sftpserver.git
Bugs, Patches, etc
------------------
Please send bug reports, improvements, etc either to
sgo-software-discuss (see URL above).
If you send patches, please use "diff -u" format.
Licence
-------
Copyright (C) 2007, 2009-2011, 2014 Richard Kettlewell
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA