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