mirror of
https://github.com/FairwindsOps/polaris.git
synced 2026-05-11 03:37:42 +00:00
32c1150b28
This change follows up #635 and lets end-users decide to disallow exemption rules defined as part of the config file or the controller annotations (whether none, any or both). The main use case here is to be able to prevent users with edit privileges over a controller to add a new exemption rule through an annotation which may obfuscate the actual policies we want to enforce. Signed-off-by: Maxime VISONNEAU <maxime.visonneau@gmail.com> Co-authored-by: Robert Brennan <accounts@rbren.io>
114 lines
3.3 KiB
Go
114 lines
3.3 KiB
Go
// Copyright 2019 FairwindsOps Inc
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package config
|
|
|
|
import (
|
|
"bytes"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"io/ioutil"
|
|
"net/http"
|
|
"strings"
|
|
|
|
"github.com/gobuffalo/packr/v2"
|
|
"k8s.io/apimachinery/pkg/util/yaml"
|
|
)
|
|
|
|
// Configuration contains all of the config for the validation checks.
|
|
type Configuration struct {
|
|
DisplayName string `json:"displayName"`
|
|
Checks map[string]Severity `json:"checks"`
|
|
CustomChecks map[string]SchemaCheck `json:"customChecks"`
|
|
Exemptions []Exemption `json:"exemptions"`
|
|
DisallowExemptions bool `json:"disallowExemptions"`
|
|
DisallowConfigExemptions bool `json:"disallowConfigExemptions"`
|
|
DisallowAnnotationExemptions bool `json:"disallowAnnotationExemptions"`
|
|
}
|
|
|
|
// Exemption represents an exemption to normal rules
|
|
type Exemption struct {
|
|
Rules []string `json:"rules"`
|
|
ControllerNames []string `json:"controllerNames"`
|
|
ContainerNames []string `json:"containerNames"`
|
|
Namespace string `json:"namespace"`
|
|
}
|
|
|
|
var configBox = (*packr.Box)(nil)
|
|
|
|
func getConfigBox() *packr.Box {
|
|
if configBox == (*packr.Box)(nil) {
|
|
configBox = packr.New("Config", "../../examples")
|
|
}
|
|
return configBox
|
|
}
|
|
|
|
// ParseFile parses config from a file.
|
|
func ParseFile(path string) (Configuration, error) {
|
|
var rawBytes []byte
|
|
var err error
|
|
if path == "" {
|
|
rawBytes, err = getConfigBox().Find("config.yaml")
|
|
} else if strings.HasPrefix(path, "https://") || strings.HasPrefix(path, "http://") {
|
|
// path is a url
|
|
response, err2 := http.Get(path)
|
|
if err2 != nil {
|
|
return Configuration{}, err2
|
|
}
|
|
rawBytes, err = ioutil.ReadAll(response.Body)
|
|
} else {
|
|
// path is local
|
|
rawBytes, err = ioutil.ReadFile(path)
|
|
}
|
|
if err != nil {
|
|
return Configuration{}, err
|
|
}
|
|
return Parse(rawBytes)
|
|
}
|
|
|
|
// Parse parses config from a byte array.
|
|
func Parse(rawBytes []byte) (Configuration, error) {
|
|
reader := bytes.NewReader(rawBytes)
|
|
conf := Configuration{}
|
|
d := yaml.NewYAMLOrJSONDecoder(reader, 4096)
|
|
for {
|
|
if err := d.Decode(&conf); err != nil {
|
|
if err == io.EOF {
|
|
break
|
|
}
|
|
return conf, fmt.Errorf("Decoding config failed: %v", err)
|
|
}
|
|
}
|
|
for key, check := range conf.CustomChecks {
|
|
err := check.Initialize(key)
|
|
if err != nil {
|
|
return conf, err
|
|
}
|
|
conf.CustomChecks[key] = check
|
|
if _, ok := conf.Checks[key]; !ok {
|
|
return conf, fmt.Errorf("no severity specified for custom check %s. Please add the following to your configuration:\n\nchecks:\n %s: warning # or danger/ignore\n\nto enable your check", key, key)
|
|
}
|
|
}
|
|
return conf, conf.Validate()
|
|
}
|
|
|
|
// Validate checks if a config is valid
|
|
func (conf Configuration) Validate() error {
|
|
if len(conf.Checks) == 0 {
|
|
return errors.New("No checks were enabled")
|
|
}
|
|
return nil
|
|
}
|