org.apache.sshd.server.subsystem.sftp

Class SftpSubsystem

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.server.subsystem.sftp.AbstractSftpSubsystemHelper

org.apache.sshd.server.subsystem.sftp.SftpSubsystem

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, FileSystemAware, org.apache.sshd.common.util.threads.ExecutorServiceCarrier, ChannelDataReceiver, ChannelSessionAware, AsyncCommand, Command, CommandLifecycle, ServerSessionHolder, SessionAware, SftpEventListenerManager, SftpSubsystemEnvironment

public class SftpSubsystem
extends AbstractSftpSubsystemHelper
implements Command, Runnable, SessionAware, FileSystemAware, org.apache.sshd.common.util.threads.ExecutorServiceCarrier, AsyncCommand, ChannelSessionAware, ChannelDataReceiver

SFTP subsystem

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.sshd.common.util.buffer.Buffer	buffer
protected ExitCallback	callback
protected ChannelSession	channelSession
protected static org.apache.sshd.common.util.buffer.Buffer	CLOSE
protected AtomicBoolean	closed
static int	DEFAULT_FILE_HANDLE_ROUNDS
static int	DEFAULT_FILE_HANDLE_SIZE
static int	DEFAULT_MAX_OPEN_HANDLES
static int	DEFAULT_MAX_READDIR_DATA_SIZE
protected Path	defaultDir
protected Environment	env
protected IoOutputStream	err
protected org.apache.sshd.common.util.threads.CloseableExecutorService	executorService
protected Map<String,byte[]>	extensions
static String	FILE_HANDLE_SIZE Size in bytes of the opaque handle value
protected int	fileHandleSize
protected FileSystem	fileSystem
protected Map<String,Handle>	handles
static String	MAX_FILE_HANDLE_RAND_ROUNDS Max. rounds to attempt to create a unique file handle - if all handles already in use after these many rounds, then an exception is thrown
static int	MAX_FILE_HANDLE_ROUNDS
static int	MAX_FILE_HANDLE_SIZE
static String	MAX_OPEN_HANDLES_PER_SESSION Properties key for the maximum of available open handles per session.
static String	MAX_READDIR_DATA_SIZE_PROP Maximum amount of data allocated for listing the contents of a directory in any single invocation of doReadDir(Buffer, int)
protected int	maxFileHandleRounds
static int	MIN_FILE_HANDLE_ROUNDS
static int	MIN_FILE_HANDLE_SIZE
protected IoOutputStream	out
protected Future<?>	pendingFuture
protected org.apache.sshd.common.random.Random	randomizer
protected BlockingQueue<org.apache.sshd.common.util.buffer.Buffer>	requests
protected AtomicLong	requestsCount
protected ServerSession	serverSession
protected int	version
protected byte[]	workBuf

Fields inherited from class org.apache.sshd.server.subsystem.sftp.AbstractSftpSubsystemHelper

ACL_SUPPORTED_MASK_PROP, AUTO_FOLLOW_LINKS, CLIENT_EXTENSIONS_PROP, DEFAULT_ACL_SUPPORTED_MASK, DEFAULT_AUTO_FOLLOW_LINKS, DEFAULT_MAX_READDATA_PACKET_LENGTH, DEFAULT_OPEN_SSH_EXTENSIONS, DEFAULT_OPEN_SSH_EXTENSIONS_NAMES, DEFAULT_SUPPORTED_CLIENT_EXTENSIONS, MAX_READDATA_PACKET_LENGTH_PROP, NEWLINE_VALUE, OPENSSH_EXTENSIONS_PROP

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.server.subsystem.sftp.SftpSubsystemEnvironment

ALL_SFTP_IMPL, HIGHER_SFTP_IMPL, LOWER_SFTP_IMPL, SFTP_VERSION

Constructor Summary

Constructors

