Package tracker

import "airdispat.ch/tracker"

Overview
Index
Subdirectories

Overview

The Airdispatch Tracker framework is a cheap and insecure implementation of the AirDispatch routing framework. It will be used for cheap creation of insecure addresses.

Index

Constants
func GetTrackingServerLocationFromURL(url string) string
type BasicTracker
func (BasicTracker) AllowConnection(fromAddr *identity.Address) bool
func (BasicTracker) HandleError(err *TrackerError)
func (BasicTracker) LogMessage(toLog ...string)
type ListRouter
func CreateListRouter(redirect RedirectHandler, trackers ...routing.Router) *ListRouter
func CreateListRouterWithStrings(redirect RedirectHandler, currentIdentity *identity.Identity, trackers ...string) *ListRouter
func (a *ListRouter) Lookup(addr string, name routing.LookupType) (*identity.Address, error)
func (a *ListRouter) LookupAlias(alias string, name routing.LookupType) (*identity.Address, error)
func (a *ListRouter) Register(key *identity.Identity, alias string, redirects map[string]routing.Redirect) error
type QueryMessage
func (b *QueryMessage) Header() message.Header
func (b *QueryMessage) ToBytes() []byte
func (b *QueryMessage) Type() string
type RedirectHandler
type RegistrationMessage
func RegistrationMessageFromBytes(b []byte) *RegistrationMessage
func (b *RegistrationMessage) Header() message.Header
func (b *RegistrationMessage) ToBytes() []byte
func (b *RegistrationMessage) Type() string
type Router
func (a *Router) Lookup(addrString string, name routing.LookupType) (*identity.Address, error)
func (a *Router) LookupAlias(alias string, name routing.LookupType) (*identity.Address, error)
func (a *Router) Register(key *identity.Identity, alias string, redirects map[string]routing.Redirect) (err error)
type Tracker
func (t *Tracker) StartServer(port string) error
type TrackerDelegate
type TrackerError

Package files

basic.go doc.go list_router.go messages.go routing.go tracker.go

Constants

const (
    Reset      = "\x1b[0m"
    Bright     = "\x1b[1m"
    Dim        = "\x1b[2m"
    Underscore = "\x1b[4m"
    Blink      = "\x1b[5m"
    Reverse    = "\x1b[7m"
    Hidden     = "\x1b[8m"

    FgBlack   = "\x1b[30m"
    FgRed     = "\x1b[31m"
    FgGreen   = "\x1b[32m"
    FgYellow  = "\x1b[33m"
    FgBlue    = "\x1b[34m"
    FgMagenta = "\x1b[35m"
    FgCyan    = "\x1b[36m"
    FgWhite   = "\x1b[37m"

    BgBlack   = "\x1b[40m"
    BgRed     = "\x1b[41m"
    BgGreen   = "\x1b[42m"
    BgYellow  = "\x1b[43m"
    BgBlue    = "\x1b[44m"
    BgMagenta = "\x1b[45m"
    BgCyan    = "\x1b[46m"
    BgWhite   = "\x1b[47m"
)

func GetTrackingServerLocationFromURL

func GetTrackingServerLocationFromURL(url string) string

GetTrackingServerLocationFromURL will attempt to get information about a tracking server from a DNS SRV Record.

type BasicTracker

type BasicTracker struct {
    TrackerDelegate
}

func (BasicTracker) AllowConnection

func (BasicTracker) AllowConnection(fromAddr *identity.Address) bool

func (BasicTracker) HandleError

func (BasicTracker) HandleError(err *TrackerError)

func (BasicTracker) LogMessage

func (BasicTracker) LogMessage(toLog ...string)

type ListRouter

ListRouter implements the AirDispatch routing.Router interface for a group of Trackers.

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

func CreateListRouter

func CreateListRouter(redirect RedirectHandler, trackers ...routing.Router) *ListRouter

CreateListRouter will return a ListRouter for a slice of currently functioning routers.

func CreateListRouterWithStrings

func CreateListRouterWithStrings(redirect RedirectHandler, currentIdentity *identity.Identity, trackers ...string) *ListRouter

