phantoms

Documentation

Index

• func GetDefaultPhantomSubnets() *pb.PhantomSubnetsList
• func GetUnweightedSubnetList(subnetsList *pb.PhantomSubnetsList) ([]*phantomNet, error)
• func V4Only(obj []*phantomNet) ([]*phantomNet, error)
• func V6Only(obj []*phantomNet) ([]*phantomNet, error)
• type PhantomIP
  • func SelectAddrFromSubnetOffset(net1 *phantomNet, offset *big.Int) (*PhantomIP, error)
  • func SelectPhantom(seed []byte, subnetsList *pb.PhantomSubnetsList, transform SubnetFilter, ...) (*PhantomIP, error)
  • func SelectPhantomUnweighted(seed []byte, subnets *pb.PhantomSubnetsList, transform SubnetFilter) (*PhantomIP, error)
  • func SelectPhantomWeighted(seed []byte, subnets *pb.PhantomSubnetsList, transform SubnetFilter) (*PhantomIP, error)
  • func (p *PhantomIP) IP() *net.IP
  • func (p *PhantomIP) SupportRandomPort() bool
• type SubnetFilter

Functions

func GetDefaultPhantomSubnets

func GetDefaultPhantomSubnets() *pb.PhantomSubnetsList

GetDefaultPhantomSubnets implements the

func GetUnweightedSubnetList

func GetUnweightedSubnetList(subnetsList *pb.PhantomSubnetsList) ([]*phantomNet, error)

GetUnweightedSubnetList returns the list of subnets provided by the protobuf. Convenience function to not have to export getSubnets() or parseSubnets()

func V4Only

func V4Only(obj []*phantomNet) ([]*phantomNet, error)

V4Only - a functor for transforming the subnet list to only include IPv4 subnets

func V6Only

func V6Only(obj []*phantomNet) ([]*phantomNet, error)

V6Only - a functor for transforming the subnet list to only include IPv6 subnets

Types

type PhantomIP

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

func SelectAddrFromSubnetOffset

func SelectAddrFromSubnetOffset(net1 *phantomNet, offset *big.Int) (*PhantomIP, error)

SelectAddrFromSubnetOffset given a CIDR block and offset, return the net.IP

func SelectPhantom

func SelectPhantom(seed []byte, subnetsList *pb.PhantomSubnetsList, transform SubnetFilter, weighted bool) (*PhantomIP, error)

SelectPhantom - select one phantom IP address based on shared secret

func SelectPhantomUnweighted

func SelectPhantomUnweighted(seed []byte, subnets *pb.PhantomSubnetsList, transform SubnetFilter) (*PhantomIP, error)

SelectPhantomUnweighted - select one phantom IP address based on shared secret

func SelectPhantomWeighted

func SelectPhantomWeighted(seed []byte, subnets *pb.PhantomSubnetsList, transform SubnetFilter) (*PhantomIP, error)

SelectPhantomWeighted - select one phantom IP address based on shared secret

func (*PhantomIP) IP

func (p *PhantomIP) IP() *net.IP

func (*PhantomIP) SupportRandomPort

func (p *PhantomIP) SupportRandomPort() bool

type SubnetFilter

type SubnetFilter func([]*phantomNet) ([]*phantomNet, error)

SubnetFilter - Filter IP subnets based on whatever to prevent specific subnets from

inclusion in choice. See v4Only and v6Only for reference.