Package org.apache.sshd.sftp.server

Class SftpSubsystem

java.lang.Object

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

org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper

org.apache.sshd.sftp.server.SftpSubsystem

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, org.apache.sshd.common.file.FileSystemAware, SessionContextHolder, SessionHolder<ServerSession>, org.apache.sshd.common.util.threads.ExecutorServiceCarrier, ChannelDataReceiver, ServerChannelSessionHolder, AsyncCommand, AsyncCommandErrorStreamAware, AsyncCommandInputStreamAware, AsyncCommandOutputStreamAware, AsyncCommandStreamsAware, Command, CommandDirectErrorStreamAware, CommandDirectInputStreamAware, CommandDirectOutputStreamAware, CommandDirectStreamsAware, CommandLifecycle, ServerSessionHolder, SftpErrorStatusDataHandlerProvider, SftpEventListenerManager, SftpFileSystemAccessorProvider, SftpSubsystemEnvironment, SftpSubsystemProxy, SftpUnsupportedAttributePolicyProvider

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

SFTP subsystem

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.sshd.common.util.buffer.Buffer	buffer
protected ExitCallback	callback
protected static org.apache.sshd.common.util.buffer.Buffer	CLOSE
protected AtomicBoolean	closed
protected Path	defaultDir
protected Environment	env
protected org.apache.sshd.common.util.threads.CloseableExecutorService	executorService
protected Map<String,byte[]>	extensions
protected int	fileHandleSize
protected FileSystem	fileSystem
protected Map<String,Handle>	handles
protected int	maxFileHandleRounds
protected int	maxHandleCount
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 Deque<String>	unusedHandles
protected int	version
protected byte[]	workBuf

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

DEFAULT_ACL_SUPPORTED_MASK, DEFAULT_OPEN_SSH_EXTENSIONS, DEFAULT_OPEN_SSH_EXTENSIONS_NAMES, DEFAULT_SUPPORTED_CLIENT_EXTENSIONS

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

log

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

ALL_SFTP_IMPL, HIGHER_SFTP_IMPL, LOWER_SFTP_IMPL, SUPPORTED_SFTP_VERSIONS

Constructor Summary

Constructors

Constructor	Description
SftpSubsystem(ChannelSession channel, SftpSubsystemConfigurator configurator)

Method Summary

Modifier and Type	Method	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(ChannelSession channel)
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 dir, 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, AtomicReference<Boolean> eof)
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)	Generates a file handle, which is used as key in a Map to record open file handles across requests.
Path	getDefaultDirectory()
org.apache.sshd.common.util.threads.CloseableExecutorService	getExecutorService()
ServerSession	getServerSession()
int	getVersion()
protected void	initializeSessionRelatedMember(ServerSession session, ChannelSession channel)
protected org.apache.sshd.common.util.buffer.Buffer	prepareReply(org.apache.sshd.common.util.buffer.Buffer buffer)
protected ChannelDataReceiver	resolveErrorDataChannelReceiver(ChannelSession channelSession, ChannelDataReceiver receiver)
void	run()
protected void	send(org.apache.sshd.common.util.buffer.Buffer buffer)
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	start(ChannelSession channel, Environment env)

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

