Mirror
/
resh
mirror of https://github.com/curusarn/resh
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add reshctl sanitize, add last recall to recorded data

Browse Source
pull/58/head v2.4.1
Simon Let 6 years ago
parent 477816e6b6
commit 3605e8abc5
8 changed files with 104 additions and 55 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 34
      Makefile
  2. 8
      cmd/collect/main.go
  3. 2
      cmd/control/cmd/root.go
  4. 54
      cmd/control/cmd/sanitize.go
  5. 41
      cmd/sanitize/main.go
  6. 11
      pkg/records/records.go
  7. 3
      scripts/hooks.sh
  8. 6
      scripts/widgets.sh

34
Makefile
Unescape View File

@ -4,40 +4,6 @@ REVISION=$(shell [ -z "$(git status --untracked-files=no --porcelain)" ] && git
VERSION="${LATEST_TAG}-DEV"
GOFLAGS=-ldflags "-X main.version=${VERSION} -X main.commit=${REVISION}"
sanitize:
#
#
# I'm going to create a sanitized version of your resh history.
# Everything is done locally - your history won't leave this machine.
# The way this works is that any sensitive information in your history is going to be replaced with its SHA1 hash.
# There is also going to be a second version with hashes trimed to 12 characters for readability
#
#
# > full hashes: ~/resh_history_sanitized.json
# > 12 char hashes: ~/resh_history_sanitized_trim12.json
#
#
# Encountered any issues? Got questions? -> Hit me up at https://github.com/curusarn/resh/issues
#
#
# Running history sanitization ...
resh-sanitize -trim-hashes 0 --output ~/resh_history_sanitized.json
resh-sanitize -trim-hashes 12 --output ~/resh_history_sanitized_trim12.json
#
#
# SUCCESS - ALL DONE!
#
#
# PLEASE HAVE A LOOK AT THE RESULT USING THESE COMMANDS:
#
# > pretty print JSON:
@echo 'cat ~/resh_history_sanitized_trim12.json | jq'
#
# > only show executed commands, don't show metadata:
@echo "cat ~/resh_history_sanitized_trim12.json | jq '.[\"cmdLine\"]'"
#
#
#
build: submodules bin/resh-session-init bin/resh-collect bin/resh-postcollect bin/resh-daemon\
bin/resh-evaluate bin/resh-sanitize bin/resh-control bin/resh-config bin/resh-inspect

8
cmd/collect/main.go
Unescape View File

@ -57,6 +57,7 @@ func main() {
// recall metadata
recallActions := flag.String("recall-actions", "", "recall actions that took place before executing the command")
recallStrategy := flag.String("recall-strategy", "", "recall strategy used during recall actions")
recallLastCmdLine := flag.String("recall-last-cmdline", "", "last recalled cmdline")
// posix variables
cols := flag.String("cols", "-1", "$COLUMNS")
@ -241,9 +242,10 @@ func main() {
ReshVersion: version,
ReshRevision: commit,
RecallActionsRaw: *recallActions,
RecallPrefix: *recallPrefix,
RecallStrategy: *recallStrategy,
RecallActionsRaw: *recallActions,
RecallPrefix: *recallPrefix,
RecallStrategy: *recallStrategy,
RecallLastCmdLine: *recallLastCmdLine,
},
}
collect.SendRecord(rec, strconv.Itoa(config.Port), "/record")

2
cmd/control/cmd/root.go
Unescape View File

@ -62,6 +62,8 @@ func Execute(ver, com string) status.Code {
rootCmd.AddCommand(updateCmd)
rootCmd.AddCommand(sanitizeCmd)
if err := rootCmd.Execute(); err != nil {
fmt.Println(err)
return status.Fail

54
cmd/control/cmd/sanitize.go
Unescape View File

@ -0,0 +1,54 @@
package cmd
import (
"fmt"
"os"
"os/exec"
"os/user"
"github.com/curusarn/resh/cmd/control/status"
"github.com/spf13/cobra"
)
var sanitizeCmd = &cobra.Command{
Use: "sanitize",
Short: "produce a sanitized version of your RESH history",
Run: func(cmd *cobra.Command, args []string) {
exitCode = status.Success
usr, _ := user.Current()
dir := usr.HomeDir
fmt.Println()
fmt.Println(" HOW IT WORKS")
fmt.Println(" In sanitized history, all sensitive information is replaced with its SHA1 hashes.")
fmt.Println()
fmt.Println("Sanitizing ...")
fmt.Println(" * ~/resh_history_sanitized.json (full lengh hashes)")
execCmd := exec.Command("resh-sanitize", "-trim-hashes", "0", "--output", dir+"/resh_history_sanitized.json")
execCmd.Stdout = os.Stdout
execCmd.Stderr = os.Stderr
err := execCmd.Run()
if err != nil {
exitCode = status.Fail
}
fmt.Println(" * ~/resh_history_sanitized_trim12.json (12 char hashes)")
execCmd = exec.Command("resh-sanitize", "-trim-hashes", "12", "--output", dir+"/resh_history_sanitized_trim12.json")
execCmd.Stdout = os.Stdout
execCmd.Stderr = os.Stderr
err = execCmd.Run()
if err != nil {
exitCode = status.Fail
}
fmt.Println()
fmt.Println("Please direct all questions and/or issues to: https://github.com/curusarn/resh/issues")
fmt.Println()
fmt.Println("Please look at the resulting sanitized history using commands below.")
fmt.Println(" * Pretty print JSON")
fmt.Println(" cat ~/resh_history_sanitized_trim12.json | jq")
fmt.Println()
fmt.Println(" * Only show commands, don't show metadata")
fmt.Println(" cat ~/resh_history_sanitized_trim12.json | jq '.[\"cmdLine\"]")
fmt.Println()
},
}

41
cmd/sanitize/main.go
Unescape View File

@ -172,6 +172,10 @@ func (s *sanitizer) sanitizeRecord(record *records.Record) error {
if err != nil {
log.Fatal("Cmd:", record.CmdLine, "; sanitization error:", err)
}
record.RecallLastCmdLine, err = s.sanitizeCmdLine(record.RecallLastCmdLine)
if err != nil {
log.Fatal("RecallLastCmdLine:", record.RecallLastCmdLine, "; sanitization error:", err)
}
if len(record.RecallActionsRaw) > 0 {
record.RecallActionsRaw, err = s.sanitizeRecallActions(record.RecallActionsRaw)
@ -187,24 +191,41 @@ func (s *sanitizer) sanitizeRecord(record *records.Record) error {
// sanitizes the recall actions by replacing the recall prefix with it's length
func (s *sanitizer) sanitizeRecallActions(str string) (string, error) {
sanStr := ""
for x, actionStr := range strings.Split(str, ";") {
divider := ";"
if strings.Contains(str, "|||") {
divider = "|||"
// normal mode
}
for x, actionStr := range strings.Split(str, divider+"arrow_") {
if x == 0 {
continue
}
if len(actionStr) == 0 {
return str, errors.New("Action can't be empty; idx=" + strconv.Itoa(x))
}
fields := strings.Split(actionStr, ":")
if len(fields) != 2 {
return str, errors.New("Action should have exactly one ':' - encountered:" + actionStr)
}
action := fields[0]
if action != "arrow_up" && action != "arrow_down" {
return str, errors.New("Action (part 1) should be either 'arrow_up' or 'arrow_down' - encountered:" + action)
var action string
var prefix string
if strings.HasPrefix(actionStr, "up:") {
action = "arrow_up"
if len(actionStr) < 3 {
return str, errors.New("Action is too short:" + actionStr)
}
if len(actionStr) != 3 {
prefix = actionStr[4:]
}
} else if strings.HasPrefix(actionStr, "down:") {
action = "arrow_down"
if len(actionStr) < 5 {
return str, errors.New("Action is too short:" + actionStr)
}
if len(actionStr) != 5 {
prefix = actionStr[6:]
}
} else {
return str, errors.New("Action should start with one of (arrow_up, arrow_down); got: arrow_" + actionStr)
}
prefix := fields[1]
sanPrefix := strconv.Itoa(len(prefix))
sanStr += ";" + action + ":" + sanPrefix
sanStr += "|||" + action + ":" + sanPrefix
}
return sanStr, nil
}

11
pkg/records/records.go
Unescape View File

@ -84,11 +84,12 @@ type BaseRecord struct {
SessionExit bool `json:"sessionExit,omitempty"`
// recall metadata
Recalled bool `json:"recalled"`
RecallHistno int `json:"recallHistno,omitempty"`
RecallStrategy string `json:"recallStrategy,omitempty"`
RecallActionsRaw string `json:"recallActionsRaw,omitempty"`
RecallActions []string `json:"recallActions,omitempty"`
Recalled bool `json:"recalled"`
RecallHistno int `json:"recallHistno,omitempty"`
RecallStrategy string `json:"recallStrategy,omitempty"`
RecallActionsRaw string `json:"recallActionsRaw,omitempty"`
RecallActions []string `json:"recallActions,omitempty"`
RecallLastCmdLine string `json:"recallLastCmdLine"`
// recall command
RecallPrefix string `json:"recallPrefix,omitempty"`

3
scripts/hooks.sh
Unescape View File

@ -3,7 +3,7 @@ __resh_reset_variables() {
__RESH_HISTNO=0
__RESH_HISTNO_MAX=""
__RESH_HISTNO_ZERO_LINE=""
__RESH_HIST_PREV_LINE="" # deprecated
__RESH_HIST_PREV_LINE=""
__RESH_HIST_PREV_CURSOR="" # deprecated
__RESH_HIST_PREV_PREFIX=""
__RESH_HIST_RECALL_ACTIONS=""
@ -18,6 +18,7 @@ __resh_preexec() {
__resh_collect --cmdLine "$__RESH_CMDLINE" \
--recall-actions "$__RESH_HIST_RECALL_ACTIONS" \
--recall-strategy "$__RESH_HIST_RECALL_STRATEGY" \
--recall-last-cmdline "$__RESH_HIST_PREV_LINE" \
> ~/.resh/collect_last_run_out.txt 2>&1 || echo "resh-collect ERROR: $(head -n 1 ~/.resh/collect_last_run_out.txt)"
}

6
scripts/widgets.sh
Unescape View File

@ -29,13 +29,15 @@ __resh_helper_arrow_post() {
[ "$__RESH_HIST_NO_PREFIX_MODE" -eq 1 ] && CURSOR=${#BUFFER}
# save current prefix so we can spot when user moves cursor or edits (the prefix part of) the line
__RESH_HIST_PREV_PREFIX=${BUFFER:0:$CURSOR}
# recorded to history
__RESH_HIST_PREV_LINE=${BUFFER}
}
__resh_widget_arrow_up() {
# run helper function
__resh_helper_arrow_pre
# append curent recall action
__RESH_HIST_RECALL_ACTIONS="$__RESH_HIST_RECALL_ACTIONS;arrow_up:$__RESH_PREFIX"
__RESH_HIST_RECALL_ACTIONS="$__RESH_HIST_RECALL_ACTIONS|||arrow_up:$__RESH_PREFIX"
# increment histno
__RESH_HISTNO=$((__RESH_HISTNO+1))
if [ "${#__RESH_HISTNO_MAX}" -gt 0 ] && [ "${__RESH_HISTNO}" -gt "${__RESH_HISTNO_MAX}" ]; then
@ -67,7 +69,7 @@ __resh_widget_arrow_down() {
# run helper function
__resh_helper_arrow_pre
# append curent recall action
__RESH_HIST_RECALL_ACTIONS="$__RESH_HIST_RECALL_ACTIONS;arrow_down:$__RESH_PREFIX"
__RESH_HIST_RECALL_ACTIONS="$__RESH_HIST_RECALL_ACTIONS|||arrow_down:$__RESH_PREFIX"
# increment histno
__RESH_HISTNO=$((__RESH_HISTNO-1))
# prevent HISTNO from getting negative (for now)

Write Preview
Loading…
Cancel
Save