[gssapi-openssh.git] / openssh / sftp-server.8

.\" $OpenBSD: sftp-server.8,v 1.14 2008/07/18 22:51:01 jmc Exp $
.\"
.\" Copyright (c) 2000 Markus Friedl.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd $Mdocdate: July 18 2008 $
.Dt SFTP-SERVER 8
.Os
.Sh NAME
.Nm sftp-server
.Nd SFTP server subsystem
.Sh SYNOPSIS
.Nm sftp-server
.Op Fl f Ar log_facility
.Op Fl l Ar log_level
.Sh DESCRIPTION
.Nm
is a program that speaks the server side of SFTP protocol
to stdout and expects client requests from stdin.
.Nm
is not intended to be called directly, but from
.Xr sshd 8
using the
.Cm Subsystem
option.
.Pp
Command-line flags to
.Nm
should be specified in the
.Cm Subsystem
declaration.
See
.Xr sshd_config 5
for more information.
.Pp
Valid options are:
.Bl -tag -width Ds
.It Fl f Ar log_facility
Specifies the facility code that is used when logging messages from
.Nm .
The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
The default is AUTH.
.It Fl l Ar log_level
Specifies which messages will be logged by
.Nm .
The possible values are:
QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
INFO and VERBOSE log transactions that
.Nm
performs on behalf of the client.
DEBUG and DEBUG1 are equivalent.
DEBUG2 and DEBUG3 each specify higher levels of debugging output.
The default is ERROR.
.El
.Pp
For logging to work,
.Nm
must be able to access
.Pa /dev/log .
Use of
.Nm
in a chroot configuation therefore requires that
.Xr syslogd 8
establish a logging socket inside the chroot directory.
.Sh SEE ALSO
.Xr sftp 1 ,
.Xr ssh 1 ,
.Xr sshd_config 5 ,
.Xr sshd 8
.Rs
.%A T. Ylonen
.%A S. Lehtinen
.%T "SSH File Transfer Protocol"
.%N draft-ietf-secsh-filexfer-00.txt
.%D January 2001
.%O work in progress material
.Re
.Sh HISTORY
.Nm
first appeared in
.Ox 2.8 .
.Sh AUTHORS
.An Markus Friedl Aq markus@openbsd.org
Commit	Line	Data
22616013	1	.\" $OpenBSD: sftp-server.8,v 1.14 2008/07/18 22:51:01 jmc Exp $
3c0ef626	2	.\"
	3	.\" Copyright (c) 2000 Markus Friedl. All rights reserved.
	4	.\"
	5	.\" Redistribution and use in source and binary forms, with or without
	6	.\" modification, are permitted provided that the following conditions
	7	.\" are met:
	8	.\" 1. Redistributions of source code must retain the above copyright
	9	.\" notice, this list of conditions and the following disclaimer.
	10	.\" 2. Redistributions in binary form must reproduce the above copyright
	11	.\" notice, this list of conditions and the following disclaimer in the
	12	.\" documentation and/or other materials provided with the distribution.
	13	.\"
	14	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	15	.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	16	.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	17	.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	18	.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	19	.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	20	.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	21	.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	22	.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	23	.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	24	.\"
22616013	25	.Dd $Mdocdate: July 18 2008 $
3c0ef626	26	.Dt SFTP-SERVER 8
	27	.Os
	28	.Sh NAME
	29	.Nm sftp-server
	30	.Nd SFTP server subsystem
	31	.Sh SYNOPSIS
	32	.Nm sftp-server
9108f8d9	33	.Op Fl f Ar log_facility
9108f8d9	34	.Op Fl l Ar log_level
3c0ef626	35	.Sh DESCRIPTION
	36	.Nm
	37	is a program that speaks the server side of SFTP protocol
	38	to stdout and expects client requests from stdin.
	39	.Nm
	40	is not intended to be called directly, but from
	41	.Xr sshd 8
	42	using the
	43	.Cm Subsystem
	44	option.
9108f8d9	45	.Pp
	46	Command-line flags to
	47	.Nm
	48	should be specified in the
	49	.Cm Subsystem
	50	declaration.
3c0ef626	51	See
cdd66111	52	.Xr sshd_config 5
3c0ef626	53	for more information.
9108f8d9	54	.Pp
	55	Valid options are:
	56	.Bl -tag -width Ds
	57	.It Fl f Ar log_facility
	58	Specifies the facility code that is used when logging messages from
	59	.Nm .
	60	The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
	61	LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
	62	The default is AUTH.
	63	.It Fl l Ar log_level
	64	Specifies which messages will be logged by
	65	.Nm .
	66	The possible values are:
	67	QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
	68	INFO and VERBOSE log transactions that
	69	.Nm
	70	performs on behalf of the client.
	71	DEBUG and DEBUG1 are equivalent.
	72	DEBUG2 and DEBUG3 each specify higher levels of debugging output.
	73	The default is ERROR.
	74	.El
22616013	75	.Pp
	76	For logging to work,
	77	.Nm
	78	must be able to access
	79	.Pa /dev/log .
	80	Use of
	81	.Nm
	82	in a chroot configuation therefore requires that
	83	.Xr syslogd 8
	84	establish a logging socket inside the chroot directory.
3c0ef626	85	.Sh SEE ALSO
	86	.Xr sftp 1 ,
	87	.Xr ssh 1 ,
cdd66111	88	.Xr sshd_config 5 ,
3c0ef626	89	.Xr sshd 8
	90	.Rs
	91	.%A T. Ylonen
	92	.%A S. Lehtinen
	93	.%T "SSH File Transfer Protocol"
	94	.%N draft-ietf-secsh-filexfer-00.txt
	95	.%D January 2001
	96	.%O work in progress material
	97	.Re
3c0ef626	98	.Sh HISTORY
3c0ef626	99	.Nm
9108f8d9	100	first appeared in
	101	.Ox 2.8 .
	102	.Sh AUTHORS
	103	.An Markus Friedl Aq markus@openbsd.org