tapir

type Action uint8

type Api struct {
	Name       string
	Client     *http.Client
	BaseUrl    string
	ApiKey     string
	Authmethod string
	Verbose    bool
	Debug      bool
}

type ApiClient struct {
	BaseUrl    string
	AuthMethod string
	ApiKey     string
	Timeout    int
	ClientName string // ClientName is used to figure out which client cert to use for TLS setup.
	UseTLS     bool
	Verbose    bool
	Debug      bool
	HttpClient *http.Client
}

type BootstrapPost struct {
	Command  string
	ListName string
	Encoding string
}

type BootstrapResponse struct {
	Time   time.Time
	Status string
	Msg    string
	// MsgCounters   map[string]uint32    // map[topic]counter
	// MsgTimeStamps map[string]time.Time // map[topic]timestamp
	TopicData map[string]TopicData
	Error     bool
	ErrorMsg  string
}

type CliFlags struct {
	ShowHdr   bool
	Verbose   bool
	Debug     bool
	UseTLS    bool
	Api       *ApiClient
	PingCount int
	Zone      string
	// TODO cleaner solution:
	// Moved "certname" from slogger.go here so it can know what cert to look
	// for. "certname" was previously declared globally in "root.go", but since
	// the move to the tapir lib, slogger.go no longer sees that variable.
	Certname string
}

type CommandPost struct {
	Command   string
	Zone      string
	Name      string // Domain name to add/remove an RPZ action for
	ListType  string
	ListName  string // used in the export-doubtlist command
	Policy    string // RPZ policy
	Action    string // RPZ action (OBE)
	RpzSource string // corresponds with the sourceid in tem.yaml
}

type CommandResponse struct {
	Time                time.Time
	Status              string
	Zone                string
	Serial              uint32
	Data                []byte
	Msg                 string
	TapirFunctionStatus TapirFunctionStatus
	Error               bool
	ErrorMsg            string
}

type ComponentStatus uint8

type ComponentStatusUpdate struct {
	Status    ComponentStatus
	Function  string // tapir-pop | tapir-edm | ...
	Component string // downstream | rpz | mqtt | config | ...
	Msg       string
	TimeStamp time.Time
	Response  chan StatusUpdaterResponse
}

type Config struct {
	CAFile   string `validate:"existing-file-ro"`
	KeyFile  string `validate:"existing-file-ro"`
	CertFile string `validate:"existing-file-ro"`
}

type DebugPost struct {
	Command   string
	Zone      string
	Qname     string
	Qtype     uint16
	Component string
	Status    ComponentStatus
}

type DebugResponse struct {
	Time   time.Time
	Status string
	Zone   string
	//	ZoneData   ZoneData
	OwnerIndex       map[string]int
	RRset            RRset
	Lists            map[string]map[string]*WBGlist
	Allowlists       map[string]*WBGlist
	Denylists        map[string]*WBGlist
	Doubtlists       map[string]*WBGlist
	DenylistedNames  map[string]bool
	DoubtlistedNames map[string]*TapirName
	RpzOutput        []RpzName
	MqttStats        MqttStats
	TopicData        map[string]TopicData
	ReaperStats      map[string]map[time.Time][]string
	Msg              string
	Error            bool
	ErrorMsg         string
}

type Domain struct {
	Name         string
	TimeAdded    time.Time `json:"time_added"`
	TTL          int       `json:"ttl"`      // in seconds
	TagMask      TagMask   `json:"tag_mask"` // here is the bitfield
	ExtendedTags []string  `json:"extended_tags"`
}

type GlobalConfig struct {
	TapirConfigVersion string
	Rpz                struct {
		EnvelopeSize int // Number of dns.RRs per zone transfer envelope
	}
	Bootstrap struct {
		Servers  []string
		BaseUrl  string
		ApiToken string
	}
	ObservationTopics []GlobalConfigTopic
	StatusTopics      []GlobalConfigTopic
}

type GlobalConfigTopic struct {
	Topic       string // Topic to subscribe (down) or publish (up) on
	PubKeyName  string // Set when sending a validation key, unset otherwise
	PrivKeyName string // Set when sending a signing key, unset otherwise
}