Constructor and Description
SftpSubsystem(org.apache.sshd.common.util.threads.CloseableExecutorService executorService, UnsupportedAttributePolicy policy, SftpFileSystemAccessor accessor, SftpErrorStatusDataHandler errorStatusDataHandler)

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	closeAllHandles()
protected void	createLink(int id, String existingPath, String linkPath, boolean symLink)
int	data(ChannelSession channel, byte[] buf, int start, int len)
void	destroy()
protected void	doBlock(int id, String handle, long offset, long length, int mask)
protected void	doCheckFileHash(int id, String targetType, String target, Collection<String> algos, long startOffset, long length, int blockSize, org.apache.sshd.common.util.buffer.Buffer buffer)
protected void	doClose(int id, String handle)
protected void	doCopyData(int id, String readHandle, long readOffset, long readLength, String writeHandle, long writeOffset)
protected void	doFSetStat(int id, String handle, Map<String,?> attrs)
protected Map<String,Object>	doFStat(int id, String handle, int flags)
protected void	doInit(org.apache.sshd.common.util.buffer.Buffer buffer, int id)
protected byte[]	doMD5Hash(int id, String targetType, String target, long startOffset, long length, byte[] quickCheckHash)
protected String	doOpen(int id, String path, int pflags, int access, Map<String,Object> attrs)
protected String	doOpenDir(int id, String path, Path p, LinkOption... options)
protected void	doOpenSSHFsync(int id, String handle)
protected void	doProcess(org.apache.sshd.common.util.buffer.Buffer buffer, int length, int type, int id)
protected int	doRead(int id, String handle, long offset, int length, byte[] data, int doff)
protected void	doReadDir(org.apache.sshd.common.util.buffer.Buffer buffer, int id)
protected void	doTextSeek(int id, String handle, long line)
protected void	doUnblock(int id, String handle, long offset, long length)
protected void	doVersionSelect(org.apache.sshd.common.util.buffer.Buffer buffer, int id, String proposed)
protected void	doWrite(int id, String handle, long offset, int length, byte[] data, int doff, int remaining)
protected String	generateFileHandle(Path file)
Path	getDefaultDirectory()
org.apache.sshd.common.util.threads.CloseableExecutorService	getExecutorService()
ServerSession	getServerSession()
int	getVersion()
protected org.apache.sshd.common.util.buffer.Buffer	prepareReply(org.apache.sshd.common.util.buffer.Buffer buffer)
void	run()
protected void	send(org.apache.sshd.common.util.buffer.Buffer buffer)
void	setChannelSession(ChannelSession session)
void	setErrorStream(OutputStream err)
void	setExitCallback(ExitCallback callback)
void	setFileSystem(FileSystem fileSystem)
void	setInputStream(InputStream in)
void	setIoErrorStream(IoOutputStream err)
void	setIoInputStream(IoInputStream in)
void	setIoOutputStream(IoOutputStream out)
void	setOutputStream(OutputStream out)
void	setSession(ServerSession session)
void	start(Environment env)

Methods inherited from class org.apache.sshd.server.subsystem.sftp.AbstractSftpSubsystemHelper

addMissingAttribute, addSftpEventListener, appendAclSupportedExtension, appendExtensions, appendNewlineExtension, appendOpenSSHExtensions, appendSupported2Extension, appendSupportedExtension, appendVendorIdExtension, appendVersionsExtension, checkVersionCompatibility, doBlock, doCheckFileHash, doCheckFileHash, doClose, doCopyData, doCopyFile, doCopyFile, doCopyFile, doExtended, doFSetStat, doFStat, doLink, doLink, doLStat, doLStat, doMakeDirectory, doMakeDirectory, doMD5Hash, doMD5Hash, doOpen, doOpenDir, doOpenSSHFsync, doOpenSSHHardLink, doOpenSSHHardLink, doRead, doReadDir, doReadLink, doReadLink, doRealPath, doRealPathV345, doRealPathV6, doRemove, doRemove, doRemove, doRemoveDirectory, doRemoveDirectory, doRename, doRename, doRename, doSetAttributes, doSetStat, doSetStat, doSpaceAvailable, doSpaceAvailable, doStat, doStat, doSymLink, doSymLink, doTextSeek, doUnblock, doUnsupported, doUnsupportedExtension, doVersionSelect, doWrite, executeExtendedCommand, getAttributes, getAttributes, getErrorStatusDataHandler, getFileSystemAccessor, getLongName, getLongName, getLongName, getPathResolutionLinkOption, getSftpEventListenerProxy, getShortName, getSupportedClientExtensions, getUnsupportedAttributePolicy, handleReadFileAttributesException, handleSetFileAttributeFailure, handleUnknownStatusFileAttributes, handleUnsupportedAttributes, handleUserPrincipalLookupServiceException, normalize, process, readAttrs, readFileAttributes, removeSftpEventListener, resolveAclSupportedCapabilities, resolveFile, resolveFileAttributes, resolveMissingFileAttributes, resolveMissingFileAttributeValue, resolveNewlineValue, resolveNormalizedLocation, resolveOpenSSHExtensions, sendAttrs, sendHandle, sendLink, sendPath, sendStatus, sendStatus, sendStatus, setFileAccessControl, setFileAttribute, setFileAttributes, setFileExtensions, setFileOwnership, setFilePermissions, setFileTime, signalOpenFailure, signalRemovalPreConditionFailure, toGroup, toUser, validateHandle, validateProposedVersion, validateRealPath, writeAttrs, writeDirEntry

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_OPEN_HANDLES_PER_SESSION

