1.\" $OpenBSD: sftp-server.8,v 1.21 2013/01/04 19:26:38 jmc Exp $ 2.\" $FreeBSD$ 3.\" 4.\" Copyright (c) 2000 Markus Friedl. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25.\" 26.Dd January 4, 2013 27.Dt SFTP-SERVER 8 28.Os 29.Sh NAME 30.Nm sftp-server 31.Nd SFTP server subsystem 32.Sh SYNOPSIS 33.Nm sftp-server 34.Op Fl ehR 35.Op Fl d Ar start_directory 36.Op Fl f Ar log_facility 37.Op Fl l Ar log_level 38.Op Fl u Ar umask 39.Sh DESCRIPTION 40.Nm 41is a program that speaks the server side of SFTP protocol 42to stdout and expects client requests from stdin. 43.Nm 44is not intended to be called directly, but from 45.Xr sshd 8 46using the 47.Cm Subsystem 48option. 49.Pp 50Command-line flags to 51.Nm 52should be specified in the 53.Cm Subsystem 54declaration. 55See 56.Xr sshd_config 5 57for more information. 58.Pp 59Valid options are: 60.Bl -tag -width Ds 61.It Fl d Ar start_directory 62specifies an alternate starting directory for users. 63The pathname may contain the following tokens that are expanded at runtime: 64%% is replaced by a literal '%', 65%h is replaced by the home directory of the user being authenticated, 66and %u is replaced by the username of that user. 67The default is to use the user's home directory. 68This option is useful in conjunction with the 69.Xr sshd_config 5 70.Cm ChrootDirectory 71option. 72.It Fl e 73Causes 74.Nm 75to print logging information to stderr instead of syslog for debugging. 76.It Fl f Ar log_facility 77Specifies the facility code that is used when logging messages from 78.Nm . 79The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2, 80LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. 81The default is AUTH. 82.It Fl h 83Displays 84.Nm 85usage information. 86.It Fl l Ar log_level 87Specifies which messages will be logged by 88.Nm . 89The possible values are: 90QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. 91INFO and VERBOSE log transactions that 92.Nm 93performs on behalf of the client. 94DEBUG and DEBUG1 are equivalent. 95DEBUG2 and DEBUG3 each specify higher levels of debugging output. 96The default is ERROR. 97.It Fl R 98Places this instance of 99.Nm 100into a read-only mode. 101Attempts to open files for writing, as well as other operations that change 102the state of the filesystem, will be denied. 103.It Fl u Ar umask 104Sets an explicit 105.Xr umask 2 106to be applied to newly-created files and directories, instead of the 107user's default mask. 108.El 109.Pp 110For logging to work, 111.Nm 112must be able to access 113.Pa /dev/log . 114Use of 115.Nm 116in a chroot configuration therefore requires that 117.Xr syslogd 8 118establish a logging socket inside the chroot directory. 119.Sh SEE ALSO 120.Xr sftp 1 , 121.Xr ssh 1 , 122.Xr sshd_config 5 , 123.Xr sshd 8 124.Rs 125.%A T. Ylonen 126.%A S. Lehtinen 127.%T "SSH File Transfer Protocol" 128.%N draft-ietf-secsh-filexfer-00.txt 129.%D January 2001 130.%O work in progress material 131.Re 132.Sh HISTORY 133.Nm 134first appeared in 135.Ox 2.8 . 136.Sh AUTHORS 137.An Markus Friedl Aq markus@openbsd.org 138