Skip to main content

Module ssh

Module ssh 

Source
Expand description

SSH wrapper module for secure remote operations

This module provides comprehensive SSH functionality for secure remote command execution and connectivity management. It includes credential management, connection configuration, and client implementation with proper error handling.

§Module Components

  • client - SSH client implementation for remote command execution
  • config - SSH configuration and management
  • credentials - SSH authentication credentials and key management
  • error - SSH error types and implementations
  • key_inspector - Best-effort detection of passphrase-protected private keys
  • public_key - SSH public key representation and validation
  • service_checker - SSH service availability testing without authentication

§Key Features

  • Private key authentication with configurable credentials
  • Connection timeout and retry mechanisms
  • Secure remote command execution with error handling
  • SSH service availability checking for connectivity testing
  • Integration with deployment automation workflows

The SSH wrapper is designed for automated deployment scenarios where secure remote access is essential for configuration and management tasks.

Re-exports§

pub use client::SshClient;
pub use config::SshConfig;
pub use config::SshConnectionConfig;
pub use config::DEFAULT_CONNECT_TIMEOUT_SECS;
pub use config::DEFAULT_MAX_RETRY_ATTEMPTS;
pub use config::DEFAULT_RETRY_INTERVAL_SECS;
pub use config::DEFAULT_RETRY_LOG_FREQUENCY;
pub use config::DEFAULT_SSH_PORT;
pub use credentials::SshCredentials;
pub use error::SshError;
pub use key_inspector::is_passphrase_protected;
pub use public_key::SshPublicKey;
pub use service_checker::SshServiceChecker;

Modules§

client
SSH client implementation for secure remote command execution
config
SSH configuration and management
credentials
SSH credentials for remote instance authentication
error
SSH error types and implementations
key_inspector
SSH private key inspection utilities
public_key
SSH public key representation and validation
service_checker
SSH Service Checker