Documentation
¶
Index ¶
- func AppendForwardedForHeader(req *http.Request)
- func ChooseBindAddress(bindAddress net.IP) (net.IP, error)
- func ChooseHostInterface() (net.IP, error)
- func CloneHeader(in http.Header) http.Header
- func CloneRequest(req *http.Request) *http.Request
- func ConnectWithRedirects(originalMethod string, originalLocation *url.URL, header http.Header, ...) (net.Conn, []byte, error)
- func FormatURL(scheme string, host string, port int, path string) *url.URL
- func GetClientIP(req *http.Request) net.IP
- func GetHTTPClient(req *http.Request) string
- func IPNetEqual(ipnet1, ipnet2 *net.IPNet) bool
- func IsConnectionReset(err error) bool
- func IsNoRoutesError(err error) bool
- func IsProbableEOF(err error) bool
- func JoinPreservingTrailingSlash(elem ...string) string
- func JoinSchemeNamePort(scheme, name, port string) string
- func NewProxierWithNoProxyCIDR(delegate func(req *http.Request) (*url.URL, error)) func(req *http.Request) (*url.URL, error)
- func SetOldTransportDefaults(t *http.Transport) *http.Transport
- func SetTransportDefaults(t *http.Transport) *http.Transport
- func SourceIPs(req *http.Request) []net.IP
- func SplitSchemeNamePort(id string) (scheme, name, port string, valid bool)
- func TLSClientConfig(transport http.RoundTripper) (*tls.Config, error)
- type AddressFamily
- type DialFunc
- type Dialer
- type DialerFunc
- type PortRange
- type RoundTripperWrapper
- type Route
- type RouteFile
- type TLSClientConfigHolder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AppendForwardedForHeader ¶ added in v1.7.0
Prepares the X-Forwarded-For header for another forwarding hop by appending the previous sender's IP address to the X-Forwarded-For chain.
func ChooseBindAddress ¶
If bind-address is usable, return it directly If bind-address is not usable (unset, 0.0.0.0, or loopback), we will use the host's default interface.
func ChooseHostInterface ¶
ChooseHostInterface is a method used fetch an IP for a daemon. If there is no routing info file, it will choose a global IP from the system interfaces. Otherwise, it will use IPv4 and IPv6 route information to return the IP of the interface with a gateway on it (with priority given to IPv4). For a node with no internet connection, it returns error.
func CloneHeader ¶ added in v1.7.0
CloneHeader creates a deep copy of an http.Header.
func CloneRequest ¶ added in v1.7.0
CloneRequest creates a shallow copy of the request along with a deep copy of the Headers.
func ConnectWithRedirects ¶ added in v1.7.0
func ConnectWithRedirects(originalMethod string, originalLocation *url.URL, header http.Header, originalBody io.Reader, dialer Dialer, requireSameHostRedirects bool) (net.Conn, []byte, error)
ConnectWithRedirects uses dialer to send req, following up to 10 redirects (relative to originalLocation). It returns the opened net.Conn and the raw response bytes. If requireSameHostRedirects is true, only redirects to the same host are permitted.
func GetClientIP ¶
Extracts and returns the clients IP from the given request. Looks at X-Forwarded-For header, X-Real-Ip header and request.RemoteAddr in that order. Returns nil if none of them are set or is set to an invalid value.
func GetHTTPClient ¶
func IPNetEqual ¶
IPNetEqual checks if the two input IPNets are representing the same subnet. For example,
10.0.0.1/24 and 10.0.0.0/24 are the same subnet. 10.0.0.1/24 and 10.0.0.0/25 are not the same subnet.
func IsConnectionReset ¶
Returns if the given err is "connection reset by peer" error.
func IsNoRoutesError ¶ added in v1.12.6
IsNoRoutesError checks if an error is of type noRoutesError
func IsProbableEOF ¶
IsProbableEOF returns true if the given error resembles a connection termination scenario that would justify assuming that the watch is empty. These errors are what the Go http stack returns back to us which are general connection closure errors (strongly correlated) and callers that need to differentiate probable errors in connection behavior between normal "this is disconnected" should use the method.
func JoinPreservingTrailingSlash ¶ added in v1.7.8
JoinPreservingTrailingSlash does a path.Join of the specified elements, preserving any trailing slash on the last non-empty segment
func JoinSchemeNamePort ¶
JoinSchemeNamePort returns a string that specifies the scheme, name, and port:
- "<name>"
- "<name>:<port>"
- "<scheme>:<name>:<port>"
None of the parameters may contain a ':' character Name is required Scheme must be "", "http", or "https"
func NewProxierWithNoProxyCIDR ¶
func NewProxierWithNoProxyCIDR(delegate func(req *http.Request) (*url.URL, error)) func(req *http.Request) (*url.URL, error)
NewProxierWithNoProxyCIDR constructs a Proxier function that respects CIDRs in NO_PROXY and delegates if no matching CIDRs are found
func SetOldTransportDefaults ¶
SetOldTransportDefaults applies the defaults from http.DefaultTransport for the Proxy, Dial, and TLSHandshakeTimeout fields if unset
func SetTransportDefaults ¶
SetTransportDefaults applies the defaults from http.DefaultTransport for the Proxy, Dial, and TLSHandshakeTimeout fields if unset
func SourceIPs ¶ added in v1.7.0
SourceIPs splits the comma separated X-Forwarded-For header or returns the X-Real-Ip header or req.RemoteAddr, in that order, ignoring invalid IPs. It returns nil if all of these are empty or invalid.
func SplitSchemeNamePort ¶
SplitSchemeNamePort takes a string of the following forms:
- "<name>", returns "", "<name>","", true
- "<name>:<port>", returns "", "<name>","<port>",true
- "<scheme>:<name>:<port>", returns "<scheme>","<name>","<port>",true
Name must be non-empty or valid will be returned false. Scheme must be "http" or "https" if specified Port is returned as a string, and it is not required to be numeric (could be used for a named port, for example).
func TLSClientConfig ¶
func TLSClientConfig(transport http.RoundTripper) (*tls.Config, error)
Types ¶
type AddressFamily ¶ added in v1.8.0
type AddressFamily uint
type Dialer ¶
type Dialer interface { // Dial connects to the host specified by req's URL, writes the request to the connection, and // returns the opened net.Conn. Dial(req *http.Request) (net.Conn, error) }
Dialer dials a host and writes a request to it.
type DialerFunc ¶ added in v1.8.0
DialerFunc implements Dialer for the provided function.
type PortRange ¶
PortRange represents a range of TCP/UDP ports. To represent a single port, set Size to 1.
func ParsePortRange ¶
ParsePortRange parses a string of the form "min-max", inclusive at both ends, and initializs a new PortRange from it.
func ParsePortRangeOrDie ¶
func (*PortRange) Set ¶
Set parses a string of the form "value", "min-max", or "min+offset", inclusive at both ends, and sets the PortRange from it. This is part of the flag.Value and pflag.Value interfaces.
type RoundTripperWrapper ¶
type RoundTripperWrapper interface { http.RoundTripper WrappedRoundTripper() http.RoundTripper }
type RouteFile ¶ added in v1.8.0
type RouteFile struct {
// contains filtered or unexported fields
}