database

package
v1.6.11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 22, 2025 License: MIT Imports: 45 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	CAPIPullLockTimeout = 10
	CapiPullLockName    = "pullCAPI"
)
View Source 
const (
	CapiMachineID      = types.CAPIOrigin
	CapiListsMachineID = types.ListOrigin
)

Variables

View Source 
var (
	UserExists        = errors.New("user already exist")
	UserNotExists     = errors.New("user doesn't exist")
	HashError         = errors.New("unable to hash")
	InsertFail        = errors.New("unable to insert row")
	QueryFail         = errors.New("unable to query")
	UpdateFail        = errors.New("unable to update")
	DeleteFail        = errors.New("unable to delete")
	ItemNotFound      = errors.New("object not found")
	ParseTimeFail     = errors.New("unable to parse time")
	ParseDurationFail = errors.New("unable to parse duration")
	MarshalFail       = errors.New("unable to serialize")
	BulkError         = errors.New("unable to insert bulk")
	ParseType         = errors.New("unable to parse type")
	InvalidIPOrRange  = errors.New("invalid ip address / range")
	InvalidFilter     = errors.New("invalid filter")
)

Functions

func BuildAlertRequestFromFilter added in v1.0.0 

func BuildAlertRequestFromFilter(alerts *ent.AlertQuery, filter map[string][]string) (*ent.AlertQuery, error)

func BuildDecisionRequestWithFilter added in v1.0.0 

func BuildDecisionRequestWithFilter(query *ent.DecisionQuery, filter map[string][]string) (*ent.DecisionQuery, error)

func GetIpsFromIpRange added in v1.0.0 

func GetIpsFromIpRange(host string) (int64, int64, error)

GetIpsFromIpRange takes a CIDR range and returns the start and end IP

func IP2Int added in v1.0.0 

func IP2Int(ip net.IP) uint32

func Int2ip added in v1.0.0 

func Int2ip(nn uint32) net.IP

func IsIpv4 added in v1.0.0 

func IsIpv4(host string) bool

func LastAddress added in v1.0.0 

func LastAddress(n *net.IPNet) net.IP

Stolen from : https://github.com/llimllib/ipaddress/ Return the final address of a net range. Convert to IPv4 if possible, otherwise return an ipv6

Types

type BouncerNotFoundError added in v1.6.3 

type BouncerNotFoundError struct {
	BouncerName string
}

func (*BouncerNotFoundError) Error added in v1.6.3 

func (e *BouncerNotFoundError) Error() string

type Client added in v1.0.0 

type Client struct {
	Ent      *ent.Client
	Log      *log.Logger
	CanFlush bool
	Type     string
	WalMode  *bool
	// contains filtered or unexported fields
}

func NewClient added in v1.0.0 

func NewClient(ctx context.Context, config *csconfig.DatabaseCfg) (*Client, error)

func (*Client) AcquireLock added in v1.6.1 

func (c *Client) AcquireLock(ctx context.Context, name string) error

func (*Client) AcquirePullCAPILock added in v1.6.1 

func (c *Client) AcquirePullCAPILock(ctx context.Context) error

func (*Client) AddToAllowlist added in v1.6.6 

func (c *Client) AddToAllowlist(ctx context.Context, list *ent.AllowList, items []*models.AllowlistItem) (int, error)

func (*Client) AlertsCountPerScenario added in v1.4.0 

func (c *Client) AlertsCountPerScenario(ctx context.Context, filters map[string][]string) (map[string]int, error)

func (*Client) ApplyAllowlistsToExistingDecisions added in v1.6.9 

func (c *Client) ApplyAllowlistsToExistingDecisions(ctx context.Context) (int, error)

func (*Client) BouncerUpdateBaseMetrics added in v1.6.3 

func (c *Client) BouncerUpdateBaseMetrics(ctx context.Context, bouncerName string, bouncerType string, baseMetrics models.BaseMetrics) error

func (*Client) BulkDeleteBouncers added in v1.5.3 

