firewall

Documentation

Index

• Variables
• type Config
  • func DefaultConfig() *Config
  • func (conf *Config) BasicCheck() error
• type Firewall
  • func NewFirewall(conf *Config, net network.Network, peerSet *peerset.PeerSet, st state.Facade, ...) (*Firewall, error)
  • func (f *Firewall) AllowBlockRequest() bool
  • func (f *Firewall) AllowConsensusRequest() bool
  • func (f *Firewall) AllowTransactionRequest() bool
  • func (f *Firewall) IsBannedAddress(remoteAddr string) bool
  • func (f *Firewall) OpenGossipBundle(data []byte, from peer.ID) (*bundle.Bundle, error)
  • func (f *Firewall) OpenStreamBundle(r io.Reader, from peer.ID) (*bundle.Bundle, error)
• type PeerBannedError
  • func (e PeerBannedError) Error() string
• type RateLimit

Variables

var ErrGossipMessage = errors.New("receive stream message as gossip message")

ErrGossipMessage is returned when a stream message sends as gossip message.

var ErrStreamMessage = errors.New("receive gossip message as stream message")

ErrStreamMessage is returned when a gossip message sends as stream message.

Types

type Config

type Config struct {
	BannedNets []string  `toml:"banned_nets"`
	RateLimit  RateLimit `toml:"rate_limit"`
}

func DefaultConfig

func DefaultConfig() *Config

func (*Config) BasicCheck

func (conf *Config) BasicCheck() error

BasicCheck performs basic checks on the configuration.

type Firewall

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

Firewall check packets before passing them to sync module.

func NewFirewall

func NewFirewall(conf *Config, net network.Network, peerSet *peerset.PeerSet, st state.Facade,
	log *logger.SubLogger,
) (*Firewall, error)

func (*Firewall) AllowBlockRequest

func (f *Firewall) AllowBlockRequest() bool

func (*Firewall) AllowConsensusRequest

func (f *Firewall) AllowConsensusRequest() bool

func (*Firewall) AllowTransactionRequest

func (f *Firewall) AllowTransactionRequest() bool

func (*Firewall) IsBannedAddress

func (f *Firewall) IsBannedAddress(remoteAddr string) bool

IsBannedAddress checks if the remote IP address is banned.

func (*Firewall) OpenGossipBundle

func (f *Firewall) OpenGossipBundle(data []byte, from peer.ID) (*bundle.Bundle, error)

func (*Firewall) OpenStreamBundle

func (f *Firewall) OpenStreamBundle(r io.Reader, from peer.ID) (*bundle.Bundle, error)

type PeerBannedError

type PeerBannedError struct {
	PeerID  lp2pcore.PeerID
	Address string
}

PeerBannedError is returned when a message received from a banned peer-id or banned address.

func (PeerBannedError) Error

func (e PeerBannedError) Error() string

type RateLimit

type RateLimit struct {
	BlockTopic       int `toml:"block_topic"`
	TransactionTopic int `toml:"transaction_topic"`
	ConsensusTopic   int `toml:"consensus_topic"`
}