Chat over SSH.

Go to file

Steven L 80a5879f04 Adding a contribituion file and issue template (#248 )		2017-10-03 13:49:52 -04:00
chat	Travis: Check for gofmt issues. (#241 )	2017-07-17 15:03:55 -04:00
cmd/ssh-chat	Windows support (fixed #217 )	2016-09-15 13:52:55 -04:00
set	tests: Fix flake in TestSetExpiring	2017-08-28 14:34:47 -04:00
sshd	Fix unit tests / Travis (#238 )	2017-06-14 09:07:24 -04:00
vendor/github.com	Windows support (fixed #217 )	2016-09-15 13:52:55 -04:00
.gitignore	Update Makefile to new ldflags syntax	2016-07-09 13:57:32 -04:00
.gitmodules	Windows support (fixed #217 )	2016-09-15 13:52:55 -04:00
.travis.yml	Travis: Check for gofmt issues. (#241 )	2017-07-17 15:03:55 -04:00
CONTRIBUTING.md	Adding a contribituion file and issue template (#248 )	2017-10-03 13:49:52 -04:00
LICENSE	LICENSE, todo.	2014-12-12 17:52:05 -08:00
Makefile	Windows support (fixed #217 )	2016-09-15 13:52:55 -04:00
README.md	README: Add FAQ link	2016-08-16 14:03:01 -04:00
auth.go	set: Improve coverage and cleanup. Switch sshchat package to use it.	2016-08-24 13:54:20 -04:00
auth_test.go	Root sshchat package, main moved into cmd/ssh-chat/.	2015-01-21 11:47:59 -08:00
build_release	Windows support (fixed #217 )	2016-09-15 13:52:55 -04:00
godoc.go	Root sshchat package, main moved into cmd/ssh-chat/.	2015-01-21 11:47:59 -08:00
host.go	Fixed /reply bug (#230 )	2017-04-27 21:04:37 -04:00
host_test.go	Fix unit tests / Travis (#238 )	2017-06-14 09:07:24 -04:00
identity.go	refactor: Id -> ID	2016-08-24 13:54:20 -04:00
issue_template.md	Adding a contribituion file and issue template (#248 )	2017-10-03 13:49:52 -04:00
logger.go	Root sshchat package, main moved into cmd/ssh-chat/.	2015-01-21 11:47:59 -08:00
motd.txt	Fix motd, invalid fingerprint, no auth whitelist.	2014-12-16 20:15:37 -08:00

README.md

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 MD5:e5:d5:d1:75:90:38:42:f6:c7:03:d7:d0:56:7d:6a:db or SHA256:HQDLlZsXL3t0lV5CHM0OXeZ5O6PcfHuzkS8cRbbTLBI. If you see something different, you might be MITM'd.

(Apologies if the server is down, try again shortly.)

Downloading a release

Recent releases include builds for MacOS (darwin/amd64) and Linux (386, amd64, and ARM6 for your RaspberryPi).

Grab the latest release here.

Compiling / Developing

You can compile ssh-chat by using make build. The resulting binary is portable and can be run on any system with a similar OS and CPU arch. Go 1.3 or higher is required to compile.

If you're developing on this repo, there is a handy Makefile that should set things up with make run.

Additionally, make debug runs the server with an http pprof server. This allows you to open http://localhost:6060/debug/pprof/ and view profiling data. See net/http/pprof for more information about pprof.

Quick Start

Usage:
  ssh-chat [OPTIONS]

Application Options:
  -v, --verbose    Show verbose logging.
      --version    Print version and exit.
  -i, --identity=  Private key to identify server with. (~/.ssh/id_rsa)
      --bind=      Host and port to listen on. (0.0.0.0:2022)
      --admin=     Fingerprint of pubkey to mark as admin.
      --whitelist= Optional file of pubkey fingerprints that are allowed to connect
      --motd=      Message of the Day file (optional)
      --log=       Write chat log to this file.
      --pprof=     enable http server for pprof

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 ":22" --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).

Frequently Asked Questions

The FAQs can be found on the project's Wiki page. Feel free to submit more questions to be answered and added to the page.

License

This project is licensed under the MIT open source license.