bird

Documentation

Overview

Package bird can lookup IP prefixes and autonomous system numbers and add them to flows in case the routers implementation doesn't support this, e.g. ipt-NETFLOW

Index

• type Annotator
  • func NewAnnotator(sock string, sock6 string, debug int) *Annotator
  • func (a *Annotator) Augment(fl *netflow.Flow)
• type Query
• type QueryCache
  • func (qc *QueryCache) Get(addr []byte) *QueryResult
  • func (qc *QueryCache) Set(addr []byte, qres *QueryResult)
• type QueryResult

Types

type Annotator

type Annotator struct {
	// contains filtered or unexported fields
}

Annotator represents a BIRD based BGP annotator

func NewAnnotator

func NewAnnotator(sock string, sock6 string, debug int) *Annotator

NewAnnotator creates a new BIRD annotator and get's service started

func (*Annotator) Augment

func (a *Annotator) Augment(fl *netflow.Flow)

Augment function provides the main interface to the external world to consume service of this module

type Query

type Query struct {
	// contains filtered or unexported fields
}

Query represents a query to BIRD and encapsulates it with a channel where it's result is expected

type QueryCache

type QueryCache struct {
	// contains filtered or unexported fields
}

QueryCache represents a set of QueryResults that have been cached

func (*QueryCache) Get

func (qc *QueryCache) Get(addr []byte) *QueryResult

Get tries to receive an entry from QueryCache `qc`

func (*QueryCache) Set

func (qc *QueryCache) Set(addr []byte, qres *QueryResult)

Set sets data for `addr` in QueryCache `qc` to `qres`

type QueryResult

type QueryResult struct {
	// Pfx is the prefix that is being used to forward packets for the IP
	// address from the query
	Pfx net.IPNet

	// As is the ASN that the subject IP is announced by
	AS uint32

	// NhAs is the ASN of the subject IPs associated Next Hop
	NHAS uint32
}

QueryResult carries all useful information we extracted from a BIRD querys result