xref: /freebsd/crypto/openssh/sftp-server.8 (revision 984485a02eb3e63b4170dd911b72de38b35b2289)
1.\" $OpenBSD: sftp-server.8,v 1.15 2009/03/26 08:38:39 sobrado 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 March 26 2009
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 f Ar log_facility
35.Op Fl l Ar log_level
36.Sh DESCRIPTION
37.Nm
38is a program that speaks the server side of SFTP protocol
39to stdout and expects client requests from stdin.
40.Nm
41is not intended to be called directly, but from
42.Xr sshd 8
43using the
44.Cm Subsystem
45option.
46.Pp
47Command-line flags to
48.Nm
49should be specified in the
50.Cm Subsystem
51declaration.
52See
53.Xr sshd_config 5
54for more information.
55.Pp
56Valid options are:
57.Bl -tag -width Ds
58.It Fl f Ar log_facility
59Specifies the facility code that is used when logging messages from
60.Nm .
61The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
62LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
63The default is AUTH.
64.It Fl l Ar log_level
65Specifies which messages will be logged by
66.Nm .
67The possible values are:
68QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
69INFO and VERBOSE log transactions that
70.Nm
71performs on behalf of the client.
72DEBUG and DEBUG1 are equivalent.
73DEBUG2 and DEBUG3 each specify higher levels of debugging output.
74The default is ERROR.
75.El
76.Pp
77For logging to work,
78.Nm
79must be able to access
80.Pa /dev/log .
81Use of
82.Nm
83in a chroot configuration therefore requires that
84.Xr syslogd 8
85establish a logging socket inside the chroot directory.
86.Sh SEE ALSO
87.Xr sftp 1 ,
88.Xr ssh 1 ,
89.Xr sshd_config 5 ,
90.Xr sshd 8
91.Rs
92.%A T. Ylonen
93.%A S. Lehtinen
94.%T "SSH File Transfer Protocol"
95.%N draft-ietf-secsh-filexfer-00.txt
96.%D January 2001
97.%O work in progress material
98.Re
99.Sh HISTORY
100.Nm
101first appeared in
102.Ox 2.8 .
103.Sh AUTHORS
104.An Markus Friedl Aq markus@openbsd.org
105