firewall

Documentation

Index

• Constants
• Variables
• func AnyApplicationPolicy(applications []Application, allowList *AllowList) net.Firewall
• type AllowList
  • func NewAllowList(operatorPublicKeys []*operator.PublicKey) *AllowList
  • func (al *AllowList) Contains(operatorPublicKey *operator.PublicKey) bool
• type Application

Constants

const (
	// PositiveIsRecognizedCachePeriod is the time period the cache maintains
	// the positive result of the last `IsRecognized` checks.
	// We use the cache to minimize calls to the on-chain client.
	PositiveIsRecognizedCachePeriod = 12 * time.Hour

	// NegativeIsRecognizedCachePeriod is the time period the cache maintains
	// the negative result of the last `IsRecognized` checks.
	// We use the cache to minimize calls to the on-chain client.
	NegativeIsRecognizedCachePeriod = 1 * time.Hour
)

Variables

var Disabled = &noFirewall{}

Disabled is an empty Firewall implementation enforcing no rules on the connection.

var EmptyAllowList = NewAllowList([]*operator.PublicKey{})

EmptyAllowList represents an empty firewall allowlist.

Functions

func AnyApplicationPolicy

func AnyApplicationPolicy(
	applications []Application,
	allowList *AllowList,
) net.Firewall

Types

type AllowList

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

AllowList represents a list of operator public keys that are not checked against the firewall rules and are always valid peers.

func NewAllowList

func NewAllowList(operatorPublicKeys []*operator.PublicKey) *AllowList

NewAllowList creates a new firewall's allowlist based on the given public key list.

func (*AllowList) Contains

func (al *AllowList) Contains(operatorPublicKey *operator.PublicKey) bool

type Application

type Application interface {
	// IsRecognized returns true if the application recognizes the operator
	// as one participating in the application.
	IsRecognized(operatorPublicKey *operator.PublicKey) (bool, error)
}

Application defines functionalities for operator verification in the firewall.