new/pipeline (#6)

Reviewed-on: #6
Co-authored-by: jake <jake.young.dev@gmail.com>
Co-committed-by: jake <jake.young.dev@gmail.com>

.gitea/workflows/security.yaml

@@ -0,0 +1,25 @@
+name: "code scans"
+on: [push, pull_request] #runs on pushes to any branch
+
+jobs:
+  scans:
+    runs-on: smoke-test
+    steps:
+      - name: "clone code"
+        uses: actions/checkout@v4
+      
+      - name: "install go"
+        uses: https://code.jakeyoungdev.com/actions/install-go@v0.1.3
+        with:
+          commands: |
+              golang.org/x/vuln/cmd/govulncheck@latest
+
+      - name: "dependency and stdlib scan"
+        uses: https://code.jakeyoungdev.com/actions/report-vulns@master
+        with:
+          manager: go
+
+      - name: "static code analysis"
+        uses: securego/gosec@master
+        with:
+          args: ./...

README.md

@@ -97,7 +97,9 @@ mctl delete <name>
 All configuration data will be kept in the home directory and any sensitive data is encrypted for added security
 
 ## Security
-RCon is an inherently insecure protocol, passwords are sent in plaintext and, if possible, the port should not be exposed to the internet. It is best to keep these connections local or over a VPN
+RCon is an inherently insecure protocol, passwords are sent in plaintext and, if possible, the port should not be exposed to the internet. It is best to keep these connections local or over a VPN.
+
+mctl utilizes [govulncheck](https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck) and [gosec](https://github.com/securego/gosec) in workflows to ensure quality, secure code is being pushed. These workflow steps must pass before a PR will be accepted
 
 ## Development
 this repo is currently in heavy development and may encounter breaking changes, use a tag to prevent any surprises

cmd/config.go

@@ -48,7 +48,8 @@ var configCmd = &cobra.Command{
 		viper.Set("server", cfgserver)
 		viper.Set("password", string(ciphert))
 		viper.Set("port", cfgport)
-		viper.WriteConfig()
+		err = viper.WriteConfig()
+		cobra.CheckErr(err)
 		fmt.Println()
 		fmt.Println("Config file updated!")
 	},
@@ -57,9 +58,11 @@ var configCmd = &cobra.Command{
 func init() {
 	initConfig()
 	configCmd.Flags().StringVarP(&cfgserver, "server", "s", "", "server address")
-	configCmd.MarkFlagRequired("server")
+	err := configCmd.MarkFlagRequired("server")
+	cobra.CheckErr(err)
 	configCmd.Flags().IntVarP(&cfgport, "port", "p", 0, "server rcon port")
-	configCmd.MarkFlagRequired("port")
+	err = configCmd.MarkFlagRequired("port")
+	cobra.CheckErr(err)
 	rootCmd.AddCommand(configCmd)
 }
 
@@ -72,7 +75,8 @@ func initConfig() {
 	viper.SetConfigType("yaml")
 	viper.SetConfigName(".mctl")
 	viper.AutomaticEnv()
-	viper.ReadInConfig()
+	err = viper.ReadInConfig()
+	cobra.CheckErr(err)
 
 	if err := viper.ReadInConfig(); err != nil {
 		//file does not exist, create it
@@ -92,6 +96,7 @@ func initConfig() {
 		//write config
 		viper.Set("customcmd", cmdMap)
 		viper.Set("device", string(uu))
-		viper.SafeWriteConfig()
+		err = viper.SafeWriteConfig()
+		cobra.CheckErr(err)
 	}
 }

cmd/delete.go

@@ -21,7 +21,8 @@ var deleteCmd = &cobra.Command{
 			cmdMap := viper.Get("customcmd").(map[string]any)
 			delete(cmdMap, args[0])
 			viper.Set("customcmd", cmdMap)
-			viper.WriteConfig()
+			err := viper.WriteConfig()
+			cobra.CheckErr(err)
 		}
 	},
 	PreRunE: func(cmd *cobra.Command, args []string) error {

cmd/save.go

@@ -36,7 +36,8 @@ var saveCmd = &cobra.Command{
 				}
 				cmdMap[args[0]] = txt
 				viper.Set("customcmd", cmdMap)
-				viper.WriteConfig()
+				err := viper.WriteConfig()
+				cobra.CheckErr(err)
 				fmt.Println("\nSaved!")
 			}
 		}

cryptography/aes.go

@@ -21,7 +21,10 @@ func EncryptPassword(b []byte) ([]byte, error) {
 		return nil, err
 	}
 
-	ct := aesg.Seal(nil, []byte(nonce), []byte(b), nil)
+	//adding #nosec trigger here since gosec interprets this as a hardcoded nonce value. The nonce is calculated using crypto/rand when the
+	//config command is ran and is pulled from memory when used any times after, for now we must prevent the scan from catching here until gosec
+	//is updated to account for this properly
+	ct := aesg.Seal(nil, []byte(nonce), []byte(b), nil) // #nosec
 	return ct, nil
 }
 

go.mod

@@ -1,6 +1,6 @@
 module code.jakeyoungdev.com/jake/mctl
 
-go 1.24.0
+go 1.24.2
 
 require (
 	github.com/jake-young-dev/mcr v1.3.1