Chat over SSH.
Go to file
Andrey Petrov 512d38d86f
Update CODE_OF_CONDUCT.md
2020-08-03 12:32:03 -04:00
.github .github: Improve CI test step 2020-05-01 11:50:16 -04:00
chat Merge branch 'master' into sponsor-prefix 2020-08-03 11:41:19 -04:00
cmd/ssh-chat main: Use x/crypto/ssh helpers for parsing passworded keys 2020-04-20 15:34:42 -04:00
internal chat, internal/humantime: Tweak departure message 2019-03-17 15:01:41 -04:00
set set: Add Interface, ZeroValue helper 2020-08-03 11:32:16 -04:00
sshd sshd: Terminal.Term() fallback to Env TERM 2020-04-17 12:22:31 -04:00
.gitignore vendor: Switch to using `go dep` 2017-10-12 13:40:35 -04:00
.travis.yml travisci: Remove explicit dep fetch (#287) 2018-12-25 14:53:38 -05:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2020-08-03 12:32:03 -04:00
CONTRIBUTING.md Adding a contribituion file and issue template (#248) 2017-10-03 13:49:52 -04:00
Gopkg.lock /uptime and /whois relative timestamps made more precise 2018-01-19 12:35:45 -05:00
Gopkg.toml vendor: Switch to using `go dep` 2017-10-12 13:40:35 -04:00
LICENSE LICENSE, todo. 2014-12-12 17:52:05 -08:00
Makefile Makefile: Fix binary ldflags missing 2020-01-06 20:14:32 -05:00
NOTICE legal: Put sshd/terminal notice in root 2019-03-18 15:36:21 -04:00
README.md README: Add CoC link 2020-08-03 11:51:56 -04:00
auth.go Better comments 2019-02-24 09:40:47 -06:00
auth_test.go /ban query support (#286) 2018-12-25 14:29:19 -05:00
build_release Windows support (fixed #217) 2016-09-15 13:52:55 -04:00
go.mod go mod: Update, mostly for x/crypto 2020-04-20 15:34:28 -04:00
go.sum go mod: Update, mostly for x/crypto 2020-04-20 15:34:28 -04:00
godoc.go Better comments 2019-02-24 09:40:47 -06:00
host.go Merge branch 'master' into sponsor-prefix 2020-08-03 11:41:19 -04:00
host_test.go sshchat: Fix tests to use new rendering format. 2019-03-21 15:33:18 -04:00
identity.go Merge branch 'master' into sponsor-prefix 2020-08-03 11:41:19 -04:00
issue_template.md Adding a contribituion file and issue template (#248) 2017-10-03 13:49:52 -04:00
logger.go Better comments 2019-02-24 09:40:47 -06:00
motd.txt Fix motd, invalid fingerprint, no auth whitelist. 2014-12-16 20:15:37 -08:00

README.md

Build Status GoDoc Downloads Bountysource

ssh-chat

Custom SSH server written in Go. Instead of a shell, you get a chat prompt.

Demo

Join the party:

$ ssh ssh.chat

Please abide by our project's Code of Conduct while participating in chat.

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 binary release here.

Play around with it. Additional deploy examples are here.

Compiling / Developing

Most people just want the latest binary release. If you're sure you want to compile it from source, read on:

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.8 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. (default: ~/.ssh/id_rsa)
      --bind=      Host and port to listen on. (default: 0.0.0.0:2022)
      --admin=     File of public keys who are admins.
      --whitelist= Optional file of public keys who are allowed to connect.
      --motd=      Optional Message of the Day file.
      --log=       Write chat log to this file.
      --pprof=     Enable pprof http server for profiling.

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

MIT