policy

Documentation

Index

• Constants
• Variables
• func FilterPolicies(args []string, configPolicies []*config.Policy, policyName string) ([]*config.Policy, error)
• func GenerateExecutionResultFile(result *ExecutionResult, outputDir string) error
• type Configuration
• type ExecuteRequest
• type ExecutionResult
• type Executor
  • func NewExecutor(conn *pgxpool.Conn, log hclog.Logger, progressUpdate UpdateCallback) *Executor
  • func (e *Executor) ExecutePolicies(ctx context.Context, req *ExecuteRequest, policies Policies, selector []string) (*ExecutionResult, error)
• type Manager
  • func NewManager(policyDir string, pool *pgxpool.Pool, logger hclog.Logger) Manager
• type ManagerImpl
  • func (m *ManagerImpl) DownloadPolicy(ctx context.Context, p *RemotePolicy) error
  • func (m *ManagerImpl) Load(ctx context.Context, p *config.Policy, execReq *ExecuteRequest) (Policies, error)
  • func (m *ManagerImpl) Run(ctx context.Context, execReq *ExecuteRequest, policies Policies) (*ExecutionResult, error)
• type Policies
  • func DecodePolicies(body hcl.Body, diags hcl.Diagnostics, basePath string) (Policies, hcl.Diagnostics)
• type Policy
• type Provider
• type Query
• type QueryResult
• type QueryType
• type RemotePolicy
  • func ParsePolicyFromArgs(args []string) (*RemotePolicy, error)
  • func ParsePolicyFromSource(policy *config.Policy) (*RemotePolicy, error)
  • func (r *RemotePolicy) GetURL() (string, error)
  • func (r *RemotePolicy) ToPolicyConfig() (*config.Policy, error)
• type Update
  • func (f Update) AllDone() bool
  • func (f Update) DoneCount() int
• type UpdateCallback
• type View

Constants

const (
	CloudQueryOrg = "cloudquery-policies"
)

Variables

var ErrPolicyOrQueryNotFound = errors.New("selected policy/query is not found")

Functions

func FilterPolicies

func FilterPolicies(args []string, configPolicies []*config.Policy, policyName string) ([]*config.Policy, error)

func GenerateExecutionResultFile

func GenerateExecutionResultFile(result *ExecutionResult, outputDir string) error

Types

type Configuration

type Configuration struct {
	Providers []*Provider `hcl:"provider,block"`
}

type ExecuteRequest

type ExecuteRequest struct {
	// Policy is the policy that should be executed.
	Policy *config.Policy

	// StopOnFailure if true policy execution will stop on first failure
	StopOnFailure bool

	// SkipVersioning if true policy will be executed without checking out the version of the policy repo using git tags
	SkipVersioning bool

	// ProviderVersions describes current versions of providers in use.
	ProviderVersions map[string]*version.Version

	// UpdateCallback is the console ui update callback
	UpdateCallback UpdateCallback
}

ExecuteRequest is a request that triggers policy execution.

type ExecutionResult

type ExecutionResult struct {
	// PolicyName is the running policy name
	PolicyName string

	// True if all policies have passed
	Passed bool

	// List of all query result sets
	Results []*QueryResult

	// Error is the reason the execution failed
	Error string

	// List of loaded Policies
	LoadedPolicies Policies
}

ExecutionResult contains all policy execution results.

type Executor

type Executor struct {
	PolicyPath []string
	// contains filtered or unexported fields
}

Executor implements the execution framework.

func NewExecutor

func NewExecutor(conn *pgxpool.Conn, log hclog.Logger, progressUpdate UpdateCallback) *Executor

NewExecutor creates a new executor.

func (*Executor) ExecutePolicies

func (e *Executor) ExecutePolicies(ctx context.Context, req *ExecuteRequest, policies Policies, selector []string) (*ExecutionResult, error)

type Manager

type Manager interface {
	// Run the given policy.
	Run(ctx context.Context, req *ExecuteRequest, policies Policies) (*ExecutionResult, error)

	// Load the policy from local / remote location
	Load(ctx context.Context, p *config.Policy, execReq *ExecuteRequest) (Policies, error)

	// DownloadPolicy downloads the policy into the manager path.
	DownloadPolicy(ctx context.Context, p *RemotePolicy) error
}