func (c *Client) BulkDeleteBouncers(ctx context.Context, bouncers []*ent.Bouncer) (int, error)

func (*Client) BulkDeleteWatchers added in v1.5.3 

func (c *Client) BulkDeleteWatchers(ctx context.Context, machines []*ent.Machine) (int, error)

func (*Client) CountDecisionsByValue added in v1.4.0 

func (c *Client) CountDecisionsByValue(ctx context.Context, value string, since *time.Time, onlyActive bool) (int, error)

func (*Client) CreateAlert added in v1.0.0 

func (c *Client) CreateAlert(ctx context.Context, machineID string, alertList []*models.Alert) ([]string, error)

func (*Client) CreateAllowList added in v1.6.6 

func (c *Client) CreateAllowList(ctx context.Context, name string, description string, allowlistID string, fromConsole bool) (*ent.AllowList, error)

func (*Client) CreateBouncer added in v1.0.0 

func (c *Client) CreateBouncer(ctx context.Context, name string, ipAddr string, apiKey string, authType string, autoCreated bool) (*ent.Bouncer, error)

func (*Client) CreateMachine added in v1.0.0 

func (c *Client) CreateMachine(ctx context.Context, machineID *string, password *strfmt.Password, ipAddress string, isValidated bool, force bool, authType string) (*ent.Machine, error)

func (*Client) CreateMetric added in v1.6.3 

func (c *Client) CreateMetric(ctx context.Context, generatedType metric.GeneratedType, generatedBy string, receivedAt time.Time, payload string) (*ent.Metric, error)

func (*Client) CreateOrUpdateAlert added in v1.5.0 

func (c *Client) CreateOrUpdateAlert(ctx context.Context, machineID string, alertItem *models.Alert) (string, error)

CreateOrUpdateAlert is specific to PAPI : It checks if alert already exists, otherwise inserts it if alert already exists, it checks it associated decisions already exists if some associated decisions are missing (ie. previous insert ended up in error) it inserts them

func (*Client) DeleteAlertByID added in v1.4.2 

func (c *Client) DeleteAlertByID(ctx context.Context, id int) error

func (*Client) DeleteAlertGraph added in v1.0.0 

func (c *Client) DeleteAlertGraph(ctx context.Context, alertItem *ent.Alert) error

func (*Client) DeleteAlertGraphBatch added in v1.2.1 

func (c *Client) DeleteAlertGraphBatch(ctx context.Context, alertItems []*ent.Alert) (int, error)

func (*Client) DeleteAlertWithFilter added in v1.0.0 

func (c *Client) DeleteAlertWithFilter(ctx context.Context, filter map[string][]string) (int, error)

func (*Client) DeleteAllowList added in v1.6.6 

func (c *Client) DeleteAllowList(ctx context.Context, name string, fromConsole bool) error

func (*Client) DeleteAllowListByID added in v1.6.6 

func (c *Client) DeleteAllowListByID(ctx context.Context, name string, allowlistID string, fromConsole bool) error

func (*Client) DeleteBouncer added in v1.0.0 

func (c *Client) DeleteBouncer(ctx context.Context, name string) error

func (*Client) DeleteDecisions added in v1.6.3 

func (c *Client) DeleteDecisions(ctx context.Context, decisions []*ent.Decision) (int, error)

DeleteDecisions removes a list of decisions from the database It returns the number of impacted decisions for the CAPI/PAPI

func (*Client) DeleteWatcher added in v1.0.0 

func (c *Client) DeleteWatcher(ctx context.Context, name string) error

func (*Client) ExpireDecisionByID added in v1.6.3 

func (c *Client) ExpireDecisionByID(ctx context.Context, decisionID int) (int, []*ent.Decision, error)

ExpireDecision set the expiration of a decision to now()

func (*Client) ExpireDecisions added in v1.6.3 

func (c *Client) ExpireDecisions(ctx context.Context, decisions []*ent.Decision) (int, error)

