config

Documentation

Index

• Constants
• Variables
• func CalcAppDataDir() string
• func ImportConfig(data []byte, directory string) error
• func IsDevVersion() bool
• func VersionFromUserAgent(userAgent string) string
• type BlockedPeer
• type Config
  • func LoadConfig(bus awlevent.Bus) (*Config, error)
  • func NewConfig(bus awlevent.Bus) *Config
  • func (c *Config) DNSNamesMapping() map[string]string
  • func (c *Config) DataDir() string
  • func (c *Config) DevMode() bool
  • func (c *Config) Export() []byte
  • func (c *Config) GenUniqPeerAlias(name, alias string) string
  • func (c *Config) GenerateNextIpAddr() string
  • func (c *Config) GetBlockedPeer(peerID string) (BlockedPeer, bool)
  • func (c *Config) GetBootstrapPeers() []peer.AddrInfo
  • func (c *Config) GetListenAddresses() []multiaddr.Multiaddr
  • func (c *Config) GetPeer(peerID string) (KnownPeer, bool)
  • func (c *Config) IsUniqPeerAlias(alias string) bool
  • func (c *Config) KnownPeersIds() []peer.ID
  • func (c *Config) LogLevel() zapcore.Level
  • func (c *Config) PeerstoreDir() string
  • func (c *Config) PrivKey() []byte
  • func (c *Config) RemoveBlockedPeer(peerID string)
  • func (c *Config) RemovePeer(peerID string) (KnownPeer, bool)
  • func (c *Config) Save()
  • func (c *Config) SetIdentity(key crypto.PrivKey, id peer.ID)
  • func (c *Config) SetListenAddresses(multiaddrs []multiaddr.Multiaddr)
  • func (c *Config) UpdatePeerLastSeen(peerID string)
  • func (c *Config) UpsertBlockedPeer(peerID, displayName string)
  • func (c *Config) UpsertPeer(peer KnownPeer)
  • func (c *Config) VPNLocalIPMask() (net.IP, net.IPMask)
• type KnownPeer
  • func (kp KnownPeer) DisplayName() string
  • func (kp KnownPeer) PeerId() peer.ID
• type P2pNodeConfig
• type UpdateConfig
• type VPNConfig

Constants

const (
	AppConfigFilename         = "config_awl.json"
	AppDataDirectory          = "anywherelan"
	DhtPeerstoreDataDirectory = "peerstore"
	AppDataDirEnvKey          = "AWL_DATA_DIR"

	// TODO 8989 maybe?
	DefaultHTTPPort      = 8639
	HttpServerDomainName = "admin"

	DefaultPeerAlias = "peer"
)

const DevVersion = "dev"

Variables

var (
	Version         = DevVersion
	UserAgent       = UserAgentPrefix + Version
	UserAgentPrefix = "awl/"
)

var DefaultBootstrapPeers []multiaddr.Multiaddr

Functions

func CalcAppDataDir

func CalcAppDataDir() string

func ImportConfig

func ImportConfig(data []byte, directory string) error

func IsDevVersion

func IsDevVersion() bool

IsDevVersion Possible duplicate of *Config.DevMode() Based on build version (unchangeable after build, could be used only by developers)

func VersionFromUserAgent

func VersionFromUserAgent(userAgent string) string

Types

type BlockedPeer

type BlockedPeer struct {
	// Hex-encoded multihash representing a peer ID
	PeerID      string `json:"peerId"`
	DisplayName string `json:"displayName"`
	// Time of adding to config (decline invitation/remove from KnownPeers)
	CreatedAt time.Time `json:"createdAt"`
}

type Config

type Config struct {
	sync.RWMutex `swaggerignore:"true"`

	Version           string                 `json:"version"`
	LoggerLevel       string                 `json:"loggerLevel"`
	HttpListenAddress string                 `json:"httpListenAddress"`
	P2pNode           P2pNodeConfig          `json:"p2pNode"`
	VPNConfig         VPNConfig              `json:"vpn"`
	KnownPeers        map[string]KnownPeer   `json:"knownPeers"`
	BlockedPeers      map[string]BlockedPeer `json:"blockedPeers"`
	Update            UpdateConfig           `json:"update"`
	// contains filtered or unexported fields
}

func LoadConfig

func LoadConfig(bus awlevent.Bus) (*Config, error)

func NewConfig

func NewConfig(bus awlevent.Bus) *Config

func (*Config) DNSNamesMapping

func (c *Config) DNSNamesMapping() map[string]string

