zssh 0.2.0

Minimal SSH server for embedded applications.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//! This crate implements a minimal SSH server for embedded targets; please refer to
//! the project repository README.md for more information and for examples of usage.
//!
//! The library works in the following way:
//!
//!  1. Write a type implementing the `Behavior` trait as desired;
//!  2. Instantiate a `Transport` backed by some async I/O stream;
//!  3. Loop, receiving new client requests via `Channel` objects;
//!  4. Handle each request, reading or writing into the channel.
//!
//! The API is designed to be minimal and simple to use.

#![no_std]
#![forbid(unsafe_code)]

mod channel;
mod codec;
mod error;
mod transport;
mod types;
mod wire;

pub use channel::{Channel, Pipe, Reader, Writer};
pub use error::{Error, ProtocolError};
pub use transport::Transport;
pub use types::{AuthMethod, Behavior, PublicKey, Request, SecretKey, TransportError};
pub use wire::DisconnectReason;

fn unwrap_unreachable<T, E>(value: Result<T, E>) -> T {
    let Ok(inner) = value else { unreachable!() };
    inner // avoids invoking expensive Debug code
}

pub extern crate ed25519_dalek;