Prevent nil pointer when loading any JSON configuration

javuto · javuto · commit 6a1590bc97c0 · 2025-01-31T20:00:35.000+01:00
diff --git a/admin/jwt.go b/admin/jwt.go
@@ -3,12 +3,13 @@ package main
 import (
 	"crypto/rsa"
 	"crypto/tls"
+	"fmt"
 
 	"github.com/golang-jwt/jwt/v4"
 	"github.com/jmpsec/osctrl/settings"
 	"github.com/jmpsec/osctrl/types"
-	"github.com/spf13/viper"
 	"github.com/rs/zerolog/log"
+	"github.com/spf13/viper"
 )
 
 // Function to load the configuration file
@@ -22,6 +23,9 @@ func loadJWTConfiguration(file string) (types.JSONConfigurationJWT, error) {
 	}
 	// JWT values
 	jwtRaw := viper.Sub(settings.AuthJWT)
+	if jwtRaw == nil {
+		return cfg, fmt.Errorf("JSON key %s not found in file %s", settings.AuthJWT, file)
+	}
 	if err := jwtRaw.Unmarshal(&cfg); err != nil {
 		return cfg, err
 	}
diff --git a/admin/main.go b/admin/main.go
@@ -206,7 +206,7 @@ func loadConfiguration(file, service string) (types.JSONConfigurationAdmin, erro
 	// Admin values
 	adminRaw := viper.Sub(service)
 	if adminRaw == nil {
-		return cfg, fmt.Errorf("JSON key %s not found in %s", service, file)
+		return cfg, fmt.Errorf("JSON key %s not found in file %s", service, file)
 	}
 	if err := adminRaw.Unmarshal(&cfg); err != nil {
 		return cfg, err
diff --git a/admin/oauth.go b/admin/oauth.go
@@ -1,6 +1,8 @@
 package main
 
 import (
+	"fmt"
+
 	"github.com/jmpsec/osctrl/settings"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/viper"
@@ -26,6 +28,9 @@ func loadOAuth(file string) (JSONConfigurationOAuth, error) {
 	}
 	// OAuth values
 	oauthRaw := viper.Sub(settings.AuthOAuth)
+	if oauthRaw == nil {
+		return cfg, fmt.Errorf("JSON key %s not found in %s", settings.AuthOAuth, file)
+	}
 	if err := oauthRaw.Unmarshal(&cfg); err != nil {
 		return cfg, err
 	}
diff --git a/admin/oidc.go b/admin/oidc.go
@@ -1,10 +1,11 @@
 package main
 
 import (
+	"fmt"
 
 	"github.com/jmpsec/osctrl/settings"
-	"github.com/spf13/viper"
 	"github.com/rs/zerolog/log"
+	"github.com/spf13/viper"
 )
 
 // JSONConfigurationOIDC to keep all OIDC details for auth
@@ -30,6 +31,9 @@ func loadOIDC(file string) (JSONConfigurationOIDC, error) {
 	}
 	// OAuth values
 	oauthRaw := viper.Sub(settings.AuthOIDC)
+	if oauthRaw == nil {
+		return cfg, fmt.Errorf("JSON key %s not found in %s", settings.AuthOIDC, file)
+	}
 	if err := oauthRaw.Unmarshal(&cfg); err != nil {
 		return cfg, err
 	}
diff --git a/admin/saml.go b/admin/saml.go
@@ -45,6 +45,9 @@ func loadSAML(file string) (JSONConfigurationSAML, error) {
 	}
 	// SAML values
 	samlRaw := viper.Sub(settings.AuthSAML)
+	if samlRaw == nil {
+		return cfg, fmt.Errorf("JSON key %s not found in %s", settings.AuthSAML, file)
+	}
 	if err := samlRaw.Unmarshal(&cfg); err != nil {
 		return cfg, err
 	}
diff --git a/api/jwt.go b/api/jwt.go
@@ -1,6 +1,8 @@
 package main
 
 import (
+	"fmt"
+
 	"github.com/jmpsec/osctrl/settings"
 	"github.com/jmpsec/osctrl/types"
 	"github.com/rs/zerolog/log"
@@ -17,8 +19,11 @@ func loadJWTConfiguration(file string) (types.JSONConfigurationJWT, error) {
 		return cfg, err
 	}
 	// JWT values
-	headersRaw := viper.Sub(settings.AuthJWT)
-	if err := headersRaw.Unmarshal(&cfg); err != nil {
+	jwtRaw := viper.Sub(settings.AuthJWT)
+	if jwtRaw == nil {
+		return cfg, fmt.Errorf("JSON key %s not found in %s", settings.AuthJWT, file)
+	}
+	if err := jwtRaw.Unmarshal(&cfg); err != nil {
 		return cfg, err
 	}
 	// No errors!
diff --git a/backend/backend.go b/backend/backend.go
@@ -48,6 +48,9 @@ func LoadConfiguration(file, key string) (JSONConfigurationDB, error) {
 	}
 	// Backend values
 	dbRaw := viper.Sub(key)
+	if dbRaw == nil {
+		return config, fmt.Errorf("JSON key %s not found in %s", key, file)
+	}
 	if err := dbRaw.Unmarshal(&config); err != nil {
 		return config, err
 	}
diff --git a/cache/cache.go b/cache/cache.go
@@ -46,8 +46,11 @@ func LoadConfiguration(file, key string) (JSONConfigurationRedis, error) {
 		return config, err
 	}
 	// Backend values
-	dbRaw := viper.Sub(key)
-	if err := dbRaw.Unmarshal(&config); err != nil {
+	redisRaw := viper.Sub(key)
+	if redisRaw == nil {
+		return config, fmt.Errorf("JSON key %s not found in %s", key, file)
+	}
+	if err := redisRaw.Unmarshal(&config); err != nil {
 		return config, err
 	}
 	// No errors!
diff --git a/carves/s3.go b/carves/s3.go
@@ -85,6 +85,9 @@ func LoadS3(file string) (types.S3Configuration, error) {
 		return _s3Cfg, err
 	}
 	cfgRaw := viper.Sub(settings.LoggingS3)
+	if cfgRaw == nil {
+		return _s3Cfg, fmt.Errorf("JSON key %s not found in %s", settings.LoggingS3, file)
+	}
 	if err := cfgRaw.Unmarshal(&_s3Cfg); err != nil {
 		return _s3Cfg, err
 	}
diff --git a/cli/api.go b/cli/api.go
@@ -68,7 +68,7 @@ func loadAPIConfiguration(file string) (JSONConfigurationAPI, error) {
 	// API values
 	apiRaw := viper.Sub(projectName)
 	if apiRaw == nil {
-		return config, fmt.Errorf("could not find key %s", projectName)
+		return config, fmt.Errorf("JSON key %s not found in %s", projectName, file)
 	}
 	if err := apiRaw.Unmarshal(&config); err != nil {
 		return config, err
diff --git a/logging/elastic.go b/logging/elastic.go
@@ -73,6 +73,9 @@ func LoadElastic(file string) (ElasticConfiguration, error) {
 		return _elasticCfg, err
 	}
 	cfgRaw := viper.Sub(settings.LoggingElastic)
+	if cfgRaw == nil {
+		return _elasticCfg, fmt.Errorf("JSON key %s not found in %s", settings.LoggingElastic, file)
+	}
 	if err := cfgRaw.Unmarshal(&_elasticCfg); err != nil {
 		return _elasticCfg, err
 	}
diff --git a/logging/graylog.go b/logging/graylog.go
@@ -2,6 +2,7 @@ package logging
 
 import (
 	"encoding/json"
+	"fmt"
 	"strings"
 	"time"
 
@@ -32,8 +33,10 @@ func LoadGraylog(file string) (GraylogConfiguration, error) {
 		return _graylogCfg, err
 	}
 	cfgRaw := viper.Sub(settings.LoggingGraylog)
-	err = cfgRaw.Unmarshal(&_graylogCfg)
-	if err != nil {
+	if cfgRaw == nil {
+		return _graylogCfg, fmt.Errorf("JSON key %s not found in %s", settings.LoggingGraylog, file)
+	}
+	if err := cfgRaw.Unmarshal(&_graylogCfg); err != nil {
 		return _graylogCfg, err
 	}
 	// No errors!
diff --git a/logging/kinesis.go b/logging/kinesis.go
@@ -65,6 +65,9 @@ func LoadKinesis(file string) (KinesisConfiguration, error) {
 		return _kinesisCfg, err
 	}
 	cfgRaw := viper.Sub(settings.LoggingSplunk)
+	if cfgRaw == nil {
+		return _kinesisCfg, fmt.Errorf("JSON key %s not found in %s", settings.LoggingSplunk, file)
+	}
 	if err := cfgRaw.Unmarshal(&_kinesisCfg); err != nil {
 		return _kinesisCfg, err
 	}
diff --git a/logging/logstash.go b/logging/logstash.go
@@ -61,6 +61,9 @@ func LoadLogstash(file string) (LogstashConfiguration, error) {
 		return _logstashCfg, err
 	}
 	cfgRaw := viper.Sub(settings.LoggingLogstash)
+	if cfgRaw == nil {
+		return _logstashCfg, fmt.Errorf("JSON key %s not found in %s", settings.LoggingLogstash, file)
+	}
 	if err := cfgRaw.Unmarshal(&_logstashCfg); err != nil {
 		return _logstashCfg, err
 	}
diff --git a/logging/s3.go b/logging/s3.go
@@ -3,6 +3,7 @@ package logging
 import (
 	"bytes"
 	"context"
+	"fmt"
 	"net/http"
 	"strconv"
 	"time"
@@ -72,6 +73,9 @@ func LoadS3(file string) (types.S3Configuration, error) {
 		return _s3Cfg, err
 	}
 	cfgRaw := viper.Sub(settings.LoggingS3)
+	if cfgRaw == nil {
+		return _s3Cfg, fmt.Errorf("JSON key %s not found in %s", settings.LoggingS3, file)
+	}
 	if err := cfgRaw.Unmarshal(&_s3Cfg); err != nil {
 		return _s3Cfg, err
 	}
diff --git a/logging/splunk.go b/logging/splunk.go
@@ -2,6 +2,7 @@ package logging
 
 import (
 	"encoding/json"
+	"fmt"
 	"strings"
 	"time"
 
@@ -54,6 +55,9 @@ func LoadSplunk(file string) (SlunkConfiguration, error) {
 		return _splunkCfg, err
 	}
 	cfgRaw := viper.Sub(settings.LoggingSplunk)
+	if cfgRaw == nil {
+		return _splunkCfg, fmt.Errorf("JSON key %s not found in %s", settings.LoggingSplunk, file)
+	}
 	if err := cfgRaw.Unmarshal(&_splunkCfg); err != nil {
 		return _splunkCfg, err
 	}
diff --git a/metrics/metrics.go b/metrics/metrics.go
@@ -35,6 +35,9 @@ func LoadConfiguration() (Configuration, error) {
 		return _metricsCfg, err
 	}
 	cfgRaw := viper.Sub(metricsName)
+	if cfgRaw == nil {
+		return _metricsCfg, fmt.Errorf("JSON key %s not found in %s", metricsName, metricsConfigFile)
+	}
 	if err := cfgRaw.Unmarshal(&_metricsCfg); err != nil {
 		return _metricsCfg, err
 	}

Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ func loadConfiguration(file, service string) (types.JSONConfigurationAdmin, erro`
`206`	`206`	`// Admin values`
`207`	`207`	`adminRaw := viper.Sub(service)`
`208`	`208`	`if adminRaw == nil {`
`209`		`- return cfg, fmt.Errorf("JSON key %s not found in %s", service, file)`
	`209`	`+ return cfg, fmt.Errorf("JSON key %s not found in file %s", service, file)`
`210`	`210`	`}`
`211`	`211`	`if err := adminRaw.Unmarshal(&cfg); err != nil {`
`212`	`212`	`return cfg, err`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,11 @@`
`1`	`1`	`package main`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "fmt"`
`4`	`5`
`5`	`6`	`"github.com/jmpsec/osctrl/settings"`
`6`		`- "github.com/spf13/viper"`
`7`	`7`	`"github.com/rs/zerolog/log"`
	`8`	`+ "github.com/spf13/viper"`
`8`	`9`	`)`
`9`	`10`
`10`	`11`	`// JSONConfigurationOIDC to keep all OIDC details for auth`
`@@ -30,6 +31,9 @@ func loadOIDC(file string) (JSONConfigurationOIDC, error) {`
`30`	`31`	`}`
`31`	`32`	`// OAuth values`
`32`	`33`	`oauthRaw := viper.Sub(settings.AuthOIDC)`
	`34`	`+ if oauthRaw == nil {`
	`35`	`+ return cfg, fmt.Errorf("JSON key %s not found in %s", settings.AuthOIDC, file)`
	`36`	`+ }`
`33`	`37`	`if err := oauthRaw.Unmarshal(&cfg); err != nil {`
`34`	`38`	`return cfg, err`
`35`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,9 @@ func loadSAML(file string) (JSONConfigurationSAML, error) {`
`45`	`45`	`}`
`46`	`46`	`// SAML values`
`47`	`47`	`samlRaw := viper.Sub(settings.AuthSAML)`
	`48`	`+ if samlRaw == nil {`
	`49`	`+ return cfg, fmt.Errorf("JSON key %s not found in %s", settings.AuthSAML, file)`
	`50`	`+ }`
`48`	`51`	`if err := samlRaw.Unmarshal(&cfg); err != nil {`
`49`	`52`	`return cfg, err`
`50`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,9 @@ func LoadConfiguration(file, key string) (JSONConfigurationDB, error) {`
`48`	`48`	`}`
`49`	`49`	`// Backend values`
`50`	`50`	`dbRaw := viper.Sub(key)`
	`51`	`+ if dbRaw == nil {`
	`52`	`+ return config, fmt.Errorf("JSON key %s not found in %s", key, file)`
	`53`	`+ }`
`51`	`54`	`if err := dbRaw.Unmarshal(&config); err != nil {`
`52`	`55`	`return config, err`
`53`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,11 @@ func LoadConfiguration(file, key string) (JSONConfigurationRedis, error) {`
`46`	`46`	`return config, err`
`47`	`47`	`}`
`48`	`48`	`// Backend values`
`49`		`- dbRaw := viper.Sub(key)`
`50`		`- if err := dbRaw.Unmarshal(&config); err != nil {`
	`49`	`+ redisRaw := viper.Sub(key)`
	`50`	`+ if redisRaw == nil {`
	`51`	`+ return config, fmt.Errorf("JSON key %s not found in %s", key, file)`
	`52`	`+ }`
	`53`	`+ if err := redisRaw.Unmarshal(&config); err != nil {`
`51`	`54`	`return config, err`
`52`	`55`	`}`
`53`	`56`	`// No errors!`
Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,9 @@ func LoadS3(file string) (types.S3Configuration, error) {`
`85`	`85`	`return _s3Cfg, err`
`86`	`86`	`}`
`87`	`87`	`cfgRaw := viper.Sub(settings.LoggingS3)`
	`88`	`+ if cfgRaw == nil {`
	`89`	`+ return _s3Cfg, fmt.Errorf("JSON key %s not found in %s", settings.LoggingS3, file)`
	`90`	`+ }`
`88`	`91`	`if err := cfgRaw.Unmarshal(&_s3Cfg); err != nil {`
`89`	`92`	`return _s3Cfg, err`
`90`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ func loadAPIConfiguration(file string) (JSONConfigurationAPI, error) {`
`68`	`68`	`// API values`
`69`	`69`	`apiRaw := viper.Sub(projectName)`
`70`	`70`	`if apiRaw == nil {`
`71`		`- return config, fmt.Errorf("could not find key %s", projectName)`
	`71`	`+ return config, fmt.Errorf("JSON key %s not found in %s", projectName, file)`
`72`	`72`	`}`
`73`	`73`	`if err := apiRaw.Unmarshal(&config); err != nil {`
`74`	`74`	`return config, err`