validate

Documentation

Index

• Constants
• func ApplyPolicyiesFromOCI(ociURL, creds, path string) (string, error)
• func EvaluateCELPolicies(policies []CELPolicy, inputFile string, t table.Writer) error
• func FetchRegoMetadata(policyDir, metaExt, regoExt string) ([]string, []string, error)
• func LoadRegoMetadata(filePaths []string) ([]*regoMetadata, error)
• func MatchPolicyMetadata(metas []*regoMetadata, key string) (string, *regoMetadata, error)
• func PrintResults(result rego.ResultSet, metas []*regoMetadata) error
• func SaveResults(filename string, newResults []Results) error
• func ValidateWithOCIPolicies(resource, policy, ociURL, creds string, processor InputProcessor) error
• func ValidateWithRego(inputContent, regoPolicyPath string, processor InputProcessor) error
• type CELPolicy
  • func ParseYAMLPolicies(policyFile string) ([]CELPolicy, error)
• type CELPolicyFile
• type DockerfileProcessor
  • func (d DockerfileProcessor) ProcessInput(content string) ([]byte, error)
• type GenericProcessor
  • func (g GenericProcessor) ProcessInput(content string) ([]byte, error)
• type InputProcessor
• type Metadata
• type PolicyFile
• type Results

Constants

const (
	HubRegoPolicy = "ghcr.io/santoshkal/genval-security-policies/rego-policies:v0.0.1"
)

Functions

func ApplyPolicyiesFromOCI

func ApplyPolicyiesFromOCI(ociURL, creds, path string) (string, error)

func EvaluateCELPolicies

func EvaluateCELPolicies(policies []CELPolicy, inputFile string, t table.Writer) error

func FetchRegoMetadata

func FetchRegoMetadata(policyDir, metaExt, regoExt string) ([]string, []string, error)

func LoadRegoMetadata

func LoadRegoMetadata(filePaths []string) ([]*regoMetadata, error)

LoadRegoMetadata loads the contents of the metadata files into a slice of pointers to RegoMeta structs

func MatchPolicyMetadata

func MatchPolicyMetadata(metas []*regoMetadata, key string) (string, *regoMetadata, error)

MatchPolicyMetadata matches the RegoMeta policy names with the Rego evaluation results and returns the matched key

func PrintResults

func PrintResults(result rego.ResultSet, metas []*regoMetadata) error

PrintResults prints the evaluation results along with the metadata

func SaveResults

func SaveResults(filename string, newResults []Results) error

SaveResults saves the results to a file as a JSON array

func ValidateWithOCIPolicies

func ValidateWithOCIPolicies(resource, policy, ociURL, creds string, processor InputProcessor) error

func ValidateWithRego

func ValidateWithRego(inputContent, regoPolicyPath string, processor InputProcessor) error

Types

type CELPolicy

type CELPolicy struct {
	APIVersion string   `yaml:"apiVersion"`
	Kind       string   `yaml:"kind"`
	Metadata   Metadata `yaml:"metadata"`
	Rule       string   `yaml:"rule"`
}

func ParseYAMLPolicies

func ParseYAMLPolicies(policyFile string) ([]CELPolicy, error)

type CELPolicyFile

type CELPolicyFile struct {
	Policies []CELPolicy `yaml:"policies"`
}

type DockerfileProcessor

type DockerfileProcessor struct{}

DOckefileProcessor processes Dockerrile input

func (DockerfileProcessor) ProcessInput

func (d DockerfileProcessor) ProcessInput(content string) ([]byte, error)

d.ProcessInput processes Dockerfile content and returns a []byte or any error

type GenericProcessor

type GenericProcessor struct{}

GenericProcessor processes generic inputs like (YAML, JSON, etc)

func (GenericProcessor) ProcessInput

func (g GenericProcessor) ProcessInput(content string) ([]byte, error)

g.ProcessInput processes generic input contents and returns a []byte or any error

type InputProcessor

type InputProcessor interface {
	ProcessInput(string) ([]byte, error)
}

type Metadata

type Metadata struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
	Severity    string `yaml:"severity"`
	Benchmark   string `yaml:"benchmark"`
}

type PolicyFile

type PolicyFile struct {
	Policies []CELPolicy `yaml:"policies"`
}

type Results

type Results struct {
	ID          string `json:"id"`
	PolicyName  string `json:"policyName"`
	Status      string `json:"status"`
	Description string `json:"description"`
	Severity    string `json:"severity"`
	Benchmark   string `json:"benchmark"`
	Category    string `json:"category"`
}