Skip to content
This repository was archived by the owner on Jul 18, 2024. It is now read-only.
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ platform for operating distributed systems in the DataCenter or in the Cloud.
Terminal sessions may include cryptographic secrets, personally identifiable
information, or other information which should not be disclosed.

The client ttyspy acts like the script(1) command, except rather than writing a
The client ttyspy acts like the `script(1)` command, except rather than writing a
local file it sends the terminal session to (presumably secure) terminal
session archive server. To protect the contents of the terminal session and
ensure the session is sent to the correct server, TLS with mutual certificate
Expand All @@ -19,8 +19,8 @@ the architecture and configuration.

## Client

The client functions as script(1) with the typescript output file piped to
curl(1). Originally it was going to be implemented by wrapping these two
The client functions as `script(1)` with the typescript output file piped to
`curl(1)`. Originally it was going to be implemented by wrapping these two
utilities using a named pipe between the two, but the non-deterministic order
in which these utilities would open the pipe prevented this method.

Expand All @@ -41,7 +41,7 @@ make
## Server

The server is a simple Go webserver which authenticates client connections by
the client's certificate and saves HTTP POSTs to /transcript path. The server
the client's certificate and saves HTTP POSTs to `/transcript` path. The server
expects a content-type of application/typescript, and X-Username, X-Hostname,
X-Gecos headers to be present. Additionally if the X-Ssh-Client header is
present it is preserved in the transcript file. Each transcript is saved into a
Expand Down