README
¶
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
Documentation
¶
Overview ¶
Package sshchat is an implementation of an ssh server which serves a chat room instead of a shell.
sshd subdirectory contains the ssh-related pieces which know nothing about chat.
chat subdirectory contains the chat-related pieces which know nothing about ssh.
The Host type is the glue between the sshd and chat pieces.
Index ¶
- Variables
- func GetPrompt(user *message.User) string
- func SetLogger(l *golog.Logger)
- type Auth
- func (a *Auth) AllowAnonymous() bool
- func (a *Auth) Ban(key ssh.PublicKey, d time.Duration)
- func (a *Auth) BanAddr(addr net.Addr, d time.Duration)
- func (a *Auth) BanClient(client string, d time.Duration)
- func (a *Auth) BanFingerprint(authkey string, d time.Duration)
- func (a *Auth) BanQuery(q string) error
- func (a *Auth) Banned() (ip []string, fingerprint []string, client []string)
- func (a *Auth) Check(addr net.Addr, key ssh.PublicKey, clientVersion string) error
- func (a *Auth) IsOp(key ssh.PublicKey) bool
- func (a *Auth) Op(key ssh.PublicKey, d time.Duration)
- func (a *Auth) Whitelist(key ssh.PublicKey, d time.Duration)
- type Host
- func (h *Host) AutoCompleteFunction(u *message.User) func(line string, pos int, key rune) (newLine string, newPos int, ok bool)
- func (h *Host) Connect(term *sshd.Terminal)
- func (h *Host) GetUser(name string) (*message.User, bool)
- func (h *Host) InitCommands(c *chat.Commands)
- func (h *Host) Serve()
- func (h *Host) SetMotd(motd string)
- func (h *Host) SetTheme(theme message.Theme)
- type Identity
Constants ¶
This section is empty.
Variables ¶
var ErrBanned = errors.New("banned")
ErrBanned is the error returned when a key is checked that is banned.
var ErrNotWhitelisted = errors.New("not whitelisted")
ErrNotWhitelisted Is the error returned when a key is checked that is not whitelisted, when whitelisting is enabled.
Functions ¶
Types ¶
type Auth ¶
type Auth struct {
// contains filtered or unexported fields
}
Auth stores lookups for bans, whitelists, and ops. It implements the sshd.Auth interface.
func (*Auth) AllowAnonymous ¶
AllowAnonymous determines if anonymous users are permitted.
func (*Auth) BanFingerprint ¶
BanFingerprint will set a public key fingerprint as banned.
func (*Auth) BanQuery ¶
BanQuery takes space-separated key="value" pairs to ban, including ip, fingerprint, client. Fields without an = will be treated as a duration, applied to the next field. For example: 5s client=foo 10min ip=1.1.1.1 Will ban client foo for 5 seconds, and ip 1.1.1.1 for 10min.
type Host ¶
type Host struct {
*chat.Room
// Version string to print on /version
Version string
// GetMOTD is used to reload the motd from an external source
GetMOTD func() (string, error)
// contains filtered or unexported fields
}
Host is the bridge between sshd and chat modules TODO: Should be easy to add support for multiple rooms, if we want.
func NewHost ¶
func NewHost(listener *sshd.SSHListener, auth *Auth) *Host
NewHost creates a Host on top of an existing listener.
func (*Host) AutoCompleteFunction ¶
func (h *Host) AutoCompleteFunction(u *message.User) func(line string, pos int, key rune) (newLine string, newPos int, ok bool)
AutoCompleteFunction returns a callback for terminal autocompletion
func (*Host) InitCommands ¶
InitCommands adds host-specific commands to a Commands container. These will override any existing commands.
type Identity ¶
type Identity struct {
sshd.Connection
// contains filtered or unexported fields
}
Identity is a container for everything that identifies a client.
func NewIdentity ¶
func NewIdentity(conn sshd.Connection) *Identity
NewIdentity returns a new identity object from an sshd.Connection.
Source Files
Directories