sshd

SSHD daemon factory implementation.

class saltfactories.daemons.sshd.Sshd(*, cwd=_Nothing.NOTHING, environ=_Nothing.NOTHING, slow_stop=True, system_encoding=_Nothing.NOTHING, timeout=_Nothing.NOTHING, script_name, base_script_args=_Nothing.NOTHING, check_ports=_Nothing.NOTHING, stats_processes=None, start_timeout, max_start_attempts=3, extra_cli_arguments_after_first_start_failure=_Nothing.NOTHING, start_checks_callbacks=_Nothing.NOTHING, config_dir, listen_address=None, listen_port=None, authorized_keys=None, sshd_config_dict=None, display_name=None, ssh_keygen_path='/usr/bin/ssh-keygen', ssh_keyscan_path='/usr/bin/ssh-keyscan')

Bases: Daemon

SSHD implementation.

Parameters:

• cwd (str | Path) –

• environ (EnvironDict) –

• slow_stop (bool) –

• system_encoding (str) –

• timeout (int | float) –

• script_name (str) –

• base_script_args (List[str]) –

• check_ports (List[int]) –

• stats_processes (StatsProcesses) –

• start_timeout (int | float) –

• max_start_attempts (int) –

• extra_cli_arguments_after_first_start_failure (List[str]) –

• start_checks_callbacks (List[Callback]) –

get_display_name()

Returns a human readable name for the factory.

get_base_script_args()

Returns any additional arguments to pass to the CLI script.

get_host_keys()

Return a list of strings which are the SSHD server host keys.

after_start(callback, *args, **kwargs)

Register a function callback to run after the daemon starts.

Arguments:

callback:

The function to call back

Keyword Arguments:

args:

The arguments to pass to the callback

kwargs:

The keyword arguments to pass to the callback

Returns:

Nothing.

Parameters:

• callback (Callable[[], None]) –

• args (Any) –

• kwargs (Any) –

Return type:

None

after_terminate(callback, *args, **kwargs)

Register a function callback to run after the daemon terminates.

Arguments:

callback:

The function to call back

Keyword Arguments:

args:

The arguments to pass to the callback

kwargs:

The keyword arguments to pass to the callback

Returns:

Nothing.

Parameters:

• callback (Callable[[], None]) –

• args (Any) –

• kwargs (Any) –

Return type:

None

before_start(callback, *args, **kwargs)

Register a function callback to run before the daemon starts.

Arguments:

callback:

The function to call back

Keyword Arguments:

args:

The arguments to pass to the callback

kwargs:

The keyword arguments to pass to the callback

Returns:

Nothing.

Parameters:

• callback (Callable[[], None]) –

• args (Any) –

• kwargs (Any) –

Return type:

None

before_terminate(callback, *args, **kwargs)

Register a function callback to run before the daemon terminates.

Arguments:

callback:

The function to call back

Keyword Arguments:

args:

The arguments to pass to the callback

kwargs:

The keyword arguments to pass to the callback

Returns:

Nothing.

Parameters:

• callback (Callable[[], None]) –

• args (Any) –

• kwargs (Any) –

Return type:

None

cmdline(*args)

Construct a list of arguments to use when starting the subprocess.

Arguments:

args:

Additional arguments to use when starting the subprocess

Parameters:

args (str) –

Return type:

List[str]

get_check_ports()

Return a list of ports to check against to ensure the daemon is running.

Return type:

List[int]

get_script_args()

Returns any additional arguments to pass to the CLI script.

Return type:

List[str]

get_script_path()

Returns the path to the script to run.

Return type:

str

get_start_check_callbacks()

Return a list of the start check callbacks.

Return type:

List[Callback]

is_running()

Returns true if the sub-process is alive.

Return type:

bool

property pid: int | None

The pid of the running process. None if not running.

process_output(stdout, stderr, cmdline=None)

Process the output. When possible JSON is loaded from the output.

Returns:

Returns a tuple in the form of (stdout, stderr, loaded_json)

Parameters:

• stdout (str) –

• stderr (str) –

• cmdline (List[str] | None) –

Return type:

Tuple[str, str, Dict[Any, Any] | None]

run(*args, env=None, _timeout=None, **kwargs)

Run the given command synchronously.

Keyword Arguments:

args:

The list of arguments to pass to cmdline() to construct the command to run

env:

Pass a dictionary of environment key, value pairs to inject into the subprocess.

_timeout:

The timeout value for this particular run() call. If this value is not None, it will be used instead of timeout, the default timeout.

Parameters:

• args (str) –

• env (EnvironDict | None) –

• _timeout (int | float | None) –

• kwargs (Any) –

Return type:

ProcessResult

run_start_checks(started_at, timeout_at)

Run checks to confirm that the daemon has started.

Parameters:

• started_at (float) –

• timeout_at (float) –

Return type:

bool

start(*extra_cli_arguments, max_start_attempts=None, start_timeout=None)

Start the daemon.

Parameters:

• extra_cli_arguments (str) –

• max_start_attempts (int | None) –

• start_timeout (int | float | None) –

Return type:

bool

start_check(callback, *args, **kwargs)

Register a function to run after the daemon starts to confirm readiness for work.

The callback must accept as the first argument timeout_at which is a float. The callback must stop trying to confirm running behavior once time.time() > timeout_at. The callback should return True to confirm that the daemon is ready for work.

Arguments:

callback:

The function to call back

Keyword Arguments:

args:

The arguments to pass to the callback

kwargs:

The keyword arguments to pass to the callback

Returns:

Nothing.

Example:

def check_running_state(timeout_at: float) -> bool:
    while time.time() <= timeout_at:
        # run some checks
        ...
        # if all is good
        break
    else:
        return False
    return True

Parameters:

• callback (Callable[[...], bool]) –

• args (Any) –

• kwargs (Any) –

Return type:

None

started(*extra_cli_arguments, max_start_attempts=None, start_timeout=None)

Start the daemon and return it’s instance so it can be used as a context manager.

Parameters:

• extra_cli_arguments (str) –

• max_start_attempts (int | None) –

• start_timeout (int | float | None) –

Return type:

Generator[Daemon, None, None]

stopped(before_stop_callback=None, after_stop_callback=None, before_start_callback=None, after_start_callback=None)

Stop the daemon and return it’s instance so it can be used as a context manager.

Keyword Arguments:

before_stop_callback:

A callable to run before stopping the daemon. The callback must accept one argument, the daemon instance.

after_stop_callback:

A callable to run after stopping the daemon. The callback must accept one argument, the daemon instance.

before_start_callback:

A callable to run before starting the daemon. The callback must accept one argument, the daemon instance.

after_start_callback:

A callable to run after starting the daemon. The callback must accept one argument, the daemon instance.

This context manager will stop the factory while the context is in place, it re-starts it once out of context.

Example:

assert factory.is_running() is True

with factory.stopped():
    assert factory.is_running() is False

assert factory.is_running() is True

Parameters:

• before_stop_callback (Callable[[Daemon], None] | None) –

• after_stop_callback (Callable[[Daemon], None] | None) –

• before_start_callback (Callable[[Daemon], None] | None) –

• after_start_callback (Callable[[Daemon], None] | None) –

Return type:

Generator[Daemon, None, None]

terminate()

Terminate the started subprocess.

Return type:

ProcessResult