Improving ScanResult functionality (#74)

* ensure end time is passed to GetAllScanResultsByTime API call

* remove the use of deprecated function

* consolidate managable and usable scan results

* use url values for crafting scan result query

* add example for scan result

* Add generated changelog entries

---------

Co-authored-by: Armin <[email protected]>
Co-authored-by: svc-changelog <[email protected]>

Author: arminaaki

_examples/scanresult/main.go

@@ -0,0 +1,53 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"time"
+
+	"github.com/palantir/tenablesc-client/tenablesc"
+)
+
+func main() {
+	client := tenablesc.NewClient(
+		os.Getenv("TENABLE_URL"), // Tenable SC host. ensure the url has /rest in their path.
+	).SetAPIKey(
+		os.Getenv("TENABLE_ACCESS_KEY"), // Tenable SC access key.
+		os.Getenv("TENABLE_SECRET_KEY"), // Tenable SC secret key.
+	)
+
+	now := time.Now()
+	dayBefore := now.Add(-1 * 24 * time.Hour)
+	scans, err := client.GetAllScanResultsByTime(dayBefore, now)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	log.Println("listing scan results for the past 24 hours")
+	for _, scan := range scans {
+		log.Println(scan.Name, scan.ID)
+	}
+
+	firstScanResult := scans[0]
+	log.Printf("get scan result for ID: %s\n", firstScanResult.ID)
+	result, err := client.GetScanResult(string(firstScanResult.ID))
+	if err != nil {
+		log.Fatal(err)
+	}
+	log.Println("scan result name returned:", result.Name)
+
+	log.Printf("downloading scan results for ID: %s\n", firstScanResult.ID)
+	outFileName := fmt.Sprintf("scan-results-%s.nessus", firstScanResult.ID)
+	downloadedData, err := client.DownloadScanResult(string(firstScanResult.ID))
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	log.Printf("writing downloaded data to file: %s", outFileName)
+	err = os.WriteFile(outFileName, downloadedData, os.FileMode(0600))
+	if err != nil {
+		log.Fatal(err)
+	}
+
+}

changelog/@unreleased/pr-74.v2.yml

@@ -0,0 +1,5 @@
+type: fix
+fix:
+  description: Improving ScanResult functionality
+  links:
+  - https://github.com/palantir/tenablesc-client/pull/74

tenablesc/scanresult.go

@@ -5,9 +5,8 @@ import (
 	"bytes"
 	"errors"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"net/url"
-	"strings"
 	"time"
 
 	"github.com/go-resty/resty/v2"
@@ -56,11 +55,9 @@ type ScanResult struct {
 
 type scanResultInternal struct {
 	Manageable []*ScanResult `json:"manageable" tenable:"recurse"`
-	Useable    []*ScanResult `json:"useable" tenable:"recurse"`
+	Usable     []*ScanResult `json:"usable" tenable:"recurse"`
 }
 
-// Do the usable/manageable split thing. ffff.
-
 // takes startTime + endTime parameters, but defaults to last 30d.
 
 func (c *Client) GetAllScanResults() ([]*ScanResult, error) {
@@ -69,32 +66,43 @@ func (c *Client) GetAllScanResults() ([]*ScanResult, error) {
 
 func (c *Client) GetAllScanResultsByTime(start, end time.Time) ([]*ScanResult, error) {
 
-	v := url.Values{}
-
+	params := url.Values{}
 	if !start.IsZero() {
-		v.Add("startTime", fmt.Sprintf("%d", start.Unix()))
+		params.Add("startTime", fmt.Sprintf("%d", start.Unix()))
 	}
 	if !end.IsZero() {
-		v.Add("endTime", fmt.Sprintf("%d", start.Unix()))
+		params.Add("endTime", fmt.Sprintf("%d", end.Unix()))
 	}
 
-	resourceURL := strings.Builder{}
-	resourceURL.WriteString(scanResultEndpoint)
-	if len(v) > 0 {
-		resourceURL.WriteString(fmt.Sprintf("?%s", v.Encode()))
+	resourceURL := url.URL{
+		Path:     scanResultEndpoint,
+		RawQuery: params.Encode(),
 	}
 
 	var resp scanResultInternal
-
 	if _, err := c.getResource(resourceURL.String(), &resp); err != nil {
 		return nil, fmt.Errorf("failed to get scan results: %w", err)
 	}
 
-	return resp.Manageable, nil
+	var spOut []*ScanResult
+	spMap := make(map[ProbablyString]bool)
+
+	for _, o := range resp.Usable {
+		spOut = append(spOut, o)
+		spMap[o.ID] = true
+	}
+	for _, o := range resp.Manageable {
+		if _, exists := spMap[o.ID]; !exists {
+			spOut = append(spOut, o)
+			spMap[o.ID] = true
+		}
+	}
+
+	return spOut, nil
 }
 
 func (c *Client) GetScanResult(id string) (*ScanResult, error) {
-	resp := ScanResult{}
+	var resp ScanResult
 	if _, err := c.getResource(fmt.Sprintf("%s/%s", scanResultEndpoint, id), &resp); err != nil {
 		return nil, fmt.Errorf("failed to get scan result %s: %w", id, err)
 	}
@@ -177,7 +185,7 @@ func firstFileFromPKZipSlice(slice []byte) ([]byte, error) {
 
 	reader, err := zip.NewReader(bytes.NewReader(slice), int64(len(slice)))
 	if err != nil {
-		return nil, fmt.Errorf("nessus scan result zip could not be parsed: %w", err)
+		return nil, fmt.Errorf("failed to create zip reader: %w", err)
 	}
 
 	if len(reader.File) == 0 {
@@ -189,7 +197,7 @@ func firstFileFromPKZipSlice(slice []byte) ([]byte, error) {
 		return nil, fmt.Errorf("could not open first file in zip: %w", err)
 	}
 
-	results, err = ioutil.ReadAll(file)
+	results, err = io.ReadAll(file)
 	if err != nil {
 		return nil, fmt.Errorf("failed to read zip file: %w", err)
 	}