rename of some flags (done to accommodate the proposed changes in platform.txt)

Author: umbynos

cli/compile/compile.go

@@ -53,9 +53,9 @@ var (
 	buildCachePath          string               // Builds of 'core.a' are saved into this path to be cached and reused.
 	buildPath               string               // Path where to save compiled files.
 	buildProperties         []string             // List of custom build properties separated by commas. Or can be used multiple times for multiple properties.
-	keysPath                string               // The path of the dir where to search for the custom keys to sign and encrypt a binary. Used only by the platforms that supports it
-	signKeyName             string               // The name of the custom signing key to use to sign a binary during the compile process. Used only by the platforms that supports it
-	encryptKeyName          string               // The name of the custom encryption key to use to encrypt a binary during the compile process. Used only by the platforms that supports it
+	keysKeychain            string               // The path of the dir where to search for the custom keys to sign and encrypt a binary. Used only by the platforms that supports it
+	signKey                 string               // The name of the custom signing key to use to sign a binary during the compile process. Used only by the platforms that supports it
+	encryptKey              string               // The name of the custom encryption key to use to encrypt a binary during the compile process. Used only by the platforms that supports it
 	warnings                string               // Used to tell gcc which warning level to use.
 	verbose                 bool                 // Turns on verbose mode.
 	quiet                   bool                 // Suppresses almost every output.
@@ -88,7 +88,7 @@ func NewCommand() *cobra.Command {
 			"  " + os.Args[0] + ` compile -b arduino:avr:uno --build-property "build.extra_flags=\"-DMY_DEFINE=\"hello world\"\"" /home/user/Arduino/MySketch` + "\n" +
 			"  " + os.Args[0] + ` compile -b arduino:avr:uno --build-property "build.extra_flags=-DPIN=2 \"-DMY_DEFINE=\"hello world\"\"" /home/user/Arduino/MySketch` + "\n" +
 			"  " + os.Args[0] + ` compile -b arduino:avr:uno --build-property build.extra_flags=-DPIN=2 --build-property "compiler.cpp.extra_flags=\"-DSSID=\"hello world\"\"" /home/user/Arduino/MySketch` + "\n" +
-			"  " + os.Args[0] + ` compile -b arduino:mbed_portenta:envie_m7:security=sien --keys-input-path /home/user/Arduino/keys --sign-key-name ecsdsa-p256-signing-key.pem --encrypt-key-name ecsdsa-p256-encrypt-key.pem /home/user/Arduino/MySketch` + "\n",
+			"  " + os.Args[0] + ` compile -b arduino:mbed_portenta:envie_m7:security=sien --keys-keychain /home/user/Arduino/keys --sign-key ecsdsa-p256-signing-key.pem --encrypt-key ecsdsa-p256-encrypt-key.pem /home/user/Arduino/MySketch` + "\n",
 		Args: cobra.MaximumNArgs(1),
 		Run:  runCompileCommand,
 	}
@@ -104,11 +104,11 @@ func NewCommand() *cobra.Command {
 		tr("List of custom build properties separated by commas. Or can be used multiple times for multiple properties."))
 	compileCommand.Flags().StringArrayVar(&buildProperties, "build-property", []string{},
 		tr("Override a build property with a custom value. Can be used multiple times for multiple properties."))
-	compileCommand.Flags().StringVar(&keysPath, "keys-input-path", "",
+	compileCommand.Flags().StringVar(&keysKeychain, "keys-keychain", "",
 		tr("The path of the dir to search for the custom keys to sign and encrypt a binary. Used only by the platforms that support it"))
-	compileCommand.Flags().StringVar(&signKeyName, "sign-key-name", "",
+	compileCommand.Flags().StringVar(&signKey, "sign-key", "",
 		tr("The name of the custom signing key to use to sign a binary during the compile process. Used only by the platforms that support it"))
-	compileCommand.Flags().StringVar(&encryptKeyName, "encrypt-key-name", "",
+	compileCommand.Flags().StringVar(&encryptKey, "encrypt-key", "",
 		tr("The name of the custom encryption key to use to encrypt a binary during the compile process. Used only by the platforms that support it"))
 	compileCommand.Flags().StringVar(&warnings, "warnings", "none",
 		tr(`Optional, can be: %s. Used to tell gcc which warning level to use (-W flag).`, "none, default, more, all"))
@@ -152,8 +152,8 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 
 	sketchPath := arguments.InitSketchPath(path)
 
-	if keysPath != "" || signKeyName != "" || encryptKeyName != "" {
-		arguments.CheckFlagsMandatory(cmd, "keys-input-path", "sign-key-name", "encrypt-key-name")
+	if keysKeychain != "" || signKey != "" || encryptKey != "" {
+		arguments.CheckFlagsMandatory(cmd, "keys-keychain", "sign-key", "encrypt-key")
 	}
 
 	var overrides map[string]string
@@ -212,9 +212,9 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 		CreateCompilationDatabaseOnly: compilationDatabaseOnly,
 		SourceOverride:                overrides,
 		Library:                       library,
-		KeysPath:                      keysPath,
-		SignKeyName:                   signKeyName,
-		EncryptKeyName:                encryptKeyName,
+		KeysKeychain:                  keysKeychain,
+		SignKey:                       signKey,
+		EncryptKey:                    encryptKey,
 	}
 	compileStdOut := new(bytes.Buffer)
 	compileStdErr := new(bytes.Buffer)

commands/compile/compile.go

@@ -129,21 +129,21 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	// so, if the flags to override the default keys are used, we try override the corresponding platform property nonetheless.
 	// It's not possible to use the default name for the keys since there could be more tools to sign and encrypt.
 	// So it's mandatory to use all the tree flags to sign and encrypt the binary
-	if req.KeysPath != "" && req.SignKeyName != "" && req.EncryptKeyName != "" {
-		keysDirPath := paths.New(req.KeysPath)
+	if req.KeysKeychain != "" && req.SignKey != "" && req.EncryptKey != "" {
+		keysDirPath := paths.New(req.KeysKeychain)
 		if !keysDirPath.IsDir() {
 			return nil, &arduino.NotFoundError{Message: tr("The path specified is not a directory: %s", keysDirPath), Cause: err}
 		}
-		signKeyPath := keysDirPath.Join(req.GetSignKeyName())
+		signKeyPath := keysDirPath.Join(req.GetSignKey())
 		if !signKeyPath.Exist() {
 			return nil, &arduino.NotFoundError{Message: tr("The path of the specified signing key does not exist: %s", signKeyPath), Cause: err}
 		}
-		encryptKeyPath := keysDirPath.Join(req.GetEncryptKeyName())
+		encryptKeyPath := keysDirPath.Join(req.GetEncryptKey())
 		if !encryptKeyPath.Exist() {
 			return nil, &arduino.NotFoundError{Message: tr("The path of the specified encryption key does not exist: %s", encryptKeyPath), Cause: err}
 		}
 		InstalledPlatformRelease := pm.GetInstalledPlatformRelease(targetPlatform)
-		ReplaceSecurityKeys(InstalledPlatformRelease.Properties, req.KeysPath, req.SignKeyName, req.EncryptKeyName)
+		ReplaceSecurityKeys(InstalledPlatformRelease.Properties, req.KeysKeychain, req.SignKey, req.EncryptKey)
 	}
 
 	builderCtx := &types.Context{}
@@ -320,25 +320,25 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 
 // ReplaceSecurityKeys function will override the properties representing the security keys specified in the platform.txt file of a platform with the ones provided by the user.
 // The keys are stored in the keyPath
-// signKeyName is the key used to sign a binary
-// encryptKeyName is the key used to encrypt it
-func ReplaceSecurityKeys(properties *properties.Map, keysPath, signKeyName, encryptKeyName string) {
+// signKey is the key used to sign a binary
+// encryptKey is the key used to encrypt it
+func ReplaceSecurityKeys(properties *properties.Map, keysKKeysKeychain, signKey, encryptKey string) {
 	toolsProps := properties.SubTree("tools").FirstLevelOf()
 	for toolName, toolProps := range toolsProps {
 		if toolProps.ContainsKey("keys.path") {
 			key := "tools." + toolName + ".keys.path"
-			properties.Set(key, keysPath)
-			logrus.Tracef("Overriding Property: %s: %s", key, keysPath)
+			properties.Set(key, keysKKeysKeychain)
+			logrus.Tracef("Overriding Property: %s: %s", key, keysKKeysKeychain)
 		}
 		if toolProps.ContainsKey("sign.name") {
 			key := "tools." + toolName + ".sign.name"
-			properties.Set(key, signKeyName)
-			logrus.Tracef("Overriding Property: %s: %s", key, signKeyName)
+			properties.Set(key, signKey)
+			logrus.Tracef("Overriding Property: %s: %s", key, signKey)
 		}
 		if toolProps.ContainsKey("encrypt.name") {
 			key := "tools." + toolName + ".encrypt.name"
-			properties.Set(key, encryptKeyName)
-			logrus.Tracef("Overriding Property: %s: %s", key, encryptKeyName)
+			properties.Set(key, encryptKey)
+			logrus.Tracef("Overriding Property: %s: %s", key, encryptKey)
 		}
 	}
 }