networking

Documentation

Overview

Package networking provides utilities for network operations, such as finding available ports and checking network connectivity.

Index

• Constants
• func AddressReferencesPrivateIp(address string) error
• func FindAvailable() int
• func FindOrUsePort(port int) (int, error)
• func IsAvailable(port int) bool
• func IsIPv6Available() bool
• func IsLocalhost(host string) bool
• func IsURL(input string) bool
• func ValidateEndpointURL(endpoint string) error
• type HttpClientBuilder
  • func NewHttpClientBuilder() *HttpClientBuilder
  • func (b *HttpClientBuilder) Build() (*http.Client, error)
  • func (b *HttpClientBuilder) WithCABundle(path string) *HttpClientBuilder
  • func (b *HttpClientBuilder) WithPrivateIPs(allow bool) *HttpClientBuilder
  • func (b *HttpClientBuilder) WithTokenFromFile(path string) *HttpClientBuilder
• type ValidatingTransport
  • func (t *ValidatingTransport) RoundTrip(req *http.Request) (*http.Response, error)

Constants

const (
	// MinPort is the minimum port number to use
	MinPort = 10000
	// MaxPort is the maximum port number to use
	MaxPort = 65535
	// MaxAttempts is the maximum number of attempts to find an available port
	MaxAttempts = 10
)

const (
	// ErrPrivateIpAddress is the error returned when the provided URL redirects to a private IP address
	ErrPrivateIpAddress = "the provided registry URL redirects to a private IP address, which is not allowed; " +
		"to override this, reset the registry URL using the --allow-private-ip (-p) flag"
)

const HttpScheme = "http"

HttpScheme is the HTTP scheme

const HttpTimeout = 30 * time.Second

HttpTimeout is the timeout for outgoing HTTP requests

const HttpsScheme = "https"

HttpsScheme is the HTTPS scheme

Functions

func AddressReferencesPrivateIp

func AddressReferencesPrivateIp(address string) error

AddressReferencesPrivateIp returns an error if the address references a private IP address

func FindAvailable

func FindAvailable() int

FindAvailable finds an available port

func FindOrUsePort

func FindOrUsePort(port int) (int, error)

FindOrUsePort checks if the provided port is available or finds an available port if none is provided. If port is 0, it will find an available port. If port is not 0, it will check if the port is available. Returns the selected port and an error if any.

func IsAvailable

func IsAvailable(port int) bool

IsAvailable checks if a port is available

func IsIPv6Available

func IsIPv6Available() bool

IsIPv6Available checks if IPv6 is available on the system by looking for IPv6 addresses on network interfaces

func IsLocalhost

func IsLocalhost(host string) bool

IsLocalhost checks if a host is localhost (for development)

func IsURL

func IsURL(input string) bool

IsURL checks if the input is a valid HTTP or HTTPS URL

func ValidateEndpointURL

func ValidateEndpointURL(endpoint string) error

ValidateEndpointURL validates that an endpoint URL is secure

Types

type HttpClientBuilder

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

HttpClientBuilder provides a fluent interface for building HTTP clients

func NewHttpClientBuilder

func NewHttpClientBuilder() *HttpClientBuilder

NewHttpClientBuilder returns a new HttpClientBuilder

func (*HttpClientBuilder) Build

func (b *HttpClientBuilder) Build() (*http.Client, error)

Build creates the configured HTTP client

func (*HttpClientBuilder) WithCABundle

func (b *HttpClientBuilder) WithCABundle(path string) *HttpClientBuilder

WithCABundle sets the CA certificate bundle path

func (*HttpClientBuilder) WithPrivateIPs

func (b *HttpClientBuilder) WithPrivateIPs(allow bool) *HttpClientBuilder

WithPrivateIPs allows connections to private IP addresses

func (*HttpClientBuilder) WithTokenFromFile

func (b *HttpClientBuilder) WithTokenFromFile(path string) *HttpClientBuilder

WithTokenFromFile sets the auth token file path

type ValidatingTransport

type ValidatingTransport struct {
	Transport http.RoundTripper
}

ValidatingTransport is for validating URLs prior to request

func (*ValidatingTransport) RoundTrip

func (t *ValidatingTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip validates the request URL prior to forwarding