Modifier and Type | Class and Description |
---|---|
class |
AgentForwardedChannel |
class |
ChannelAgentForwarding
The client side channel that will receive requests forwards by the SSH server.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
ProxyAgentFactory.isPreferredUnixAgent(PropertyResolver resolver) |
Modifier and Type | Interface and Description |
---|---|
interface |
ClientFactoryManager
The
ClientFactoryManager enable the retrieval of additional configuration needed specifically for the
client side. |
Modifier and Type | Class and Description |
---|---|
class |
SshClient
Entry point for the client side of the SSH protocol.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ClientChannel
A client channel used to communicate with the SSH server.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractClientChannel
TODO Add javadoc
|
class |
ChannelDirectTcpip
TODO Add javadoc
|
class |
ChannelExec
Client channel to run a remote command
|
class |
ChannelSession
Client side channel session
|
class |
ChannelShell
Client channel to open a remote shell
|
class |
ChannelSubsystem
Client channel to run a subsystem
|
class |
PtyCapableChannelSession
Serves as the base channel session for executing remote commands - including a full shell.
|
Modifier and Type | Method and Description |
---|---|
static <C extends SshClient> |
SshClientConfigFileReader.configure(C client,
PropertyResolver props,
boolean lenient,
boolean ignoreUnsupported) |
static <C extends SshClient> |
SshClientConfigFileReader.setupClientHeartbeat(C client,
PropertyResolver props) |
Modifier and Type | Interface and Description |
---|---|
interface |
ClientSession
An authenticated session to a given SSH server.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractClientSession
Provides default implementations of
ClientSession related methods |
class |
ClientConnectionService
Client side
ssh-connection service. |
class |
ClientSessionImpl
The default implementation of a
ClientSession |
class |
ClientUserAuthService
Client side
ssh-auth service. |
Modifier and Type | Interface and Description |
---|---|
interface |
FactoryManager
This interface allows retrieving all the
NamedFactory used in the SSH protocol. |
interface |
Service
See RFC 4253 [SSH-TRANS] and the SSH_MSG_SERVICE_REQUEST packet.
|
Modifier and Type | Field and Description |
---|---|
static PropertyResolver |
PropertyResolver.EMPTY
An "empty" resolver with no properties and no parent
|
static PropertyResolver |
SyspropsMapWrapper.RAW_PROPS_RESOLVER
Exposes the "raw" system properties as a
PropertyResolver without any further filtering |
static PropertyResolver |
SyspropsMapWrapper.SYSPROPS_RESOLVER
A
PropertyResolver with no parent that exposes the system properties |
Modifier and Type | Method and Description |
---|---|
default PropertyResolver |
Service.getParentPropertyResolver() |
PropertyResolver |
PropertyResolver.getParentPropertyResolver() |
static PropertyResolver |
PropertyResolverUtils.toPropertyResolver(Map<String,?> props)
Wraps a
Map into a PropertyResolver so it can be used with these utilities |
static PropertyResolver |
PropertyResolverUtils.toPropertyResolver(Map<String,?> props,
PropertyResolver parent) |
static PropertyResolver |
PropertyResolverUtils.toPropertyResolver(Properties props) |
Modifier and Type | Method and Description |
---|---|
Optional<T> |
Property.get(PropertyResolver resolver) |
Optional<T> |
Property.BaseProperty.get(PropertyResolver resolver) |
Optional<T> |
Property.Validating.get(PropertyResolver resolver) |
static Boolean |
PropertyResolverUtils.getBoolean(PropertyResolver resolver,
String name) |
static boolean |
PropertyResolverUtils.getBooleanProperty(PropertyResolver resolver,
String name,
boolean defaultValue) |
static Charset |
PropertyResolverUtils.getCharset(PropertyResolver resolver,
String name,
Charset defaultValue) |
static Integer |
PropertyResolverUtils.getInteger(PropertyResolver resolver,
String name) |
static int |
PropertyResolverUtils.getIntProperty(PropertyResolver resolver,
String name,
int defaultValue) |
static Long |
PropertyResolverUtils.getLong(PropertyResolver resolver,
String name) |
static long |
PropertyResolverUtils.getLongProperty(PropertyResolver resolver,
String name,
long defaultValue) |
static Duration |
Closeable.getMaxCloseWaitTime(PropertyResolver resolver) |
static Object |
PropertyResolverUtils.getObject(PropertyResolver resolver,
String name) |
static Object |
PropertyResolverUtils.getObject(PropertyResolver resolver,
String name,
Object defaultValue) |
T |
Property.getOrCustomDefault(PropertyResolver resolver,
T defaultValue) |
T |
Property.BaseProperty.getOrCustomDefault(PropertyResolver resolver,
T defaultValue) |
T |
Property.Validating.getOrCustomDefault(PropertyResolver resolver,
T defaultValue) |
default T |
Property.getOrNull(PropertyResolver resolver) |
default T |
Property.getRequired(PropertyResolver resolver) |
static String |
PropertyResolverUtils.getString(PropertyResolver resolver,
String name) |
static String |
PropertyResolverUtils.getStringProperty(PropertyResolver resolver,
String name,
String defaultValue) |
static boolean |
PropertyResolver.isEmpty(PropertyResolver resolver) |
default void |
Property.remove(PropertyResolver resolver) |
void |
Property.Validating.remove(PropertyResolver resolver) |
static Map<String,Object> |
PropertyResolverUtils.resolvePropertiesSource(PropertyResolver resolver,
String name)
Unwinds the resolvers hierarchy until found one with a non-
null value for the requested property or
reached top. |
static Object |
PropertyResolverUtils.resolvePropertyValue(PropertyResolver resolver,
String name)
Unwinds the resolvers hierarchy until found one with a non-
null value for the requested property or
reached top. |
void |
Property.set(PropertyResolver resolver,
T value) |
void |
Property.BaseProperty.set(PropertyResolver resolver,
T value) |
void |
Property.Validating.set(PropertyResolver resolver,
T value) |
static PropertyResolver |
PropertyResolverUtils.toPropertyResolver(Map<String,?> props,
PropertyResolver parent) |
static Object |
PropertyResolverUtils.updateProperty(PropertyResolver resolver,
String name,
boolean value) |
static Object |
PropertyResolverUtils.updateProperty(PropertyResolver resolver,
String name,
int value) |
static Object |
PropertyResolverUtils.updateProperty(PropertyResolver resolver,
String name,
long value) |
static Object |
PropertyResolverUtils.updateProperty(PropertyResolver resolver,
String name,
Object value) |
Modifier and Type | Interface and Description |
---|---|
interface |
Channel
Represents a channel opened over an SSH session - holds information that is common both to server and client
channels.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractChannel
Provides common client/server channel functionality
|
Modifier and Type | Method and Description |
---|---|
PropertyResolver |
AbstractChannel.getParentPropertyResolver() |
Modifier and Type | Method and Description |
---|---|
void |
RemoteWindow.init(long size,
long packetSize,
PropertyResolver resolver)
Initializes the
RemoteWindow with the packet and window sizes received from the peer. |
protected void |
Window.init(long size,
long packetSize,
PropertyResolver resolver) |
void |
LocalWindow.init(PropertyResolver resolver)
Initializes the
LocalWindow with the packet and window sizes from the resolver . |
Constructor and Description |
---|
BufferedIoOutputStream(Object id,
long channelId,
IoOutputStream out,
PropertyResolver resolver) |
ChannelPipedInputStream(PropertyResolver resolver,
LocalWindow localWindow) |
Modifier and Type | Method and Description |
---|---|
static <M extends AbstractFactoryManager> |
SshConfigFileReader.configure(M manager,
PropertyResolver props,
boolean lenient,
boolean ignoreUnsupported)
Configures an
AbstractFactoryManager with the values read from some configuration. |
static <M extends AbstractFactoryManager> |
SshConfigFileReader.configureCiphers(M manager,
PropertyResolver props,
boolean lenient,
boolean ignoreUnsupported) |
static <M extends AbstractFactoryManager> |
SshConfigFileReader.configureCompression(M manager,
PropertyResolver props,
boolean lenient,
boolean ignoreUnsupported)
Configure the factory manager using one of the known
CompressionConfigValue s. |
static <M extends AbstractFactoryManager> |
SshConfigFileReader.configureKeyExchanges(M manager,
PropertyResolver props,
boolean lenient,
Function<? super DHFactory,? extends KeyExchangeFactory> xformer,
boolean ignoreUnsupported) |
static <M extends AbstractFactoryManager> |
SshConfigFileReader.configureMacs(M manager,
PropertyResolver resolver,
boolean lenient,
boolean ignoreUnsupported) |
static <M extends AbstractFactoryManager> |
SshConfigFileReader.configureSignatures(M manager,
PropertyResolver props,
boolean lenient,
boolean ignoreUnsupported) |
static BuiltinCiphers.ParseResult |
SshConfigFileReader.getCiphers(PropertyResolver props) |
static CompressionFactory |
SshConfigFileReader.getCompression(PropertyResolver props) |
static BuiltinDHFactories.ParseResult |
SshConfigFileReader.getKexFactories(PropertyResolver props) |
static BuiltinMacs.ParseResult |
SshConfigFileReader.getMacs(PropertyResolver props) |
static BuiltinSignatures.ParseResult |
SshConfigFileReader.getSignatures(PropertyResolver props) |
Modifier and Type | Class and Description |
---|---|
class |
TcpipClientChannel
TODO Add javadoc
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractFactoryManager |
Modifier and Type | Method and Description |
---|---|
PropertyResolver |
AbstractFactoryManager.getParentPropertyResolver() |
Modifier and Type | Method and Description |
---|---|
void |
AbstractFactoryManager.setParentPropertyResolver(PropertyResolver parent) |
Modifier and Type | Field and Description |
---|---|
protected PropertyResolver |
Nio2Connector.ConnectionCompletionHandler.propertyResolver |
protected PropertyResolver |
Nio2Service.propertyResolver |
Modifier and Type | Method and Description |
---|---|
protected Nio2CompletionHandler<Void,Object> |
Nio2Connector.createConnectionCompletionHandler(IoConnectFuture future,
AsynchronousSocketChannel socket,
AttributeRepository context,
PropertyResolver propertyResolver,
IoHandler handler) |
protected Nio2Session |
Nio2Connector.createSession(PropertyResolver propertyResolver,
IoHandler handler,
AsynchronousSocketChannel socket) |
Constructor and Description |
---|
ConnectionCompletionHandler(IoConnectFuture future,
AsynchronousSocketChannel socket,
AttributeRepository context,
PropertyResolver propertyResolver,
IoHandler handler) |
Nio2Acceptor(PropertyResolver propertyResolver,
IoHandler handler,
AsynchronousChannelGroup group,
ExecutorService resumeTasks) |
Nio2Connector(PropertyResolver propertyResolver,
IoHandler handler,
AsynchronousChannelGroup group,
ExecutorService resumeTasks) |
Nio2Service(PropertyResolver propertyResolver,
IoHandler handler,
AsynchronousChannelGroup group,
ExecutorService resumeTasks) |
Nio2Session(Nio2Service service,
PropertyResolver propertyResolver,
IoHandler handler,
AsynchronousSocketChannel socket,
SocketAddress acceptanceAddress) |
Modifier and Type | Interface and Description |
---|---|
interface |
ConnectionService
Interface implementing ssh-connection service.
|
interface |
Session
Represents an SSH session.
|
interface |
SessionContext
A "succinct" summary of the most important attributes of an SSH session
|
interface |
SessionHeartbeatController |
Modifier and Type | Class and Description |
---|---|
class |
AbstractConnectionService
Base implementation of ConnectionService.
|
class |
AbstractSession
The AbstractSession handles all the basic SSH protocol such as key exchange, authentication, encoding and decoding.
|
class |
SessionHelper
Contains split code in order to make
AbstractSession class smaller |
Modifier and Type | Method and Description |
---|---|
PropertyResolver |
SessionHelper.getParentPropertyResolver() |
Modifier and Type | Method and Description |
---|---|
void |
Buffer.dumpHex(SimplifiedLog logger,
Level level,
String prefix,
PropertyResolver resolver) |
static void |
BufferUtils.dumpHex(SimplifiedLog logger,
Level level,
String prefix,
PropertyResolver resolver,
char sep,
byte... data) |
static void |
BufferUtils.dumpHex(SimplifiedLog logger,
Level level,
String prefix,
PropertyResolver resolver,
char sep,
byte[] data,
int offset,
int len) |
void |
Buffer.dumpHex(SimplifiedLog logger,
String prefix,
PropertyResolver resolver) |
Constructor and Description |
---|
LoggingFilterOutputStream(OutputStream out,
String msg,
org.slf4j.Logger log,
PropertyResolver resolver) |
Modifier and Type | Interface and Description |
---|---|
interface |
SecurityProviderRegistrar |
Modifier and Type | Class and Description |
---|---|
class |
AbstractSecurityProviderRegistrar |
Modifier and Type | Method and Description |
---|---|
default PropertyResolver |
SecurityProviderRegistrar.getParentPropertyResolver() |
Modifier and Type | Method and Description |
---|---|
static boolean |
SecurityProviderRegistrar.isSecurityEntitySupported(PropertyResolver resolver,
String propName,
Class<?> entityType,
String name,
String defaultValue) |
Modifier and Type | Class and Description |
---|---|
class |
BouncyCastleSecurityProviderRegistrar |
Modifier and Type | Class and Description |
---|---|
class |
EdDSASecurityProviderRegistrar |
Modifier and Type | Interface and Description |
---|---|
interface |
ServerFactoryManager
The
ServerFactoryManager enable the retrieval of additional configuration needed specifically for the
server side. |
Modifier and Type | Class and Description |
---|---|
class |
SshServer
The SshServer class is the main entry point for the server side of the SSH protocol.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ServerChannel |
Modifier and Type | Class and Description |
---|---|
class |
AbstractServerChannel
TODO Add javadoc
|
Constructor and Description |
---|
PipeDataReceiver(PropertyResolver resolver,
LocalWindow localWindow) |
Modifier and Type | Method and Description |
---|---|
static <S extends SshServer> |
SshServerConfigFileReader.configure(S server,
PropertyResolver props,
boolean lenient,
boolean ignoreUnsupported) |
static AgentForwardingFilter |
SshServerConfigFileReader.resolveAgentForwardingFilter(PropertyResolver options) |
static Object |
SshServerConfigFileReader.resolveBanner(PropertyResolver options) |
static ForwardingFilter |
SshServerConfigFileReader.resolveServerForwarding(PropertyResolver options) |
static TcpForwardingFilter |
SshServerConfigFileReader.resolveTcpForwardingFilter(PropertyResolver options) |
static X11ForwardingFilter |
SshServerConfigFileReader.resolveX11ForwardingFilter(PropertyResolver options) |
static <S extends ServerFactoryManager> |
SshServerConfigFileReader.setupServerHeartbeat(S server,
PropertyResolver props) |
static <S extends ServerFactoryManager> |
SshServerConfigFileReader.setupSftpSubsystem(S server,
PropertyResolver props) |
Modifier and Type | Class and Description |
---|---|
class |
TcpipServerChannel
TODO Add javadoc
|
Modifier and Type | Interface and Description |
---|---|
interface |
ServerSession |
Modifier and Type | Class and Description |
---|---|
class |
AbstractServerSession
Provides default implementations for
ServerSession related methods |
class |
ServerConnectionService
Server side
ssh-connection service. |
class |
ServerSessionImpl
The default implementation for a
ServerSession |
class |
ServerUserAuthService |
Modifier and Type | Class and Description |
---|---|
class |
ChannelForwardedX11 |
Modifier and Type | Method and Description |
---|---|
static <I extends OpenSSHLimitsExtensionInfo> |
OpenSSHLimitsExtensionInfo.fill(PropertyResolver resolver,
I info) |
Constructor and Description |
---|
OpenSSHLimitsExtensionInfo(PropertyResolver resolver) |
Modifier and Type | Method and Description |
---|---|
PropertyResolver |
SftpFileSystemInitializationContext.getPropertyResolver() |
Modifier and Type | Method and Description |
---|---|
protected SftpErrorDataHandler |
SftpFileSystemProvider.resolveSftpErrorDataHandler(URI uri,
SftpErrorDataHandler errorHandler,
PropertyResolver resolver) |
protected SftpVersionSelector |
SftpFileSystemProvider.resolveSftpVersionSelector(URI uri,
SftpVersionSelector defaultSelector,
PropertyResolver resolver) |
void |
SftpFileSystemInitializationContext.setPropertyResolver(PropertyResolver propertyResolver) |
Modifier and Type | Class and Description |
---|---|
protected class |
DefaultSftpClient.SftpChannelSubsystem |
Modifier and Type | Method and Description |
---|---|
static Boolean |
SftpHelper.indicateEndOfNamesList(Buffer buffer,
int version,
PropertyResolver resolver)
Appends the end-of-list=
TRUE indicator for SSH_FXP_NAME responses, provided the version is at
least 6 and the feature is enabled |
static Boolean |
SftpHelper.indicateEndOfNamesList(Buffer buffer,
int version,
PropertyResolver resolver,
boolean indicatorValue)
Appends the end-of-list indicator for
SSH_FXP_NAME responses, provided the version is at least 6, the
feature is enabled and the indicator value is not null |
Copyright © 2008–2024 The Apache Software Foundation. All rights reserved.