xref: /freebsd/crypto/openssh/sftp-server.8 (revision 8fc257994d0ce2396196d7a06d50d20c8015f4b7)
1.\" $OpenBSD: sftp-server.8,v 1.19 2010/01/09 03:36:00 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 9, 2010
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 f Ar log_facility
36.Op Fl l Ar log_level
37.Op Fl u Ar umask
38.Sh DESCRIPTION
39.Nm
40is a program that speaks the server side of SFTP protocol
41to stdout and expects client requests from stdin.
42.Nm
43is not intended to be called directly, but from
44.Xr sshd 8
45using the
46.Cm Subsystem
47option.
48.Pp
49Command-line flags to
50.Nm
51should be specified in the
52.Cm Subsystem
53declaration.
54See
55.Xr sshd_config 5
56for more information.
57.Pp
58Valid options are:
59.Bl -tag -width Ds
60.It Fl e
61Causes
62.Nm
63to print logging information to stderr instead of syslog for debugging.
64.It Fl f Ar log_facility
65Specifies the facility code that is used when logging messages from
66.Nm .
67The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
68LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
69The default is AUTH.
70.It Fl h
71Displays
72.Nm
73usage information.
74.It Fl l Ar log_level
75Specifies which messages will be logged by
76.Nm .
77The possible values are:
78QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
79INFO and VERBOSE log transactions that
80.Nm
81performs on behalf of the client.
82DEBUG and DEBUG1 are equivalent.
83DEBUG2 and DEBUG3 each specify higher levels of debugging output.
84The default is ERROR.
85.It Fl R
86Places this instance of
87.Nm
88into a read-only mode.
89Attempts to open files for writing, as well as other operations that change
90the state of the filesystem, will be denied.
91.It Fl u Ar umask
92Sets an explicit
93.Xr umask 2
94to be applied to newly-created files and directories, instead of the
95user's default mask.
96.El
97.Pp
98For logging to work,
99.Nm
100must be able to access
101.Pa /dev/log .
102Use of
103.Nm
104in a chroot configuration therefore requires that
105.Xr syslogd 8
106establish a logging socket inside the chroot directory.
107.Sh SEE ALSO
108.Xr sftp 1 ,
109.Xr ssh 1 ,
110.Xr sshd_config 5 ,
111.Xr sshd 8
112.Rs
113.%A T. Ylonen
114.%A S. Lehtinen
115.%T "SSH File Transfer Protocol"
116.%N draft-ietf-secsh-filexfer-00.txt
117.%D January 2001
118.%O work in progress material
119.Re
120.Sh HISTORY
121.Nm
122first appeared in
123.Ox 2.8 .
124.Sh AUTHORS
125.An Markus Friedl Aq markus@openbsd.org
126