Merge pull request #346 from dmur1/add-remote-command-#333

add a command to set/query a task's remote ip:port information

Author: dmur1

README.md

@@ -372,7 +372,7 @@ for example:
 
 ---
 
-### 📃 <u>re</u>adme
+### 📃 <u>rea</u>dme
 
 ```
 $ ret readme 
@@ -384,6 +384,24 @@ make the readme with ret
 
 ---
 
+### 📡 <u>rem</u>ote
+
+```
+$ ret remote [ip=127.0.0.1] [port=9001] 
+```
+
+set or query a task's ip and port with ret
+
+supply no arguments to see the current ip and port
+
+note that task metadata is stored in hidden directory `.ret` and therefore scoped to the cwd
+
+task metadata is stored in the `.ret/task.json` file
+
+🔗 https://github.com/rerrorctf/ret/blob/main/commands/remote.go
+
+---
+
 ### 🚮 <u>rm</u>ctf
 
 ```

commands/remote.go

@@ -0,0 +1,75 @@
+package commands
+
+import (
+	"fmt"
+	"ret/config"
+	"ret/theme"
+	"ret/util"
+)
+
+func init() {
+	Commands = append(Commands, Command{
+		Name:  "remote",
+		Emoji: "📡",
+		Func:  Remote,
+		Help:  RemoteHelp,
+		Arguments: []Argument{
+			{
+				Name:     "ip",
+				Optional: true,
+				List:     false,
+				Default:  "127.0.0.1",
+			},
+			{
+				Name:     "port",
+				Optional: true,
+				List:     false,
+				Default:  "9001",
+			},
+		},
+		SeeAlso: nil})
+}
+
+func RemoteHelp() string {
+	return "set or query a task's ip and port with ret\n\n" +
+		"supply no arguments to see the current ip and port\n\n" +
+		"note that task metadata is stored in hidden directory " + theme.ColorCyan + "`.ret`" + theme.ColorReset + " and therefore scoped to the cwd\n\n" +
+		"task metadata is stored in the " + theme.ColorCyan + "`" + config.TaskFileName + "`" + theme.ColorReset + " file\n"
+}
+
+func displayCurrentTaskIpAndPort() {
+	ip := util.GetCurrentTaskIp()
+	port := util.GetCurrentTaskPort()
+
+	fmt.Printf("📡 "+theme.ColorBlue+"%s:%d"+theme.ColorReset+"\n", ip, port)
+}
+
+func setCurrentTaskIpAndPort(newIp string, newPort int) {
+	oldIp := util.GetCurrentTaskIp()
+	oldPort := util.GetCurrentTaskPort()
+
+	if (oldIp != newIp) || (oldPort != newPort) {
+		fmt.Printf(theme.ColorGray+"📡 changing ip:port from: "+theme.ColorRed+"%s:%d"+theme.ColorGray+" to: "+theme.ColorGreen+"%s:%d"+theme.ColorReset+"\n",
+			oldIp, oldPort, newIp, newPort)
+	} else {
+		fmt.Printf(theme.ColorGray+"📡 setting ip:port to: "+theme.ColorGreen+"%s:%d"+theme.ColorReset+"\n", newIp, newPort)
+	}
+
+	util.SetCurrentTaskIp(newIp)
+	util.SetCurrentTaskPort(newPort)
+}
+
+func Remote(args []string) {
+	if len(args) == 0 {
+		displayCurrentTaskIpAndPort()
+		return
+	}
+
+	util.EnsureSkeleton()
+
+	var ip string
+	var port int
+	util.GetRemoteParams(args, &ip, &port)
+
+	setCurrentTaskIpAndPort(ip, port)
+}

data/task.go

@@ -4,5 +4,7 @@ type Task struct {
 	Name        string `json:"name"`
 	Category    string `json:"category"`
 	Description string `json:"description"`
+	Ip          string `json:"ip"`
+	Port        int    `json:"port"`
 	Flag        string `json:"flag"`
 }

util/task.go

@@ -11,6 +11,8 @@ import (
 
 func GetCurrentTask() data.Task {
 	var task data.Task
+	task.Ip = "127.0.0.1"
+	task.Port = 9001
 
 	jsonData, err := os.ReadFile(config.TaskFileName)
 	if err != nil {
@@ -80,3 +82,25 @@ func SetCurrentTaskFlag(flag string) {
 	task.Flag = flag
 	SetCurrentTask(&task)
 }
+
+func GetCurrentTaskIp() string {
+	task := GetCurrentTask()
+	return task.Ip
+}
+
+func SetCurrentTaskIp(ip string) {
+	task := GetCurrentTask()
+	task.Ip = ip
+	SetCurrentTask(&task)
+}
+
+func GetCurrentTaskPort() int {
+	task := GetCurrentTask()
+	return task.Port
+}
+
+func SetCurrentTaskPort(port int) {
+	task := GetCurrentTask()
+	task.Port = port
+	SetCurrentTask(&task)
+}