kubernetes: k8s.io/kubernetes/pkg/proxy/util Index | Files | Directories

package util

import "k8s.io/kubernetes/pkg/proxy/util"


Package Files

endpoints.go network.go port.go utils.go


const (
    // IPv4ZeroCIDR is the CIDR block for the whole IPv4 address space
    IPv4ZeroCIDR = ""

    // IPv6ZeroCIDR is the CIDR block for the whole IPv6 address space
    IPv6ZeroCIDR = "::/0"


var (
    // ErrAddressNotAllowed indicates the address is not allowed
    ErrAddressNotAllowed = errors.New("address not allowed")

    // ErrNoAddresses indicates there are no addresses for the hostname
    ErrNoAddresses = errors.New("No addresses for hostname")

func AppendPortIfNeeded Uses

func AppendPortIfNeeded(addr string, port int32) string

AppendPortIfNeeded appends the given port to IP address unless it is already in "ipv4:port" or "[ipv6]:port" format.

func BuildPortsToEndpointsMap Uses

func BuildPortsToEndpointsMap(endpoints *v1.Endpoints) map[string][]string

BuildPortsToEndpointsMap builds a map of portname -> all ip:ports for that portname. Explode Endpoints.Subsets[*] into this structure.

func EnsureSysctl Uses

func EnsureSysctl(sysctl utilsysctl.Interface, name string, newVal int) error

EnsureSysctl sets a kernel sysctl to a given numeric value.

func GetClusterIPByFamily Uses

func GetClusterIPByFamily(ipFamily v1.IPFamily, service *v1.Service) string

GetClusterIPByFamily returns a service clusterip by family

func GetLocalAddrs Uses

func GetLocalAddrs() ([]net.IP, error)

GetLocalAddrs returns a list of all network addresses on the local system

func GetNodeAddresses Uses

func GetNodeAddresses(cidrs []string, nw NetworkInterfacer) (sets.String, error)

GetNodeAddresses return all matched node IP addresses based on given cidr slice. Some callers, e.g. IPVS proxier, need concrete IPs, not ranges, which is why this exists. NetworkInterfacer is injected for test purpose. We expect the cidrs passed in is already validated. Given an empty input `[]`, it will return `` and `::/0` directly. If multiple cidrs is given, it will return the minimal IP sets, e.g. given input `[,]`, it will only return ``. NOTE: GetNodeAddresses only accepts CIDRs, if you want concrete IPs, e.g., then the input should be

func IPPart Uses

func IPPart(s string) string

IPPart returns just the IP part of an IP or IP:port or endpoint string. If the IP part is an IPv6 address enclosed in brackets (e.g. "[fd00:1::5]:9999"), then the brackets are stripped as well.

func IsAllowedHost Uses

func IsAllowedHost(host net.IP, denied []*net.IPNet) error

IsAllowedHost checks if the given IP host address is in a network in the denied list.

func IsProxyableHostname Uses

func IsProxyableHostname(ctx context.Context, resolv Resolver, hostname string) error

IsProxyableHostname checks if the IP addresses for a given hostname are permitted to be proxied

func IsProxyableIP Uses

func IsProxyableIP(ip string) error

IsProxyableIP checks if a given IP address is permitted to be proxied

func IsZeroCIDR Uses

func IsZeroCIDR(cidr string) bool

IsZeroCIDR checks whether the input CIDR string is either the IPv4 or IPv6 zero CIDR

func LogAndEmitIncorrectIPVersionEvent Uses

func LogAndEmitIncorrectIPVersionEvent(recorder record.EventRecorder, fieldName, fieldValue, svcNamespace, svcName string, svcUID types.UID)

LogAndEmitIncorrectIPVersionEvent logs and emits incorrect IP version event.

func MapCIDRsByIPFamily Uses

func MapCIDRsByIPFamily(cidrStrings []string) map[v1.IPFamily][]string

MapCIDRsByIPFamily maps a slice of IPs to their respective IP families (v4 or v6)

func MapIPsByIPFamily Uses

func MapIPsByIPFamily(ipStrings []string) map[v1.IPFamily][]string

MapIPsByIPFamily maps a slice of IPs to their respective IP families (v4 or v6)

func OtherIPFamily Uses

func OtherIPFamily(ipFamily v1.IPFamily) v1.IPFamily

OtherIPFamily returns the other ip family

func PortPart Uses

func PortPart(s string) (int, error)

PortPart returns just the port part of an endpoint string.

func RevertPorts Uses

func RevertPorts(replacementPortsMap, originalPortsMap map[LocalPort]Closeable)

RevertPorts is closing ports in replacementPortsMap but not in originalPortsMap. In other words, it only closes the ports opened in this sync.

func ShouldSkipService Uses

func ShouldSkipService(service *v1.Service) bool

ShouldSkipService checks if a given service should skip proxying

func ShuffleStrings Uses

func ShuffleStrings(s []string) []string

ShuffleStrings copies strings from the specified slice into a copy in random order. It returns a new slice.

func ToCIDR Uses

func ToCIDR(ip net.IP) string

ToCIDR returns a host address of the form <ip-address>/32 for IPv4 and <ip-address>/128 for IPv6

type Closeable Uses

type Closeable interface {
    Close() error

Closeable is an interface around closing a port.

type DialContext Uses

type DialContext = func(context.Context, string, string) (net.Conn, error)

DialContext is a dial function matching the signature of net.Dialer.DialContext.

func NewFilteredDialContext Uses

func NewFilteredDialContext(wrapped DialContext, resolv Resolver, opts *FilteredDialOptions) DialContext

NewFilteredDialContext returns a DialContext function that filters connections based on a FilteredDialOptions.

type FilteredDialOptions Uses

type FilteredDialOptions struct {
    // DialHostIPDenylist restricts hosts from being dialed.
    DialHostCIDRDenylist []*net.IPNet
    // AllowLocalLoopback controls connections to local loopback hosts (as defined by
    // IsProxyableIP).
    AllowLocalLoopback bool

FilteredDialOptions configures how a DialContext is wrapped by NewFilteredDialContext.

type LocalPort Uses

type LocalPort struct {
    // Description is the identity message of a given local port.
    Description string
    // IP is the IP address part of a given local port.
    // If this string is empty, the port binds to all local IP addresses.
    IP  string
    // Port is the port part of a given local port.
    Port int
    // Protocol is the protocol part of a given local port.
    // The value is assumed to be lower-case. For example, "udp" not "UDP", "tcp" not "TCP".
    Protocol string

LocalPort describes a port on specific IP address and protocol

func (*LocalPort) String Uses

func (lp *LocalPort) String() string

type NetworkInterfacer Uses

type NetworkInterfacer interface {
    Addrs(intf *net.Interface) ([]net.Addr, error)
    Interfaces() ([]net.Interface, error)

NetworkInterfacer defines an interface for several net library functions. Production code will forward to net library functions, and unit tests will override the methods for testing purposes.

type PortOpener Uses

type PortOpener interface {
    OpenLocalPort(lp *LocalPort, isIPv6 bool) (Closeable, error)

PortOpener is an interface around port opening/closing. Abstracted out for testing.

type RealNetwork Uses

type RealNetwork struct{}

RealNetwork implements the NetworkInterfacer interface for production code, just wrapping the underlying net library function calls.

func (RealNetwork) Addrs Uses

func (RealNetwork) Addrs(intf *net.Interface) ([]net.Addr, error)

Addrs wraps net.Interface.Addrs(), it's a part of NetworkInterfacer interface.

func (RealNetwork) Interfaces Uses

func (RealNetwork) Interfaces() ([]net.Interface, error)

Interfaces wraps net.Interfaces(), it's a part of NetworkInterfacer interface.

type Resolver Uses

type Resolver interface {
    LookupIPAddr(ctx context.Context, host string) ([]net.IPAddr, error)

Resolver is an interface for net.Resolver



Package util imports 15 packages (graph) and is imported by 127 packages. Updated 2020-12-09. Refresh now. Tools for package owners.