Documentation
¶
Index ¶
- Constants
- type ActivatePolicyProfileRequest
- type Options
- type PolicyConfigProvider
- type PolicyProfileResponse
- type PolicyProvider
- type ProcessResponse
- type RiskPolicyProvider
- type RiskPolicyProviderOptions
- type Server
- func NewServer(store *sqlite.Store) (*Server, error)
- func NewServerWithOptions(store *sqlite.Store, opts Options) (*Server, error)
- func NewServerWithPolicy(store *sqlite.Store, policy PolicyProvider) (*Server, error)
- func NewServerWithPolicyConfig(store *sqlite.Store, policy PolicyProvider, policyStore *policyconfig.Store) (*Server, error)
- func NewServerWithPolicyConfigAndOptions(store *sqlite.Store, policy PolicyProvider, policyStore *policyconfig.Store, ...) (*Server, error)
- func OpenDefaultServer(dbPath string) (*Server, func() error, error)
- func OpenDefaultServerWithOptions(dbPath string, opts Options) (*Server, func() error, error)
- func (s *Server) EvaluateHook(ctx context.Context, event risk.HookEvent) (risk.RiskDecision, error)
- func (s *Server) Handler() http.Handler
- func (s *Server) IngestEvent(ctx context.Context, event risk.HookEvent) (risk.RiskDecision, error)
- func (s *Server) ListenAndServe(addr string) error
- func (s *Server) ProcessHookEvent(ctx context.Context, event risk.HookEvent) (risk.RiskDecision, error)
- func (s *Server) RuntimeCore() *runtimecore.Core
Constants ¶
View Source
const (
DefaultAddr = "127.0.0.1:4765"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActivatePolicyProfileRequest ¶ added in v0.7.0
type PolicyConfigProvider ¶ added in v0.7.0
type PolicyConfigProvider interface {
ActivePolicyConfig(context.Context) (guardpolicy.Config, error)
}
type PolicyProfileResponse ¶ added in v0.7.0
type PolicyProfileResponse struct {
Profile policy.Profile `json:"profile"`
RecommendedProfile policy.Profile `json:"recommended_profile"`
Version string `json:"version"`
RulePack string `json:"rule_pack"`
RulePackVersion string `json:"rule_pack_version"`
ConfigDigest string `json:"config_digest"`
ActivationID string `json:"activation_id"`
Source string `json:"source"`
Status string `json:"status"`
LoadedAt time.Time `json:"loaded_at"`
}
type PolicyProvider ¶ added in v0.7.0
type ProcessResponse ¶
type RiskPolicyProvider ¶ added in v0.7.0
type RiskPolicyProvider struct {
// contains filtered or unexported fields
}
func NewRiskPolicyProvider ¶ added in v0.7.0
func NewRiskPolicyProvider() RiskPolicyProvider
func NewRiskPolicyProviderWithJudge ¶ added in v0.7.0
func NewRiskPolicyProviderWithJudge(localJudge judge.Judge) RiskPolicyProvider
func NewRiskPolicyProviderWithOptions ¶ added in v0.7.0
func NewRiskPolicyProviderWithOptions(opts RiskPolicyProviderOptions) RiskPolicyProvider
func (RiskPolicyProvider) DecideHook ¶ added in v0.7.0
func (p RiskPolicyProvider) DecideHook(ctx context.Context, event risk.HookEvent) (risk.RiskDecision, error)
type RiskPolicyProviderOptions ¶ added in v0.7.0
type RiskPolicyProviderOptions struct {
Judge judge.Judge
PolicyEngine guardpolicy.Engine
PolicyConfig guardpolicy.Config
PolicyConfigProvider PolicyConfigProvider
}
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
func NewServerWithOptions ¶ added in v0.7.0
func NewServerWithPolicy ¶ added in v0.7.0
func NewServerWithPolicy(store *sqlite.Store, policy PolicyProvider) (*Server, error)
NewServerWithPolicy creates a Guard server with an injected policy provider. A nil interface uses the default local risk policy; callers must not pass a typed-nil provider because it still satisfies the PolicyProvider interface.
func NewServerWithPolicyConfig ¶ added in v0.7.0
func NewServerWithPolicyConfig(store *sqlite.Store, policy PolicyProvider, policyStore *policyconfig.Store) (*Server, error)
func NewServerWithPolicyConfigAndOptions ¶ added in v0.8.0
func NewServerWithPolicyConfigAndOptions(store *sqlite.Store, policy PolicyProvider, policyStore *policyconfig.Store, opts Options) (*Server, error)
func OpenDefaultServerWithOptions ¶ added in v0.7.0
func (*Server) EvaluateHook ¶ added in v0.7.0
func (*Server) IngestEvent ¶ added in v0.7.0
func (*Server) ListenAndServe ¶
func (*Server) ProcessHookEvent ¶
func (*Server) RuntimeCore ¶ added in v0.7.0
func (s *Server) RuntimeCore() *runtimecore.Core
Click to show internal directories.
Click to hide internal directories.