util

Documentation

Index

• Constants
• func AddChains(table string, expected map[string][][]string) error
• func CheckChainsExist(table string, expected map[string][][]string) bool
• func DNATRuleSpec(dstIP, srcIP, dPort, destinationIP, destinationPort string) []string
• func DirectTCPIPHandler(srv *glssh.Server, conn *ssh.ServerConn, newChan ssh.NewChannel, ...)
• func GetHexIP(ip string) (string, error)
• func GetRuleName(ip string) (string, error)
• func IsPortOpen(ip, port string) bool
• func NewSSHServer(addr string) glssh.Server
• func ReplaceChains(table string, expected map[string][][]string) error
• func RuleSyncingCondition(stat corev1.ConditionStatus) status.Condition
• func RuleUpdatingCondition(stat corev1.ConditionStatus) status.Condition
• func SNATRuleSpec(dstIP, srcIP, dPort string) []string
• type Controller
  • func NewController(cl clv1alpha1.SubmarinerV1alpha1Interface, ...) *Controller
  • func (c *Controller) Run()
• type ReconcilerInterface
• type Tunnel
  • func NewTunnel(local, server, remote string, config *ssh.ClientConfig) *Tunnel
  • func (t *Tunnel) Forward() error
  • func (t *Tunnel) ForwardNB()
  • func (t *Tunnel) RemoteForward() error
  • func (t *Tunnel) RemoteForwardNB()
  • func (t *Tunnel) String() string

Constants

const (
	// TableNAT represents nat table in iptables
	TableNAT = "nat"
	// ChainPrerouting represents PREROUTING chain in iptables
	ChainPrerouting = "PREROUTING"
	// ChainPostrouting represents POSTROUTING chain in iptables
	ChainPostrouting = "POSTROUTING"
)

const (

	// MinPort is the smallest port number that can be used by forwarder pod
	MinPort = 2049
	// MaxPort is the biggest port number that can be used by forwarder pod
	MaxPort = 65536
)

const (
	// SSHPort is port number to used for ssh server
	// TODO: change this to variable
	SSHPort = "2022"
)

Functions

func AddChains

func AddChains(table string, expected map[string][][]string) error

AddChains adds {expected} rules in {table}. Existing ruleSpec in the chains won't be deleted. It returns error if there are any error on adding chains. {expected} is passed as a map of chain name to slice of ruleSpec. ex) to specify "-j pre1" and "-j pre2" in "PREROUTING" chain

map[string][][]string{"PREROUTING": [][]string{{"-j", "pre1"}, {"-j", "pre2"}}}

func CheckChainsExist

func CheckChainsExist(table string, expected map[string][][]string) bool

CheckChainsExist checks if all {expected} rules exist in {table}. It returns error if it fails to find any expected rules or there's error in checking {expected} is passed as a map of chain name to slice of ruleSpec. ex) to specify "-j pre1" and "-j pre2" in "PREROUTING" chain

map[string][][]string{"PREROUTING": [][]string{{"-j", "pre1"}, {"-j", "pre2"}}}

func DNATRuleSpec

func DNATRuleSpec(dstIP, srcIP, dPort, destinationIP, destinationPort string) []string

DNATRuleSpec returns ruleSpec to DNAT for the given arguments

func DirectTCPIPHandler

func DirectTCPIPHandler(srv *glssh.Server, conn *ssh.ServerConn, newChan ssh.NewChannel, ctx glssh.Context)

DirectTCPIPHandler is a handler for direct-tcpip. This is modified from gliderlabs original one so that it can reserve source ip.

func GetHexIP

func GetHexIP(ip string) (string, error)

GetHexIP returns hex expression of IP address ex) 192.168.122.1 -> c0a87a01

func GetRuleName

func GetRuleName(ip string) (string, error)

GetRuleName returns configmap name for gateway which has ip ex) 192.168.122.1 -> gwrulec0a87a01

func IsPortOpen

func IsPortOpen(ip, port string) bool

IsPortOpen checks if ip:port is open by connecting to it It returns false if there is an error connecting to it or connection is nil, otherwise it returns true.

func NewSSHServer

func NewSSHServer(addr string) glssh.Server

NewSSHServer returns ssh server instance that will listen on {addr}

func ReplaceChains

func ReplaceChains(table string, expected map[string][][]string) error

ReplaceChains replaces rules in {table} to {expected}. Existing rules in the chains will be deleted. It returns error if there are any error on replacing chains. {expected} is passed as a map of chain name to slice of ruleSpec. ex) to specify "-j pre1" and "-j pre2" in "PREROUTING" chain

map[string][][]string{"PREROUTING": [][]string{{"-j", "pre1"}, {"-j", "pre2"}}}

func RuleSyncingCondition

func RuleSyncingCondition(stat corev1.ConditionStatus) status.Condition

RuleSyncingCondition sets submarinerv1alpha1.ConditionRuleSyncing to stat

func RuleUpdatingCondition

func RuleUpdatingCondition(stat corev1.ConditionStatus) status.Condition

RuleUpdatingCondition sets submarinerv1alpha1.ConditionRuleUpdating to stat

func SNATRuleSpec

func SNATRuleSpec(dstIP, srcIP, dPort string) []string

SNATRuleSpec returns ruleSpec to SNAT for the given arguments

Types

type Controller

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

Controller represents a cotroller

func NewController

func NewController(cl clv1alpha1.SubmarinerV1alpha1Interface, informerFactory sbinformers.SharedInformerFactory, informer cache.SharedIndexInformer, reconciler ReconcilerInterface) *Controller

NewController returns a controller instance

func (*Controller) Run

func (c *Controller) Run()

Run runs a controller

type ReconcilerInterface

type ReconcilerInterface interface {
	Reconcile(namespace, name string) error
}

ReconcilerInterface is an interface for reconciler

type Tunnel

type Tunnel struct {
	Cancel context.CancelFunc
	// contains filtered or unexported fields
}

Tunnel represents ssh tunnel

func NewTunnel

func NewTunnel(local, server, remote string, config *ssh.ClientConfig) *Tunnel

NewTunnel returns a Tunnel instance

func (*Tunnel) Forward

func (t *Tunnel) Forward() error

Forward implements ssh forward functionality. It forwards remote endpoint to local endpoint via server endpoint where ssh forward server running. Forward() can be canceled by calling Cancel().

func (*Tunnel) ForwardNB

func (t *Tunnel) ForwardNB()

ForwardNB is non-blocking version of Forward It retries with exponential backoff on failure.

func (*Tunnel) RemoteForward

func (t *Tunnel) RemoteForward() error

RemoteForward implements ssh remote forward functionality. It forwards local endpoint to remote endpoint via server endpoint where ssh forward server running. RemoteForward() can be canceled by calling Cancel().

func (*Tunnel) RemoteForwardNB

func (t *Tunnel) RemoteForwardNB()

RemoteForwardNB is non-blocking version of RemoteForward It retries with exponential backoff on failure.

func (*Tunnel) String

func (t *Tunnel) String() string

String returns string representation of Tunnel. ex)

"local: 192.168.122.100:8080, server: 192.168.122.101:2022, remote: 192.168.122.102:80"