mirror of
https://github.com/shazow/ssh-chat.git
synced 2025-04-13 07:37:17 +03:00
100 lines
2.1 KiB
Markdown
100 lines
2.1 KiB
Markdown
# ssh-chat
|
|
|
|
Custom SSH server written in Go. Instead of a shell, you get a chat prompt.
|
|
|
|
## Demo
|
|
|
|
Join the party:
|
|
|
|
```
|
|
$ ssh chat.shazow.net
|
|
```
|
|
|
|
The server's RSA key fingerprint is `e5:d5:d1:75:90:38:42:f6:c7:03:d7:d0:56:7d:6a:db`. If you see something different, you might be [MITM](https://en.wikipedia.org/wiki/Man-in-the-middle_attack)'d.
|
|
|
|
(Apologies if the server is down, try again shortly.)
|
|
|
|
|
|
## Quick Start
|
|
|
|
```
|
|
Usage:
|
|
ssh-chat [OPTIONS]
|
|
|
|
Application Options:
|
|
-v, --verbose Show verbose logging.
|
|
-b, --bind= Host and port to listen on. (0.0.0.0:22)
|
|
-i, --identity= Private key to identify server with. (~/.ssh/id_rsa)
|
|
|
|
Help Options:
|
|
-h, --help Show this help message
|
|
```
|
|
|
|
After doing `go get github.com/shazow/ssh-chat` on this repo, you should be able
|
|
to run a command like:
|
|
|
|
```
|
|
$ ssh-chat --verbose --bind ":2022" --identity ~/.ssh/id_dsa
|
|
```
|
|
|
|
To bind on port 22, you'll need to make sure it's free (move any other ssh
|
|
daemons to another port) and run ssh-chat as root (or with sudo).
|
|
|
|
## ssh-chat on Docker
|
|
|
|
You can run ssh-chat using a Docker image without manually installing go-lang:
|
|
|
|
```
|
|
$ docker pull alvin/ssh-chat
|
|
$ docker run -d -p 0.0.0.0:(your host machine port):2022 --name ssh-chat alvin/ssh-chat
|
|
```
|
|
|
|
Or you can build your own image:
|
|
|
|
```
|
|
$ docker build -t (your-docker-username)/ssh-chat .
|
|
```
|
|
|
|
then run it:
|
|
|
|
```
|
|
$ docker run -d -p 0.0.0.0:(your host machine port):2022 --name ssh-chat (your-docker-username)/ssh-chat
|
|
```
|
|
|
|
## Developing
|
|
|
|
If you're developing on this repo, there is a handy Makefile that should set
|
|
things up with `make run`.
|
|
|
|
|
|
## TODO:
|
|
|
|
* [x] Welcome message.
|
|
* [x] set term width properly
|
|
* [x] client map rather than list
|
|
* [x] backfill chat history
|
|
* [x] tab completion
|
|
* [x] /ban
|
|
* [ ] /ban by ip
|
|
* [x] /help
|
|
* [x] /about
|
|
* [x] /list
|
|
* [x] /nick
|
|
* [x] pubkey fingerprint
|
|
* [x] truncate usernames
|
|
* [ ] rename collision bug
|
|
* [ ] op ops on join
|
|
* [ ] piped stdout bug
|
|
* [ ] saner sanitizing of inputs (version string, allow space/period)
|
|
* [x] Some tests.
|
|
* [ ] More tests.
|
|
* [ ] Even more tests.
|
|
* [ ] Lots of refactoring
|
|
* [ ] Pull out the chat-related stuff into isolation from the ssh serving
|
|
stuff
|
|
|
|
|
|
## License
|
|
|
|
MIT
|