feat: added 'list device' command

cmd/list.go

@@ -1,19 +1,23 @@
 package cmd
 
 import (
-	"encoding/json"
 	"fmt"
-	"strings"
+	"os"
-	"time"
 
 	"github.com/davidallendj/magellan/internal/cache/sqlite"
+	urlx "github.com/davidallendj/magellan/internal/urlx"
+	magellan "github.com/davidallendj/magellan/pkg"
+	"github.com/davidallendj/magellan/pkg/crawler"
+	"github.com/davidallendj/magellan/pkg/secrets"
 	"github.com/rs/zerolog/log"
 
 	"github.com/spf13/cobra"
 )
 
 var (
-	showCache bool
+	showCacheInfo bool
+	listUsername  string
+	listPassword  string
 )
 
 // The `list` command provides an easy way to show what was found
@@ -31,33 +35,70 @@ var ListCmd = &cobra.Command{
 		"See the 'scan' command on how to perform a scan.",
 	Run: func(cmd *cobra.Command, args []string) {
 		// check if we just want to show cache-related info and exit
-		if showCache {
+		if showCacheInfo {
-			fmt.Printf("cache: %s\n", cachePath)
+			magellan.PrintMapFormat(map[string]any{
-			return
+				"path": cachePath,
+			}, format)
+			os.Exit(0)
 		}
 
 		// load the assets found from scan
 		scannedResults, err := sqlite.GetScannedAssets(cachePath)
 		if err != nil {
-			log.Error().Err(err).Msg("failed to get scanned assets")
+			log.Error().Err(err).Str("path", cachePath).Msg("failed to get scanned assets from cache")
 		}
-		format = strings.ToLower(format)
+
-		if format == "json" {
+		// print cache data in specified format
-			b, err := json.Marshal(scannedResults)
+		magellan.PrintRemoteAssets(scannedResults, format)
-			if err != nil {
+	},
-				log.Error().Err(err).Msgf("failed to unmarshal scanned results")
+}
-			}
+
-			fmt.Printf("%s\n", string(b))
+var listDrivesCmd = &cobra.Command{
-		} else {
+	Use: "drives [bmc_host]",
-			for _, r := range scannedResults {
+	Example: `  # list all storage drives with username/password override and skip TLS verification
-				fmt.Printf("%s:%d (%s) @%s\n", r.Host, r.Port, r.Protocol, r.Timestamp.Format(time.UnixDate))
+  magellan list drives https://$bmc_host -u $bmc_username -p $bmc_password -i
-			}
+
+  # list all storage drives with secrets store defaults
+  export MASTER_KEY=$(magellan secrets generatekey)
+  magellan secrets store default $bmc_username:$bmc_password --secrets-file secrets/store.json
+  magellan list drives https://$bmc_host --secrets-file secrets/store.json`,
+	Args: func(cmd *cobra.Command, args []string) error {
+		// Validate that the only argument is a valid URI
+		var err error
+		if err := cobra.ExactArgs(1)(cmd, args); err != nil {
+			return err
 		}
+		args[0], err = urlx.Sanitize(args[0])
+		if err != nil {
+			return fmt.Errorf("failed to sanitize URI: %w", err)
+		}
+		return nil
+	},
+	Run: func(cmd *cobra.Command, args []string) {
+		store := secrets.NewStaticStore(listUsername, listPassword)
+		drives, err := magellan.ListDrives(&crawler.CrawlerConfig{
+			URI:             args[0],
+			CredentialStore: store, //initSecretsStore(args[0]),
+			Insecure:        insecure,
+			UseDefault:      false,
+		})
+		if err != nil {
+			log.Error().Err(err).Msg("failed to get drives")
+			os.Exit(1)
+		}
+		magellan.PrintDrives(drives)
 	},
 }
 
 func init() {
-	ListCmd.Flags().StringVar(&format, "format", "", "Set the output format (json|default)")
+	ListCmd.Flags().StringVar(&format, "format", "none", "Set the output format (none|json|yaml)")
-	ListCmd.Flags().BoolVar(&showCache, "cache-info", false, "Show cache information and exit")
+	ListCmd.Flags().BoolVar(&showCacheInfo, "cache-info", false, "Alias for 'magellan cache info'")
+
+	listDrivesCmd.Flags().StringVarP(&listUsername, "username", "u", "", "Set the username for the BMC")
+	listDrivesCmd.Flags().StringVarP(&listPassword, "password", "p", "", "Set the password for the BMC")
+	listDrivesCmd.Flags().BoolVarP(&insecure, "insecure", "i", false, "Ignore SSL errors")
+	listDrivesCmd.Flags().StringVarP(&secretsFile, "secrets-file", "f", "secrets.json", "set the secrets file with BMC credentials")
+
+	ListCmd.AddCommand(listDrivesCmd)
 	rootCmd.AddCommand(ListCmd)
 }

pkg/list.go

@@ -0,0 +1,100 @@
+package magellan
+
+import (
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/davidallendj/magellan/internal/util"
+	"github.com/davidallendj/magellan/pkg/crawler"
+	"github.com/rs/zerolog/log"
+	"github.com/stmcginnis/gofish"
+	"github.com/stmcginnis/gofish/redfish"
+)
+
+func PrintRemoteAssets(data []RemoteAsset, format string) {
+	switch strings.ToLower(format) {
+	case "json":
+		util.PrintJSON(data)
+	case "yaml":
+		util.PrintYAML(data)
+	case "none":
+		for _, r := range data {
+			fmt.Printf("%s:%d (%s) @%s\n", r.Host, r.Port, r.Protocol, r.Timestamp.Format(time.UnixDate))
+		}
+	default:
+		log.Error().Msg("unrecognized format")
+	}
+}
+
+func PrintMapFormat(data map[string]any, format string) {
+	switch strings.ToLower(format) {
+	case "json":
+		util.PrintJSON(data)
+	case "yaml":
+		util.PrintYAML(data)
+	case "none":
+		for k, v := range data {
+			fmt.Printf("%s: %v\n", k, v)
+		}
+	default:
+		log.Error().Msg("unrecognized format")
+	}
+}
+
+func ListDrives(cc *crawler.CrawlerConfig) ([]*redfish.Drive, error) {
+	user, err := cc.GetUserPass()
+	if err != nil {
+		return nil, fmt.Errorf("failed to get username and password: %v", err)
+	}
+	log.Info().Str("username", user.Username).Str("password", user.Password).Str("host", cc.URI).Msg("credentials used")
+	// Create a new instance of gofish client, ignoring self-signed certs
+	c, err := gofish.Connect(gofish.ClientConfig{
+		Endpoint:  cc.URI,
+		Username:  user.Username,
+		Password:  user.Password,
+		Insecure:  cc.Insecure,
+		BasicAuth: true,
+	})
+	if err != nil {
+		return nil, fmt.Errorf("failed to connect to host: %v", util.TidyJSON(err.Error()))
+	}
+	defer c.Logout()
+
+	// Retrieve the service root
+	systems, err := c.Service.Systems()
+	if err != nil {
+		return nil, fmt.Errorf("failed to retrieve systems: %v", err)
+	}
+
+	// aggregate all of the drives together
+	foundDrives := []*redfish.Drive{}
+	for _, system := range systems {
+		storage, err := system.Storage()
+		if err != nil {
+			continue
+		}
+
+		for _, ss := range storage {
+			drives, err := ss.Drives()
+			if err != nil {
+				continue
+			}
+
+			foundDrives = append(foundDrives, drives...)
+		}
+	}
+	return foundDrives, nil
+}
+
+func PrintDrives(drives []*redfish.Drive) {
+	for i, drive := range drives {
+		fmt.Printf("Drive %d\n", i)
+		fmt.Printf("\tManufacturer: %s\n", drive.Manufacturer)
+		fmt.Printf("\tModel: %s\n", drive.Model)
+		fmt.Printf("\tSize: %d GiB\n", (drive.CapacityBytes / 1024 / 1024 / 1024))
+		fmt.Printf("\tSerial number: %s\n", drive.SerialNumber)
+		fmt.Printf("\tPart number: %s\n", drive.PartNumber)
+		fmt.Printf("\tLocation: %s %d\n", drive.PhysicalLocation.PartLocation.LocationType, drive.PhysicalLocation.PartLocation.LocationOrdinalValue)
+	}
+}