pinhole

Documentation

Overview

Package pinhole provides networkservice.NetworkService{Client,Server} chain elements for ensuring remote mechanism packets get through any ACLs

Code generated by "-output tunnel_ip_map.gen.go -type ipPortMap<IPPort,struct{}> -output tunnel_ip_map.gen.go -type ipPortMap<IPPort,struct{}>"; DO NOT EDIT.

Index

• func DeleteExtra(ctx context.Context, isClient bool)
• func NewClient(vppConn api.Connection, opts ...Option) networkservice.NetworkServiceClient
• func NewServer(vppConn api.Connection, opts ...Option) networkservice.NetworkServiceServer
• func StoreExtra(ctx context.Context, isClient bool, ipPort *IPPort)
• type IPPort
  • func LoadExtra(ctx context.Context, isClient bool) (value *IPPort, ok bool)
  • func NewIPPort(ip string, port uint16) *IPPort
  • func (i *IPPort) IP() net.IP
  • func (i *IPPort) Port() uint16
• type Option
  • func WithSharedMutex(mutex *sync.Mutex) Option

Functions

func DeleteExtra

func DeleteExtra(ctx context.Context, isClient bool)

DeleteExtra deletes an extra IPPort stored in per Connection.Id metadata

func NewClient

func NewClient(vppConn api.Connection, opts ...Option) networkservice.NetworkServiceClient

NewClient - returns a new client that will set an ACL permitting remote protocols packets through if and only if there's an ACL on the interface

func NewServer

func NewServer(vppConn api.Connection, opts ...Option) networkservice.NetworkServiceServer

NewServer - returns a new client that will set an ACL permitting remote protocols packets through if and only if there's an ACL on the interface

func StoreExtra

func StoreExtra(ctx context.Context, isClient bool, ipPort *IPPort)

StoreExtra sets an extra IPPort stored in per Connection.Id metadata.

Types

type IPPort

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

IPPort stores IP and port for an ACL rule

func LoadExtra

func LoadExtra(ctx context.Context, isClient bool) (value *IPPort, ok bool)

LoadExtra returns an extra IPPort stored in per Connection.Id metadata, or nil if no value is present. The ok result indicates whether value was found in the per Connection.Id metadata.

func NewIPPort

func NewIPPort(ip string, port uint16) *IPPort

NewIPPort returns *IPPort entry

func (*IPPort) IP

func (i *IPPort) IP() net.IP

IP - converts string to net.IP

func (*IPPort) Port

func (i *IPPort) Port() uint16

Port - returns port

type Option

type Option func(*option)

Option - options for the pinhole chain element

func WithSharedMutex

func WithSharedMutex(mutex *sync.Mutex) Option

WithSharedMutex - set shared mutex between client and server chain elements. This is necessary because the pinhole chain element dumps VPP, performs some manipulations and reassign ACL rules. Possible data race.