glm-5.1
053ace6fcc
Add top-level README.md with alpha status warning, quick start guide, architecture overview, feature flags, transport modes, auth docs, and Node.js API examples. Add dual LICENSE-MIT and LICENSE-APACHE files. Add comprehensive crate-level and module-level rustdoc to all three crates (wraith-core, wraith, wraith-napi) and all public modules (transport, client, server, auth, socks5, error). Add doc comments to key public types (Transport, TransportAcceptor, ConnectOptions, ClientSession, Server, ServeOptions, KeySource, ServerAuthConfig, etc). Update Cargo.toml files with workspace-level package metadata (version, edition, license, repository) and crate descriptions.
17 lines
829 B
Rust
17 lines
829 B
Rust
//! Client-side SSH session management.
|
|
//!
|
|
//! Provides `ClientSession` for establishing an SSH connection over any transport,
|
|
//! running a local SOCKS5 proxy, and managing port forwards. Also provides
|
|
//! `ChannelManager` for programmatic channel management with automatic reconnection.
|
|
//!
|
|
//! The client always starts a SOCKS5 proxy (default `127.0.0.1:1080`) when running
|
|
//! via `ClientSession::run()`. For VPN-like "route all traffic" behavior, use
|
|
//! [tun2proxy](https://github.com/tun2proxy/tun2proxy) alongside the SOCKS5 proxy.
|
|
|
|
pub mod channel_manager;
|
|
pub mod connect;
|
|
pub mod forward;
|
|
|
|
pub use channel_manager::{ChannelManager, ForwardRequest};
|
|
pub use connect::{ClientSession, ConnectError, ConnectOptions, TransportMode};
|
|
pub use forward::{LocalForwarder, PortForwardSpec, PortForwardSpecKind, RemoteForwarder}; |