'\" te
.\" To view license terms, attribution, and copyright for OpenSSH, the default path is /var/sadm/pkg/SUNWsshdr/install/copyright. If the Solaris operating environment has been installed anywhere other than the default, modify the given path to access the file at the installed location.
.\" Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
.TH sftp-server 1M "18 Apr 2011" "SunOS 5.11" "System Administration Commands"
.SH NAME
sftp-server \- SFTP server subsystem
.SH SYNOPSIS
.LP
.nf
\fB/usr/lib/ssh/sftp-server\fR [\fB-f\fR \fIlog_facility\fR] [\fB-l\fR \fIlog_level\fR]
.fi

.SH DESCRIPTION
.sp
.LP
\fBsftp-server\fR implements the server side of the SSH File Transfer Protocol as defined in the IETF \fBdraft-ietf-secsh-filexfer\fR.
.sp
.LP
\fBsftp-server\fR is a subsystem for \fBsshd\fR(1M) and must not be run directly. Command-line flags to \fBsftp-server\fR should be specified in the Subsystem declaration. See \fBsshd_config\fR(4) for more information.
.sp
.LP
To enable the \fBsftp-server\fR subsystem for \fBsshd\fR add the following to \fB/etc/ssh/sshd_config\fR:
.sp
.in +2
.nf
Subsystem   sftp     /usr/lib/ssh/sftp-server
.fi
.in -2
.sp

.sp
.LP
To run \fBsftp-server\fR in a \fBchroot\fR configuration,  use \fBinternal-sftp\fR instead of \fB/usr/lib/ssh/sftp-server\fR. Otherwise, the \fBchroot\fR directory must contain the necessary files and directories to support the user's session. See the \fBChrootDirectory\fR and \fBSubsystem\fR options in \fBsshd_config\fR(4)) for more information on how \fBsshd\fR and \fBsftp-server\fR work with \fBchroot\fR(2).
.sp
.LP
See \fBsshd_config\fR(4) for a description of the format and contents of that file.
.sp
.LP
There is no relationship between the protocol used by \fBsftp-server\fR and the FTP protocol (RFC 959) provided by \fBin.ftpd\fR.
.sp
.LP
For logging to work, \fBsftp-server\fR must be able to access \fB/dev/log\fR. Use of \fBsftp-server\fR in a \fBchroot\fR configuration therefore requires that \fBsyslogd\fR(1M) establish a logging socket inside the \fBchroot\fR directory.
.SH OPTIONS
.sp
.LP
Valid options are listed below. As stated above, these options,  if used, are specified in the Subsystem declaration of \fBsshd_config\fR.
.sp
.ne 2
.mk
.na
\fB\fB-f\fR \fIlog_facility\fR\fR
.ad
.sp .6
.RS 4n
Specifies the facility code that is used when logging messages from \fBsftp-server\fR. The possible values are: \fBDAEMON\fR, \fBUSER\fR, \fBAUTH\fR, \fBLOCAL0\fR, \fBLOCAL1\fR, \fBLOCAL2\fR, \fBLOCAL3\fR, \fBLOCAL4\fR, \fBLOCAL5\fR, \fBLOCAL6\fR, \fBLOCAL7\fR. The default is \fBAUTH\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-l\fR \fIlog_level\fR\fR
.ad
.sp .6
.RS 4n
Specifies which messages will be logged by \fBsftp-server\fR. The possible values are: \fBQUIET\fR, \fBFATAL\fR, \fBERROR\fR, \fBINFO\fR, \fBVERBOSE\fR, \fBDEBUG\fR, \fBDEBUG1\fR, \fBDEBUG2\fR, and \fBDEBUG3\fR. \fBINFO\fR and \fBVERBOSE\fR log transactions that \fBsftp-server\fR performs on behalf of the client. \fBDEBUG\fR and \fBDEBUG1\fR are equivalent. \fBDEBUG2\fR and \fBDEBUG3\fR each specify higher levels of debugging output. The default is \fBERROR\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-u\fR \fIumask\fR\fR
.ad
.sp .6
.RS 4n
Sets an explicit \fBumask\fR(2) to be applied to newly-created files and directories, instead of the user's default mask.
.RE

.SH EXIT STATUS
.sp
.LP
The following exit values are returned:
.sp
.ne 2
.mk
.na
\fB\fB0\fR\fR
.ad
.RS 6n
.rt  
Successful completion.
.RE

.sp
.ne 2
.mk
.na
\fB>\fB0\fR\fR
.ad
.RS 6n
.rt  
An error occurred.
.RE

.SH FILES
.sp
.ne 2
.mk
.na
\fB\fB/usr/lib/ssh/sftp-server\fR\fR
.ad
.RS 28n
.rt  
Server-side binary.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Availabilityservice/network/ssh
_
Interface StabilityCommitted
.TE

.SH SEE ALSO
.sp
.LP
\fBsftp\fR(1), \fBssh\fR(1), \fBssh-add\fR(1), \fBssh-keygen\fR(1), \fBsshd\fR(1M), \fBsyslogd\fR(1M), \fBchroot\fR(2), \fBumask\fR(2), \fBsshd_config\fR(4), \fBattributes\fR(5)