Manager is the interface that describes the interaction with the policy hub. Implemented by ManagerImpl.

func NewManager

func NewManager(policyDir string, pool *pgxpool.Pool, logger hclog.Logger) Manager

NewManager returns a new manager instance.

type ManagerImpl

type ManagerImpl struct {
	// contains filtered or unexported fields
}

ManagerImpl is the manager implementation struct.

func (*ManagerImpl) DownloadPolicy

func (m *ManagerImpl) DownloadPolicy(ctx context.Context, p *RemotePolicy) error

DownloadPolicy downloads the given policy from GitHub and stores it in the local policy directory.

func (*ManagerImpl) Load

func (m *ManagerImpl) Load(ctx context.Context, p *config.Policy, execReq *ExecuteRequest) (Policies, error)

func (*ManagerImpl) Run

func (m *ManagerImpl) Run(ctx context.Context, execReq *ExecuteRequest, policies Policies) (*ExecutionResult, error)

type Policies

type Policies []*Policy

func DecodePolicies

func DecodePolicies(body hcl.Body, diags hcl.Diagnostics, basePath string) (Policies, hcl.Diagnostics)

type Policy

type Policy struct {
	Name        string         `hcl:"name,label"`
	Description string         `hcl:"description,optional"`
	Config      *Configuration `hcl:"configuration,block"`

	Source string `hcl:"source,optional"`

	Policies []*Policy `hcl:"policy,block"`
	Queries  []*Query  `hcl:"query,block"`
	Views    []*View   `hcl:"view,block"`
}

type Provider

type Provider struct {
	Type    string `hcl:"type,label"`
	Version string `hcl:"version,optional"`
}

type Query

type Query struct {
	Name         string    `hcl:"name,label"`
	Description  string    `hcl:"description,optional"`
	ExpectOutput bool      `hcl:"expect_output,optional"`
	Type         QueryType `hcl:"type,optional"`
	Query        string    `hcl:"query"`
}

type QueryResult

type QueryResult struct {
	Name        string          `json:"name"`
	Description string          `json:"description"`
	Columns     []string        `json:"result_headers"`
	Data        [][]interface{} `json:"result_rows"`
	Type        QueryType       `json:"type"`
	Passed      bool            `json:"check_passed"`
}

QueryResult contains the result information from an executed query.

type QueryType

type QueryType string

const (
	ManualQuery    QueryType = "manual"
	AutomaticQuery QueryType = "automatic"
)

type RemotePolicy

type RemotePolicy struct {
	// SourceControl is the source control which the policy hosted on. Github / Gitlab
	SourceControl string

	// Organization is the organization / user which own the policy.
	Organization string

	// Repository is the policy repository name.
	Repository string

	// Repository is the policy repository version.
	Version string
}

func ParsePolicyFromArgs

func ParsePolicyFromArgs(args []string) (*RemotePolicy, error)

ParsePolicyFromArgs parses policy execution arguments from given args. The first argument is the repository/policy name we want to run, the second argument is the subpath to execute.

func ParsePolicyFromSource

func ParsePolicyFromSource(policy *config.Policy) (*RemotePolicy, error)

func (*RemotePolicy) GetURL

func (r *RemotePolicy) GetURL() (string, error)

func (*RemotePolicy) ToPolicyConfig

func (r *RemotePolicy) ToPolicyConfig() (*config.Policy, error)

type Update

type Update struct {
	// PolicyID is the name of the policy that is being updated.
	PolicyName string
	// Version is the policy version.
	Version string
	// FinishedQueries is the number queries that have finished evaluating
	FinishedQueries int
	// QueriesCount is the amount of queries collected so far
	QueriesCount int
	// Error if any returned by the provider
	Error string
}

func (Update) AllDone

func (f Update) AllDone() bool

func (Update) DoneCount

func (f Update) DoneCount() int

type UpdateCallback

type UpdateCallback func(update Update)

type View

type View struct {
	Name        string `hcl:"name,label"`
	Description string `hcl:"description,optional"`

	Query *Query `hcl:"query,block"`
}