Added header verification before file upload

Author: rjtokenring

cli/cli.go

@@ -19,7 +19,7 @@ package cli
 
 import (
 	"fmt"
-	"io/ioutil"
+	"io"
 	"os"
 	"strings"
 
@@ -83,7 +83,7 @@ func parseFormatString(arg string) (feedback.OutputFormat, bool) {
 }
 
 func preRun(flags *cliFlags) error {
-	logrus.SetOutput(ioutil.Discard)
+	logrus.SetOutput(io.Discard)
 	// enable log only if verbose flag is passed
 	if flags.verbose {
 		logrus.SetLevel(logrus.InfoLevel)

cli/ota/encode.go

@@ -18,12 +18,12 @@
 package ota
 
 import (
+	"fmt"
 	"os"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cloud-cli/command/ota"
-	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -53,8 +53,6 @@ func initEncodeBinaryCommand() *cobra.Command {
 }
 
 func runEncodeCommand(flags *encodeBinaryFlags) error {
-	logrus.Infof("Encoding binary %s", flags.file)
-	
 	params := &ota.EncodeParams{
 		FQBN: flags.FQBN,
 		File: flags.file,
@@ -64,6 +62,7 @@ func runEncodeCommand(flags *encodeBinaryFlags) error {
 		return err
 	}
 
-	logrus.Info("Encode successfully performed. OTA file: ", *otafile)
+	feedback.Print(fmt.Sprintf("Encode successfully performed. File: %s", *otafile))
+
 	return nil
 }

command/ota/encode.go

@@ -20,6 +20,8 @@ package ota
 import (
 	"fmt"
 	"os"
+
+	"github.com/arduino/arduino-cloud-cli/internal/ota"
 )
 
 type EncodeParams struct {
@@ -29,8 +31,19 @@ type EncodeParams struct {
 
 // Encode command is used to encode a firmware OTA
 func Encode(params *EncodeParams) (*string, error) {
+	_, err := os.Stat(params.File)
+	if err != nil {
+		return nil, fmt.Errorf("file %s does not exists: %w", params.File, err)
+	}
+
+	// Verify if file has already an OTA header
+	header, _ := ota.DecodeOtaFirmwareHeader(params.File)
+	if header != nil {
+		return nil, fmt.Errorf("file %s contains a valid OTA header. Skip header encoding", params.File)
+	}
+
 	otaFile := fmt.Sprintf("%s.ota", params.File)
-	_, err := os.Stat(otaFile)
+	_, err = os.Stat(otaFile)
 	if err == nil {
 		// file already exists, we need to delete it
 		if err = os.Remove(otaFile); err != nil {

command/ota/massupload.go

@@ -24,8 +24,10 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cloud-cli/config"
 	"github.com/arduino/arduino-cloud-cli/internal/iot"
+	"github.com/arduino/arduino-cloud-cli/internal/ota"
 	iotclient "github.com/arduino/iot-client-go"
 )
 
@@ -64,6 +66,15 @@ func MassUpload(ctx context.Context, params *MassUploadParams, cred *config.Cred
 		return nil, fmt.Errorf("file %s does not exists: %w", params.File, err)
 	}
 
+	if !params.DoNotApplyHeader {
+		//Verify if file has already an OTA header
+		header, _ := ota.DecodeOtaFirmwareHeader(params.File)
+		if header != nil {
+			feedback.Print("File contains a valid OTA header. Skip header generation.")
+			params.DoNotApplyHeader = true
+		}
+	}
+
 	// Generate .ota file
 	var otaFile string
 	if params.DoNotApplyHeader {

command/ota/upload.go

@@ -23,8 +23,11 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/arduino/arduino-cli/cli/feedback"
+
 	"github.com/arduino/arduino-cloud-cli/config"
 	"github.com/arduino/arduino-cloud-cli/internal/iot"
+	"github.com/arduino/arduino-cloud-cli/internal/ota"
 )
 
 const (
@@ -61,6 +64,15 @@ func Upload(ctx context.Context, params *UploadParams, cred *config.Credentials)
 		return err
 	}
 
+	if !params.DoNotApplyHeader {
+		//Verify if file has already an OTA header
+		header, _ := ota.DecodeOtaFirmwareHeader(params.File)
+		if header != nil {
+			feedback.Print("File contains a valid OTA header. Skip header generation.")
+			params.DoNotApplyHeader = true
+		}
+	}
+
 	var otaFile string
 	if params.DoNotApplyHeader {
 		otaFile = params.File

go.mod

@@ -1,6 +1,6 @@
 module github.com/arduino/arduino-cloud-cli
 
-go 1.17
+go 1.19
 
 require (
 	github.com/antihax/optional v1.0.0

internal/ota/boadpids.go

@@ -44,8 +44,8 @@ var (
 		"0266": "arduino:mbed_giga:giga",
 	}
 
-	ArduinoVendorID  = "2341"
-	
+	ArduinoVendorID = "2341"
+
 	ArduinoFqbnToPID = map[string]string{
 		"arduino:samd:nano_33_iot":            "8057",
 		"arduino:samd:mkr1000":                "804E",

internal/ota/decoder.go

@@ -78,7 +78,6 @@ func extractXID(buff []byte) string {
 // DecodeOtaFirmwareHeader decodes the OTA firmware header from a binary file.
 // File is composed by an header and a payload (optionally lzss compressed).
 // Method is also checking CRC32 of the file, verifying that file is not corrupted.
-// See: https://arduino.atlassian.net/wiki/spaces/RFC/pages/1616871540/OTA+header+structure
 func DecodeOtaFirmwareHeader(binaryFilePath string) (*OtaFirmwareHeader, error) {
 	// Check if file exists
 	if _, err := os.Stat(binaryFilePath); err != nil {