maride/gotty
1
0
Fork 0
mirror of https://github.com/sorenisanerd/gotty.git synced 2024-11-22 20:34:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

1. Adjusted the log format

Browse Source 
2. optimized code
Merge branch 'develop'
This commit is contained in:
llaoj 2022-12-11 18:01:49 +08:00
commit f764187d57
7 changed files with 111 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gotty
View File

@ -7,6 +7,9 @@
// [bool] Permit clients to write to the TTY
// permit_write = false
// [bool] Log user's writes in the TTY
// write_log = false
// [bool] Enable basic authentication
// enable_basic_auth = false

15
README.md
View File

@ -57,6 +57,7 @@ By default, GoTTY starts a web server at port 8080. Open the URL on your web bro
--port value, -p value Port number to liten (default: "8080") [$GOTTY_PORT]
--path value, -m value Base path (default: "/") [$GOTTY_PATH]
--permit-write, -w Permit clients to write to the TTY (BE CAREFUL) (default: false) [$GOTTY_PERMIT_WRITE]
--write-log Log user's writes in the TTY (default: false) [$GOTTY_WRITE_LOG]
--credential value, -c value Credential for Basic Authentication (ex: user:pass, default disabled) [$GOTTY_CREDENTIAL]
--random-url, -r Add a random string to the URL (default: false) [$GOTTY_RANDOM_URL]
--random-url-length value Random URL length (default: 8) [$GOTTY_RANDOM_URL_LENGTH]
@ -151,14 +152,14 @@ When you want to create a jailed environment for each client, you can use Docker
$ gotty -w docker run -it --rm busybox
```
## Writes log
## Write log
User's input in terminal can be found in logs. for example:
If you set `--write-log` option, user's writes in the TTY can be Logged. for example:
if you run gotty like this:
```shell
./gotty -w --permit-arguments ./test.sh
./gotty -w --write-log --permit-arguments ./test.sh
```
this is `test.sh`:
@ -170,16 +171,16 @@ 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:
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 user's writes in the log (operation logs):
```
...
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"]}
2022/11/13 10:48:12 [write-log] {"arg":["without-istio","sleep-7b6d569576-57sjq","sleep","21001713"]} lsCR
2022/11/13 10:48:14 [write-log] {"arg":["without-istio","sleep-7b6d569576-57sjq","sleep","21001713"]} pwdCR
...
```
Using the `[wlog]` flag, you can collect and store these logs persistently. All args are in the log, including the userID.
Using the `[write-log]` flag, you can collect and store these logs persistently. All args are in the log, including the userID.
## Development

3
server/handlers.go
View File

@ -150,6 +150,9 @@ func (server *Server) processWSConn(ctx context.Context, conn *websocket.Conn, h
if server.options.PermitWrite {
opts = append(opts, webtty.WithPermitWrite())
}
if server.options.WriteLog {
opts = append(opts, webtty.WithWriteLog())
}
if server.options.EnableReconnect {
opts = append(opts, webtty.WithReconnect(server.options.ReconnectTime))
}

1
server/options.go
View File

@ -9,6 +9,7 @@ type Options struct {
Port string `hcl:"port" flagName:"port" flagSName:"p" flagDescribe:"Port number to liten" default:"8080"`
Path string `hcl:"path" flagName:"path" flagSName:"m" flagDescribe:"Base path" default:"/"`
PermitWrite bool `hcl:"permit_write" flagName:"permit-write" flagSName:"w" flagDescribe:"Permit clients to write to the TTY (BE CAREFUL)" default:"false"`
WriteLog bool `hcl:"write_log" flagName:"write-log" flagDescribe:"Log user's writes in the TTY" default:"false"`
EnableBasicAuth bool `hcl:"enable_basic_auth" default:"false"`
Credential string `hcl:"credential" flagName:"credential" flagSName:"c" flagDescribe:"Credential for Basic Authentication (ex: user:pass, default disabled)" default:""`
EnableRandomUrl bool `hcl:"enable_random_url" flagName:"random-url" flagSName:"r" flagDescribe:"Add a random string to the URL" default:"false"`

93
utils/log.go
View File

@ -2,34 +2,7 @@ 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{
var CtrlChar = map[byte]string{
0: "NUL",
1: "SOH",
2: "STX",
@ -66,29 +39,65 @@ func ASCIIToStr(codes []byte) string {
127: "DEL",
}
str := ""
var CtrlCharGroup = map[string]string{
"1B5B41": "UP",
"1B5B42": "DOWN",
"1B5B43": "RIGHT",
"1B5B44": "LEFT",
// shell control codes
// codes[0]+codes[1]+codes[n-1]
// for example:
// [1B(ESC) 5B([) 32(2) 3B(;) 35(5) 52(R)]: row 2 col 5
// [1B(ESC) 5B([) 31(1) 30(0) 3B(;) 35(5) 52(R)]: row 10 col 5
// [1B(ESC) 5B([) 32(2) 32(2) 3B(;) 35(5) 52(R)]: row 22 col 5
"1B5B52": "",
// maybe there will be more control char group
// ...
}
func FormatWriteLog(codes []byte, line *string) {
n := len(codes)
// when user uses the keyboard arrow keys
// arrow keys are combination of 3 ASCII codes
if n == 3 {
if str, exist := ASCIIGroupToStr(fmt.Sprintf("%X", codes)); exist {
*line += str
return
}
}
// for some shells
// they will automatically send some control characters
// after typing the command and pressing Enter
// which indicate the current row and column.
if n >= 6 {
if str, exist := ASCIIGroupToStr(fmt.Sprintf("%X", []byte{codes[0], codes[1], codes[n-1]})); exist {
*line += str
return
}
}
str := ASCIIToStr(codes)
*line += str
return
}
func ASCIIToStr(codes []byte) (str string) {
for _, code := range codes {
if value, ok := control[code]; ok {
if value, ok := CtrlChar[code]; ok {
str += value
} else {
str += string(code)
}
}
return str
return
}
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 {
func ASCIIGroupToStr(group string) (string, bool) {
if value, ok := CtrlCharGroup[group]; ok {
return value, true
}

8
webtty/option.go
View File

@ -17,6 +17,14 @@ func WithPermitWrite() Option {
}
}
// WithWriteLog sets a WebTTY to log user's writes in the TTY.
func WithWriteLog() Option {
return func(wt *WebTTY) error {
wt.writeLog = true
return nil
}
}
// WithFixedColumns sets a fixed width to TTY master.
func WithFixedColumns(columns int) Option {
return func(wt *WebTTY) error {

24
webtty/webtty.go
View File

@ -23,6 +23,7 @@ type WebTTY struct {
windowTitle []byte
arguments map[string][]string
permitWrite bool
writeLog bool
columns int
rows int
reconnect int // in seconds
@ -91,14 +92,18 @@ func (wt *WebTTY) Run(ctx context.Context) error {
go func() {
errs <- func() error {
buffer := make([]byte, wt.bufferSize)
line := ""
var line string
arguments, err := json.Marshal(wt.arguments)
if err != nil {
return err
}
for {
n, err := wt.masterConn.Read(buffer)
if err != nil {
return ErrMasterClosed
}
err = wt.handleMasterReadEvent(buffer[:n], &line)
err = wt.handleMasterReadEvent(buffer[:n], &line, arguments)
if err != nil {
return err
}
@ -167,7 +172,7 @@ func (wt *WebTTY) masterWrite(data []byte) error {
return nil
}
func (wt *WebTTY) handleMasterReadEvent(data []byte, line *string) error {
func (wt *WebTTY) handleMasterReadEvent(data []byte, line *string, argument []byte) error {
if len(data) == 0 {
return errors.New("unexpected zero length read from master")
}
@ -188,16 +193,15 @@ func (wt *WebTTY) handleMasterReadEvent(data []byte, line *string) error {
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 wt.writeLog {
utils.FormatWriteLog(decodedBuffer[:n], line)
// 13(ASCII) means carriage return(CR)
// it is the end of a 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))
log.Printf("[write-log] %s %s\n", argument, *line)
*line = ""
}
}
_, err = wt.slave.Write(decodedBuffer[:n])
if err != nil {