type MqttData struct {
	Topic     string
	Payload   []byte
	Validated bool
}

type MqttDetails struct {
	Topics       []string
	Bootstrap    []string
	BootstrapUrl string
	BootstrapKey string
}

type MqttEngine struct {
	Running           bool
	Creator           string
	ClientID          string
	Server            string
	QoS               int
	ConnectionManager *autopaho.ConnectionManager
	ClientCert        tls.Certificate
	CaCertPool        *x509.CertPool
	MsgChan           chan paho.PublishReceived
	CmdChan           chan MqttEngineCmd
	PublishChan       chan MqttPkgOut
	SubscribeChan     chan MqttPkgIn
	DataMu            sync.Mutex
	TopicData         map[string]TopicData // map[topic]TopicData
	PrefixTopics      map[string]bool      // eg. "pubkey/up/" is a prefix topic if we subscribe to pubkey/up/#
	CanPublish        bool                 // can publish to all topics
	CanSubscribe      bool                 // can subscribe to all topics
	Logger            *log.Logger
	Cancel            context.CancelFunc
	Keystore          jwk.Set
}

type MqttEngineCmd struct {
	Cmd  string
	Resp chan MqttEngineResponse
}

type MqttEngineResponse struct {
	Status   string
	Error    bool
	ErrorMsg string
}

type MqttPkgIn struct {
	Type     string // text | data, only used on sender side
	Error    bool   // only used for sub.
	ErrorMsg string // only used for sub.
	Msg      string
	Topic    string // topic on which this message arrived
	Retain   bool
	//	Data      TapirMsg
	//	RawData   interface{} // outgoing data, an unparsed struct
	Payload   []byte // incoming data, as received from the network
	Validated bool
	TimeStamp time.Time // time mqtt packet was sent or received, mgmt by MQTT Engine
}

type MqttPkgOut struct {
	Type      string // text | data, only used on sender side
	Error     bool   // only used for sub.
	ErrorMsg  string // only used for sub.
	Msg       string
	Topic     string // topic on which this message arrived
	Retain    bool
	Data      TapirMsg
	RawData   interface{} // outgoing data, an unparsed struct
	TimeStamp time.Time   // time mqtt packet was sent or received, mgmt by MQTT Engine
}

type MqttStats struct {
	MsgCounters   map[string]uint32
	MsgTimeStamps map[string]time.Time
}

type OwnerData struct {
	Name    string
	RRtypes map[uint16]RRset
}

type Owners []OwnerData

type PingPost struct {
	Msg   string
	Pings int
}

type PingResponse struct {
	Time       time.Time
	BootTime   time.Time
	Daemon     string
	ServerHost string
	Version    string
	Client     string
	Msg        string
	Pings      int
	Pongs      int
}

type PubKeyUpload struct {
	JWSMessage    string
	Signature     string
	ClientCertPEM string
}

type RRArray []dns.RR

type RRset struct {
	RRs []dns.RR
}

type RpzName struct {
	Name   string
	RR     *dns.RR
	Action Action
}

type ShowAPIresponse struct {
	Status int
	Msg    string
	Data   []string
}

type SimpleConfig struct {
	CAFile string `validate:"existing-file-ro"`
}

type SloggerCmdPost struct {
	Command string
}

type SloggerCmdResponse struct {
	Time time.Time
	// TapirFunctionStatus TapirFunctionStatus
	PopStatus map[string]TapirFunctionStatus
	EdmStatus map[string]TapirFunctionStatus
	Msg       string
	Error     bool
	ErrorMsg  string
}

type StatusUpdaterResponse struct {
	FunctionStatus  TapirFunctionStatus
	KnownComponents []string
	Msg             string
	Error           bool
	ErrorMsg        string
}

type TagMask uint32

type TapirComponentStatus struct {
	Component   string
	Status      ComponentStatus
	ErrorMsg    string
	WarningMsg  string
	Msg         string
	NumFails    int
	NumWarnings int
	LastFail    time.Time
	LastWarn    time.Time
	LastSuccess time.Time
}

