qlog

Documentation

Index

• func CacheMulticastMessages(cache *gocache.Cache, msgChan chan *dns.Msg)
• func MulticastMdnsListen(msgChan chan *dns.Msg)
• func MulticastMdnsQuery()
• func ParseMulticastMessage(msg *dns.Msg) map[string]string
• func ReadCachedHostname(cache *gocache.Cache, address string) string
• type LogInfo
• type QLog
  • func New(conf *config.GudgeonConfig) (QLog, error)
  • func NewWithReverseLookup(conf *config.GudgeonConfig, rlookup ReverseLookupFunction) (QLog, error)
• type QueryLogQuery
• type ReverseLookupFunction

Functions

func CacheMulticastMessages

func CacheMulticastMessages(cache *gocache.Cache, msgChan chan *dns.Msg)

func MulticastMdnsListen

func MulticastMdnsListen(msgChan chan *dns.Msg)

func MulticastMdnsQuery

func MulticastMdnsQuery()

func ParseMulticastMessage

func ParseMulticastMessage(msg *dns.Msg) map[string]string

func ReadCachedHostname

func ReadCachedHostname(cache *gocache.Cache, address string) string

Types

type LogInfo

type LogInfo struct {
	// client address
	Address string

	// hold the information but aren't serialized
	Request        *dns.Msg                   `json:"-"`
	Response       *dns.Msg                   `json:"-"`
	Result         *resolver.ResolutionResult `json:"-"`
	RequestContext *resolver.RequestContext   `json:"-"`

	// generated/calculated values
	Consumer       string
	ClientName     string
	ConnectionType string
	RequestDomain  string
	RequestType    string
	ResponseText   string
	// hard consumer blocked
	Blocked bool
	// matching
	Match     rule.Match
	MatchList string
	MatchRule string
	// cached in resolver cache store
	Cached bool
	// when this log record was created
	// todo: add when it was received and when it was completed
	//       through the context so we can compute a delta
	Created time.Time
}

info passed over channel and stored in database and that is recovered via the Query method

type QLog

type QLog interface {
	Query(query *QueryLogQuery) ([]*LogInfo, uint64)
	Log(address *net.IP, request *dns.Msg, response *dns.Msg, rCon *resolver.RequestContext, result *resolver.ResolutionResult)
	Stop()
}

public interface

func New

func New(conf *config.GudgeonConfig) (QLog, error)

create a new query log according to configuration

func NewWithReverseLookup

func NewWithReverseLookup(conf *config.GudgeonConfig, rlookup ReverseLookupFunction) (QLog, error)

type QueryLogQuery

type QueryLogQuery struct {
	// query on fields
	Address        string
	ClientName     string
	ConnectionType string
	RequestDomain  string
	RequestType    string
	ResponseText   string
	Blocked        *bool
	Cached         *bool
	Match          *rule.Match
	// query on created time
	After  *time.Time
	Before *time.Time
	// query limits for paging
	Skip  int
	Limit int
	// query sort
	SortBy    string
	Direction string
}

the type that is used to make queries against the query log (should be used by the web interface to find queries)

type ReverseLookupFunction

type ReverseLookupFunction = func(addres string) string

allows a dependency injection-way of defining a reverse lookup function, takes a string address (should be an IP) and returns a string that contains the domain name result