public static final String MAX_OPEN_HANDLES_PER_SESSION

Properties key for the maximum of available open handles per session.

See Also:

Constant Field Values

DEFAULT_MAX_OPEN_HANDLES

public static final int DEFAULT_MAX_OPEN_HANDLES

See Also:

Constant Field Values

FILE_HANDLE_SIZE

public static final String FILE_HANDLE_SIZE

Size in bytes of the opaque handle value

See Also:

DEFAULT_FILE_HANDLE_SIZE, Constant Field Values

MIN_FILE_HANDLE_SIZE

public static final int MIN_FILE_HANDLE_SIZE

See Also:

Constant Field Values

DEFAULT_FILE_HANDLE_SIZE

public static final int DEFAULT_FILE_HANDLE_SIZE

See Also:

Constant Field Values

MAX_FILE_HANDLE_SIZE

public static final int MAX_FILE_HANDLE_SIZE

See Also:

Constant Field Values

MAX_FILE_HANDLE_RAND_ROUNDS

public static final String MAX_FILE_HANDLE_RAND_ROUNDS

Max. rounds to attempt to create a unique file handle - if all handles already in use after these many rounds, then an exception is thrown

See Also:

generateFileHandle(Path), DEFAULT_FILE_HANDLE_ROUNDS, Constant Field Values

MIN_FILE_HANDLE_ROUNDS

public static final int MIN_FILE_HANDLE_ROUNDS

See Also:

Constant Field Values

DEFAULT_FILE_HANDLE_ROUNDS

public static final int DEFAULT_FILE_HANDLE_ROUNDS

See Also:

Constant Field Values

MAX_FILE_HANDLE_ROUNDS

public static final int MAX_FILE_HANDLE_ROUNDS

See Also:

Constant Field Values

MAX_READDIR_DATA_SIZE_PROP

public static final String MAX_READDIR_DATA_SIZE_PROP

Maximum amount of data allocated for listing the contents of a directory in any single invocation of doReadDir(Buffer, int)

See Also:

DEFAULT_MAX_READDIR_DATA_SIZE, Constant Field Values

DEFAULT_MAX_READDIR_DATA_SIZE

public static final int DEFAULT_MAX_READDIR_DATA_SIZE

See Also:

Constant Field Values

CLOSE

protected static final org.apache.sshd.common.util.buffer.Buffer CLOSE

closed

protected final AtomicBoolean closed

requestsCount

protected final AtomicLong requestsCount

extensions

protected final Map<String,byte[]> extensions

handles

protected final Map<String,Handle> handles

buffer

protected final org.apache.sshd.common.util.buffer.Buffer buffer

requests

protected final BlockingQueue<org.apache.sshd.common.util.buffer.Buffer> requests

callback

protected ExitCallback callback

out

protected IoOutputStream out

err

protected IoOutputStream err

env

protected Environment env

randomizer

protected org.apache.sshd.common.random.Random randomizer

fileHandleSize

protected int fileHandleSize

maxFileHandleRounds

protected int maxFileHandleRounds

pendingFuture

protected Future<?> pendingFuture

workBuf

protected byte[] workBuf

fileSystem

protected FileSystem fileSystem

defaultDir

protected Path defaultDir

version

protected int version

serverSession

protected ServerSession serverSession

channelSession

protected ChannelSession channelSession

executorService

protected org.apache.sshd.common.util.threads.CloseableExecutorService executorService