func (*Config) DataDir

func (c *Config) DataDir() string

func (*Config) DevMode

func (c *Config) DevMode() bool

DevMode Possible duplicate of IsDevVersion() Based on Config.LoggerLevel (could be used by any user)

func (*Config) Export

func (c *Config) Export() []byte

func (*Config) GenUniqPeerAlias

func (c *Config) GenUniqPeerAlias(name, alias string) string

func (*Config) GenerateNextIpAddr

func (c *Config) GenerateNextIpAddr() string

GenerateNextIpAddr is not thread safe.

func (*Config) GetBlockedPeer

func (c *Config) GetBlockedPeer(peerID string) (BlockedPeer, bool)

func (*Config) GetBootstrapPeers

func (c *Config) GetBootstrapPeers() []peer.AddrInfo

func (*Config) GetListenAddresses

func (c *Config) GetListenAddresses() []multiaddr.Multiaddr

func (*Config) GetPeer

func (c *Config) GetPeer(peerID string) (KnownPeer, bool)

func (*Config) IsUniqPeerAlias

func (c *Config) IsUniqPeerAlias(alias string) bool

func (*Config) KnownPeersIds

func (c *Config) KnownPeersIds() []peer.ID

func (*Config) LogLevel

func (c *Config) LogLevel() zapcore.Level

func (*Config) PeerstoreDir

func (c *Config) PeerstoreDir() string

func (*Config) PrivKey

func (c *Config) PrivKey() []byte

func (*Config) RemoveBlockedPeer

func (c *Config) RemoveBlockedPeer(peerID string)

func (*Config) RemovePeer

func (c *Config) RemovePeer(peerID string) (KnownPeer, bool)

func (*Config) Save

func (c *Config) Save()

func (*Config) SetIdentity

func (c *Config) SetIdentity(key crypto.PrivKey, id peer.ID)

func (*Config) SetListenAddresses

func (c *Config) SetListenAddresses(multiaddrs []multiaddr.Multiaddr)

func (*Config) UpdatePeerLastSeen

func (c *Config) UpdatePeerLastSeen(peerID string)

func (*Config) UpsertBlockedPeer

func (c *Config) UpsertBlockedPeer(peerID, displayName string)

func (*Config) UpsertPeer

func (c *Config) UpsertPeer(peer KnownPeer)

func (*Config) VPNLocalIPMask

func (c *Config) VPNLocalIPMask() (net.IP, net.IPMask)

type KnownPeer

type KnownPeer struct {
	// Hex-encoded multihash representing a peer ID
	PeerID string `json:"peerId"`
	// Peer provided name
	Name string `json:"name"`
	// User provided name
	Alias string `json:"alias"`
	// IPAddr used for forwarding
	IPAddr string `json:"ipAddr"`
	// DomainName without zone suffix (.awl)
	DomainName string `json:"domainName"`
	// Time of adding to config (accept/invite)
	CreatedAt time.Time `json:"createdAt"`
	// Time of last connection
	LastSeen time.Time `json:"lastSeen"`
	// Has remote peer confirmed our invitation
	Confirmed bool `json:"confirmed"`
	// Has remote peer declined our invitation
	Declined bool `json:"declined"`
}

func (KnownPeer) DisplayName

func (kp KnownPeer) DisplayName() string

func (KnownPeer) PeerId

func (kp KnownPeer) PeerId() peer.ID

type P2pNodeConfig

type P2pNodeConfig struct {
	// Hex-encoded multihash representing a peer ID, calculated from Identity
	PeerID                  string        `json:"peerId"`
	Name                    string        `json:"name"`
	Identity                string        `json:"identity"`
	BootstrapPeers          []string      `json:"bootstrapPeers"`
	ListenAddresses         []string      `json:"listenAddresses"`
	ReconnectionIntervalSec time.Duration `json:"reconnectionIntervalSec" swaggertype:"primitive,integer"`
	AutoAcceptAuthRequests  bool          `json:"autoAcceptAuthRequests"`
}

type UpdateConfig

type UpdateConfig struct {
	LowestPriorityChan    string `json:"lowestPriorityChan"`
	UpdateServerURL       string `json:"updateServerURL"`
	TrayAutoCheckEnabled  bool   `json:"trayAutoCheckEnabled"`
	TrayAutoCheckInterval string `json:"trayAutoCheckInterval"`
}

type VPNConfig

type VPNConfig struct {
	InterfaceName string `json:"interfaceName"`
	IPNet         string `json:"ipNet"`
}