CreateListRouterWithStrings will return a ListRouter with an identity and list of tracker URLS.

func (*ListRouter) Lookup

func (a *ListRouter) Lookup(addr string, name routing.LookupType) (*identity.Address, error)

Lookup will return a new identity.Address for an address fingerprint.

func (*ListRouter) LookupAlias

func (a *ListRouter) LookupAlias(alias string, name routing.LookupType) (*identity.Address, error)

LookupAlias will return a new identity.Address for an alias.

func (*ListRouter) Register

func (a *ListRouter) Register(key *identity.Identity, alias string, redirects map[string]routing.Redirect) error

Register will register an address with a list of trackers.

type QueryMessage

QueryMessage is a struct that represents the protocol buffers representation of querying a tracker.

type QueryMessage struct {
    From    *identity.Identity
    Address string
    Alias   string
}

func (*QueryMessage) Header

func (b *QueryMessage) Header() message.Header

Header will return the message header.

func (*QueryMessage) ToBytes

func (b *QueryMessage) ToBytes() []byte

ToBytes will serialize a QueryMessage to be sent over the wire.

func (*QueryMessage) Type

func (b *QueryMessage) Type() string

Type will return the QueryCode type for this message.

type RedirectHandler

RedirectHandler is to ensure that different implementations can handle redirects differently.

type RedirectHandler interface {
    HandleRedirect(routing.LookupType, routing.Redirect) (*identity.Address, error)
}

type RegistrationMessage

RegistrationMessage is the record that is sent to the Tracker to allow setting up a new record.

type RegistrationMessage struct {
    Address  string
    Location string
    Alias    string
    Redirect map[string]routing.Redirect
    Key      []byte
}

func RegistrationMessageFromBytes

func RegistrationMessageFromBytes(b []byte) *RegistrationMessage

RegistrationMessageFromBytes will deserialize a registration message into an easy to use struct.

func (*RegistrationMessage) Header

func (b *RegistrationMessage) Header() message.Header

Header will return the RegistrationMessage header.

func (*RegistrationMessage) ToBytes

func (b *RegistrationMessage) ToBytes() []byte

ToBytes will serialize a RegistrationMessage to be sent over the wire.

func (*RegistrationMessage) Type

func (b *RegistrationMessage) Type() string

Type will return the type of the message - in this case, RegistrationCode.

type Router

Router implements the AirDispatch routing.Router interface for the tracker system.

type Router struct {
    URL        string
    Origin     *identity.Identity
    Redirector RedirectHandler
}

func (*Router) Lookup

func (a *Router) Lookup(addrString string, name routing.LookupType) (*identity.Address, error)

Lookup will perform a Router lookup on an address, and return a new (*identity).Address.

func (*Router) LookupAlias

func (a *Router) LookupAlias(alias string, name routing.LookupType) (*identity.Address, error)

LookupAlias will perform a Router lookup on a certain alias, and return a new (*identity).Address.

func (*Router) Register

func (a *Router) Register(key *identity.Identity, alias string, redirects map[string]routing.Redirect) (err error)

Register will register an identity (and alias) with a tracker.

type Tracker

The tracker structure that holds variables to the delegate and keypair.

type Tracker struct {
    Key      *identity.Identity
    Delegate TrackerDelegate
}

func (*Tracker) StartServer

func (t *Tracker) StartServer(port string) error

The function that starts the Tracking Server on a Specific Port

type TrackerDelegate

The delegate protocol used to interact with a specific tracker implementation

type TrackerDelegate interface {
    HandleError(err *TrackerError)
    LogMessage(toLog ...string)
    AllowConnection(fromAddr *identity.Address) bool

    SaveRecord(address *identity.Address, record *message.SignedMessage, alias string)

    GetRecordByAddress(address *identity.Address) *message.SignedMessage
    GetRecordByAlias(alias string) *message.SignedMessage
}

type TrackerError

The error Structure used to store all of the errors generated by the tracker framework

type TrackerError struct {
    Location string
    Error    error
}

Subdirectories

Name	Synopsis

tracker
wire

airdispat.ch/tracker

AirDispatch Tracker