1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
|
// Copyright 2022 Northern.tech AS
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cmd
import (
"bufio"
"compress/gzip"
"context"
"encoding/binary"
"encoding/gob"
"fmt"
"io"
"os"
"os/signal"
"syscall"
"time"
"github.com/pkg/errors"
"github.com/spf13/cobra"
"github.com/spf13/viper"
"golang.org/x/sys/unix"
"golang.org/x/term"
"github.com/mendersoftware/go-lib-micro/ws"
wsshell "github.com/mendersoftware/go-lib-micro/ws/shell"
"github.com/mendersoftware/mender-cli/client/deviceconnect"
"github.com/mendersoftware/mender-cli/log"
)
const (
// default terminal size
defaultTermWidth = 80
defaultTermHeight = 40
// dummy delay for playback
playbackSleep = time.Millisecond * 32
// cli args
argRecord = "record"
argPlayback = "playback"
)
var terminalCmd = &cobra.Command{
Use: "terminal [DEVICE_ID]",
Short: "Remotely access a terminal on a device",
Long: "Remotely access a terminal on a device\n" +
"Basic usage is terminal DEVICE_ID, which starts a new terminal " +
"session with the remote device. The session can be saved locally " +
"using --record flag. When using --playback flag, no DEVICE_ID is " +
"required and no connection will be established.",
Args: cobra.RangeArgs(0, 1),
Run: func(c *cobra.Command, args []string) {
cmd, err := NewTerminalCmd(c, args)
CheckErr(err)
CheckErr(cmd.Run())
},
}
func init() {
terminalCmd.Flags().StringP(argRecord, "", "", "recording file path to save the session to")
terminalCmd.Flags().
StringP(argPlayback, "", "", "recording file path to playback the session from")
}
// TerminalCmd handles the terminal command
type TerminalCmd struct {
server string
token string
skipVerify bool
deviceID string
sessionID string
running bool
healthcheck chan int
stop chan struct{}
err error
recordFile string
recording bool
stopRecording chan bool
playbackFile string
terminalOutputChan chan []byte
}
const (
deviceIDMaxLength = 64
terminalTypeMaxLength = 32
terminalTypeDefault = "xterm-256color"
)
type TerminalRecordingHeader struct {
Version uint8
DeviceID [deviceIDMaxLength]byte
TerminalType [terminalTypeMaxLength]byte
TerminalWidth int16
TerminalHeight int16
Timestamp int64
}
const (
terminalRecordingVersion = 1
)
type TerminalRecordingType int8
type TerminalRecordingData struct {
Type TerminalRecordingType
Data []byte
}
const (
terminalRecordingOutput TerminalRecordingType = iota
)
// NewTerminalCmd returns a new TerminalCmd
func NewTerminalCmd(cmd *cobra.Command, args []string) (*TerminalCmd, error) {
server := viper.GetString(argRootServer)
if server == "" {
return nil, errors.New("No server")
}
skipVerify, err := cmd.Flags().GetBool(argRootSkipVerify)
if err != nil {
return nil, err
}
recordFile, err := cmd.Flags().GetString(argRecord)
if err != nil {
return nil, err
}
playbackFile, err := cmd.Flags().GetString(argPlayback)
if err != nil {
return nil, err
}
token, err := getAuthToken(cmd)
if err != nil {
return nil, err
}
deviceID := ""
if len(args) == 1 {
deviceID = args[0]
}
if playbackFile == "" && deviceID == "" {
return nil, errors.New("No device specified")
}
return &TerminalCmd{
server: server,
token: token,
skipVerify: skipVerify,
deviceID: deviceID,
healthcheck: make(chan int),
stop: make(chan struct{}),
recordFile: recordFile,
stopRecording: make(chan bool),
terminalOutputChan: make(chan []byte),
playbackFile: playbackFile,
}, nil
}
// send the shell start message
func (c *TerminalCmd) startShell(client *deviceconnect.Client, termWidth, termHeight int) error {
m := &ws.ProtoMsg{
Header: ws.ProtoHdr{
Proto: ws.ProtoTypeShell,
MsgType: wsshell.MessageTypeSpawnShell,
Properties: map[string]interface{}{
"terminal_width": termWidth,
"terminal_height": termHeight,
},
},
}
if err := client.WriteMessage(m); err != nil {
return err
}
return nil
}
// send the stop shell message
func (c *TerminalCmd) stopShell(client *deviceconnect.Client) error {
m := &ws.ProtoMsg{
Header: ws.ProtoHdr{
Proto: ws.ProtoTypeShell,
MsgType: wsshell.MessageTypeStopShell,
SessionID: c.sessionID,
},
}
if err := client.WriteMessage(m); err != nil {
return err
}
return nil
}
func (c *TerminalCmd) record() {
f, err := os.Create(c.recordFile)
if err != nil {
log.Err(fmt.Sprintf("Can't create recording file: %s: %s", c.recordFile, err.Error()))
}
defer f.Close()
fz := gzip.NewWriter(f)
defer fz.Close()
data := TerminalRecordingHeader{
Version: terminalRecordingVersion,
Timestamp: time.Now().Unix(),
TerminalWidth: defaultTermWidth,
TerminalHeight: defaultTermHeight,
}
copy(data.DeviceID[:], []byte(c.deviceID))
copy(data.TerminalType[:], []byte(terminalTypeDefault))
err = binary.Write(fz, binary.LittleEndian, data)
if err != nil {
log.Err(fmt.Sprintf("Header write failed: %s", err.Error()))
}
err = fz.Flush()
if err != nil {
log.Err(fmt.Sprintf("Header flush failed: %s", err.Error()))
}
log.Info(fmt.Sprintf("Recording to file: %s", c.recordFile))
e := gob.NewEncoder(fz)
for {
select {
case <-c.stopRecording:
return
case terminalOutput := <-c.terminalOutputChan:
o := TerminalRecordingData{
Type: terminalRecordingOutput,
Data: terminalOutput,
}
err = e.Encode(o)
fz.Flush()
if err != nil {
log.Err(fmt.Sprintf("Error encoding %q: %s", string(terminalOutput), err.Error()))
return
}
}
}
}
func (c *TerminalCmd) playback(w io.Writer) error {
f, err := os.Open(c.playbackFile)
if err != nil {
log.Err(fmt.Sprintf("Can't open %s: %s", c.playbackFile, err.Error()))
return err
}
defer f.Close()
fz, err := gzip.NewReader(f)
if err != nil {
return err
}
defer fz.Close()
var header TerminalRecordingHeader
err = binary.Read(fz, binary.LittleEndian, &header)
if err != nil {
log.Err(fmt.Sprintf("Can't read header: %s", err.Error()))
return err
}
dateTime := time.Unix(header.Timestamp, 0)
log.Info(fmt.Sprintf("Playing back from file: %s", c.playbackFile))
log.Info(fmt.Sprintf("Device ID: %s", string(header.DeviceID[:])))
log.Info(fmt.Sprintf("Terminal type: %s", string(header.TerminalType[:])))
log.Info(fmt.Sprintf("Terminal size: %dx%d", header.TerminalWidth, header.TerminalHeight))
log.Info(fmt.Sprintf("Timestamp: %s", dateTime.Format(time.UnixDate)))
log.Info("")
d := gob.NewDecoder(fz)
for {
var o TerminalRecordingData
err = d.Decode(&o)
if err != nil {
if err != io.EOF {
log.Err(fmt.Sprintf("Decoding error: %s", err.Error()))
return err
}
break
}
if o.Type == terminalRecordingOutput {
_, err = w.Write(o.Data)
if err != nil {
log.Err(fmt.Sprintf("Writting error: %s", err.Error()))
return err
}
}
time.Sleep(playbackSleep)
}
log.Info("\r")
return nil
}
// Run executes the command
func (c *TerminalCmd) Run() error {
ctx, cancelContext := context.WithCancel(context.Background())
defer cancelContext()
// get the terminal width and height
termWidth := defaultTermWidth
termHeight := defaultTermHeight
termID := int(os.Stdout.Fd())
isTerminal := false
stat, _ := os.Stdout.Stat()
if (stat.Mode() & os.ModeCharDevice) > 0 {
var err error
termWidth, termHeight, err = term.GetSize(termID)
if err != nil {
return errors.Wrap(err, "Unable to get the terminal size")
}
isTerminal = true
}
// when playing back, no further processing is required
if c.playbackFile != "" {
if _, err := os.Stat(c.playbackFile); err == nil {
return c.playback(os.Stdout)
} else {
return err
}
}
// start recording when applicable
if _, err := os.Stat(c.recordFile); os.IsNotExist(err) {
if len(c.recordFile) > 0 {
c.recording = true
go c.record()
}
} else {
log.Err(fmt.Sprintf(
"Can't create recording file: %s exists, refused to record.",
c.recordFile,
))
}
client := deviceconnect.NewClient(c.server, c.token, c.skipVerify)
// check if the device is connected
device, err := client.GetDevice(c.deviceID)
if err != nil {
return errors.Wrap(err, "unable to get the device")
} else if device.Status != deviceconnect.CONNECTED {
return errors.New("the device is not connected")
}
// connect to the websocket and start the ping-pong connection health-check
err = client.Connect(c.deviceID, c.token)
if err != nil {
return err
}
go client.PingPong(ctx)
defer client.Close()
// set the terminal in raw mode
if isTerminal {
fmt.Fprintln(os.Stderr, "Press CTRL+] to quit the session")
oldState, err := term.MakeRaw(termID)
if err != nil {
return errors.Wrap(err, "Unable to set the terminal in raw mode")
}
defer func() {
_ = term.Restore(termID, oldState)
}()
}
// start the shell
if err := c.startShell(client, termWidth, termHeight); err != nil {
return err
}
// wait for CTRL+C, signals or stop
c.runLoop(ctx, client, termID, termWidth, termHeight)
// cancel the context
cancelContext()
// stop shell message
if err := c.stopShell(client); err != nil {
return err
}
// return the error message (if any)
return c.err
}
// Run executes the command
func (c *TerminalCmd) runLoop(
ctx context.Context,
client *deviceconnect.Client,
termID, termWidth, termHeight int,
) {
// message channel
msgChan := make(chan *ws.ProtoMsg)
c.running = true
go c.pipeStdin(msgChan, os.Stdin)
go c.pipeStdout(msgChan, client, os.Stdout)
// handle CTRL+C and signals
quit := make(chan os.Signal, 1)
signal.Notify(quit, unix.SIGINT, unix.SIGTERM)
// resize the terminal window
go c.resizeTerminal(ctx, msgChan, termID, termWidth, termHeight)
healthcheckTimeout := time.Now().Add(24 * time.Hour)
for c.running {
select {
case msg := <-msgChan:
err := client.WriteMessage(msg)
if err != nil {
fmt.Fprintf(os.Stderr, "error: %v\n", err)
break
}
case healthcheckInterval := <-c.healthcheck:
healthcheckTimeout = time.Now().Add(time.Duration(healthcheckInterval) * time.Second)
case <-time.After(time.Until(healthcheckTimeout)):
_ = c.stopShell(client)
c.err = errors.New("health check failed, connection with the device lost")
c.running = false
case <-quit:
c.running = false
case <-c.stop:
c.running = false
}
}
}
func (c *TerminalCmd) resizeTerminal(
ctx context.Context,
msgChan chan *ws.ProtoMsg,
termID int,
termWidth int,
termHeight int,
) {
resize := make(chan os.Signal, 1)
signal.Notify(resize, syscall.SIGWINCH)
defer signal.Stop(resize)
for {
select {
case <-ctx.Done():
return
case <-resize:
newTermWidth, newTermHeight, _ := term.GetSize(termID)
if newTermWidth != termWidth || newTermHeight != termHeight {
termWidth = newTermWidth
termHeight = newTermHeight
m := &ws.ProtoMsg{
Header: ws.ProtoHdr{
Proto: ws.ProtoTypeShell,
MsgType: wsshell.MessageTypeResizeShell,
Properties: map[string]interface{}{
"terminal_width": termWidth,
"terminal_height": termHeight,
},
},
}
msgChan <- m
}
}
}
}
func (c *TerminalCmd) Stop() {
c.running = false
c.stop <- struct{}{}
if c.recording {
c.stopRecording <- true
}
}
func (c *TerminalCmd) pipeStdin(msgChan chan *ws.ProtoMsg, r io.Reader) {
s := bufio.NewReader(r)
for c.running {
raw := make([]byte, 1024)
n, err := s.Read(raw)
if err != nil {
if c.running {
if err != io.EOF {
fmt.Fprintf(os.Stderr, "error: %v\n", err)
}
} else {
c.Stop()
}
break
}
// CTRL+] terminates the session
if raw[0] == 29 {
c.Stop()
return
}
m := &ws.ProtoMsg{
Header: ws.ProtoHdr{
Proto: ws.ProtoTypeShell,
MsgType: wsshell.MessageTypeShellCommand,
SessionID: c.sessionID,
},
Body: raw[:n],
}
msgChan <- m
}
}
func (c *TerminalCmd) pipeStdout(
msgChan chan *ws.ProtoMsg,
client *deviceconnect.Client,
w io.Writer,
) {
for c.running {
m, err := client.ReadMessage()
if err != nil {
if c.running {
fmt.Fprintf(os.Stderr, "error: %v\n", err)
} else {
c.Stop()
}
break
}
if m.Header.Proto == ws.ProtoTypeShell &&
m.Header.MsgType == wsshell.MessageTypeShellCommand {
if _, err := w.Write(m.Body); err != nil {
break
}
if c.recording {
c.terminalOutputChan <- m.Body
}
} else if m.Header.Proto == ws.ProtoTypeShell &&
m.Header.MsgType == wsshell.MessageTypePingShell {
if healthcheckTimeout, ok := m.Header.Properties["timeout"].(int64); ok &&
healthcheckTimeout > 0 {
c.healthcheck <- int(healthcheckTimeout)
}
m := &ws.ProtoMsg{
Header: ws.ProtoHdr{
Proto: ws.ProtoTypeShell,
MsgType: wsshell.MessageTypePongShell,
SessionID: c.sessionID,
},
}
msgChan <- m
} else if m.Header.Proto == ws.ProtoTypeShell &&
m.Header.MsgType == wsshell.MessageTypeSpawnShell {
status, ok := m.Header.Properties["status"].(int64)
if ok && status == int64(wsshell.ErrorMessage) {
c.err = errors.New(fmt.Sprintf("Unable to start the shell: %s", string(m.Body)))
c.Stop()
} else {
c.sessionID = string(m.Header.SessionID)
}
} else if m.Header.Proto == ws.ProtoTypeShell &&
m.Header.MsgType == wsshell.MessageTypeStopShell {
c.Stop()
break
}
}
}
|