Enables support for supermicro x11ssl-f and x11scz-f (#411)

Author: mergify[bot]

go.mod

@@ -5,7 +5,7 @@ go 1.21
 require (
 	dario.cat/mergo v1.0.1
 	github.com/Jeffail/gabs/v2 v2.7.0
-	github.com/bmc-toolbox/common v0.0.0-20241031162543-6b96e5981a0d
+	github.com/bmc-toolbox/common v0.0.0-20250112191656-b6de52e8303d
 	github.com/bombsimon/logrusr/v2 v2.0.1
 	github.com/ghodss/yaml v1.0.0
 	github.com/go-logr/logr v1.4.2

go.sum

@@ -8,6 +8,8 @@ github.com/VictorLowther/soap v0.0.0-20150314151524-8e36fca84b22 h1:a0MBqYm44o0N
 github.com/VictorLowther/soap v0.0.0-20150314151524-8e36fca84b22/go.mod h1:/B7V22rcz4860iDqstGvia/2+IYWXf3/JdQCVd/1D2A=
 github.com/bmc-toolbox/common v0.0.0-20241031162543-6b96e5981a0d h1:dMmFDAAEpXizInaNwPSa5LM6tX/xDIPKjL6v9jYfMxo=
 github.com/bmc-toolbox/common v0.0.0-20241031162543-6b96e5981a0d/go.mod h1:Cdnkm+edb6C0pVkyCrwh3JTXAe0iUF9diDG/DztPI9I=
+github.com/bmc-toolbox/common v0.0.0-20250112191656-b6de52e8303d h1:5c0jhS9jNLm1t3GVEESsWv+p6recFRLGW90zp8HDIDs=
+github.com/bmc-toolbox/common v0.0.0-20250112191656-b6de52e8303d/go.mod h1:Cdnkm+edb6C0pVkyCrwh3JTXAe0iUF9diDG/DztPI9I=
 github.com/bombsimon/logrusr/v2 v2.0.1 h1:1VgxVNQMCvjirZIYaT9JYn6sAVGVEcNtRE0y4mvaOAM=
 github.com/bombsimon/logrusr/v2 v2.0.1/go.mod h1:ByVAX+vHdLGAfdroiMg6q0zgq2FODY2lc5YJvzmOJio=
 github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=

providers/supermicro/errors.go

@@ -8,10 +8,13 @@ import (
 )
 
 var (
-	ErrQueryFRUInfo      = errors.New("FRU information query returned error")
-	ErrXMLAPIUnsupported = errors.New("XML API is unsupported")
-	ErrModelUnknown      = errors.New("Model number unknown")
-	ErrModelUnsupported  = errors.New("Model not supported")
+	ErrQueryFRUInfo         = errors.New("FRU information query returned error")
+	ErrXMLAPIUnsupported    = errors.New("XML API is unsupported")
+	ErrModelUnknown         = errors.New("Model number unknown")
+	ErrModelUnsupported     = errors.New("Model not supported")
+	ErrBoardIDUnknown       = errors.New("BoardID could not be identified")
+	ErrUnexpectedResponse   = errors.New("Unexpected response content")
+	ErrUnexpectedStatusCode = errors.New("Unexpected status code")
 )
 
 type UnexpectedResponseError struct {

providers/supermicro/supermicro.go

@@ -150,34 +150,60 @@ func NewClient(host, user, pass string, log logr.Logger, opts ...Option) *Client
 	}
 }
 
-// Open a connection to a Supermicro BMC using the vendor API.
-func (c *Client) Open(ctx context.Context) (err error) {
+func (c *Client) login(ctx context.Context, encodeCreds bool) error {
+	var user, pass string
+	if encodeCreds {
+		user = base64.StdEncoding.EncodeToString([]byte(c.serviceClient.user))
+		pass = base64.StdEncoding.EncodeToString([]byte(c.serviceClient.pass))
+	} else {
+		user = c.serviceClient.user
+		pass = c.serviceClient.pass
+	}
+
 	data := fmt.Sprintf(
 		"name=%s&pwd=%s&check=00",
-		base64.StdEncoding.EncodeToString([]byte(c.serviceClient.user)),
-		base64.StdEncoding.EncodeToString([]byte(c.serviceClient.pass)),
+		user,
+		pass,
 	)
 
 	headers := map[string]string{"Content-Type": "application/x-www-form-urlencoded"}
 
 	body, status, err := c.serviceClient.query(ctx, "cgi/login.cgi", http.MethodPost, bytes.NewBufferString(data), headers, 0)
 	if err != nil {
-		return errors.Wrap(bmclibErrs.ErrLoginFailed, err.Error())
+		return err
 	}
 
 	if status != 200 {
-		return errors.Wrap(bmclibErrs.ErrLoginFailed, strconv.Itoa(status))
+		return errors.Wrap(ErrUnexpectedStatusCode, strconv.Itoa(status))
+	}
+
+	// Older Supermicro boards return 200 for failed logins
+	if !bytes.Contains(body, []byte(`url_redirect.cgi?url_name=mainmenu`)) &&
+		!bytes.Contains(body, []byte(`url_redirect.cgi?url_name=topmenu`)) {
+		return ErrUnexpectedResponse
 	}
 
+	return nil
+}
+
+// Open a connection to a Supermicro BMC using the vendor API.
+func (c *Client) Open(ctx context.Context) (err error) {
 	// called after a session was opened but further login dependencies failed
 	closeWithError := func(ctx context.Context, err error) error {
 		_ = c.Close(ctx)
 		return err
 	}
 
-	if !bytes.Contains(body, []byte(`url_redirect.cgi?url_name=mainmenu`)) &&
-		!bytes.Contains(body, []byte(`url_redirect.cgi?url_name=topmenu`)) {
-		return closeWithError(ctx, errors.Wrap(bmclibErrs.ErrLoginFailed, "unexpected response contents"))
+	// first attempt login with base64 encoded user,pass
+	if err := c.login(ctx, true); err != nil {
+		if !errors.Is(err, ErrUnexpectedResponse) && !errors.Is(err, ErrUnexpectedStatusCode) {
+			return closeWithError(ctx, errors.Wrap(bmclibErrs.ErrLoginFailed, err.Error()))
+		}
+
+		// retry with plain text user, pass
+		if err2 := c.login(ctx, false); err2 != nil {
+			return closeWithError(ctx, errors.Wrap(bmclibErrs.ErrLoginFailed, err2.Error()))
+		}
 	}
 
 	contentsTopMenu, status, err := c.serviceClient.query(ctx, "cgi/url_redirect.cgi?url_name=topmenu", http.MethodGet, nil, nil, 0)

providers/supermicro/supermicro_test.go

@@ -187,21 +187,13 @@ func TestOpen(t *testing.T) {
 		},
 		{
 			"login error",
-			"401: failed to login",
+			"failed to login",
 			"foo",
 			"bar",
 			handlerFuncMap{
 				"/cgi/login.cgi": func(w http.ResponseWriter, r *http.Request) {
 					assert.Equal(t, r.Method, http.MethodPost)
 					assert.Equal(t, r.Header.Get("Content-Type"), "application/x-www-form-urlencoded")
-
-					b, err := io.ReadAll(r.Body)
-					if err != nil {
-						t.Fatal(err)
-					}
-
-					assert.Equal(t, `name=Zm9v&pwd=YmFy&check=00`, string(b))
-
 					response := []byte(`barf`)
 					w.WriteHeader(401)
 					_, _ = w.Write(response)

providers/supermicro/x11.go

@@ -15,6 +15,7 @@ import (
 	"github.com/bmc-toolbox/common"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
+	"github.com/stmcginnis/gofish/oem/smc"
 	"github.com/stmcginnis/gofish/redfish"
 )
 
@@ -36,6 +37,23 @@ func (c *x11) deviceModel() string {
 }
 
 func (c *x11) queryDeviceModel(ctx context.Context) (string, error) {
+	model, err := c.deviceModelFromFruInfo(ctx)
+	if err != nil {
+		// Identify BoardID from Redfish since fru info failed to return the information
+		model, err2 := c.deviceModelFromBoardID(ctx)
+		if err2 != nil {
+			return "", errors.Wrap(err, err2.Error())
+		}
+
+		c.model = model
+		return model, nil
+	}
+
+	c.model = model
+	return model, nil
+}
+
+func (c *x11) deviceModelFromFruInfo(ctx context.Context) (string, error) {
 	errBoardPartNumUnknown := errors.New("baseboard part number unknown")
 	data, err := c.fruInfo(ctx)
 	if err != nil {
@@ -47,14 +65,46 @@ func (c *x11) queryDeviceModel(ctx context.Context) (string, error) {
 	}
 
 	partNum := strings.TrimSpace(data.Board.PartNum)
-
 	if data.Board == nil || partNum == "" {
 		return "", errors.Wrap(errBoardPartNumUnknown, "baseboard part number empty")
 	}
 
-	c.model = common.FormatProductName(partNum)
+	return common.FormatProductName(partNum), nil
+}
+
+func (c *x11) deviceModelFromBoardID(ctx context.Context) (string, error) {
+	if err := c.redfishSession(ctx); err != nil {
+		return "", err
+	}
+
+	chassis, err := c.redfish.Chassis(ctx)
+	if err != nil {
+		return "", err
+	}
+
+	var boardID string
+	for _, ch := range chassis {
+		smcChassis, err := smc.FromChassis(ch)
+		if err != nil {
+			return "", errors.Wrap(ErrBoardIDUnknown, err.Error())
+		}
+
+		if smcChassis.BoardID != "" {
+			boardID = smcChassis.BoardID
+			break
+		}
+	}
+
+	if boardID == "" {
+		return "", ErrBoardIDUnknown
+	}
+
+	model := common.SupermicroModelFromBoardID(boardID)
+	if model == "" {
+		return "", errors.Wrap(ErrModelUnknown, "unable to identify model from board ID: "+boardID)
+	}
 
-	return c.model, nil
+	return model, nil
 }
 
 func (c *x11) fruInfo(ctx context.Context) (*FruInfo, error) {