Go Shell Makefile
Clone or download
Permalink
Failed to load latest commit information.
chat /shrug ¯\_(ツ)_/¯ Jan 19, 2018
cmd/ssh-chat Windows support (fixed #217) Sep 15, 2016
set tests: Fix flake in TestSetExpiring Aug 28, 2017
sshd Fix unit tests / Travis (#238) Jun 14, 2017
.gitignore vendor: Switch to using `go dep` Oct 12, 2017
.travis.yml vendor: Switch to using `go dep` Oct 12, 2017
CONTRIBUTING.md Adding a contribituion file and issue template (#248) Oct 3, 2017
Gopkg.lock /uptime and /whois relative timestamps made more precise Jan 19, 2018
Gopkg.toml vendor: Switch to using `go dep` Oct 12, 2017
LICENSE LICENSE, todo. Dec 13, 2014
Makefile vendor: Switch to using `go dep` Oct 12, 2017
README.md README: Link deploy examples Feb 15, 2018
auth.go set: Improve coverage and cleanup. Switch sshchat package to use it. Aug 24, 2016
auth_test.go Root sshchat package, main moved into cmd/ssh-chat/. Jan 21, 2015
build_release Windows support (fixed #217) Sep 15, 2016
godoc.go Root sshchat package, main moved into cmd/ssh-chat/. Jan 21, 2015
host.go /uptime and /whois relative timestamps made more precise Jan 19, 2018
host_test.go Fix unit tests / Travis (#238) Jun 14, 2017
humantime.go /uptime and /whois relative timestamps made more precise Jan 19, 2018
humantime_test.go /uptime and /whois relative timestamps made more precise Jan 19, 2018
identity.go /uptime and /whois relative timestamps made more precise Jan 19, 2018
issue_template.md Adding a contribituion file and issue template (#248) Oct 3, 2017
logger.go Root sshchat package, main moved into cmd/ssh-chat/. Jan 21, 2015
motd.txt Fix motd, invalid fingerprint, no auth whitelist. Dec 17, 2014

README.md

Build Status Bountysource GoDoc

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.

Play around with it. Additional deploy examples are 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.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. (~/.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.