Merge branch 'release/v1.1.0' into main

Author: qu35t-code

.github/workflows/go.yml

@@ -16,6 +16,8 @@ jobs:
     strategy:
       matrix:
         go: ['1.19', '1.20', '1.21']
+        os: [ 'linux', 'windows', 'darwin' ]
+        arch: [ 'amd64', 'arm64' ]
     steps:
     - uses: actions/checkout@v3
 
@@ -25,4 +27,7 @@ jobs:
         go-version: ${{ matrix.go }}
 
     - name: Build
+      env:
+        GOOS: ${{ matrix.os }}
+        GOARCH: ${{ matrix.arch }}
       run: go build -v ./...

README.md

@@ -1,3 +1,32 @@
+# htb-cli
+
+![Workflows (main)](https://github.com/GoToolSharing/htb-cli/actions/workflows/go.yml/badge.svg?branch=main)
+![Workflows (dev)](https://github.com/GoToolSharing/htb-cli/actions/workflows/go.yml/badge.svg?branch=dev)
+
+<div>
+  <img alt="current version" src="https://img.shields.io/badge/linux-supported-success">
+  <img alt="current version" src="https://img.shields.io/badge/windows-supported-success">
+  <img alt="current version" src="https://img.shields.io/badge/mac-supported-success">
+  <br>
+  <img alt="amd64" src="https://img.shields.io/badge/amd64%20(x86__64)-supported-success">
+  <img alt="arm64" src="https://img.shields.io/badge/arm64%20(aarch64)-supported-success">
+</div>
+
+## Installation
+
+`go install github.com/GoToolSharing/htb-cli@latest`
+
+## Configuration
+
+You must add a Hackthebox **App token** in the **HTB_TOKEN** environment variable (zshrc maybe).
+API Token can be find here : https://app.hackthebox.com/profile/settings => `Create App Token`
+
+```
+export HTB_TOKEN=eyJ...
+```
+
+## Helper
+
 ```
 This software, engineered using the Go programming language, serves to streamline and automate various tasks for the HackTheBox platform, enhancing user efficiency and productivity.
 
@@ -6,12 +35,13 @@ Usage:
 
 Available Commands:
   active      Catalogue of active machines
-  submit      Submit credentials (User and Root Flags)
   help        Help about any command
   info        Showcase detailed machine information
-  reset       Reset a machine - [WIP]
+  reset       Reset a machine
   start       Start a machine
+  status      Displays the status of HackTheBox servers
   stop        Stop the current machine
+  submit      Submit credentials (User and Root Flags)
 
 Flags:
   -h, --help           help for htb-cli
@@ -21,58 +51,68 @@ Flags:
 Use "htb-cli [command] --help" for more information about a command.
 ```
 
-## Installation
-
-`go install github.com/GoToolSharing/htb-cli@latest`
-
-## Configuration
-
-You must add a Hackthebox **App token** in the **HTB_TOKEN** environment variable (zshrc maybe).
-API Token can be find here : https://app.hackthebox.com/profile/settings => Create App Token
-
-```
-export HTB_TOKEN=eyJ...
-```
-
 ## Start
 
 ```
-> htb-cli start -m Flight
+❯ htb-cli start -m Blue
+? The following machine was found : Blue Yes
 Machine deployed to lab.
 ```
 
 ## Stop
 
 ```
-> htb-cli stop
+❯ htb-cli stop
 Machine terminated.
 ```
 
 ## Reset
 
 ```
-> htb-cli reset -m Flight
-Machine terminated.
+❯ htb-cli reset
+CozyHosting will be reset in 1 minute.
 ```
 
 ## Submit
 
 This command allows to submit the user flag and the root flag of active and retired machines. The first argument is the flag and the second the difficulty /10.
 
+### Submit machine flag
 ```
-> htb-cli submit -f flag4testing -d 3
-
+❯ htb-cli submit -m SteamCloud -f flag4testing -d 3
+? The following machine was found : SteamCloud Yes
 SteamCloud user is now owned.
 ```
 
+### Submit challenge flag
+```
+❯ htb-cli submit -c Phonebook -f flag4testing -d 3
+? The following challenge was found : Phonebook Yes
+Incorrect flag
+```
+
 ## Info
 
-By default the command shows the active machine.
+```
+❯ htb-cli info
+? Do you want to check for active machine ? Yes
+Name   |OS        |Active   |Difficulty   |Stars   |IP            |Status            |Release
+Blue   |Windows   |0        |Easy         |4.5     |10.10.10.40   |✅ User - ✅ Root   |2017-07-28
+```
 
 ```
-> htb-cli info -m Zipper -m Sau
+❯ htb-cli info -m Zip -m pilgrimage
+? Do you want to check for active machine ? No
+? The following machine was found : Zipping Yes
+Name      |OS      |Active   |Difficulty   |Stars   |FirstUserBlood   |FirstRootBlood   |Status            |Release
+Zipping   |Linux   |✅        |Medium       |4.1     |0H 15M 9S        |1H 12M 28S       |❌ User - ❌ Root   |2023-08-26
+? The following machine was found : Pilgrimage Yes
+Pilgrimage   |Linux   |✅    |Easy   |4.5   |0H 17M 0S   |0H 20M 33S   |✅ User - ✅ Root   |2023-06-24
+```
 
-Name     |OS      |Active   |Difficulty   |Stars   |FirstUserBlood   |FirstRootBlood   |Status            |Release
-Zipper   |Linux   |0        |Hard         |4.5     |1H 57M 59S       |2H 8M 18S        |❌ User - ❌ Root   |2018-10-20
-Sau      |Linux   |1        |Easy         |4.6     |0H 8M 39S        |0H 11M 40S       |✅ User - ✅ Root   |2023-07-08
+## Status
+
+```
+❯ htb-cli status
+All Systems Operational
 ```

cmd/info.go

@@ -8,57 +8,163 @@ import (
 	"text/tabwriter"
 	"time"
 
+	"github.com/AlecAivazis/survey/v2"
 	"github.com/GoToolSharing/htb-cli/utils"
 	"github.com/kyokomi/emoji/v2"
 	"github.com/spf13/cobra"
 )
 
 var machineParam []string
+var challengeParam []string
+
+func checkActiveMachine() {
+	machine_id := utils.GetActiveMachineID(proxyParam)
+	status := "Not defined"
+	retired_status := "Not defined"
+	if machine_id != "" {
+		log.Println("Active machine found !")
+		log.Println("Machine ID:", machine_id)
+		w := tabwriter.NewWriter(os.Stdout, 0, 0, 3, ' ', tabwriter.Debug)
+		fmt.Fprintln(w, "Name\tOS\tActive\tDifficulty\tStars\tIP\tStatus\tRelease")
+		url := "https://www.hackthebox.com/api/v4/machine/profile/" + machine_id
+		resp, err := utils.HtbRequest(http.MethodGet, url, proxyParam, nil)
+		if err != nil {
+			log.Fatal(err)
+		}
+		info := utils.ParseJsonMessage(resp, "info")
+		data := info.(map[string]interface{})
+		if data["authUserInUserOwns"] == nil && data["authUserInRootOwns"] == nil {
+			status = emoji.Sprint(":x:User - :x:Root")
+		} else if data["authUserInUserOwns"] == true && data["authUserInRootOwns"] == nil {
+			status = emoji.Sprint(":white_check_mark:User - :x:Root")
+		} else if data["authUserInUserOwns"] == nil && data["authUserInRootOwns"] == true {
+			status = emoji.Sprint(":x:User - :white_check_mark:Root")
+		} else if data["authUserInUserOwns"] == true && data["authUserInRootOwns"] == true {
+			status = emoji.Sprint(":white_check_mark:User - :white_check_mark:Root")
+		}
+		if data["retired"].(float64) == 0 {
+			retired_status = emoji.Sprint(":white_check_mark:")
+		} else {
+			retired_status = emoji.Sprint(":x:")
+		}
+		t, err := time.Parse(time.RFC3339Nano, data["release"].(string))
+		if err != nil {
+			fmt.Println("Erreur when date parsing :", err)
+			return
+		}
+		datetime := t.Format("2006-01-02")
+		fmt.Fprintf(w, "%v\t%v\t%v\t%v\t%v\t%v\t%v\t%v\n", data["name"], data["os"], retired_status, data["difficultyText"], data["stars"], data["ip"], status, datetime)
+		w.Flush()
+	}
+}
 
 var infoCmd = &cobra.Command{
 	Use:   "info",
 	Short: "Showcase detailed machine information",
 	Long:  "Displays detailed information of the specified machines in a structured table.",
 	Run: func(cmd *cobra.Command, args []string) {
-		w := tabwriter.NewWriter(os.Stdout, 0, 0, 3, ' ', tabwriter.Debug)
-		fmt.Fprintln(w, "Name\tOS\tActive\tDifficulty\tStars\tFirstUserBlood\tFirstRootBlood\tStatus\tRelease")
-		status := "Not defined"
-		log.Println(machineParam)
-		for index, _ := range machineParam {
-			machine_id := utils.SearchMachineIDByName(machineParam[index], proxyParam)
+		if len(machineParam) > 0 && len(challengeParam) > 0 {
+			fmt.Println("Error: You can only specify either -m or -c flags, not both.")
+			cmd.Help()
+			os.Exit(1)
+		}
+		var confirmation bool
+		confirmation_message := "Do you want to check for active machine ?"
+		prompt := &survey.Confirm{
+			Message: confirmation_message,
+		}
+		if err := survey.AskOne(prompt, &confirmation); err != nil {
+			log.Fatal(err)
+		}
+		if confirmation {
+			checkActiveMachine()
+		}
 
-			url := "https://www.hackthebox.com/api/v4/machine/profile/" + machine_id
-			resp, err := utils.HtbRequest(http.MethodGet, url, proxyParam, nil)
-			if err != nil {
-				log.Fatal(err)
-			}
-			info := utils.ParseJsonMessage(resp, "info")
+		// Machines search
+		if len(machineParam) > 0 {
+			w := tabwriter.NewWriter(os.Stdout, 0, 0, 3, ' ', tabwriter.Debug)
+			fmt.Fprintln(w, "Name\tOS\tActive\tDifficulty\tStars\tFirstUserBlood\tFirstRootBlood\tStatus\tRelease")
+			status := "Not defined"
+			retired_status := "Not defined"
+			log.Println(machineParam)
+			for index, _ := range machineParam {
+				machine_id := utils.SearchItemIDByName(machineParam[index], proxyParam, "Machine")
 
-			data := info.(map[string]interface{})
-			if data["authUserInUserOwns"] == nil && data["authUserInRootOwns"] == nil {
-				status = emoji.Sprint(":x:User - :x:Root")
-			} else if data["authUserInUserOwns"] == true && data["authUserInRootOwns"] == nil {
-				status = emoji.Sprint(":white_check_mark:User - :x:Root")
-			} else if data["authUserInUserOwns"] == nil && data["authUserInRootOwns"] == true {
-				status = emoji.Sprint(":x:User - :white_check_mark:Root")
-			} else if data["authUserInUserOwns"] == true && data["authUserInRootOwns"] == true {
-				status = emoji.Sprint(":white_check_mark:User - :white_check_mark:Root")
-			}
-			t, err := time.Parse(time.RFC3339Nano, data["release"].(string))
-			if err != nil {
-				fmt.Println("Erreur when date parsing :", err)
-				return
+				url := "https://www.hackthebox.com/api/v4/machine/profile/" + machine_id
+				resp, err := utils.HtbRequest(http.MethodGet, url, proxyParam, nil)
+				if err != nil {
+					log.Fatal(err)
+				}
+				info := utils.ParseJsonMessage(resp, "info")
+
+				data := info.(map[string]interface{})
+				if data["authUserInUserOwns"] == nil && data["authUserInRootOwns"] == nil {
+					status = emoji.Sprint(":x:User - :x:Root")
+				} else if data["authUserInUserOwns"] == true && data["authUserInRootOwns"] == nil {
+					status = emoji.Sprint(":white_check_mark:User - :x:Root")
+				} else if data["authUserInUserOwns"] == nil && data["authUserInRootOwns"] == true {
+					status = emoji.Sprint(":x:User - :white_check_mark:Root")
+				} else if data["authUserInUserOwns"] == true && data["authUserInRootOwns"] == true {
+					status = emoji.Sprint(":white_check_mark:User - :white_check_mark:Root")
+				}
+				if data["retired"].(float64) == 0 {
+					retired_status = emoji.Sprint(":white_check_mark:")
+				} else {
+					retired_status = emoji.Sprint(":x:")
+				}
+				t, err := time.Parse(time.RFC3339Nano, data["release"].(string))
+				if err != nil {
+					fmt.Println("Erreur when date parsing :", err)
+					return
+				}
+				datetime := t.Format("2006-01-02")
+				fmt.Fprintf(w, "%v\t%v\t%v\t%v\t%v\t%v\t%v\t%v\t%v\n", data["name"], data["os"], retired_status, data["difficultyText"], data["stars"], data["firstUserBloodTime"], data["firstRootBloodTime"], status, datetime)
+				w.Flush()
 			}
-			datetime := t.Format("2006-01-02")
-			fmt.Fprintf(w, "%v\t%v\t%v\t%v\t%v\t%v\t%v\t%v\t%v\n", data["name"], data["os"], data["active"], data["difficultyText"], data["stars"], data["firstUserBloodTime"], data["firstRootBloodTime"], status, datetime)
 		}
-		w.Flush()
 
+		// Challenges search
+		if len(challengeParam) > 0 {
+			w := tabwriter.NewWriter(os.Stdout, 0, 0, 3, ' ', tabwriter.Debug)
+			fmt.Fprintln(w, "Name\tCategory\tActive\tDifficulty\tStars\tSolves\tStatus\tRelease")
+			status := "Not defined"
+			retired_status := "Not defined"
+			log.Println(challengeParam)
+			for index, _ := range challengeParam {
+				challenge_id := utils.SearchItemIDByName(challengeParam[index], proxyParam, "Challenge")
+				log.Println("Challenge id:", challenge_id)
+				url := "https://www.hackthebox.com/api/v4/challenge/info/" + challenge_id
+				resp, err := utils.HtbRequest(http.MethodGet, url, proxyParam, nil)
+				if err != nil {
+					log.Fatal(err)
+				}
+				info := utils.ParseJsonMessage(resp, "challenge")
+				data := info.(map[string]interface{})
+				if data["authUserSolve"] == false {
+					status = emoji.Sprint(":x:Flag")
+				} else {
+					status = emoji.Sprint(":white_check_mark:Flag")
+				}
+				if data["retired"].(float64) == 0 {
+					retired_status = emoji.Sprint(":white_check_mark:")
+				} else {
+					retired_status = emoji.Sprint(":x:")
+				}
+				t, err := time.Parse(time.RFC3339Nano, data["release_date"].(string))
+				if err != nil {
+					fmt.Println("Erreur when date parsing :", err)
+					return
+				}
+				datetime := t.Format("2006-01-02")
+				fmt.Fprintf(w, "%v\t%v\t%v\t%v\t%v\t%v\t%v\t%v\n", data["name"], data["category_name"], retired_status, data["difficulty"], data["stars"], data["solves"], status, datetime)
+				w.Flush()
+			}
+		}
 	},
 }
 
 func init() {
 	rootCmd.AddCommand(infoCmd)
 	infoCmd.Flags().StringSliceVarP(&machineParam, "machine", "m", []string{}, "Machine name")
-	infoCmd.MarkFlagRequired("machine")
+	infoCmd.Flags().StringSliceVarP(&challengeParam, "challenge", "c", []string{}, "Challenge name")
 }

cmd/reset.go

@@ -11,7 +11,7 @@ import (
 
 var resetCmd = &cobra.Command{
 	Use:   "reset",
-	Short: "Reset a machine - [WIP]",
+	Short: "Reset a machine",
 	Long:  "Initiates a reset request for the selected machine.",
 	Run: func(cmd *cobra.Command, args []string) {
 		machine_id := utils.GetActiveMachineID(proxyParam)

cmd/start.go

@@ -16,7 +16,7 @@ var startCmd = &cobra.Command{
 	Short: "Start a machine",
 	Long:  `Starts a Hackthebox machine specified in argument`,
 	Run: func(cmd *cobra.Command, args []string) {
-		machine_id := utils.SearchMachineIDByName(machineChoosen, proxyParam)
+		machine_id := utils.SearchItemIDByName(machineChoosen, proxyParam, "Machine")
 		log.Println("Machine ID :", machine_id)
 		machine_type := utils.GetMachineType(machine_id, proxyParam)
 		log.Println("Machine Type :", machine_type)