TheArchive/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2025-04-21 14:11:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

ssh/tailssh: add docs to CastHeader fields

Browse Source 
Updates tailscale/corp#9967

Signed-off-by: Maisem Ali <maisem@tailscale.com>
This commit is contained in:
Maisem Ali 2023-03-22 19:08:00 -07:00 committed by Maisem Ali
parent 9d8b7a7383
commit 8765568373
1 changed files with 51 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
ssh/tailssh/tailssh.go
View File

@ -1315,6 +1315,56 @@ func randBytes(n int) []byte {
return b return b
} }
// CastHeader is the header of an asciinema file.
type CastHeader struct {
// Version is the asciinema file format version.
Version int `json:"version"`
// Width is the terminal width in characters.
// It is non-zero for Pty sessions.
Width int `json:"width"`
// Height is the terminal height in characters.
// It is non-zero for Pty sessions.
Height int `json:"height"`
// Timestamp is the unix timestamp of when the recording started.
Timestamp int64 `json:"timestamp"`
// Env is the environment variables of the session.
// Only "TERM" is set (2023-03-22).
Env map[string]string `json:"env"`
// Command is the command that was executed.
// Typically empty for shell sessions.
Command string `json:"command,omitempty"`
// Tailscale-specific fields:
// SrcNode is the FQDN of the node originating the connection.
// It is also the MagicDNS name for the node.
// It does not have a trailing dot.
// e.g. "host.tail-scale.ts.net"
SrcNode string `json:"srcNode"`
// SrcNodeID is the node ID of the node originating the connection.
SrcNodeID tailcfg.StableNodeID `json:"srcNodeID"`
// SrcNodeTags is the list of tags on the node originating the connection (if any).
SrcNodeTags []string `json:"srcNodeTags,omitempty"`
// SrcNodeUserID is the user ID of the node originating the connection (if not tagged).
SrcNodeUserID tailcfg.UserID `json:"srcNodeUserID,omitempty"` // if not tagged
// SrcNodeUser is the LoginName of the node originating the connection (if not tagged).
SrcNodeUser string `json:"srcNodeUser,omitempty"`
// SSHUser is the username as presented by the client.
SSHUser string `json:"sshUser"` // as presented by the client
// LocalUser is the effective username on the server.
LocalUser string `json:"localUser"`
}
// startNewRecording starts a new SSH session recording. // startNewRecording starts a new SSH session recording.
func (ss *sshSession) startNewRecording() (_ *recording, err error) { func (ss *sshSession) startNewRecording() (_ *recording, err error) {
recorders := ss.recorders() recorders := ss.recorders()
@ -1374,29 +1424,12 @@ func (ss *sshSession) startNewRecording() (_ *recording, err error) {
rec.out = pw rec.out = pw
// {"version": 2, "width": 221, "height": 84, "timestamp": 1647146075, "env": {"SHELL": "/bin/bash", "TERM": "screen"}}
type CastHeader struct {
Version int `json:"version"`
Width int `json:"width"`
Height int `json:"height"`
Timestamp int64 `json:"timestamp"`
Env map[string]string `json:"env"`
// Tailscale-specific fields:
SrcNode string `json:"srcNode"` // node FQDN
SrcNodeID tailcfg.StableNodeID `json:"srcNodeID"`
SrcNodeTags []string `json:"srcNodeTags"`
SSHUser string `json:"sshUser"` // as presented by the client
LocalUser string `json:"localUser"`
SrcNodeUserID tailcfg.UserID `json:"srcNodeUserID"` // if not tagged
SrcNodeUser string `json:"srcNodeUser"`
}
ch := CastHeader{ ch := CastHeader{
Version: 2, Version: 2,
Width: w.Width, Width: w.Width,
Height: w.Height, Height: w.Height,
Timestamp: now.Unix(), Timestamp: now.Unix(),
Command: strings.Join(ss.Command(), " "),
Env: map[string]string{ Env: map[string]string{
"TERM": term, "TERM": term,
// TODO(bradfitz): anything else important? // TODO(bradfitz): anything else important?