Merge be591a2 into 6cc2538

Author: spbsoluble

CHANGELOG.md

@@ -1,3 +1,19 @@
+# v1.7.0
+
+## Features
+
+### CLI
+
+- `stores import csv`: supports interactive credential input, as well as input via flags and environmental
+  variables. [docs](docs/kfutil_stores_import_csv.md)
+
+## Fixes
+
+### CLI
+
+- `stores import csv`: providing a `Password(/StorePassword)` does not crash CLI.
+- `stores import csv`: results CSV retains input header ordering.
+
 # v1.6.2
 
 ## Fixes

cmd/constants.go

@@ -34,6 +34,10 @@ const (
 	DebugFuncExit             = "exiting: %s"
 	DebugFuncCall             = "calling: %s"
 	MinHttpTimeout            = 3
+
+	EnvStoresImportCSVServerUsername = "KFUTIL_CSV_SERVER_USERNAME"
+	EnvStoresImportCSVServerPassword = "KFUTIL_CSV_SERVER_PASSWORD"
+	EnvStoresImportCSVStorePassword  = "KFUTIL_CSV_STORE_PASSWORD"
 )
 
 var ProviderTypeChoices = []string{

cmd/storesBulkOperations.go

@@ -99,7 +99,7 @@ func serializeStoreFromTypeDef(storeTypeName string, input string) (string, erro
 
 var importStoresCmd = &cobra.Command{
 	Use:   "import",
-	Short: "Import a file with certificate store parameters and create them in keyfactor.",
+	Short: "Import a file with certificate store definitions and create them in Keyfactor Command.",
 	Long:  `Tools for generating import templates and importing certificate stores`,
 }
 
@@ -109,14 +109,32 @@ var storesCreateFromCSVCmd = &cobra.Command{
 	Long: `Certificate stores: Will parse a CSV and attempt to create a certificate store for each row with the provided parameters.
 'store-type-name' OR 'store-type-id' are required.
 'file' is the path to the file to be imported.
-'resultspath' is where the import results will be written to.`,
+'resultspath' is where the import results will be written to.
+*NOTE*: If you do not wish to include credentials in your CSV file they can be provided one of three ways:
+- via the --server-username --server-password and --store-password flags
+- via environment variables: KFUTIL_CSV_SERVER_USERNAME, KFUTIL_CSV_SERVER_PASSWORD, KFUTIL_CSV_STORE_PASSWORD
+- via interactive prompts
+`,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		// Specific flags
 		storeTypeName, _ := cmd.Flags().GetString("store-type-name")
 		storeTypeID, _ := cmd.Flags().GetInt("store-type-id")
 		filePath, _ := cmd.Flags().GetString("file")
 		outPath, _ := cmd.Flags().GetString("results-path")
 		dryRun, _ := cmd.Flags().GetBool("dry-run")
+		serverUsername, _ := cmd.Flags().GetString("server-username")
+		serverPassword, _ := cmd.Flags().GetString("server-password")
+		storePassword, _ := cmd.Flags().GetString("store-password")
+
+		if serverUsername == "" {
+			serverUsername = os.Getenv(EnvStoresImportCSVServerUsername)
+		}
+		if serverPassword == "" {
+			serverPassword = os.Getenv(EnvStoresImportCSVServerPassword)
+		}
+		if storePassword == "" {
+			storePassword = os.Getenv(EnvStoresImportCSVStorePassword)
+		}
 
 		//// Flag Checks
 		//inputErr := storeTypeIdentifierFlagCheck(cmd)
@@ -259,6 +277,19 @@ var storesCreateFromCSVCmd = &cobra.Command{
 
 		errorCount := 0
 
+		if !noPrompt {
+			promptCreds := promptForInteractiveYesNo("Input default credentials to use for certificate stores?")
+			if promptCreds {
+				outputResult("NOTE: Credentials provided in file will take precedence over prompts.", outputFormat)
+				serverUsername = promptForInteractiveParameter("ServerUsername", serverUsername)
+				log.Debug().Str("serverUsername", serverUsername).Msg("ServerUsername")
+				serverPassword = promptForInteractivePassword("ServerPassword", serverPassword)
+				log.Debug().Str("serverPassword", hashSecretValue(serverPassword)).Msg("ServerPassword")
+				storePassword = promptForInteractivePassword("StorePassword", storePassword)
+				log.Debug().Str("storePassword", hashSecretValue(storePassword)).Msg("StorePassword")
+			}
+		}
+
 		log.Info().Msgf("Processing CSV rows from file '%s'", filePath)
 		for idx, row := range inFile {
 			log.Debug().Msgf("Processing row '%d'", idx)
@@ -270,7 +301,6 @@ var storesCreateFromCSVCmd = &cobra.Command{
 				continue
 			}
 			reqJson := getJsonForRequest(headerRow, row)
-
 			reqJson = formatProperties(reqJson, reqPropertiesForStoreType)
 
 			reqJson.Set(intID, "CertStoreType")
@@ -286,7 +316,31 @@ var storesCreateFromCSVCmd = &cobra.Command{
 			// parse properties
 			var createStoreReqParameters api.CreateStoreFctArgs
 			props := unmarshalPropertiesString(reqJson.S("Properties").String())
+
+			//check if ServerUsername is present in the properties
+			_, uOk := props["ServerUsername"]
+			if !uOk && serverUsername != "" {
+				props["ServerUsername"] = serverUsername
+			}
+
+			_, pOk := props["ServerPassword"]
+			if !pOk && serverPassword != "" {
+				props["ServerPassword"] = serverPassword
+			}
+
+			rowStorePassword := reqJson.S("Password").String()
 			reqJson.Delete("Properties") // todo: why is this deleting the properties from the request json?
+			var passwdParams *api.StorePasswordConfig
+			if rowStorePassword != "" {
+				reqJson.Delete("Password")
+				passwdParams = &api.StorePasswordConfig{
+					Value: &rowStorePassword,
+				}
+			} else {
+				passwdParams = &api.StorePasswordConfig{
+					Value: &storePassword,
+				}
+			}
 			mJSON := reqJson.String()
 			conversionError := json.Unmarshal([]byte(mJSON), &createStoreReqParameters)
 
@@ -299,10 +353,10 @@ var storesCreateFromCSVCmd = &cobra.Command{
 				return conversionError
 			}
 
+			createStoreReqParameters.Password = passwdParams
 			createStoreReqParameters.Properties = props
 			log.Debug().Msgf("Request parameters: %v", createStoreReqParameters)
 
-			// make request.
 			log.Info().Msgf("Calling Command to create store from row '%d'", idx)
 			res, err := kfClient.CreateStore(&createStoreReqParameters)
 
@@ -335,6 +389,7 @@ var storesCreateFromCSVCmd = &cobra.Command{
 			Int("totalSuccess", totalSuccess).Send()
 
 		log.Info().Msgf("Writing results to file '%s'", outPath)
+
 		//writeCsvFile(outPath, originalMap)
 		mapToCSV(inputMap, outPath)
 		log.Info().Int("totalRows", totalRows).
@@ -1111,6 +1166,39 @@ func init() {
 		-1,
 		"The ID of the cert store type for the stores.",
 	)
+	storesCreateFromCSVCmd.Flags().StringVarP(
+		&storeTypeName,
+		"server-username",
+		"u",
+		"",
+		"The username Keyfactor Command will use to use connect to the certificate store host. "+
+			"This field can be specified in the CSV file in the column `Properties.ServerUsername`. "+
+			"This value can also be sourced from the environmental variable `KFUTIL_CSV_SERVER_USERNAME`. "+
+			"*NOTE* a value provided in the CSV file will override any other input value",
+	)
+	storesCreateFromCSVCmd.Flags().StringVarP(
+		&storeTypeName,
+		"server-password",
+		"p",
+		"",
+		"The password Keyfactor Command will use to use connect to the certificate store host. "+
+			"This field can be specified in the CSV file in the column `Properties.ServerPassword`. "+
+			"This value can also be sourced from the environmental variable `KFUTIL_CSV_SERVER_PASSWORD`. "+
+			"*NOTE* a value provided in the CSV file will override any other input value",
+	)
+	storesCreateFromCSVCmd.Flags().StringVarP(
+		&storeTypeName,
+		"store-password",
+		"s",
+		"",
+		"The credential information Keyfactor Command will use to access the certificates in a specific certificate"+
+			" store (the store password). This is different from credential information Keyfactor Command uses to"+
+			" access a certificate store host."+
+			" This field can be specified in the CSV file in the column `Password`. This value can also be sourced from"+
+			" the environmental variable `KFUTIL_CSV_STORE_PASSWORD`. *NOTE* a value provided in the CSV file will"+
+			" override any other input value",
+	)
+
 	storesCreateFromCSVCmd.Flags().StringVarP(&file, "file", "f", "", "CSV file containing cert stores to create.")
 	storesCreateFromCSVCmd.MarkFlagRequired("file")
 	storesCreateFromCSVCmd.Flags().BoolP("dry-run", "d", false, "Do not import, just check for necessary fields.")

docs/kfutil.md

@@ -46,4 +46,4 @@ A CLI wrapper around the Keyfactor Platform API.
 * [kfutil stores](kfutil_stores.md)	 - Keyfactor certificate stores APIs and utilities.
 * [kfutil version](kfutil_version.md)	 - Shows version of kfutil
 
-###### Auto generated by spf13/cobra on 12-Dec-2024
+###### Auto generated on 27-Apr-2025

docs/kfutil_completion.md

@@ -45,4 +45,4 @@ See each sub-command's help for details on how to use the generated script.
 * [kfutil completion powershell](kfutil_completion_powershell.md)	 - Generate the autocompletion script for powershell
 * [kfutil completion zsh](kfutil_completion_zsh.md)	 - Generate the autocompletion script for zsh
 
-###### Auto generated by spf13/cobra on 12-Dec-2024
+###### Auto generated on 27-Apr-2025

docs/kfutil_completion_bash.md

@@ -64,4 +64,4 @@ kfutil completion bash
 
 * [kfutil completion](kfutil_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 12-Dec-2024
+###### Auto generated on 27-Apr-2025

docs/kfutil_completion_fish.md

@@ -55,4 +55,4 @@ kfutil completion fish [flags]
 
 * [kfutil completion](kfutil_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 12-Dec-2024
+###### Auto generated on 27-Apr-2025

docs/kfutil_completion_powershell.md

@@ -52,4 +52,4 @@ kfutil completion powershell [flags]
 
 * [kfutil completion](kfutil_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 12-Dec-2024
+###### Auto generated on 27-Apr-2025

docs/kfutil_completion_zsh.md

@@ -66,4 +66,4 @@ kfutil completion zsh [flags]
 
 * [kfutil completion](kfutil_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 12-Dec-2024
+###### Auto generated on 27-Apr-2025

docs/kfutil_containers.md

@@ -41,4 +41,4 @@ A collections of APIs and utilities for interacting with Keyfactor certificate s
 * [kfutil containers get](kfutil_containers_get.md)	 - Get certificate store container by ID or name.
 * [kfutil containers list](kfutil_containers_list.md)	 - List certificate store containers.
 
-###### Auto generated by spf13/cobra on 12-Dec-2024
+###### Auto generated on 27-Apr-2025