Struct ServerBuilder 

pub struct ServerBuilder { /* private fields */ }

Builder for creating an SSH server.

Implementations

impl ServerBuilder

pub fn new() -> Self

Creates a new server builder.

pub fn address(self, addr: impl Into<String>) -> Self

Sets the listen address.

pub fn version(self, version: impl Into<String>) -> Self

Sets the server version.

pub fn banner(self, banner: impl Into<String>) -> Self

Sets a static banner.

pub fn banner_handler<F>(self, handler: F) -> Self

where F: Fn(&Context) -> String + Send + Sync + 'static,

Sets a dynamic banner handler.

pub fn host_key_path(self, path: impl Into<String>) -> Self

Sets the host key path.

pub fn host_key_pem(self, pem: Vec<u8>) -> Self

Sets the host key from PEM data.

pub fn with_middleware(self, mw: Middleware) -> Self

Adds middleware to the server.

pub fn handler<F, Fut>(self, handler: F) -> Self

where F: Fn(Session) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Sets the main handler.

pub fn handler_arc(self, handler: Handler) -> Self

Sets the main handler from a pre-wrapped Handler.

Use this when you already have a Handler (e.g., from the handler function).

pub fn auth_handler<H: AuthHandler + 'static>(self, handler: H) -> Self

Sets the trait-based authentication handler.

If set, this takes precedence over the callback-based handlers.

pub fn max_auth_attempts(self, max: u32) -> Self

Sets the maximum authentication attempts.

pub fn auth_rejection_delay(self, delay_ms: u64) -> Self

Sets the authentication rejection delay in milliseconds.

pub fn allow_no_auth(self) -> Self

Allow unauthenticated access when no auth handlers are configured.

By default, auth_none is rejected unless at least one auth handler is registered. Call this to explicitly opt in to anonymous access (e.g., for demo/development servers).

pub fn public_key_auth<F>(self, handler: F) -> Self

where F: Fn(&Context, &PublicKey) -> bool + Send + Sync + 'static,

Sets the public key authentication handler.

pub fn password_auth<F>(self, handler: F) -> Self

where F: Fn(&Context, &str) -> bool + Send + Sync + 'static,

Sets the password authentication handler.

pub fn keyboard_interactive_auth<F>(self, handler: F) -> Self

where F: Fn(&Context, &str, &[String], &[bool]) -> Vec<String> + Send + Sync + 'static,

Sets the keyboard-interactive authentication handler.

pub fn idle_timeout(self, duration: Duration) -> Self

Sets the idle timeout.

pub fn max_timeout(self, duration: Duration) -> Self

Sets the maximum connection timeout.

pub fn subsystem<F, Fut>(self, name: impl Into<String>, handler: F) -> Self

where F: Fn(Session) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Adds a subsystem handler.

pub fn build(self) -> Result<Server>

Builds the server.

Trait Implementations

impl Default for ServerBuilder

fn default() -> ServerBuilder

Returns the “default value” for a type.