Constructor Detail

SftpSubsystem

public SftpSubsystem(org.apache.sshd.common.util.threads.CloseableExecutorService executorService,
                     UnsupportedAttributePolicy policy,
                     SftpFileSystemAccessor accessor,
                     SftpErrorStatusDataHandler errorStatusDataHandler)

Parameters:

executorService - The CloseableExecutorService to be used by the SftpSubsystem command when starting execution. If null then a single-threaded ad-hoc service is used.

policy - The UnsupportedAttributePolicy to use if failed to access some local file attributes

accessor - The SftpFileSystemAccessor to use for opening files and directories

errorStatusDataHandler - The (never null) SftpErrorStatusDataHandler to use when generating failed commands error messages

See Also:

ThreadUtils.newSingleThreadExecutor(String)

Method Detail

getVersion

public int getVersion()

Specified by:

getVersion in interface SftpSubsystemEnvironment

Returns:

The negotiated version

getDefaultDirectory

public Path getDefaultDirectory()

Specified by:

getDefaultDirectory in interface SftpSubsystemEnvironment

Returns:

The default root directory used to resolve relative paths - a.k.a. the chroot location

getExecutorService

public org.apache.sshd.common.util.threads.CloseableExecutorService getExecutorService()

Specified by:

getExecutorService in interface org.apache.sshd.common.util.threads.ExecutorServiceCarrier

setSession

public void setSession(ServerSession session)

Specified by:

setSession in interface SessionAware

getServerSession

public ServerSession getServerSession()

Specified by:

getServerSession in interface ServerSessionHolder

setChannelSession

public void setChannelSession(ChannelSession session)

Specified by:

setChannelSession in interface ChannelSessionAware

setFileSystem

public void setFileSystem(FileSystem fileSystem)

Specified by:

setFileSystem in interface FileSystemAware

setExitCallback

public void setExitCallback(ExitCallback callback)

Specified by:

setExitCallback in interface Command

setInputStream

public void setInputStream(InputStream in)

Specified by:

setInputStream in interface Command

setOutputStream

public void setOutputStream(OutputStream out)

Specified by:

setOutputStream in interface Command

setErrorStream

public void setErrorStream(OutputStream err)

Specified by:

setErrorStream in interface Command

setIoInputStream

public void setIoInputStream(IoInputStream in)

Specified by:

setIoInputStream in interface AsyncCommand

setIoOutputStream

public void setIoOutputStream(IoOutputStream out)

Specified by:

setIoOutputStream in interface AsyncCommand

setIoErrorStream

public void setIoErrorStream(IoOutputStream err)

Specified by:

setIoErrorStream in interface AsyncCommand

start

public void start(Environment env)
           throws IOException

Specified by:

start in interface CommandLifecycle

Throws:

IOException

data

public int data(ChannelSession channel,
                byte[] buf,
                int start,
                int len)
         throws IOException

Specified by:

data in interface ChannelDataReceiver

Throws:

IOException

run

public void run()

Specified by:

run in interface Runnable

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ChannelDataReceiver

Throws:

IOException

doProcess

protected void doProcess(org.apache.sshd.common.util.buffer.Buffer buffer,
                         int length,
                         int type,
                         int id)
                  throws IOException

Overrides:

doProcess in class AbstractSftpSubsystemHelper

Throws:

IOException

createLink

protected void createLink(int id,
                          String existingPath,
                          String linkPath,
                          boolean symLink)
                   throws IOException

Specified by:

createLink in class AbstractSftpSubsystemHelper

Throws:

IOException

doTextSeek

protected void doTextSeek(int id,
                          String handle,
                          long line)
                   throws IOException

Specified by:

doTextSeek in class AbstractSftpSubsystemHelper

Throws:

IOException

doOpenSSHFsync

protected void doOpenSSHFsync(int id,
                              String handle)
                       throws IOException

Specified by:

doOpenSSHFsync in class AbstractSftpSubsystemHelper

Throws:

IOException

doCheckFileHash

protected void doCheckFileHash(int id,
                               String targetType,
                               String target,
                               Collection<String> algos,
                               long startOffset,
                               long length,
                               int blockSize,
                               org.apache.sshd.common.util.buffer.Buffer buffer)
                        throws Exception

Specified by:

