Package | Description |
---|---|
org.apache.sshd.client.config | |
org.apache.sshd.common | |
org.apache.sshd.common.io.nio2 | |
org.apache.sshd.core | |
org.apache.sshd.scp | |
org.apache.sshd.server.config | |
org.apache.sshd.sftp |
Modifier and Type | Field and Description |
---|---|
static Property<Duration> |
SshClientConfigFileReader.CLIENT_LIVECHECK_INTERVAL_PROP |
static Property<Duration> |
SshClientConfigFileReader.CLIENT_LIVECHECK_REPLIES_WAIT |
static Property<Boolean> |
SshClientConfigFileReader.CLIENT_LIVECHECK_USE_NULLS |
Modifier and Type | Class and Description |
---|---|
static class |
Property.BaseProperty<T> |
static class |
Property.BooleanProperty |
static class |
Property.CharsetProperty |
static class |
Property.DurationInSecondsProperty |
static class |
Property.DurationProperty |
static class |
Property.EnumProperty<T extends Enum<T>> |
static class |
Property.IntegerProperty |
static class |
Property.LongProperty |
static class |
Property.ObjectProperty |
static class |
Property.StringProperty |
static class |
Property.Validating<T> |
Modifier and Type | Field and Description |
---|---|
static Property<Boolean> |
CommonModuleProperties.ALLOW_INSECURE_AUTH
If set to
true then
UserAuthMethodFactory.isSecureAuthenticationTransport(SessionContext) returns
true even if transport is insecure. |
static Property<Boolean> |
CommonModuleProperties.ALLOW_NON_INTEGRITY_AUTH
If set to
true then
UserAuthMethodFactory.isDataIntegrityAuthenticationTransport(SessionContext)
returns true even if transport has no MAC(s) to verify message integrity |
static Property<Duration> |
CommonModuleProperties.CLOSE_WAIT_TIMEOUT
Timeout (milliseconds) for waiting on a
CloseFuture to successfully complete its action. |
protected Property<T> |
Property.Validating.delegate |
static Property<Integer> |
CommonModuleProperties.HEXDUMP_CHUNK_SIZE |
static Property<Duration> |
CommonModuleProperties.SESSION_HEARTBEAT_INTERVAL
Property used to register the interval for the heartbeat - if not set or non-positive then disabled
|
static Property<SessionHeartbeatController.HeartbeatType> |
CommonModuleProperties.SESSION_HEARTBEAT_TYPE
Property used to register the
SessionHeartbeatController.HeartbeatType -
if non-existent or NONE then disabled. |
Modifier and Type | Method and Description |
---|---|
static Property<Boolean> |
Property.bool(String name) |
static Property<Boolean> |
Property.bool(String name,
boolean def) |
static Property<Charset> |
Property.charset(String name) |
static Property<Charset> |
Property.charset(String name,
Charset def) |
static Property<Duration> |
Property.duration(String name) |
static Property<Duration> |
Property.duration(String name,
Duration def) |
static Property<Duration> |
Property.duration(String name,
Duration def,
Duration min) |
static Property<Duration> |
Property.durationSec(String name) |
static Property<Duration> |
Property.durationSec(String name,
Duration def) |
static Property<Duration> |
Property.durationSec(String name,
Duration def,
Duration min) |
static <T extends Enum<T>> |
Property.enum_(String name,
Class<T> type) |
static <T extends Enum<T>> |
Property.enum_(String name,
Class<T> type,
T def) |
static Property<Integer> |
Property.integer(String name) |
static Property<Integer> |
Property.integer(String name,
int def) |
static Property<Long> |
Property.long_(String name) |
static Property<Long> |
Property.long_(String name,
long def) |
static Property<Object> |
Property.object(String name) |
static Property<Object> |
Property.object(String name,
Object def) |
static Property<String> |
Property.string(String name) |
static Property<String> |
Property.string(String name,
String def) |
static <T> Property<T> |
Property.validating(Property<T> prop,
Consumer<? super T> validator) |
Modifier and Type | Method and Description |
---|---|
static <T> Property<T> |
Property.validating(Property<T> prop,
Consumer<? super T> validator) |
Constructor and Description |
---|
Validating(Property<T> delegate,
Consumer<? super T> validator) |
Modifier and Type | Field and Description |
---|---|
static Map<Property<?>,AbstractMap.SimpleImmutableEntry<SocketOption<?>,Object>> |
Nio2Service.CONFIGURABLE_OPTIONS |
Modifier and Type | Method and Description |
---|---|
protected <T> boolean |
Nio2Service.setOption(NetworkChannel socket,
Property<?> property,
SocketOption<T> option,
T defaultValue) |
Modifier and Type | Field and Description |
---|---|
static Property<Boolean> |
CoreModuleProperties.ABORT_ON_INVALID_CERTIFICATE
Defines if we should abort in case we encounter an invalid (e.g.
|
static Property<Boolean> |
CoreModuleProperties.ALLOW_DHG1_KEX_FALLBACK
Whether allowed to fall back to DH group with SHA-1 KEX if exhausted all available primes for SHA-256.
|
static Property<String> |
CoreModuleProperties.AUTH_METHODS
This key is used when configuring multi-step authentications.
|
static Property<Duration> |
CoreModuleProperties.AUTH_SOCKET_TIMEOUT
Property that can be set on the
Session in order to control the authentication timeout (millis). |
static Property<Duration> |
CoreModuleProperties.AUTH_TIMEOUT
Key used to retrieve the value of the timeout after which it will close the connection if the other side has not
been authenticated - in milliseconds.
|
static Property<Integer> |
CoreModuleProperties.BUFFER_SIZE
Value used by the
InvertedShellWrapper to control copy buffer size. |
static Property<Integer> |
CoreModuleProperties.BUFFERED_IO_OUTPUT_MAX_PENDING_WRITE_SIZE
Key used when creating a
BufferedIoOutputStream in order to specify max. |
static Property<Duration> |
CoreModuleProperties.BUFFERED_IO_OUTPUT_MAX_PENDING_WRITE_WAIT
Key used when creating a
BufferedIoOutputStream in order to specify max. |
static Property<Duration> |
CoreModuleProperties.CHANNEL_CLOSE_TIMEOUT
Key used to configure the timeout used when writing a close request on a channel.
|
static Property<Duration> |
CoreModuleProperties.CHANNEL_OPEN_TIMEOUT
Value that can be set on the
FactoryManager or the session to configure the
channel open timeout value (millis). |
static Property<String> |
CoreModuleProperties.CLIENT_IDENTIFICATION
Key used to retrieve the value of the client identification string.
|
static Property<Duration> |
CoreModuleProperties.COMMAND_EXIT_TIMEOUT
Key used to configure the timeout used when receiving a close request on a channel to wait until the command
cleanly exits after setting an EOF on the input stream.
|
static Property<Duration> |
CoreModuleProperties.DISCONNECT_TIMEOUT
Key used to retrieve the value of the disconnect timeout which is used when a disconnection is attempted.
|
static Property<Duration> |
CoreModuleProperties.FORWARD_REQUEST_TIMEOUT
Used to configure the timeout (milliseconds) for receiving a response for the forwarding request
|
static Property<Integer> |
CoreModuleProperties.FORWARDER_BUFFER_SIZE
Property that can be set on the factory manager in order to control the buffer size used to forward data from the
established channel
|
static Property<Duration> |
CoreModuleProperties.HEARTBEAT_INTERVAL
Key used to set the heartbeat interval in milliseconds (0 to disable = default)
|
static Property<Duration> |
CoreModuleProperties.HEARTBEAT_REPLY_WAIT
Key used to indicate that the heartbeat request is also expecting a reply - time in milliseconds to wait
for the reply.
|
static Property<String> |
CoreModuleProperties.HEARTBEAT_REQUEST
Key used to check the heartbeat request that should be sent to the server
|
static Property<Duration> |
CoreModuleProperties.IDLE_TIMEOUT
Key used to retrieve the value of idle timeout after which it will close the connection - in milliseconds.
|
static Property<Boolean> |
CoreModuleProperties.IGNORE_INVALID_IDENTITIES
Whether to ignore invalid identities files when pre-initializing the client session
|
static Property<Long> |
CoreModuleProperties.IGNORE_MESSAGE_FREQUENCY
Average number of packets to be skipped before an
SSH_MSG_IGNORE message is inserted in the stream. |
static Property<Integer> |
CoreModuleProperties.IGNORE_MESSAGE_SIZE
Minimum size of
SSH_MSG_IGNORE payload to send if feature enabled. |
static Property<Integer> |
CoreModuleProperties.IGNORE_MESSAGE_VARIANCE
The variance to be used around the configured
CoreModuleProperties.IGNORE_MESSAGE_FREQUENCY value in order to avoid insertion
at a set frequency. |
static Property<Integer> |
CoreModuleProperties.INPUT_STREAM_PUMP_CHUNK_SIZE
On some platforms, a call to always throws an
IOException . |
static Property<String> |
CoreModuleProperties.INTERACTIVE_LANGUAGE_TAG
As per RFC-4256:
The language tag is deprecated and SHOULD be the empty string.
|
static Property<String> |
CoreModuleProperties.INTERACTIVE_SUBMETHODS
As per RFC-4256:
The submethods field is included so the user can give a hint of which actual methods to use.
|
static Property<Boolean> |
CoreModuleProperties.KB_SERVER_INTERACTIVE_ECHO_PROMPT
|
static Property<String> |
CoreModuleProperties.KB_SERVER_INTERACTIVE_INSTRUCTION
|
static Property<String> |
CoreModuleProperties.KB_SERVER_INTERACTIVE_LANG
|
static Property<String> |
CoreModuleProperties.KB_SERVER_INTERACTIVE_NAME
|
static Property<String> |
CoreModuleProperties.KB_SERVER_INTERACTIVE_PROMPT
|
static Property<Duration> |
CoreModuleProperties.KEX_PROPOSAL_SETUP_TIMEOUT
If the peer initiates a key exchange, we send our own KEX_INIT message with the proposal.
|
static Property<Long> |
CoreModuleProperties.LIMIT_PACKET_SIZE
A safety value that is designed to avoid an attack that uses large channel packet sizes
|
static Property<Integer> |
CoreModuleProperties.MAX_AUTH_REQUESTS
Key used to retrieve the value in the configuration properties map of the maximum number of failed authentication
requests before the server closes the connection.
|
static Property<Integer> |
CoreModuleProperties.MAX_CONCURRENT_CHANNELS
Property that can be used to configure max.
|
static Property<Integer> |
CoreModuleProperties.MAX_CONCURRENT_SESSIONS
Key used to retrieve the value of the maximum concurrent open session count per username.
|
static Property<Integer> |
CoreModuleProperties.MAX_EXTDATA_BUFSIZE
Maximum amount of extended (a.k.a.
|
static Property<Integer> |
CoreModuleProperties.MAX_IDENTIFICATION_SIZE
Maximum allowed size of the initial identification text sent during the handshake
|
static Property<Long> |
CoreModuleProperties.MAX_PACKET_SIZE
Key used to retrieve the value of the maximum packet size in the configuration properties map.
|
static Property<Integer> |
CoreModuleProperties.MIN_READ_BUFFER_SIZE
Minimum read buffer size in bytes.
|
static Property<String> |
CoreModuleProperties.MODULI_URL
A URL pointing to the moduli file.
|
static Property<Integer> |
CoreModuleProperties.NIO_WORKERS
Number of NIO worker threads to use.
|
static Property<Duration> |
CoreModuleProperties.NIO2_MIN_WRITE_TIMEOUT
Minimum NIO2 write wait timeout for a single outgoing packet - in milliseconds
|
static Property<Integer> |
CoreModuleProperties.NIO2_READ_BUFFER_SIZE
Read buffer size in bytes.
|
static Property<Duration> |
CoreModuleProperties.NIO2_READ_TIMEOUT
Key used to retrieve the value of the socket read timeout for NIO2 session implementation - in milliseconds.
|
static Property<Integer> |
CoreModuleProperties.PASSWORD_PROMPTS
Specifies the number of interactive prompts before giving up.
|
static Property<Boolean> |
CoreModuleProperties.PREFER_UNIX_AGENT
|
static Property<String> |
CoreModuleProperties.PREFERRED_AUTHS
Ordered comma separated list of authentications methods.
|
static Property<Integer> |
CoreModuleProperties.PROP_DHGEX_CLIENT_MAX_KEY |
static Property<Integer> |
CoreModuleProperties.PROP_DHGEX_CLIENT_MIN_KEY |
static Property<Integer> |
CoreModuleProperties.PROP_DHGEX_CLIENT_PRF_KEY |
static Property<Integer> |
CoreModuleProperties.PROP_DHGEX_SERVER_MAX_KEY
See
DHGEXServer . |
static Property<Integer> |
CoreModuleProperties.PROP_DHGEX_SERVER_MIN_KEY
See
DHGEXServer . |
static Property<String> |
CoreModuleProperties.PROXY_AUTH_CHANNEL_TYPE
Value that can be set in order to control the type of authentication channel being requested when forwarding a
PTY session.
|
static Property<String> |
CoreModuleProperties.PROXY_CHANNEL_TYPE
Value used to configure the type of proxy forwarding channel to be used.
|
static Property<Duration> |
CoreModuleProperties.PUMP_SLEEP_TIME
Value used by the
InvertedShellWrapper to control the "busy-wait"
sleep time (millis) on the pumping loop if nothing was pumped - must be positive. |
static Property<Long> |
CoreModuleProperties.REKEY_BLOCKS_LIMIT
Key re-exchange will be automatically performed after the specified number of cipher blocks has been processed -
positive 64-bit value.
|
static Property<Long> |
CoreModuleProperties.REKEY_BYTES_LIMIT
Key re-exchange will be automatically performed after the session has sent or received the given amount of bytes.
|
static Property<Long> |
CoreModuleProperties.REKEY_PACKETS_LIMIT
Key re-exchange will be automatically performed after the specified number of packets has been exchanged -
positive 64-bit value.
|
static Property<Duration> |
CoreModuleProperties.REKEY_TIME_LIMIT
Key re-exchange will be automatically performed after the specified amount of time has elapsed since the last key
exchange - in milliseconds.
|
static Property<Boolean> |
CoreModuleProperties.REQUEST_EXEC_REPLY
Configure whether reply for the "exec" request is required
|
static Property<Boolean> |
CoreModuleProperties.REQUEST_SHELL_REPLY
Configure whether reply for the "shell" request is required
|
static Property<Boolean> |
CoreModuleProperties.REQUEST_SUBSYSTEM_REPLY
Configure whether reply for the "subsystem&quoot; request is required
|
static Property<Boolean> |
CoreModuleProperties.SEND_IMMEDIATE_IDENTIFICATION
Whether to send the identification string immediately upon session connection being established or wait for the
server's identification before sending our own.
|
static Property<Boolean> |
CoreModuleProperties.SEND_IMMEDIATE_KEXINIT
Whether to send
SSH_MSG_KEXINIT immediately after sending the client identification string or wait until
the severer's one has been received. |
static Property<Boolean> |
CoreModuleProperties.SEND_REPLY_FOR_CHANNEL_DATA
RFC4254 does not clearly specify how to handle
SSH_MSG_CHANNEL_DATA and
SSH_MSG_CHANNEL_EXTENDED_DATA received through an unknown channel. |
static Property<String> |
CoreModuleProperties.SERVER_EXTRA_IDENTIFICATION_LINES
Key used to retrieve any extra lines to be sent during initial protocol handshake before the
identification.
|
static Property<String> |
CoreModuleProperties.SERVER_IDENTIFICATION
Key used to retrieve the value of the server identification string.
|
static Property<Integer> |
CoreModuleProperties.SOCKET_BACKLOG
Socket backlog.
|
static Property<Boolean> |
CoreModuleProperties.SOCKET_KEEPALIVE
Socket keep-alive.
|
static Property<Integer> |
CoreModuleProperties.SOCKET_LINGER
Socket linger.
|
static Property<Integer> |
CoreModuleProperties.SOCKET_RCVBUF
Socket receive buffer size.
|
static Property<Boolean> |
CoreModuleProperties.SOCKET_REUSEADDR
Socket reuse address.
|
static Property<Integer> |
CoreModuleProperties.SOCKET_SNDBUF
Socket send buffer size.
|
static Property<Duration> |
CoreModuleProperties.STOP_WAIT_TIME
Timeout (milliseconds) to wait for client / server stop request if immediate stop requested.
|
static Property<Boolean> |
CoreModuleProperties.TCP_NODELAY
Socket tcp no-delay.
|
static Property<Duration> |
CoreModuleProperties.WAIT_FOR_SPACE_TIMEOUT
Configure max.
|
static Property<Object> |
CoreModuleProperties.WELCOME_BANNER
Key used to retrieve the value of welcome banner that will be displayed when a user connects to the server.
|
static Property<Charset> |
CoreModuleProperties.WELCOME_BANNER_CHARSET
The charset to use if the configured welcome banner points to a file - if not specified (either as a string or a
Charset then the local default is used. |
static Property<String> |
CoreModuleProperties.WELCOME_BANNER_LANGUAGE
Key used to denote the language code for the welcome banner (if such a banner is configured).
|
static Property<WelcomeBannerPhase> |
CoreModuleProperties.WELCOME_BANNER_PHASE
The
WelcomeBannerPhase value - either as an enum or a string |
static Property<Long> |
CoreModuleProperties.WINDOW_SIZE
Key used to retrieve the value of the channel window size in the configuration properties map.
|
static Property<Duration> |
CoreModuleProperties.WINDOW_TIMEOUT
Key used to retrieve timeout (msec.) to wait for data to become available when reading from a channel.
|
static Property<Integer> |
CoreModuleProperties.X11_BASE_PORT
Configuration value for the
X11ForwardSupport to control the base port number
for the X11 display number socket binding. |
static Property<String> |
CoreModuleProperties.X11_BIND_HOST
Configuration value for the
X11ForwardSupport to control the host used to bind
to for the X11 display when looking for a free port. |
static Property<Integer> |
CoreModuleProperties.X11_DISPLAY_OFFSET
Configuration value for the
X11ForwardSupport to control from which X11
display number to start looking for a free value. |
static Property<Integer> |
CoreModuleProperties.X11_MAX_DISPLAYS
Configuration value for the
X11ForwardSupport to control up to which (but not
including) X11 display number to look or a free value. |
static Property<Duration> |
CoreModuleProperties.X11_OPEN_TIMEOUT
Configuration value for the
X11ForwardSupport to control the channel open
timeout. |
Modifier and Type | Field and Description |
---|---|
static Property<Boolean> |
ScpModuleProperties.ENABLE_SCP_SHELL
Whether to provide an
ScpShell instance if WinSCP client detected or at all |
static Property<Boolean> |
ScpModuleProperties.PROP_AUTO_SYNC_FILE_ON_WRITE
Whether to synchronize written file data with underlying file-system
|
static Property<Duration> |
ScpModuleProperties.SCP_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT
Configurable value for controlling the wait timeout for waiting on a channel exit status' for an SCP command in
milliseconds.
|
static Property<Duration> |
ScpModuleProperties.SCP_EXEC_CHANNEL_OPEN_TIMEOUT
Configurable value of the for controlling the wait timeout for opening a channel for an SCP command in
milliseconds.
|
static Property<Charset> |
ScpModuleProperties.SCP_INCOMING_ENCODING
Used to indicate the
Charset (or its name) for decoding incoming commands/responses sent by the peer
(either client or server). |
static Property<Charset> |
ScpModuleProperties.SCP_OUTGOING_ENCODING
Used to indicate the
Charset (or its name) for encoding outgoing commands/responses sent to the peer
(either client or server). |
static Property<Charset> |
ScpModuleProperties.SHELL_ENVVARS_ENCODING_CHARSET
Used to indicate the
Charset (or its name) for handling environment values in ScpShell -
extracted from the channel session when shell initialized. |
static Property<Charset> |
ScpModuleProperties.SHELL_NAME_DECODING_CHARSET
Used to indicate the
Charset (or its name) for decoding incoming commands to be processed by the
ScpShell - extracted from the channel session when shell initialized. |
static Property<Charset> |
ScpModuleProperties.SHELL_NAME_ENCODING_CHARSET
Used to indicate the
Charset (or its name) for encoding returned textual responses from the
ScpShell - extracted from the channel session when shell initialized. |
Modifier and Type | Field and Description |
---|---|
static Property<String> |
SshServerConfigFileReader.ALLOW_AGENT_FORWARDING_CONFIG_PROP |
static Property<String> |
SshServerConfigFileReader.ALLOW_TCP_FORWARDING_CONFIG_PROP |
static Property<String> |
SshServerConfigFileReader.ALLOW_X11_FORWARDING_CONFIG_PROP |
static Property<String> |
SshServerConfigFileReader.BANNER_CONFIG_PROP |
static Property<Duration> |
SshServerConfigFileReader.SERVER_ALIVE_INTERVAL_PROP |
static Property<Integer> |
SshServerConfigFileReader.SFTP_FORCED_VERSION_PROP |
static Property<String> |
SshServerConfigFileReader.VISUAL_HOST_KEY |
Modifier and Type | Field and Description |
---|---|
static Property<String> |
SftpModuleProperties.ACL_SUPPORTED_MASK
Comma separate list of
SSH_ACL_CAP_xxx names - where name can be without the prefix. |
static Property<Boolean> |
SftpModuleProperties.APPEND_END_OF_LIST_INDICATOR
Used to control whether to append the end-of-list indicator for SSH_FXP_NAME responses via
SftpHelper.indicateEndOfNamesList(Buffer, int, PropertyResolver, boolean) call, as indicated by
SFTP v6 - section 9.4 |
static Property<Duration> |
SftpModuleProperties.AUTH_TIME
|
static Property<Boolean> |
SftpModuleProperties.AUTO_FOLLOW_LINKS
Whether to automatically follow symbolic links when resolving paths
|
static Property<String> |
SftpModuleProperties.CLIENT_EXTENSIONS
Allows controlling reports of which client extensions are supported (and reported via "support" and
"support2" server extensions) as a comma-separate list of names.
|
static Property<Duration> |
SftpModuleProperties.CONNECT_TIME
|
static Property<Integer> |
SftpModuleProperties.COPY_BUF_SIZE
Internal allocate buffer size when copying data to/from the channel
|
static Property<Integer> |
SftpModuleProperties.FILE_HANDLE_SIZE
Size in bytes of the opaque handle value
|
static Property<Integer> |
SftpModuleProperties.MAX_FILE_HANDLE_RAND_ROUNDS
Max.
|
static Property<Integer> |
SftpModuleProperties.MAX_OPEN_HANDLES_PER_SESSION
Properties key for the maximum of available open handles per session.
|
static Property<Integer> |
SftpModuleProperties.MAX_READDATA_PACKET_LENGTH
Force the use of a max.
|
static Property<Integer> |
SftpModuleProperties.MAX_READDIR_DATA_SIZE
Maximum amount of data allocated for listing the contents of a directory in any single invocation of
SftpSubsystem.doReadDir(Buffer, int) |
static Property<Integer> |
SftpModuleProperties.MAX_WRITEDATA_PACKET_LENGTH
Force the use of a max.
|
static Property<Charset> |
SftpModuleProperties.NAME_DECODER_CHARSET
|
static Property<Charset> |
SftpModuleProperties.NAME_DECODING_CHARSET
Used to indicate the
Charset (or its name) for decoding referenced files/folders names - extracted from
the client session when 1st initialized. |
static Property<String> |
SftpModuleProperties.NEWLINE_VALUE
Property that can be used to set the reported NL value.
|
static Property<String> |
SftpModuleProperties.OPENSSH_EXTENSIONS
Comma-separated list of which
OpenSSH extensions are reported and what version is reported for each -
format: name=version . |
static Property<Integer> |
SftpModuleProperties.POOL_SIZE
See
SftpFileSystem . |
static Property<Integer> |
SftpModuleProperties.READ_BUFFER_SIZE
|
static Property<Duration> |
SftpModuleProperties.SFTP_CHANNEL_OPEN_TIMEOUT
Property that can be used on the
FactoryManager to control the internal timeout
used by the client to open a channel. |
static Property<Integer> |
SftpModuleProperties.SFTP_VERSION
Force the use of a given sftp version
|
static Property<Integer> |
SftpModuleProperties.WRITE_BUFFER_SIZE
|
static Property<Integer> |
SftpModuleProperties.WRITE_CHUNK_SIZE
Property used to avoid large buffers when
AbstractSftpClient.write(SftpClient.Handle, long, byte[], int, int) is
invoked with a large buffer size. |
Copyright © 2008–2024 The Apache Software Foundation. All rights reserved.