1
0
mirror of https://github.com/aquasecurity/kube-bench.git synced 2024-11-01 04:49:55 +00:00

Merge pull request #9 from aquasecurity/json

If output format is JSON, don't also output human-readable warnings
This commit is contained in:
Liz Rice 2017-06-23 11:10:08 +01:00 committed by GitHub
commit f920d61a6a
2 changed files with 63 additions and 31 deletions

View File

@ -54,6 +54,7 @@ var (
func runChecks(t check.NodeType) { func runChecks(t check.NodeType) {
var summary check.Summary var summary check.Summary
var warnings []string
var file string var file string
// Set up for config file check. // Set up for config file check.
@ -66,7 +67,15 @@ func runChecks(t check.NodeType) {
kubeNodeConf = append(kubeNodeConf, viper.Get("kubeConfDir").(string)+"/kubelet") kubeNodeConf = append(kubeNodeConf, viper.Get("kubeConfDir").(string)+"/kubelet")
kubeNodeConf = append(kubeNodeConf, viper.Get("kubeConfDir").(string)+"/proxy") kubeNodeConf = append(kubeNodeConf, viper.Get("kubeConfDir").(string)+"/proxy")
verifyNodeType(t) warnings, err := verifyNodeType(t, warnings)
if err != nil {
for _, w := range warnings {
colorPrint(check.WARN, w)
}
fmt.Fprintf(os.Stderr, "failed to verify node type: %v\n", err)
os.Exit(1)
}
switch t { switch t {
case check.MASTER: case check.MASTER:
@ -86,22 +95,19 @@ func runChecks(t check.NodeType) {
// Variable substitutions. Replace all occurrences of variables in controls file. // Variable substitutions. Replace all occurrences of variables in controls file.
s := strings.Replace(string(in), "$kubeConfDir", viper.Get("kubeConfDir").(string), -1) s := strings.Replace(string(in), "$kubeConfDir", viper.Get("kubeConfDir").(string), -1)
s = strings.Replace(s, "$etcdConfDir", viper.Get("etcdConfDir").(string), -1) s = strings.Replace(s, "$etcdConfDir", viper.Get("etcdConfDir").(string), -1)
s = strings.Replace(s, "$flanneldConfDir", viper.Get("etcdConfDir").(string), -1) s = strings.Replace(s, "$flanneldConfDir", viper.Get("flanneldConfDir").(string), -1)
controls := check.NewControls(t, []byte(s)) controls := check.NewControls(t, []byte(s))
if groupList != "" && checkList == "" { if groupList != "" && checkList == "" {
// log.Println("group: set, checks: not set")
ids := cleanIDs(groupList) ids := cleanIDs(groupList)
summary = controls.RunGroup(ids...) summary = controls.RunGroup(ids...)
} else if checkList != "" && groupList == "" { } else if checkList != "" && groupList == "" {
// log.Println("group: not set, checks: set")
ids := cleanIDs(checkList) ids := cleanIDs(checkList)
summary = controls.RunChecks(ids...) summary = controls.RunChecks(ids...)
} else if checkList != "" && groupList != "" { } else if checkList != "" && groupList != "" {
// log.Println("group: set, checks: set")
fmt.Fprintf(os.Stderr, "group option and check option can't be used together\n") fmt.Fprintf(os.Stderr, "group option and check option can't be used together\n")
os.Exit(1) os.Exit(1)
@ -109,14 +115,17 @@ func runChecks(t check.NodeType) {
summary = controls.RunGroup() summary = controls.RunGroup()
} }
if jsonFmt { // if we successfully ran some tests and it's json format, ignore the warnings
if (summary.Fail > 0 || summary.Warn > 0 || summary.Pass > 0) && jsonFmt {
out, err := controls.JSON() out, err := controls.JSON()
if err != nil { if err != nil {
fmt.Fprintf(os.Stderr, "failed to output in JSON format: %v\n", err)
os.Exit(1)
} }
fmt.Println(string(out)) fmt.Println(string(out))
} else { } else {
prettyPrint(controls, summary) prettyPrint(warnings, controls, summary)
} }
} }
@ -131,7 +140,8 @@ func cleanIDs(list string) []string {
return ids return ids
} }
func verifyNodeType(t check.NodeType) { // verifyNodeType checks the executables and config files are as expected for the specified tests (master, node or federated)
func verifyNodeType(t check.NodeType, w []string) ([]string, error) {
var binPath []string var binPath []string
var confPath []string var confPath []string
var out []byte var out []byte
@ -153,40 +163,58 @@ func verifyNodeType(t check.NodeType) {
for _, b := range binPath { for _, b := range binPath {
_, err := exec.LookPath(b) _, err := exec.LookPath(b)
if err != nil { if err != nil {
colorPrint(check.WARN, fmt.Sprintf("%s: command not found on path - version check skipped\n", b)) w = append(w, fmt.Sprintf("%s: command not found on path - version check skipped\n", b))
continue continue
} }
// Check version // Check version
cmd := exec.Command(b, "--version") cmd := exec.Command(b, "--version")
out, _ = cmd.Output() out, err = cmd.Output()
if matched, _ := regexp.MatchString(kubeVersion, string(out)); !matched { if err != nil {
colorPrint(check.FAIL, return w, fmt.Errorf("failed executing %s --version: %v", b, err)
fmt.Sprintf( }
"%s unsupported version, expected %s, got %s\n",
b, matched, err := regexp.MatchString(kubeVersion, string(out))
kubeVersion, if err != nil {
string(out), return w, fmt.Errorf("regexp match for version failed: %v", err)
)) }
os.Exit(1)
if !matched {
return w, fmt.Errorf(
"%s unsupported version, expected %s, got %s",
b,
kubeVersion,
string(out),
)
} }
} }
// Check if the executables for this type of node are running.
for _, b := range binPath { for _, b := range binPath {
// Check if running.
cmd := exec.Command("ps", "-ef") cmd := exec.Command("ps", "-ef")
out, _ = cmd.Output() out, err := cmd.Output()
if matched, _ := regexp.MatchString(".*"+b, string(out)); !matched { if err != nil {
colorPrint(check.FAIL, fmt.Sprintf("%s is not running\n", b)) return w, fmt.Errorf("failed executing ps -ef: %v", err)
os.Exit(1) }
matched, err := regexp.MatchString(".*"+b, string(out))
if err != nil {
return w, fmt.Errorf("regexp match for ps output failed: %v", err)
}
if !matched {
return w, fmt.Errorf("%s is not running", b)
} }
} }
// Check whether the config files for this type of node are in the expected location
for _, c := range confPath { for _, c := range confPath {
if _, err := os.Stat(c); os.IsNotExist(err) { if _, err := os.Stat(c); os.IsNotExist(err) {
colorPrint(check.WARN, fmt.Sprintf("config file %s does not exist\n", c)) w = append(w, fmt.Sprintf("config file %s does not exist\n", c))
} }
} }
return w, nil
} }
// colorPrint outputs the state in a specific colour, along with a message string // colorPrint outputs the state in a specific colour, along with a message string
@ -195,8 +223,14 @@ func colorPrint(state check.State, s string) {
fmt.Printf("%s", s) fmt.Printf("%s", s)
} }
func prettyPrint(r *check.Controls, summary check.Summary) { // prettyPrint outputs the results to stdout in human-readable format
// Print checks and results. func prettyPrint(warnings []string, r *check.Controls, summary check.Summary) {
colorPrint(check.INFO, fmt.Sprintf("Using config file: %s\n", viper.ConfigFileUsed()))
for _, w := range warnings {
colorPrint(check.WARN, w)
}
colorPrint(check.INFO, fmt.Sprintf("%s %s\n", r.ID, r.Text)) colorPrint(check.INFO, fmt.Sprintf("%s %s\n", r.ID, r.Text))
for _, g := range r.Groups { for _, g := range r.Groups {
colorPrint(check.INFO, fmt.Sprintf("%s %s\n", g.ID, g.Text)) colorPrint(check.INFO, fmt.Sprintf("%s %s\n", g.ID, g.Text))

View File

@ -96,10 +96,8 @@ func initConfig() {
viper.SetDefault("federatedFile", cfgDir+"/federated.yaml") viper.SetDefault("federatedFile", cfgDir+"/federated.yaml")
// If a config file is found, read it in. // If a config file is found, read it in.
if err := viper.ReadInConfig(); err == nil { if err := viper.ReadInConfig(); err != nil {
colorPrint(check.INFO, fmt.Sprintf("Using config file: %s\n", viper.ConfigFileUsed())) colorPrint(check.FAIL, fmt.Sprintf("Failed to read config file: %v\n", err))
} else {
colorPrint(check.FAIL, fmt.Sprintf("Faied to read config file: %v\n", err))
os.Exit(1) os.Exit(1)
} }
} }