type TapirFunctionStatus struct {
	Function        string // tapir-pop | tapir-edm | ...
	FunctionID      string
	ComponentStatus map[string]TapirComponentStatus // downstreamnotify | downstreamixfr | rpzupdate | mqttmsg | config | ...
	NumFailures     int
	LastFailure     time.Time
}

type TapirMsg struct {
	SrcName  string   `json:"src_name"`  // must match a defined source
	Creator  string   `json:"creator"`   // "spark"	|| "tapir-cli"
	MsgType  string   `json:"msg_type"`  // "observation", "reset", "global-config"...
	ListType string   `json:"list_type"` // "{allow|deny|doubt}list"
	Added    []Domain `json:"added"`
	Removed  []Domain `json:"removed"`
	Msg      string   `json:"msg"`
	//	GlobalConfig        GlobalConfig
	//	TapirFunctionStatus TapirFunctionStatus
	TimeStamp time.Time `json:"timestamp"` // time encoded in the payload by the sender, not touched by MQTT
	TimeStr   string    `json:"time_str"`  // time string encoded in the payload by the sender, not touched by MQTT
}

type TapirName struct {
	//	SrcFormat string          // "tapir-feed-v1" | ...
	Name      string
	TimeAdded time.Time
	TTL       time.Duration
	// Tags    []string // XXX: extremely wasteful, a bitfield would be better,
	TagMask TagMask // bitfield
	NumTags uint8
	//      but don't know how many tags there can be
	Action Action // bitfield NXDOMAIN|NODATA|DROP|...
}

type TapirPubKey struct {
	Pubkey string
}

type TopicData struct {
	Topic        string // topic must be in the TopicData, because sometimes we change it, and we need to keep the TopicData entry.
	SigningKey   *ecdsa.PrivateKey
	Sign         bool
	Validate     bool   // should incoming messages be validated by the validator key?
	PubMode      string // "raw" indicates that the data should just be passed through untouched
	SubMode      string // "raw" indicates that the data should just be passed through untouched
	SubscriberCh chan MqttPkgIn
	PubMsgs      uint32
	SubMsgs      uint32
	LatestPub    time.Time
	LatestSub    time.Time
}

type WBGlist struct {
	Name        string
	Description string
	Type        string // allowlist | denylist | doubtlist
	Immutable   bool   // true = won't be updated by globalconfig topic.
	SrcFormat   string // Format of external source: dawg | rpz | tapir-mqtt-v1 | ...
	Format      string // Format of internal storage: dawg | map | slice | trie | rbtree | ...
	Datasource  string // file | xfr | mqtt | https | api | ...
	Filename    string
	Upstream    string
	Dawgf       dawg.Finder
	MqttDetails *MqttDetails

	// doubtlist sources needs more complex stuff here:
	//	DoubtNames   map[string]DoubtName
	RpzZoneName string
	RpzUpstream string
	RpzSerial   int
	Names       map[string]TapirName // XXX: same data as in ZoneData.RpzData, should only keep one
	ReaperData  map[time.Time]map[string]bool
}

type ZoneData struct {
	ZoneName   string
	ZoneType   ZoneType // 1 = "xfr", 2 = "map", 3 = "slice". An xfr zone only supports xfr related ops
	Owners     Owners
	OwnerIndex map[string]int
	ApexLen    int // # RRs that are stored separately
	SOA        dns.SOA
	NSrrs      []dns.RR // apex NS RRs

	// Rest of zone
	BodyRRs RRArray
	RRs     RRArray // BodyRRs + ApexRRs

	// Data		map[string]map[uint16][]dns.RR	// map[owner]map[rrtype][]dns.RR
	Data   map[string]OwnerData // map[owner]map[rrtype][]dns.RR
	RpzMap map[string]*RpzName  // map[owner]map[rrtype][]dns.RR

	// Other stuff
	DroppedRRs     int
	KeptRRs        int
	XfrType        string // axfr | ixfr
	Logger         *log.Logger
	IncomingSerial uint32
	//	RRKeepFunc     func(uint16) bool
	RRParseFunc func(*dns.RR, *ZoneData) bool
	Verbose     bool
	Debug       bool
}

type ZoneType uint8