doCheckFileHash in class AbstractSftpSubsystemHelper

Throws:

Exception

doMD5Hash

protected byte[] doMD5Hash(int id,
                           String targetType,
                           String target,
                           long startOffset,
                           long length,
                           byte[] quickCheckHash)
                    throws Exception

Specified by:

doMD5Hash in class AbstractSftpSubsystemHelper

Throws:

Exception

doVersionSelect

protected void doVersionSelect(org.apache.sshd.common.util.buffer.Buffer buffer,
                               int id,
                               String proposed)
                        throws IOException

Specified by:

doVersionSelect in class AbstractSftpSubsystemHelper

Throws:

IOException

doBlock

protected void doBlock(int id,
                       String handle,
                       long offset,
                       long length,
                       int mask)
                throws IOException

Specified by:

doBlock in class AbstractSftpSubsystemHelper

Throws:

IOException

doUnblock

protected void doUnblock(int id,
                         String handle,
                         long offset,
                         long length)
                  throws IOException

Specified by:

doUnblock in class AbstractSftpSubsystemHelper

Throws:

IOException

doCopyData

protected void doCopyData(int id,
                          String readHandle,
                          long readOffset,
                          long readLength,
                          String writeHandle,
                          long writeOffset)
                   throws IOException

Specified by:

doCopyData in class AbstractSftpSubsystemHelper

Throws:

IOException

doReadDir

protected void doReadDir(org.apache.sshd.common.util.buffer.Buffer buffer,
                         int id)
                  throws IOException

Specified by:

doReadDir in class AbstractSftpSubsystemHelper

Throws:

IOException

doOpenDir

protected String doOpenDir(int id,
                           String path,
                           Path p,
                           LinkOption... options)
                    throws IOException

Specified by:

doOpenDir in class AbstractSftpSubsystemHelper

Throws:

IOException

doFSetStat

protected void doFSetStat(int id,
                          String handle,
                          Map<String,?> attrs)
                   throws IOException

Specified by:

doFSetStat in class AbstractSftpSubsystemHelper

Throws:

IOException

doFStat

protected Map<String,Object> doFStat(int id,
                                     String handle,
                                     int flags)
                              throws IOException

Specified by:

doFStat in class AbstractSftpSubsystemHelper

Throws:

IOException

doWrite

protected void doWrite(int id,
                       String handle,
                       long offset,
                       int length,
                       byte[] data,
                       int doff,
                       int remaining)
                throws IOException

Specified by:

doWrite in class AbstractSftpSubsystemHelper

Throws:

IOException

doRead

protected int doRead(int id,
                     String handle,
                     long offset,
                     int length,
                     byte[] data,
                     int doff)
              throws IOException

Specified by:

doRead in class AbstractSftpSubsystemHelper

Throws:

IOException

doClose

protected void doClose(int id,
                       String handle)
                throws IOException

Specified by:

doClose in class AbstractSftpSubsystemHelper

Throws:

IOException

doOpen

protected String doOpen(int id,
                        String path,
                        int pflags,
                        int access,
                        Map<String,Object> attrs)
                 throws IOException

Specified by:

doOpen in class AbstractSftpSubsystemHelper

Parameters:

id - Request id

path - Path

pflags - Open mode flags - see SSH_FXF_XXX flags

access - Access mode flags - see ACE4_XXX flags

attrs - Requested attributes

Returns:

The assigned (opaque) handle

Throws:

IOException - if failed to execute

generateFileHandle

protected String generateFileHandle(Path file)
                             throws IOException

Throws:

IOException

doInit

protected void doInit(org.apache.sshd.common.util.buffer.Buffer buffer,
                      int id)
               throws IOException

Specified by:

doInit in class AbstractSftpSubsystemHelper

Throws:

IOException

prepareReply

protected org.apache.sshd.common.util.buffer.Buffer prepareReply(org.apache.sshd.common.util.buffer.Buffer buffer)

Specified by:

prepareReply in class AbstractSftpSubsystemHelper

send

protected void send(org.apache.sshd.common.util.buffer.Buffer buffer)
             throws IOException

Specified by:

send in class AbstractSftpSubsystemHelper

Throws:

IOException

destroy

public void destroy()

Specified by:

destroy in interface CommandLifecycle

closeAllHandles

protected void closeAllHandles()