Skip to main content

Crate toride_ssh

Crate toride_ssh 

Source
Expand description

toride-ssh — async SSH manager library.

This is the facade crate that re-exports all sub-crates behind a unified API. The entry point is SshManager, which resolves ~/.ssh paths and provides accessor methods for each subsystem.

§Subsystem accessors

§Testing with a custom CLI runner

Use SshManager::with_cli_runner to inject a MockCliRunner so that no real SSH processes are spawned during tests.

Re-exports§

pub use toride_ssh_config as config;
pub use toride_ssh_key as key;
pub use toride_ssh_agent as agent;
pub use toride_ssh_authorized_keys as authorized_keys;
pub use toride_ssh_doctor as doctor;
pub use toride_ssh_forward as forward;
pub use toride_ssh_known_hosts as known_hosts;

Modules§

paths
SSH path resolution for the ~/.ssh directory layout.
privilege
Privilege-escalation helpers for operations that need root.
runner
Thin helpers for running external SSH tools via duct.
undo
Undo/restore mechanism for file mutations.

Structs§

DefaultCliRunner
Production CliRunner that delegates to TokioRunner from toride-runner, which uses tokio::process internally.
Diagnostic
A single diagnostic finding from the SSH doctor.
Fingerprint
SHA-256 fingerprint of an SSH key.
KeyCreateParams
Parameters for creating a new SSH key.
KeyDeleteParams
Parameters for deleting an SSH key.
MockCliRunner
A canned-response CliRunner for unit tests.
Permissions
Unix file permission mode.
SshKey
A discovered SSH key with metadata.
SshManager
Entry point for all SSH management operations.
SshPaths
Resolved paths for the ~/.ssh directory.

Enums§

DiagnosticSeverity
Re-export toride_diagnostic_types::Severity for consumers that need the shared ecosystem severity type (used by doctor reports, UI, etc.). How serious a diagnostic finding is.
Error
Errors returned by toride-ssh operations.
KeyFormat
Target format for key conversion.
KeySource
Where a key was discovered.
KeyType
SSH key algorithm.
PrivilegedOp
An operation that requires elevated privileges to perform.
Severity
Diagnostic severity level.

Traits§

CliRunner
Abstraction over external command execution.

Functions§

is_root
Return true when the process is running as root (effective UID 0).
run_privileged
Execute a privileged operation asynchronously.

Type Aliases§

Result
Alias for results in this crate.