addMissingAttribute, addSftpEventListener, appendAclSupportedExtension, appendExtensions, appendNewlineExtension, appendOpenSSHExtensions, appendSupported2Extension, appendSupportedExtension, appendVendorIdExtension, appendVersionsExtension, checkSymlinkState, 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, doOpenSSHLimits, doPosixRename, doRead, doReadDir, doReadLink, doReadLink, doRealPath, doRealPathV345, doRealPathV6, doRemove, doRemove, doRemoveDirectory, doRemoveDirectory, doRemoveFile, 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, getLongName, getOpenSSHLimitsExtensionInfo, getPathResolutionLinkOption, getServerChannelSession, getSftpEventListenerProxy, getShortName, getSupportedClientExtensions, getUnsupportedAttributePolicy, handleReadFileAttributesException, handleSetFileAttributeFailure, handleUnknownStatusFileAttributes, handleUnsupportedAttributes, handleUserPrincipalLookupServiceException, normalize, process, readAttrs, readFileAttributes, removeSftpEventListener, resolveAclSupportedCapabilities, resolveFile, resolveFileAttributes, resolveMissingFileAttributes, resolveMissingFileAttributeValue, resolveNewlineValue, resolveNormalizedLocation, resolveOpenSSHExtensions, resolvePathResolutionFollowLinks, resolveReportedFileAttributes, sendAttrs, sendHandle, sendLink, sendPath, sendStatus, sendStatus, sendStatus, setFileAccessControl, setFileAttribute, setFileAttributes, setFileExtensions, setFileOwnership, setFilePermissions, setFileRawViewAttribute, setFileTime, signalOpenFailure, signalRemovalPreConditionFailure, toGroup, toUser, validateHandle, validateParentExistWithNoSymlinksIfNeverFollowSymlinks, validateProposedVersion, validateRealPath, writeAttrs, writeDirEntry, writeDirEntry

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

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.file.FileSystemAware

setFileSystemFactory

Methods inherited from interface org.apache.sshd.common.session.SessionHolder

getSessionContext

Methods inherited from interface org.apache.sshd.sftp.server.SftpSubsystemEnvironment

getSession

Field Detail

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

env

protected Environment env

randomizer

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

maxHandleCount

protected int maxHandleCount

unusedHandles

protected Deque<String> unusedHandles

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

executorService

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

Constructor Detail

SftpSubsystem

public SftpSubsystem(ChannelSession channel,
                     SftpSubsystemConfigurator configurator)

Parameters:

channel - The ChannelSession through which the command was received

configurator - The SftpSubsystemConfigurator to use

Method Detail

resolveErrorDataChannelReceiver

protected ChannelDataReceiver resolveErrorDataChannelReceiver(ChannelSession channelSession,
                                                              ChannelDataReceiver receiver)

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

initializeSessionRelatedMember

protected void initializeSessionRelatedMember(ServerSession session,
                                              ChannelSession channel)

getServerSession

public ServerSession getServerSession()

Specified by:

getServerSession in interface ServerSessionHolder

setFileSystem

public void setFileSystem(FileSystem fileSystem)

Specified by:

setFileSystem in interface org.apache.sshd.common.file.FileSystemAware

setExitCallback

public void setExitCallback(ExitCallback callback)

Specified by:

setExitCallback in interface Command

setInputStream

public void setInputStream(InputStream in)

Specified by:

setInputStream in interface CommandDirectInputStreamAware

setOutputStream

public void setOutputStream(OutputStream out)

Specified by:

setOutputStream in interface CommandDirectOutputStreamAware

setErrorStream

public void setErrorStream(OutputStream err)

Specified by:

setErrorStream in interface CommandDirectErrorStreamAware

setIoInputStream

public void setIoInputStream(IoInputStream in)

Specified by:

setIoInputStream in interface AsyncCommandInputStreamAware

setIoOutputStream

public void setIoOutputStream(IoOutputStream out)

Specified by:

setIoOutputStream in interface AsyncCommandOutputStreamAware

setIoErrorStream

public void setIoErrorStream(IoOutputStream err)

Specified by:

setIoErrorStream in interface AsyncCommandErrorStreamAware

start

public void start(ChannelSession channel,
                  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 AutoCloseable

Specified by:

close in interface Closeable

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 dir,
                           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,
                     AtomicReference<Boolean> eof)
              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

Generates a file handle, which is used as key in a Map to record open file handles across requests. For historical reasons, the handle is returned as a String, and other APIs also use String for handles, so we're kind of stuck with that.

As of version 2.10.1, the result must be encoded using StandardCharsets.ISO_8859_1, and it must not have more than 256 IOS-8859-1 characters (i.e., bytes).

This method is called with the monitor on the handles Map held.

Parameters:

file - to generate a handle for

Returns:

the file handle

Throws:

IOException - if no handle could be generated

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(ChannelSession channel)

Specified by:

destroy in interface CommandLifecycle

closeAllHandles

protected void closeAllHandles()