database

Documentation

Index

• Constants
• func Delete(v interface{}) error
• func Save(v interface{}) error
• func Setup(config Config) (err error)
• func ToJSONB(v interface{}) datatypes.JSON
• func UpdateAgent(agent *Agent, fields *AgentWritableFields) error
• func VerifyUser(verification string) error
• type Agent
  • func FindAgentByToken(token string) (*Agent, error)
  • func FindAgentsForAlert() ([]*Agent, error)
  • func RegisterAgent(fields *AgentWritableFields) (*Agent, error)
  • func (a *Agent) Save() error
• type AgentWritableFields
  • func (f *AgentWritableFields) Validate() error
• type Config
• type JSONB
  • func (j *JSONB) Scan(value interface{}) error
  • func (j JSONB) Value() (driver.Value, error)
• type User
  • func FindUserByID(id int) (*User, error)
  • func LoginUser(address, email, password string) (*User, error)
  • func RegisterUser(address, email, password string) (*User, error)
  • func UpdateUser(user *User, ip string, newPassword string, use2FA bool) (*User, error)

Constants

const MaxAgentRules = 100

const MaxAlertAfter = 21600 // 6 hours

const MaxAlertPeriod = 10800 // 3 hours

const MinAgentNameLength = 3

const MinAlertAfter = 30 // 30 seconds

const MinAlertPeriod = 1800 // 30 minutes

const MinPasswordLength = 8

Functions

func Delete

func Delete(v interface{}) error

func Save

func Save(v interface{}) error

func Setup

func Setup(config Config) (err error)

func ToJSONB

func ToJSONB(v interface{}) datatypes.JSON

func UpdateAgent

func UpdateAgent(agent *Agent, fields *AgentWritableFields) error

func VerifyUser

func VerifyUser(verification string) error

Types

type Agent

type Agent struct {
	ID          uint           `gorm:"primarykey" json:"id"`
	CreatedAt   time.Time      `gorm:"index" json:"created_at"`
	UpdatedAt   time.Time      `gorm:"index" json:"updated_at"`
	SeenAt      time.Time      `gorm:"index" json:"seen_at"`
	DeletedAt   gorm.DeletedAt `gorm:"index" json:"-"`
	UserID      uint           `gorm:"index" json:"-"`
	AlertAfter  uint           `gorm:"index" json:"alert_after"`
	AlertPeriod uint           `gorm:"index" json:"alert_period"`
	AlertAt     time.Time      `gorm:"index" json:"alert_at"`
	Name        string         `json:"name"`
	Rules       datatypes.JSON `sql:"type:jsonb" json:"rules"`
	Token       string         `gorm:"index" json:"token"`
	Address     string         `json:"address"`
	UserAgent   string         `json:"user_agent"`
}

func FindAgentByToken

func FindAgentByToken(token string) (*Agent, error)

func FindAgentsForAlert

func FindAgentsForAlert() ([]*Agent, error)

func RegisterAgent

func RegisterAgent(fields *AgentWritableFields) (*Agent, error)

func (*Agent) Save

func (a *Agent) Save() error

type AgentWritableFields

type AgentWritableFields struct {
	ID          uint
	Name        string
	Rules       []*firewall.Rule
	User        *User
	AlertAfter  uint
	AlertPeriod uint
}

func (*AgentWritableFields) Validate

func (f *AgentWritableFields) Validate() error

type Config

type Config struct {
	Hostname string `yaml:"host"`
	Port     int    `yaml:"port"`
	User     string `yaml:"user"`
	Password string `yaml:"password"`
	Name     string `yaml:"name"`
}

type JSONB

type JSONB map[string]interface{}

func (*JSONB) Scan

func (j *JSONB) Scan(value interface{}) error

func (JSONB) Value

func (j JSONB) Value() (driver.Value, error)

type User

type User struct {
	ID           uint           `gorm:"primarykey" json:"-""`
	CreatedAt    time.Time      `gorm:"index" json:"created_at"`
	UpdatedAt    time.Time      `gorm:"index" json:"updated_at"`
	DeletedAt    gorm.DeletedAt `gorm:"index" json:"-"`
	Email        string         `gorm:"uniqueIndex" json:"email"`
	Verification string         `gorm:"index" json:"-"`
	Verified     bool           `gorm:"index" json:"-"`
	Use2FA       bool           `gorm:"default:true" json:"use_2fa"` // i know it's not 2fa yet
	Hash         string         `json:"-"`
	Address      string         `json:"address"`
	Agents       []Agent        `json:"-"`
}

func FindUserByID

func FindUserByID(id int) (*User, error)

func LoginUser

func LoginUser(address, email, password string) (*User, error)

func RegisterUser

func RegisterUser(address, email, password string) (*User, error)

func UpdateUser

func UpdateUser(user *User, ip string, newPassword string, use2FA bool) (*User, error)