ExpireDecisions sets the expiration of a list of decisions to now() It returns the number of impacted decisions for the CAPI/PAPI

func (*Client) ExpireDecisionsWithFilter added in v1.6.3 

func (c *Client) ExpireDecisionsWithFilter(ctx context.Context, filter map[string][]string) (int, []*ent.Decision, error)

ExpireDecisionsWithFilter updates the expiration time to now() for the decisions matching the filter, and returns the updated items

func (*Client) FlushAgentsAndBouncers added in v1.4.0 

func (c *Client) FlushAgentsAndBouncers(ctx context.Context, agentsCfg *csconfig.AuthGCCfg, bouncersCfg *csconfig.AuthGCCfg) error

func (*Client) FlushAlerts added in v1.0.0 

func (c *Client) FlushAlerts(ctx context.Context, maxAge time.Duration, maxItems int) error

func (*Client) FlushOrphans added in v1.1.0 

func (c *Client) FlushOrphans(ctx context.Context)

func (*Client) GetActiveDecisionsTimeLeftByValue added in v1.6.2 

func (c *Client) GetActiveDecisionsTimeLeftByValue(ctx context.Context, decisionValue string) (time.Duration, error)

func (*Client) GetAlertByID added in v1.0.0 

func (c *Client) GetAlertByID(ctx context.Context, alertID int) (*ent.Alert, error)

func (*Client) GetAllowList added in v1.6.6 

func (c *Client) GetAllowList(ctx context.Context, name string, withContent bool) (*ent.AllowList, error)

func (*Client) GetAllowListByID added in v1.6.6 

func (c *Client) GetAllowListByID(ctx context.Context, allowlistID string, withContent bool) (*ent.AllowList, error)

func (*Client) GetAllowlistsContentForAPIC added in v1.6.6 

func (c *Client) GetAllowlistsContentForAPIC(ctx context.Context) ([]net.IP, []*net.IPNet, error)

func (*Client) GetBouncerUsageMetricsByName added in v1.6.3 

func (c *Client) GetBouncerUsageMetricsByName(ctx context.Context, bouncerName string) ([]*ent.Metric, error)

func (*Client) GetConfigItem added in v1.5.0 

func (c *Client) GetConfigItem(ctx context.Context, key string) (string, error)

func (*Client) GetLPUsageMetricsByMachineID added in v1.6.3 

func (c *Client) GetLPUsageMetricsByMachineID(ctx context.Context, machineId string) ([]*ent.Metric, error)

func (*Client) IsAllowlisted added in v1.6.6 

func (c *Client) IsAllowlisted(ctx context.Context, value string) (bool, string, error)

func (*Client) IsAllowlistedBy added in v1.6.9 

func (c *Client) IsAllowlistedBy(ctx context.Context, value string) (reasons []string, err error)

IsAllowlistedBy returns a list of human-readable reasons explaining which allowlists the given value (IP or CIDR) matches.

Few cases: - value is an IP/range directly is in allowlist - value is an IP/range in a range in allowlist - value is a range and an IP/range belonging to it is in allowlist

The result is sorted by the name of the associated allowlist for consistent presentation.

func (*Client) IsLocked added in v1.6.1 

func (c *Client) IsLocked(err error) bool

func (*Client) IsMachineRegistered added in v1.0.0 

func (c *Client) IsMachineRegistered(ctx context.Context, machineID string) (bool, error)

func (*Client) ListAllowLists added in v1.6.6 

func (c *Client) ListAllowLists(ctx context.Context, withContent bool) ([]*ent.AllowList, error)

func (*Client) ListBouncers added in v1.0.0 

func (c *Client) ListBouncers(ctx context.Context) ([]*ent.Bouncer, error)

func (*Client) ListMachines added in v1.0.0 

func (c *Client) ListMachines(ctx context.Context) ([]*ent.Machine, error)

func (*Client) LoadAPICToken added in v1.6.9 

