1. add writes logs in stdout

Merge branch 'develop'
This commit is contained in:
llaoj 2022-11-15 09:52:03 +08:00
commit abddcbc68d
5 changed files with 152 additions and 2 deletions

View File

@ -151,6 +151,36 @@ When you want to create a jailed environment for each client, you can use Docker
$ gotty -w docker run -it --rm busybox $ gotty -w docker run -it --rm busybox
``` ```
## Writes log
User's input in terminal can be found in logs. for example:
if you run gotty like this:
```shell
./gotty -w --permit-arguments ./test.sh
```
this is `test.sh`:
```sh
#!/bin/bash
echo "Welcome: $4"
kubectl -n $1 exec -it $2 -c $3 -- sh
```
visit `http://127.0.0.1:8080/?arg=without-istio&arg=sleep-7b6d569576-57sjq&arg=sleep&arg=21001713` and input your commands in shell, and you will see operation logs in stdout:
```
...
2022/11/13 10:48:12 [wlog] lsCR {"arg":["without-istio","sleep-7b6d569576-57sjq","sleep","21001713"]}
2022/11/13 10:48:14 [wlog] pwdCR {"arg":["without-istio","sleep-7b6d569576-57sjq","sleep","21001713"]}
...
```
Using the `[wlog]` flag, you can collect and store these logs persistently. All args are in the log, including the userID.
## Development ## Development
You can build a binary by simply running `make`. go1.16 is required. You can build a binary by simply running `make`. go1.16 is required.

View File

@ -145,6 +145,7 @@ func (server *Server) processWSConn(ctx context.Context, conn *websocket.Conn, h
opts := []webtty.Option{ opts := []webtty.Option{
webtty.WithWindowTitle(titleBuf.Bytes()), webtty.WithWindowTitle(titleBuf.Bytes()),
webtty.WithArguments(params),
} }
if server.options.PermitWrite { if server.options.PermitWrite {
opts = append(opts, webtty.WithPermitWrite()) opts = append(opts, webtty.WithPermitWrite())

96
utils/log.go Normal file
View File

@ -0,0 +1,96 @@
package utils
import "fmt"
func FormatWritesLog(codes []byte, line *string) {
n := len(codes)
str := ""
exist := false
if n == 3 {
if str, exist = ASCIIGroupToStr(fmt.Sprintf("%X", codes)); exist {
*line += str
codes = nil
}
}
// sh control codes
if n >= 6 {
if str, exist = ASCIIGroupToStr(fmt.Sprintf("%X", []byte{codes[0], codes[1], codes[n-1]})); exist {
*line += str
codes = nil
}
}
if codes != nil {
str = ASCIIToStr(codes)
*line += str
}
return
}
func ASCIIToStr(codes []byte) string {
control := map[byte]string{
0: "NUL",
1: "SOH",
2: "STX",
3: "ETX",
4: "EOT",
5: "ENQ",
6: "ACK",
7: "BEL",
8: "BS",
9: "HT",
10: "LF",
11: "VT",
12: "FF",
13: "CR",
14: "SO",
15: "SI",
16: "DLE",
17: "DCI",
18: "DC2",
19: "DC3",
20: "DC4",
21: "NAK",
22: "SYN",
23: "TB",
24: "CAN",
25: "EM",
26: "SUB",
27: "ESC",
28: "FS",
29: "GS",
30: "RS",
31: "US",
32: "SPACE",
127: "DEL",
}
str := ""
for _, code := range codes {
if value, ok := control[code]; ok {
str += value
} else {
str += string(code)
}
}
return str
}
func ASCIIGroupToStr(sum string) (string, bool) {
group := map[string]string{
"1B5B41": "UP",
"1B5B42": "DOWN",
"1B5B43": "RIGHT",
"1B5B44": "LEFT",
// sh control codes: codes[0]codes[1]codes[5]
// eg. "ESC[ 1;5 R"
"1B5B52": "",
}
if value, ok := group[sum]; ok {
return value, true
}
return "", false
}

View File

@ -41,6 +41,14 @@ func WithWindowTitle(windowTitle []byte) Option {
} }
} }
// WithArguments sets the command line arguments that clients send
func WithArguments(arguments map[string][]string) Option {
return func(wt *WebTTY) error {
wt.arguments = arguments
return nil
}
}
// WithReconnect enables reconnection on the master side. // WithReconnect enables reconnection on the master side.
func WithReconnect(timeInSeconds int) Option { func WithReconnect(timeInSeconds int) Option {
return func(wt *WebTTY) error { return func(wt *WebTTY) error {

View File

@ -4,6 +4,8 @@ import (
"context" "context"
"encoding/base64" "encoding/base64"
"encoding/json" "encoding/json"
"github.com/sorenisanerd/gotty/utils"
"log"
"sync" "sync"
"github.com/pkg/errors" "github.com/pkg/errors"
@ -19,6 +21,7 @@ type WebTTY struct {
slave Slave slave Slave
windowTitle []byte windowTitle []byte
arguments map[string][]string
permitWrite bool permitWrite bool
columns int columns int
rows int rows int
@ -88,13 +91,14 @@ func (wt *WebTTY) Run(ctx context.Context) error {
go func() { go func() {
errs <- func() error { errs <- func() error {
buffer := make([]byte, wt.bufferSize) buffer := make([]byte, wt.bufferSize)
line := ""
for { for {
n, err := wt.masterConn.Read(buffer) n, err := wt.masterConn.Read(buffer)
if err != nil { if err != nil {
return ErrMasterClosed return ErrMasterClosed
} }
err = wt.handleMasterReadEvent(buffer[:n]) err = wt.handleMasterReadEvent(buffer[:n], &line)
if err != nil { if err != nil {
return err return err
} }
@ -163,7 +167,7 @@ func (wt *WebTTY) masterWrite(data []byte) error {
return nil return nil
} }
func (wt *WebTTY) handleMasterReadEvent(data []byte) error { func (wt *WebTTY) handleMasterReadEvent(data []byte, line *string) error {
if len(data) == 0 { if len(data) == 0 {
return errors.New("unexpected zero length read from master") return errors.New("unexpected zero length read from master")
} }
@ -184,6 +188,17 @@ func (wt *WebTTY) handleMasterReadEvent(data []byte) error {
return errors.Wrapf(err, "failed to decode received data") return errors.Wrapf(err, "failed to decode received data")
} }
// log.Printf("[wlog] %v %X\n", decodedBuffer[:n], decodedBuffer[:n])
utils.FormatWritesLog(decodedBuffer[:n], line)
if decodedBuffer[n-1] == 13 {
argumentsByte, err := json.Marshal(wt.arguments)
if err != nil {
return errors.Wrapf(err, "failed to marshal arguments map")
}
log.Printf("[wlog] %s %s\n", *line, string(argumentsByte))
*line = ""
}
_, err = wt.slave.Write(decodedBuffer[:n]) _, err = wt.slave.Write(decodedBuffer[:n])
if err != nil { if err != nil {
return errors.Wrapf(err, "failed to write received data to slave") return errors.Wrapf(err, "failed to write received data to slave")