public final class CoreModuleProperties extends Object
Modifier and Type | Field and Description |
---|---|
static Property<Boolean> |
ABORT_ON_INVALID_CERTIFICATE
Defines if we should abort in case we encounter an invalid (e.g.
|
static String |
AGENT_FORWARDING_TYPE
The request type of agent forwarding.
|
static String |
AGENT_FORWARDING_TYPE_IETF
The agent forwarding type defined by IETF (https://tools.ietf.org/html/draft-ietf-secsh-agent-02).
|
static String |
AGENT_FORWARDING_TYPE_OPENSSH
The agent forwarding type defined by OpenSSH.
|
static Property<String> |
AUTH_METHODS
This key is used when configuring multi-step authentications.
|
static Property<Duration> |
AUTH_SOCKET_TIMEOUT
Property that can be set on the
Session in order to control the authentication timeout (millis). |
static Property<Duration> |
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 String |
AUTO_WELCOME_BANNER_VALUE
Special value that can be set for the
WELCOME_BANNER property indicating that the server should generate
a banner consisting of the random art of the server's keys (if any are provided). |
static Property<Integer> |
BUFFER_SIZE
Value used by the
InvertedShellWrapper to control copy buffer size. |
static Property<Integer> |
BUFFERED_IO_OUTPUT_MAX_PENDING_WRITE_SIZE
Key used when creating a
BufferedIoOutputStream in order to specify max. |
static Property<Duration> |
BUFFERED_IO_OUTPUT_MAX_PENDING_WRITE_WAIT
Key used when creating a
BufferedIoOutputStream in order to specify max. |
static Property<Duration> |
CHANNEL_CLOSE_TIMEOUT
Key used to configure the timeout used when writing a close request on a channel.
|
static Property<Duration> |
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> |
CLIENT_IDENTIFICATION
Key used to retrieve the value of the client identification string.
|
static Property<Duration> |
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 int |
DEFAULT_FORWARDER_BUF_SIZE |
static Property<Duration> |
DISCONNECT_TIMEOUT
Key used to retrieve the value of the disconnect timeout which is used when a disconnection is attempted.
|
static Property<Duration> |
FORWARD_REQUEST_TIMEOUT
Used to configure the timeout (milliseconds) for receiving a response for the forwarding request
|
static Property<Integer> |
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> |
HEARTBEAT_INTERVAL
Key used to set the heartbeat interval in milliseconds (0 to disable = default)
|
static Property<Duration> |
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> |
HEARTBEAT_REQUEST
Key used to check the heartbeat request that should be sent to the server
|
static Property<Duration> |
IDLE_TIMEOUT
Key used to retrieve the value of idle timeout after which it will close the connection - in milliseconds.
|
static Property<Boolean> |
IGNORE_INVALID_IDENTITIES
Whether to ignore invalid identities files when pre-initializing the client session
|
static Property<Long> |
IGNORE_MESSAGE_FREQUENCY
Average number of packets to be skipped before an
SSH_MSG_IGNORE message is inserted in the stream. |
static Property<Integer> |
IGNORE_MESSAGE_SIZE
Minimum size of
SSH_MSG_IGNORE payload to send if feature enabled. |
static Property<Integer> |
IGNORE_MESSAGE_VARIANCE
The variance to be used around the configured
IGNORE_MESSAGE_FREQUENCY value in order to avoid insertion
at a set frequency. |
static Property<Integer> |
INPUT_STREAM_PUMP_CHUNK_SIZE
On some platforms, a call to always throws an
IOException . |
static Property<String> |
INTERACTIVE_LANGUAGE_TAG
As per RFC-4256:
The language tag is deprecated and SHOULD be the empty string.
|
static Property<String> |
INTERACTIVE_SUBMETHODS
As per RFC-4256:
The submethods field is included so the user can give a hint of which actual methods he wants to use.
|
static Property<Boolean> |
KB_SERVER_INTERACTIVE_ECHO_PROMPT
|
static Property<String> |
KB_SERVER_INTERACTIVE_INSTRUCTION
|
static Property<String> |
KB_SERVER_INTERACTIVE_LANG
|
static Property<String> |
KB_SERVER_INTERACTIVE_NAME
|
static Property<String> |
KB_SERVER_INTERACTIVE_PROMPT
|
static Property<Long> |
LIMIT_PACKET_SIZE
A safety value that is designed to avoid an attack that uses large channel packet sizes
|
static Property<Integer> |
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> |
MAX_CONCURRENT_CHANNELS
Property that can be used to configure max.
|
static Property<Integer> |
MAX_CONCURRENT_SESSIONS
Key used to retrieve the value of the maximum concurrent open session count per username.
|
static Property<Integer> |
MAX_EXTDATA_BUFSIZE
Maximum amount of extended (a.k.a.
|
static int |
MAX_FORWARDER_BUF_SIZE |
static Property<Integer> |
MAX_IDENTIFICATION_SIZE
Maximum allowed size of the initial identification text sent during the handshake
|
static Property<Long> |
MAX_PACKET_SIZE
Key used to retrieve the value of the maximum packet size in the configuration properties map.
|
static int |
MIN_FORWARDER_BUF_SIZE |
static Property<String> |
MODULI_URL
A URL pointing to the moduli file.
|
static Property<Integer> |
NIO_WORKERS
Number of NIO worker threads to use.
|
static Property<Duration> |
NIO2_MIN_WRITE_TIMEOUT
Minimum NIO2 write wait timeout for a single outgoing packet - in milliseconds
|
static Property<Integer> |
NIO2_READ_BUFFER_SIZE
Read buffer size for NIO2 sessions See
Nio2Session |
static Property<Duration> |
NIO2_READ_TIMEOUT
Key used to retrieve the value of the socket read timeout for NIO2 session implementation - in milliseconds.
|
static Property<Integer> |
PASSWORD_PROMPTS
Specifies the number of interactive prompts before giving up.
|
static Property<Boolean> |
PREFER_UNIX_AGENT
|
static Property<String> |
PREFERRED_AUTHS
Ordered comma separated list of authentications methods.
|
static Property<Integer> |
PROP_DHGEX_CLIENT_MAX_KEY |
static Property<Integer> |
PROP_DHGEX_CLIENT_MIN_KEY |
static Property<Integer> |
PROP_DHGEX_CLIENT_PRF_KEY |
static Property<Integer> |
PROP_DHGEX_SERVER_MAX_KEY
See
DHGEXServer . |
static Property<Integer> |
PROP_DHGEX_SERVER_MIN_KEY
See
DHGEXServer . |
static Property<String> |
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> |
PROXY_CHANNEL_TYPE
Value used to configure the type of proxy forwarding channel to be used.
|
static Property<Duration> |
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> |
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> |
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> |
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> |
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> |
REQUEST_EXEC_REPLY
Configure whether reply for the "exec" request is required
|
static Property<Boolean> |
REQUEST_SHELL_REPLY
Configure whether reply for the "shell" request is required
|
static Property<Boolean> |
REQUEST_SUBSYSTEM_REPLY
Configure whether reply for the "subsystem&quoot; request is required
|
static Property<Boolean> |
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> |
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> |
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 char |
SERVER_EXTRA_IDENT_LINES_SEPARATOR
Separator used in the
SERVER_EXTRA_IDENTIFICATION_LINES configuration string to indicate new line break |
static Property<String> |
SERVER_EXTRA_IDENTIFICATION_LINES
Key used to retrieve any extra lines to be sent during initial protocol handshake before the
identification.
|
static Property<String> |
SERVER_IDENTIFICATION
Key used to retrieve the value of the server identification string.
|
static Property<Integer> |
SOCKET_BACKLOG
Socket backlog.
|
static Property<Boolean> |
SOCKET_KEEPALIVE
Socket keep-alive.
|
static Property<Integer> |
SOCKET_LINGER
Socket linger.
|
static Property<Integer> |
SOCKET_RCVBUF
Socket receive buffer size.
|
static Property<Boolean> |
SOCKET_REUSEADDR
Socket reuse address.
|
static Property<Integer> |
SOCKET_SNDBUF
Socket send buffer size.
|
static Property<Duration> |
STOP_WAIT_TIME
Timeout (milliseconds) to wait for client / server stop request if immediate stop requested.
|
static Property<Boolean> |
TCP_NODELAY
Socket tcp no-delay.
|
static Property<Duration> |
WAIT_FOR_SPACE_TIMEOUT
Configure max.
|
static Property<Object> |
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> |
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> |
WELCOME_BANNER_LANGUAGE
Key used to denote the language code for the welcome banner (if such a banner is configured).
|
static Property<WelcomeBannerPhase> |
WELCOME_BANNER_PHASE
The
WelcomeBannerPhase value - either as an enum or a string |
static Property<Long> |
WINDOW_SIZE
Key used to retrieve the value of the channel window size in the configuration properties map.
|
static Property<Duration> |
WINDOW_TIMEOUT
Key used to retrieve timeout (msec.) to wait for data to become available when reading from a channel.
|
static Property<Integer> |
X11_BASE_PORT
Configuration value for the
X11ForwardSupport to control the base port number
for the X11 display number socket binding. |
static Property<String> |
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> |
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> |
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> |
X11_OPEN_TIMEOUT
Configuration value for the
X11ForwardSupport to control the channel open
timeout. |
public static final Property<String> PROXY_AUTH_CHANNEL_TYPE
public static final Property<Duration> CHANNEL_OPEN_TIMEOUT
FactoryManager
or the session to configure the
channel open timeout value (millis).public static final Property<String> PROXY_CHANNEL_TYPE
public static final Property<Duration> AUTH_SOCKET_TIMEOUT
Session
in order to control the authentication timeout (millis).public static final int DEFAULT_FORWARDER_BUF_SIZE
public static final int MIN_FORWARDER_BUF_SIZE
public static final int MAX_FORWARDER_BUF_SIZE
public static final Property<Integer> FORWARDER_BUFFER_SIZE
public static final Property<String> PREFERRED_AUTHS
null
/empty, then the session's
ClientAuthenticationManager.getUserAuthFactories()
is used as-ispublic static final Property<Integer> PASSWORD_PROMPTS
public static final Property<String> CLIENT_IDENTIFICATION
public static final Property<Boolean> SEND_IMMEDIATE_IDENTIFICATION
public static final Property<Boolean> SEND_IMMEDIATE_KEXINIT
SSH_MSG_KEXINIT
immediately after sending the client identification string or wait until
the severer's one has been received.SEND_IMMEDIATE_IDENTIFICATION
public static final Property<Duration> HEARTBEAT_INTERVAL
public static final Property<String> HEARTBEAT_REQUEST
public static final Property<Duration> HEARTBEAT_REPLY_WAIT
public static final Property<Boolean> IGNORE_INVALID_IDENTITIES
public static final Property<Boolean> ABORT_ON_INVALID_CERTIFICATE
public static final Property<String> INTERACTIVE_LANGUAGE_TAG
public static final Property<String> INTERACTIVE_SUBMETHODS
public static final Property<Boolean> REQUEST_EXEC_REPLY
public static final Property<Integer> INPUT_STREAM_PUMP_CHUNK_SIZE
IOException
. So we need to protect against that and chunk the call into smaller calls. This problem was
found on Windows, JDK 1.6.0_03-b05.public static final Property<Boolean> REQUEST_SHELL_REPLY
public static final Property<Boolean> REQUEST_SUBSYSTEM_REPLY
Default value for REQUEST_SUBSYSTEM_REPLY
- according to
RFC4254 section 6.5:
It is RECOMMENDED that the reply to these messages be requested and checked.
public static final Property<Long> WINDOW_SIZE
public static final Property<Duration> WINDOW_TIMEOUT
public static final Property<Integer> BUFFERED_IO_OUTPUT_MAX_PENDING_WRITE_SIZE
BufferedIoOutputStream
in order to specify max. allowed unwritten pending bytes.
If this value is exceeded then the code waits up to BUFFERED_IO_OUTPUT_MAX_PENDING_WRITE_WAIT
for the
pending data to be written and thus make room for the new request.public static final Property<Duration> BUFFERED_IO_OUTPUT_MAX_PENDING_WRITE_WAIT
BufferedIoOutputStream
in order to specify max. wait time (msec.) for pending
writes to be completed before enqueuing a new requestpublic static final Property<Long> MAX_PACKET_SIZE
public static final Property<Long> LIMIT_PACKET_SIZE
public static final Property<Duration> AUTH_TIMEOUT
public static final Property<Duration> IDLE_TIMEOUT
public static final Property<Duration> NIO2_READ_TIMEOUT
public static final Property<Duration> NIO2_MIN_WRITE_TIMEOUT
public static final Property<Duration> DISCONNECT_TIMEOUT
public static final Property<Duration> CHANNEL_CLOSE_TIMEOUT
public static final Property<Duration> STOP_WAIT_TIME
public static final Property<Integer> SOCKET_BACKLOG
AsynchronousServerSocketChannel.bind(java.net.SocketAddress, int)
public static final Property<Boolean> SOCKET_KEEPALIVE
StandardSocketOptions.SO_KEEPALIVE
public static final Property<Integer> SOCKET_SNDBUF
StandardSocketOptions.SO_SNDBUF
public static final Property<Integer> SOCKET_RCVBUF
StandardSocketOptions.SO_RCVBUF
public static final Property<Boolean> SOCKET_REUSEADDR
StandardSocketOptions.SO_REUSEADDR
public static final Property<Integer> SOCKET_LINGER
StandardSocketOptions.SO_LINGER
public static final Property<Boolean> TCP_NODELAY
StandardSocketOptions.TCP_NODELAY
public static final Property<Integer> NIO2_READ_BUFFER_SIZE
Nio2Session
public static final Property<Integer> MAX_IDENTIFICATION_SIZE
public static final Property<Long> REKEY_BYTES_LIMIT
public static final Property<Duration> REKEY_TIME_LIMIT
public static final Property<Long> REKEY_PACKETS_LIMIT
public static final Property<Long> REKEY_BLOCKS_LIMIT
public static final Property<Long> IGNORE_MESSAGE_FREQUENCY
SSH_MSG_IGNORE
message is inserted in the stream. If
non-positive, then feature is disabledIGNORE_MESSAGE_VARIANCE
,
RFC4251 section 9.3.1public static final Property<Integer> IGNORE_MESSAGE_VARIANCE
IGNORE_MESSAGE_FREQUENCY
value in order to avoid insertion
at a set frequency. If zero, then exact frequency is used. If negative, then the absolute value is
used. If greater or equal to the frequency, then assumed to be zero - i.e., no variancepublic static final Property<Integer> IGNORE_MESSAGE_SIZE
SSH_MSG_IGNORE
payload to send if feature enabled. If non-positive then no message is
sent. Otherwise, the actual size is between this size and twice its valuepublic static final String AGENT_FORWARDING_TYPE
public static final String AGENT_FORWARDING_TYPE_IETF
public static final String AGENT_FORWARDING_TYPE_OPENSSH
public static final Property<Duration> WAIT_FOR_SPACE_TIMEOUT
public static final Property<Duration> FORWARD_REQUEST_TIMEOUT
public static final Property<Integer> MAX_CONCURRENT_CHANNELS
public static final Property<Boolean> SEND_REPLY_FOR_CHANNEL_DATA
SSH_MSG_CHANNEL_DATA
and
SSH_MSG_CHANNEL_EXTENDED_DATA
received through an unknown channel. Therefore, we provide a configurable
approach to it with the default set to ignore it.public static final Property<Integer> MAX_AUTH_REQUESTS
public static final Property<Object> WELCOME_BANNER
null
/empty then no banner will be sent. The value can be one of the following:
File
or Path
, in which case its contents will be transmitted.
Note: if the file is empty or does not exits, no banner will be transmitted.
URI
or a string starting with "file:/", in which case it will be converted to a
Path
and handled accordingly.
AUTO_WELCOME_BANNER_VALUE
, in which case the
relevant banner content will be generated.
toString()
value yields a non empty string will be used as the banner
contents.public static final String AUTO_WELCOME_BANNER_VALUE
WELCOME_BANNER
property indicating that the server should generate
a banner consisting of the random art of the server's keys (if any are provided). If no server keys are
available, then no banner will be sentpublic static final Property<String> WELCOME_BANNER_LANGUAGE
public static final Property<WelcomeBannerPhase> WELCOME_BANNER_PHASE
WelcomeBannerPhase
value - either as an enum or a stringpublic static final Property<Charset> WELCOME_BANNER_CHARSET
Charset
then the local default is used.public static final Property<String> AUTH_METHODS
publickey,password publickey,keyboard-interactive
would require the user to complete public key
authentication, followed by either password or keyboard interactive authentication. Only methods that are next in
one or more lists are offered at each stage, so for this example, it would not be possible to attempt password or
keyboard-interactive authentication before public key.public static final Property<Integer> MAX_CONCURRENT_SESSIONS
public static final Property<String> SERVER_EXTRA_IDENTIFICATION_LINES
public static final char SERVER_EXTRA_IDENT_LINES_SEPARATOR
SERVER_EXTRA_IDENTIFICATION_LINES
configuration string to indicate new line breakpublic static final Property<String> SERVER_IDENTIFICATION
public static final Property<Duration> COMMAND_EXIT_TIMEOUT
public static final Property<String> MODULI_URL
public static final Property<String> KB_SERVER_INTERACTIVE_INSTRUCTION
public static final Property<Boolean> KB_SERVER_INTERACTIVE_ECHO_PROMPT
public static final Property<Integer> MAX_EXTDATA_BUFSIZE
ChannelDataReceiver
for
the data is registeredpublic static final Property<Integer> PROP_DHGEX_SERVER_MIN_KEY
DHGEXServer
.public static final Property<Integer> PROP_DHGEX_SERVER_MAX_KEY
DHGEXServer
.public static final Property<Duration> PUMP_SLEEP_TIME
InvertedShellWrapper
to control the "busy-wait"
sleep time (millis) on the pumping loop if nothing was pumped - must be positive.public static final Property<Integer> BUFFER_SIZE
InvertedShellWrapper
to control copy buffer size.public static final Property<Duration> X11_OPEN_TIMEOUT
X11ForwardSupport
to control the channel open
timeout.public static final Property<Integer> X11_DISPLAY_OFFSET
X11ForwardSupport
to control from which X11
display number to start looking for a free value.public static final Property<Integer> X11_MAX_DISPLAYS
X11ForwardSupport
to control up to which (but not
including) X11 display number to look or a free value.public static final Property<Integer> X11_BASE_PORT
X11ForwardSupport
to control the base port number
for the X11 display number socket binding.public static final Property<String> X11_BIND_HOST
X11ForwardSupport
to control the host used to bind
to for the X11 display when looking for a free port.Copyright © 2008–2022 The Apache Software Foundation. All rights reserved.