func (c *Client) LoadAPICToken(ctx context.Context, logger logrus.FieldLogger) (string, time.Time, bool)

LoadAPICToken attempts to retrieve and validate a JWT token from the local database. It returns the token string, its expiration time, and a boolean indicating whether the token is valid.

A token is considered valid if:

  • it exists in the database,
  • it is a properly formatted JWT with an "exp" claim,
  • it is not expired or near expiry.

func (*Client) MachineUpdateBaseMetrics added in v1.6.3 

func (c *Client) MachineUpdateBaseMetrics(ctx context.Context, machineID string, baseMetrics models.BaseMetrics, hubItems models.HubItems, datasources map[string]int64) error

func (*Client) MarkUsageMetricsAsSent added in v1.6.3 

func (c *Client) MarkUsageMetricsAsSent(ctx context.Context, ids []int) error

func (*Client) QueryAlertWithFilter added in v1.0.0 

func (c *Client) QueryAlertWithFilter(ctx context.Context, filter map[string][]string) ([]*ent.Alert, error)

func (*Client) QueryAllDecisionsWithFilters added in v1.1.0 

func (c *Client) QueryAllDecisionsWithFilters(ctx context.Context, filters map[string][]string) ([]*ent.Decision, error)

func (*Client) QueryBouncersInactiveSince added in v1.6.3 

func (c *Client) QueryBouncersInactiveSince(ctx context.Context, t time.Time) ([]*ent.Bouncer, error)

func (*Client) QueryDecisionCountByScenario added in v1.4.0 

func (c *Client) QueryDecisionCountByScenario(ctx context.Context) ([]*DecisionsByScenario, error)

func (*Client) QueryDecisionWithFilter added in v1.0.0 

func (c *Client) QueryDecisionWithFilter(ctx context.Context, filter map[string][]string) ([]*ent.Decision, error)

func (*Client) QueryExpiredDecisionsSinceWithFilters added in v1.1.0 

func (c *Client) QueryExpiredDecisionsSinceWithFilters(ctx context.Context, since *time.Time, filters map[string][]string) ([]*ent.Decision, error)

func (*Client) QueryExpiredDecisionsWithFilters added in v1.1.0 

func (c *Client) QueryExpiredDecisionsWithFilters(ctx context.Context, filters map[string][]string) ([]*ent.Decision, error)

func (*Client) QueryMachineByID added in v1.0.0 

func (c *Client) QueryMachineByID(ctx context.Context, machineID string) (*ent.Machine, error)

func (*Client) QueryMachinesInactiveSince added in v1.6.3 

func (c *Client) QueryMachinesInactiveSince(ctx context.Context, t time.Time) ([]*ent.Machine, error)

func (*Client) QueryNewDecisionsSinceWithFilters added in v1.1.0 

func (c *Client) QueryNewDecisionsSinceWithFilters(ctx context.Context, since *time.Time, filters map[string][]string) ([]*ent.Decision, error)

func (*Client) QueryPendingMachine added in v1.0.0 

func (c *Client) QueryPendingMachine(ctx context.Context) ([]*ent.Machine, error)

func (*Client) ReleaseLock added in v1.6.1 

func (c *Client) ReleaseLock(ctx context.Context, name string) error

func (*Client) ReleaseLockWithTimeout added in v1.6.1 

func (c *Client) ReleaseLockWithTimeout(ctx context.Context, name string, timeout int) error

func (*Client) ReleasePullCAPILock added in v1.6.1 

func (c *Client) ReleasePullCAPILock(ctx context.Context) error

func (*Client) RemoveFromAllowlist added in v1.6.6 

func (c *Client) RemoveFromAllowlist(ctx context.Context, list *ent.AllowList, values ...string) (int, error)

func (*Client) ReplaceAllowlist added in v1.6.6 

func (c *Client) ReplaceAllowlist(ctx context.Context, list *ent.AllowList, items []*models.AllowlistItem, fromConsole bool) (int, error)

func (*Client) SaveAPICToken added in v1.6.9 

