sshdance 0.3.0

A simple SSH TUI-application framework
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# SSHDance

![](./misc/demo.gif)

So here is a small networking lib made by me that **hopefully** will make it a bit easier to make ssh sites...

I do not like being overly formal so if you want to see an example of it working look at `examples/intro`. There probably be a branch in this repo titled `qubic-experimental` or something that I will push changes I'm making to SSHdance for my site...

Have fun and may meme driven development be with you

## I have no attention span and want to get this working NOW

Great get yourself some `nix` and run `nix flake init --template github:AwesomeQubic/sshdance/qubic-experimental`.<br>
Remember to enable nix-command and flakes in your nix configs see the [docs](https://nixos.wiki/wiki/Flakes)

## I want to help develop this lib

Well great tho look at the root of this project you see a file called `flake.nix`?

If yes then great, its a file used to build environments using `nix` package manager and should get us to use same compiler and everything, so I politely ask you to either use NixOs or get standalone nix to work on this project

## I have nix now what do I work on?

Well here is a list of my current TODOs:

 - Nix templates so we do not have to bother people with getting this lib to work
 - Better input handling
 - Make this more formal

## Example

```rust
#[tokio::main]
async fn main() -> Result<(), sshdance::Error> {
    tracing_subscriber::fmt::init();
    let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), 2223);
    SshDanceBuilder::<SimpleTerminalHandler<HelloWorld>>::new(socket)
        .run()
        .await
        .unwrap();
    Ok(())
}

#[derive(Default)]
pub struct HelloWorld {}

impl SshTerminal for HelloWorld {
    type MessageType = ();

    fn draw(&mut self, frame: &mut Frame<'_>) {
        let line = ratatui::text::Line::default()
            .spans([Span::styled(
                "Hello ssh",
                Style::new().add_modifier(Modifier::BOLD).fg(Color::Reset),
            )])
            .centered();
        frame.render_widget(line, frame.area());
    }
}

```

## Security
This is less secure than correctly setup HTTPs. There are no protections against potential MITM-attacks on first connections, depending on client configuration, public keys are typically stored to compare with the key served from the server. This also means there are no proper means to rotate keys without it looking like a MITM-attack.

**Use at your own risk!**