README
¶
Noisy Sockets Shell
A WebSockets based remote shell written in Go.
Why?
Because I wanted something akin to OpenSSH but with a simpler protocol that could be used directly in the browser.
Design
- WebSockets (to support browser clients, with relatively low overhead for native clients).
- JSON-RPC 2.0 inspired bidirectional messaging protocol (with message versioning).
- Single channel per connection (multiplexing over TCP isn't worth it due to head-of-line blocking).
- Only supports remote terminals (no port-forwarding, exec, etc).
Usage
Go
go get github.com/noisysocks/shell
TypeScript
A TypeScript client is available on npm as @noisysocks/shell.
npm install @noisysocks/shell
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a remote shell client.
func (*Client) OpenTerminal ¶
func (c *Client) OpenTerminal(columns, rows int, env []string, input io.DeadlineReader, output io.DeadlineWriter, onExit ExitHandler) error
OpenTerminal opens a new terminal.
func (*Client) ResizeTerminal ¶
ResizeTerminal resizes the terminal window.
type ExitHandler ¶
ExitHandler is a callback function that is called when the remote shell process exits.
type Handler ¶
type Handler struct {
// contains filtered or unexported fields
}
Handler handles a shell session.
func NewHandler ¶
NewHandler creates a new shell handler and starts the session.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package env provides utilities for working with environment variables.
|
Package env provides utilities for working with environment variables. |
|
internal
|
|
|
Package io provides context-aware I/O operations.
|
Package io provides context-aware I/O operations. |
|
Package main implements an insecure WebSocket server that can be used to create a shell session.
|
Package main implements an insecure WebSocket server that can be used to create a shell session. |
Click to show internal directories.
Click to hide internal directories.