Skip to content

HTB API and Sherlocks improvements #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bytebl33d wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

HTB API and Sherlocks improvements #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a8877b
Fixed bugs with new API v5
bytebl33d Aug 18, 2026
14c9fbe
Fix: sherlock search and download
bytebl33d Aug 20, 2026
87fa7f2
feat(sherlocks): add interactive TUI, task hints, and release metadata
bytebl33d Sep 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions cmd/info.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,12 @@ type Response struct {
}

// Retrieves data for user profile
func fetchData(itemID int, endpoint string, infoKey string) (map[string]interface{}, error) {
url := fmt.Sprintf("%s%s%d", config.BaseHackTheBoxAPIURL, endpoint, itemID)
func fetchData(itemID int, endpoint string, infoKey string, apiVersion string) (map[string]interface{}, error) {
baseURL := config.BaseHackTheBoxAPIURL
if apiVersion == "v5" {
baseURL = strings.Replace(config.BaseHackTheBoxAPIURL, "/v4", "/v5", 1)
}
url := fmt.Sprintf("%s%s%d", baseURL, endpoint, itemID)
config.GlobalConfig.Logger.Debug(fmt.Sprintf("URL: %s", url))

resp, err := utils.HtbRequest(http.MethodGet, url, nil)
Expand All @@ -32,13 +36,25 @@ func fetchData(itemID int, endpoint string, infoKey string) (map[string]interfac
}

parsedInfo := utils.ParseJsonMessage(resp, infoKey)

// Handle v5 API response
if apiVersion == "v5" && infoKey == "data" {
if dataArray, ok := parsedInfo.([]interface{}); ok {
return map[string]interface{}{
"activity": dataArray,
}, nil
}
return nil, errors.New("Could not convert data to array")
}

dataMap, ok := parsedInfo.(map[string]interface{})
if !ok {
return nil, errors.New("Could not convert parsedInfo to map[string]interface{}")
}
return dataMap, nil
}


// fetchAndDisplayInfo fetches and displays information based on the specified parameters.
func fetchAndDisplayInfo(url, header string, params []string, elementType string) error {
w := utils.SetTabWriterHeader(header)
Expand Down Expand Up @@ -82,18 +98,20 @@ func fetchAndDisplayInfo(url, header string, params []string, elementType string
data := info.(map[string]interface{})

endpoints := []struct {
name string
url string
name string
url string
apiVersion string
infoKey string
}{
{"Fortresses", "/user/profile/progress/fortress/"},
{"Prolabs", "/user/profile/progress/prolab/"},
{"Activity", "/user/profile/activity/"},
{"Fortresses", "/user/profile/progress/fortress/", "v4", "profile"},
{"Prolabs", "/user/profile/progress/prolab/", "v4", "profile"},
{"Activity", "/user/profile/activity/", "v5", "data"},
}

dataMaps := make(map[string]map[string]interface{})

for _, ep := range endpoints {
data, err := fetchData(itemID, ep.url, "profile")
data, err := fetchData(itemID, ep.url, ep.infoKey, ep.apiVersion)
if err != nil {
fmt.Printf("Error fetching data for %s: %v\n", ep.name, err)
continue
Expand Down
76 changes: 62 additions & 14 deletions cmd/machines.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"log"
"net/http"
"os"
"strings"
"time"

"github.com/GoToolSharing/htb-cli/config"
Expand All @@ -20,7 +21,6 @@ import (
const (
machineURL = config.BaseHackTheBoxAPIURL + "/machine/paginated/?per_page=20"
retiredURL = config.BaseHackTheBoxAPIURL + "/machine/list/retired/paginated/?per_page=20&sort_by=release-date"
scheduledURL = config.BaseHackTheBoxAPIURL + "/machine/unreleased/"
activeTitle = "Active"
retiredTitle = "Retired"
scheduledTitle = "Scheduled"
Expand All @@ -30,6 +30,8 @@ const (
Computer = "\U0001F5A5 "
)

var scheduledURL = strings.Replace(config.BaseHackTheBoxAPIURL, "/v4", "/v5", 1) + "/machines?per_page=15&state=unreleased"

// getColorFromDifficultyText returns the color corresponding to the given difficulty.
func getColorFromDifficultyText(difficultyText string) string {
switch difficultyText {
Expand Down Expand Up @@ -67,48 +69,94 @@ func createFlex(info interface{}, title string, isScheduled bool) (*tview.Flex,
data := value.(map[string]interface{})

// Determining the color according to difficulty

key := "Undefined"
_ = key
if title == "Scheduled" {
key = data["difficulty_text"].(string)
if val, ok := data["difficultyText"].(string); ok {
key = val
}
} else {
key = data["difficultyText"].(string)
if val, ok := data["difficultyText"].(string); ok {
key = val
}
}
color := getColorFromDifficultyText(key)
osEmoji := getOSEmoji(data["os"].(string))

osStr := "Unknown"
if os, ok := data["os"].(string); ok {
osStr = os
}
osEmoji := getOSEmoji(osStr)

var formatString string

// Choice of display format depending on the nature of the information
if isScheduled {
diffText := "Undefined"
if val, ok := data["difficultyText"].(string); ok {
diffText = val
}
name := "Undefined"
if val, ok := data["name"].(string); ok {
name = val
}
formatString = fmt.Sprintf("%-10s %s%-10s %s%-10s[-]",
data["name"], osEmoji, data["os"], color, data["difficulty_text"])
name, osEmoji, osStr, color, diffText)
} else {
// Convert and format date
parsedDate, err := time.Parse(time.RFC3339Nano, data["release"].(string))
var releaseDateStr string
if val, ok := data["release"].(string); ok {
releaseDateStr = val
} else if val, ok := data["releaseDate"].(string); ok {
releaseDateStr = val
}

if releaseDateStr == "" {
continue
}

parsedDate, err := time.Parse(time.RFC3339Nano, releaseDateStr)
if err != nil {
return nil, fmt.Errorf("error parsing date: %v", err)
// Try RFC3339 format for v5 API
parsedDate, err = time.Parse(time.RFC3339, releaseDateStr)
if err != nil {
return nil, fmt.Errorf("error parsing date: %v", err)
}
}
formattedDate := parsedDate.Format("02 January 2006")

userEmoji := CrossMark + "User"
if value, ok := data["authUserInUserOwns"]; ok && value != nil {
if value.(bool) {
if val, ok := data["authUserInUserOwns"]; ok && val != nil {
if boolVal, ok := val.(bool); ok && boolVal {
userEmoji = CheckMark + "User"
}
}

rootEmoji := CrossMark + "Root"
if value, ok := data["authUserInRootOwns"]; ok && value != nil {
if value.(bool) {
if val, ok := data["authUserInRootOwns"]; ok && val != nil {
if boolVal, ok := val.(bool); ok && boolVal {
rootEmoji = CheckMark + "Root"
}
}

name := "Undefined"
if val, ok := data["name"].(string); ok {
name = val
}

diffText := "Undefined"
if val, ok := data["difficultyText"].(string); ok {
diffText = val
}

star := 0.0
if val, ok := data["star"].(float64); ok {
star = val
}

formatString = fmt.Sprintf("%-15s %s%-10s %s%-10s[-] %-5v %-5v %-7v %-30s",
data["name"], osEmoji, data["os"], color, data["difficultyText"],
data["star"], userEmoji, rootEmoji, formattedDate)
name, osEmoji, osStr, color, diffText,
star, userEmoji, rootEmoji, formattedDate)
}

flex.AddItem(tview.NewTextView().SetText(formatString).SetDynamicColors(true), 1, 0, false)
Expand Down
Loading