func (c *Client) SaveAPICToken(ctx context.Context, tokenKey string, token string) error

SaveAPICToken stores the given JWT token in the local database under the appropriate config item.

func (*Client) SelectBouncerByName added in v1.4.0 

func (c *Client) SelectBouncerByName(ctx context.Context, bouncerName string) (*ent.Bouncer, error)

func (*Client) SelectBouncerWithIP added in v1.6.5 

func (c *Client) SelectBouncerWithIP(ctx context.Context, apiKeyHash string, clientIP string) (*ent.Bouncer, error)

func (*Client) SelectBouncers added in v1.6.5 

func (c *Client) SelectBouncers(ctx context.Context, apiKeyHash string, authType string) ([]*ent.Bouncer, error)

func (*Client) SetConfigItem added in v1.5.0 

func (c *Client) SetConfigItem(ctx context.Context, key string, value string) error

func (*Client) StartFlushScheduler added in v1.0.0 

func (c *Client) StartFlushScheduler(ctx context.Context, config *csconfig.FlushDBCfg) (*gocron.Scheduler, error)

func (*Client) TotalAlerts added in v1.0.0 

func (c *Client) TotalAlerts(ctx context.Context) (int, error)

func (*Client) UpdateAllowlistMeta added in v1.6.6 

func (c *Client) UpdateAllowlistMeta(ctx context.Context, allowlistID string, name string, description string) error

func (*Client) UpdateBouncerIP added in v1.0.0 

func (c *Client) UpdateBouncerIP(ctx context.Context, ipAddr string, id int) error

func (*Client) UpdateBouncerLastPull added in v1.0.0 

func (c *Client) UpdateBouncerLastPull(ctx context.Context, lastPull time.Time, id int) error

func (*Client) UpdateBouncerTypeAndVersion added in v1.0.0 

func (c *Client) UpdateBouncerTypeAndVersion(ctx context.Context, bType string, version string, id int) error

func (*Client) UpdateCommunityBlocklist added in v1.2.0 

func (c *Client) UpdateCommunityBlocklist(ctx context.Context, alertItem *models.Alert) (int, int, int, error)

UpdateCommunityBlocklist is called to update either the community blocklist (or other lists the user subscribed to) it takes care of creating the new alert with the associated decisions, and it will as well deleted the "older" overlapping decisions: 1st pull, you get decisions [1,2,3]. it inserts [1,2,3] 2nd pull, you get decisions [1,2,3,4]. it inserts [1,2,3,4] and will try to delete [1,2,3,4] with a different alert ID and same origin

func (*Client) UpdateMachineIP added in v1.0.0 

func (c *Client) UpdateMachineIP(ctx context.Context, ipAddr string, id int) error

func (*Client) UpdateMachineLastHeartBeat added in v1.4.0 

func (c *Client) UpdateMachineLastHeartBeat(ctx context.Context, machineID string) error

func (*Client) UpdateMachineScenarios added in v1.0.0 

func (c *Client) UpdateMachineScenarios(ctx context.Context, scenarios string, id int) error

func (*Client) UpdateMachineVersion added in v1.0.0 

func (c *Client) UpdateMachineVersion(ctx context.Context, ipAddr string, id int) error

func (*Client) ValidateMachine added in v1.0.0 

func (c *Client) ValidateMachine(ctx context.Context, machineID string) error

type DecisionsByScenario added in v1.4.0 

type DecisionsByScenario struct {
	Scenario string
	Count    int
	Origin   string
	Type     string
}

type MachineNotFoundError added in v1.6.3 

type MachineNotFoundError struct {
	MachineID string
}

func (*MachineNotFoundError) Error added in v1.6.3 

func (e *MachineNotFoundError) Error() string

Source Files

View all Source files

Directories

Path Synopsis
ent
alert
allowlist
allowlistitem
bouncer
configitem
decision
enttest
event
hook
lock
machine
meta
metric
migrate
predicate
runtime
schema

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.