crypto/openssh/sftp-server.8

   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
  40 is a program that speaks the server side of SFTP protocol
  41 to stdout and expects client requests from stdin.
  42 .Nm
  43 is not intended to be called directly, but from
  44 .Xr sshd 8
  45 using the
  46 .Cm Subsystem
  47 option.
  48 .Pp
  49 Command-line flags to
  50 .Nm
  51 should be specified in the
  52 .Cm Subsystem
  53 declaration.
  54 See
  55 .Xr sshd_config 5
  56 for more information.
  57 .Pp
  58 Valid options are:
  59 .Bl -tag -width Ds
  60 .It Fl e
  61 Causes
  62 .Nm
  63 to print logging information to stderr instead of syslog for debugging.
  64 .It Fl f Ar log_facility
  65 Specifies the facility code that is used when logging messages from
  66 .Nm .
  67 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
  68 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
  69 The default is AUTH.
  70 .It Fl h
  71 Displays
  72 .Nm
  73 usage information.
  74 .It Fl l Ar log_level
  75 Specifies which messages will be logged by
  76 .Nm .
  77 The possible values are:
  78 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
  79 INFO and VERBOSE log transactions that
  80 .Nm
  81 performs on behalf of the client.
  82 DEBUG and DEBUG1 are equivalent.
  83 DEBUG2 and DEBUG3 each specify higher levels of debugging output.
  84 The default is ERROR.
  85 .It Fl R
  86 Places this instance of
  87 .Nm
  88 into a read-only mode.
  89 Attempts to open files for writing, as well as other operations that change
  90 the state of the filesystem, will be denied.
  91 .It Fl u Ar umask
  92 Sets an explicit
  93 .Xr umask 2
  94 to be applied to newly-created files and directories, instead of the
  95 user's default mask.
  96 .El
  97 .Pp
  98 For logging to work,
  99 .Nm
 100 must be able to access
 101 .Pa /dev/log .
 102 Use of
 103 .Nm
 104 in a chroot configuration therefore requires that
 105 .Xr syslogd 8
 106 establish 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
 122 first appeared in
 123 .Ox 2.8 .
 124 .Sh AUTHORS
 125 .An Markus Friedl Aq markus@openbsd.org