Class ServerBuilder

java.lang.Object

org.apache.sshd.common.BaseBuilder<SshServer, ServerBuilder>

org.apache.sshd.server.ServerBuilder

All Implemented Interfaces:

Supplier<SshServer>, org.apache.sshd.common.util.ObjectBuilder<SshServer>

public class ServerBuilder
extends BaseBuilder<SshServer, ServerBuilder>

SshServer builder

Field Summary

Fields

Modifier and Type	Field	Description
static final List<ChannelFactory>	DEFAULT_CHANNEL_FACTORIES
static final List<org.apache.sshd.common.compression.CompressionFactory>	DEFAULT_COMPRESSION_FACTORIES
static final List<RequestHandler<ConnectionService>>	DEFAULT_GLOBAL_REQUEST_HANDLERS
static final KeyboardInteractiveAuthenticator	DEFAULT_INTERACTIVE_AUTHENTICATOR
static final KexExtensionHandler	DEFAULT_KEX_EXTENSION_HANDLER
static final PublickeyAuthenticator	DEFAULT_PUBLIC_KEY_AUTHENTICATOR
static final List<org.apache.sshd.common.cipher.BuiltinCiphers>	DEFAULT_SERVER_CIPHERS_PREFERENCE	Default list of ciphers for a server.
static final Function<DHFactory, KeyExchangeFactory>	DH2KEX
protected KeyboardInteractiveAuthenticator	interactiveAuthenticator
protected PublickeyAuthenticator	pubkeyAuthenticator

Fields inherited from class BaseBuilder

channelFactories, channelStreamPacketWriterResolver, cipherFactories, compressionFactories, DEFAULT_CIPHERS_PREFERENCE, DEFAULT_FILE_SYSTEM_FACTORY, DEFAULT_FORWARDER_FACTORY, DEFAULT_FORWARDING_FILTER, DEFAULT_KEX_PREFERENCE, DEFAULT_MAC_PREFERENCE, DEFAULT_SIGNATURE_PREFERENCE, DEFAULT_UNKNOWN_CHANNEL_REFERENCE_HANDLER, factory, fileSystemFactory, forwarderFactory, forwardingFilter, globalRequestHandlers, kexExtensionHandler, keyExchangeFactories, macFactories, randomFactory, signatureFactories, unknownChannelReferenceHandler

Constructor Summary

Constructors

Constructor	Description
ServerBuilder()

Method Summary

Modifier and Type	Method	Description
SshServer	build(boolean isFillWithDefaultValues)
static ServerBuilder	builder()
protected ServerBuilder	fillWithDefaultValues()
ServerBuilder	interactiveAuthenticator(KeyboardInteractiveAuthenticator auth)
ServerBuilder	publickeyAuthenticator(PublickeyAuthenticator auth)
static List<org.apache.sshd.common.NamedFactory<org.apache.sshd.common.compression.Compression>>	setUpDefaultCompressionFactories(boolean ignoreUnsupported)
static List<KeyExchangeFactory>	setUpDefaultKeyExchanges(boolean ignoreUnsupported)
static List<org.apache.sshd.common.NamedFactory<org.apache.sshd.common.signature.Signature>>	setUpDefaultSignatureFactories(boolean ignoreUnsupported)

Methods inherited from class BaseBuilder

build, channelFactories, channelStreamPacketWriterResolver, cipherFactories, compressionFactories, factory, fileSystemFactory, forwarderFactory, forwardingFilter, globalRequestHandlers, kexExtensionHandler, keyExchangeFactories, macFactories, me, randomFactory, setUpDefaultCiphers, setUpDefaultMacs, signatureFactories, unknownChannelReferenceHandler

Methods inherited from class Object

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

Methods inherited from interface org.apache.sshd.common.util.ObjectBuilder

get

Field Details

DH2KEX

public static final Function<DHFactory, KeyExchangeFactory> DH2KEX

DEFAULT_CHANNEL_FACTORIES

public static final List<ChannelFactory> DEFAULT_CHANNEL_FACTORIES

DEFAULT_GLOBAL_REQUEST_HANDLERS

public static final List<RequestHandler<ConnectionService>> DEFAULT_GLOBAL_REQUEST_HANDLERS

DEFAULT_PUBLIC_KEY_AUTHENTICATOR

public static final PublickeyAuthenticator DEFAULT_PUBLIC_KEY_AUTHENTICATOR

DEFAULT_INTERACTIVE_AUTHENTICATOR

public static final KeyboardInteractiveAuthenticator DEFAULT_INTERACTIVE_AUTHENTICATOR

DEFAULT_COMPRESSION_FACTORIES

public static final List<org.apache.sshd.common.compression.CompressionFactory> DEFAULT_COMPRESSION_FACTORIES

DEFAULT_KEX_EXTENSION_HANDLER

public static final KexExtensionHandler DEFAULT_KEX_EXTENSION_HANDLER

DEFAULT_SERVER_CIPHERS_PREFERENCE

public static final List<org.apache.sshd.common.cipher.BuiltinCiphers> DEFAULT_SERVER_CIPHERS_PREFERENCE

Default list of ciphers for a server. This excludes the AES-CBC ciphers -- OpenSSH has stopped proposing them by default in 2014 (and removed them from the client proposal in 2017, too). CBC is susceptible to padding oracle attacks and other attacks and is thus not recommended anymore.

For clients, we do still include the CBC modes to better support connecting with legacy servers.

pubkeyAuthenticator

protected PublickeyAuthenticator pubkeyAuthenticator

interactiveAuthenticator

protected KeyboardInteractiveAuthenticator interactiveAuthenticator

Constructor Details

ServerBuilder

public ServerBuilder()

Method Details

interactiveAuthenticator

public ServerBuilder interactiveAuthenticator(KeyboardInteractiveAuthenticator auth)

publickeyAuthenticator

public ServerBuilder publickeyAuthenticator(PublickeyAuthenticator auth)

fillWithDefaultValues

protected ServerBuilder fillWithDefaultValues()

Overrides:

fillWithDefaultValues in class BaseBuilder<SshServer, ServerBuilder>

build

public SshServer build(boolean isFillWithDefaultValues)

Overrides:

build in class BaseBuilder<SshServer, ServerBuilder>

setUpDefaultSignatureFactories

public static List<org.apache.sshd.common.NamedFactory<org.apache.sshd.common.signature.Signature>> setUpDefaultSignatureFactories(boolean ignoreUnsupported)

setUpDefaultCompressionFactories

public static List<org.apache.sshd.common.NamedFactory<org.apache.sshd.common.compression.Compression>> setUpDefaultCompressionFactories(boolean ignoreUnsupported)

setUpDefaultKeyExchanges

public static List<KeyExchangeFactory> setUpDefaultKeyExchanges(boolean ignoreUnsupported)

Parameters:

ignoreUnsupported - If true then all the default key exchanges are included, regardless of whether they are currently supported by the JCE. Otherwise, only the supported ones out of the list are included

Returns:

A List of the default NamedFactory instances of the KeyExchanges according to the preference order defined by BaseBuilder.DEFAULT_KEX_PREFERENCE. Note: the list may be filtered to exclude unsupported JCE key exchanges according to the ignoreUnsupported parameter

See Also:

• BuiltinDHFactories.isSupported()

builder

public static ServerBuilder builder()