util

Documentation

Overview

Package util implements helper functions for the api

Index

• func CreateAndSetAuthToken(config model.Reader) error
• func DoGet(c *http.Client, url string, conn ShouldCloseConnection) (body []byte, e error)
• func DoGetWithOptions(c *http.Client, url string, options *ReqOptions) (body []byte, e error)
• func DoPost(c *http.Client, url string, contentType string, body io.Reader) (resp []byte, e error)
• func DoPostChunked(c *http.Client, url string, contentType string, body io.Reader, ...) error
• func GetAuthToken() string
• func GetClient(verify bool) *http.Client
• func GetClientWithTimeout(to time.Duration, verify bool) *http.Client
• func GetDCAAuthToken() string
• func InitDCAAuthToken(config model.Reader) error
• func IsForbidden(ip string) bool
• func IsIPv6(ip string) bool
• func SetAuthToken(config model.Reader) error
• func Validate(w http.ResponseWriter, r *http.Request) error
• func ValidateDCARequest(w http.ResponseWriter, r *http.Request) error
• func WithCloseConnection(state bool) func(*IPCEndpoint)
• func WithHTTPClient(client *http.Client) func(*IPCEndpoint)
• func WithHostAndPort(cmdHost string, cmdPort int) func(*IPCEndpoint)
• func WithURLScheme(scheme string) func(*IPCEndpoint)
• type EndpointOption
• type GetOption
  • func WithValues(values url.Values) GetOption
• type IPCEndpoint
  • func NewIPCEndpoint(config config.Component, endpointPath string, options ...EndpointOption) (*IPCEndpoint, error)
  • func (end *IPCEndpoint) DoGet(options ...GetOption) ([]byte, error)
• type ReqOptions
• type ShouldCloseConnection

Functions

func CreateAndSetAuthToken

func CreateAndSetAuthToken(config model.Reader) error

CreateAndSetAuthToken creates and sets the authorization token Requires that the config has been set up before calling

func DoGet

func DoGet(c *http.Client, url string, conn ShouldCloseConnection) (body []byte, e error)

DoGet is a wrapper around performing HTTP GET requests

func DoGetWithOptions

func DoGetWithOptions(c *http.Client, url string, options *ReqOptions) (body []byte, e error)

DoGetWithOptions is a wrapper around performing HTTP GET requests

func DoPost

func DoPost(c *http.Client, url string, contentType string, body io.Reader) (resp []byte, e error)

DoPost is a wrapper around performing HTTP POST requests

func DoPostChunked

func DoPostChunked(c *http.Client, url string, contentType string, body io.Reader, onChunk func([]byte)) error

DoPostChunked is a wrapper around performing HTTP POST requests that stream chunked data

func GetAuthToken

func GetAuthToken() string

GetAuthToken gets the session token

func GetClient

func GetClient(verify bool) *http.Client

GetClient is a convenience function returning an http client `GetClient(false)` must be used only for HTTP requests whose destination is localhost (ie, for Agent commands).

func GetClientWithTimeout

func GetClientWithTimeout(to time.Duration, verify bool) *http.Client

GetClientWithTimeout is a convenience function returning an http client Arguments correspond to the request timeout duration, and a boolean to verify the server TLS client (false should only be used on localhost trusted endpoints).

func GetDCAAuthToken

func GetDCAAuthToken() string

GetDCAAuthToken gets the session token

func InitDCAAuthToken

func InitDCAAuthToken(config model.Reader) error

InitDCAAuthToken initialize the session token for the Cluster Agent based on config options Requires that the config has been set up before calling

func IsForbidden

func IsForbidden(ip string) bool

IsForbidden returns whether the cluster check runner server is allowed to listen on a given ip The function is a non-secure helper to help avoiding setting an IP that's too permissive. The function doesn't guarantee any security feature

func IsIPv6

func IsIPv6(ip string) bool

IsIPv6 is used to differentiate between ipv4 and ipv6 addresses.

func SetAuthToken

func SetAuthToken(config model.Reader) error

SetAuthToken sets the session token Requires that the config has been set up before calling

func Validate

func Validate(w http.ResponseWriter, r *http.Request) error

Validate validates an http request

func ValidateDCARequest

func ValidateDCARequest(w http.ResponseWriter, r *http.Request) error

ValidateDCARequest is used for the exposed endpoints of the DCA. It is different from Validate as we want to have different validations.

func WithCloseConnection

func WithCloseConnection(state bool) func(*IPCEndpoint)

WithCloseConnection is an option to close the connection

func WithHTTPClient

func WithHTTPClient(client *http.Client) func(*IPCEndpoint)

WithHTTPClient is an option to assign a different http.Client

func WithHostAndPort

func WithHostAndPort(cmdHost string, cmdPort int) func(*IPCEndpoint)

WithHostAndPort is an option to use a host address for sending IPC requests default is the config settings "cmd_host" (default localhost) and "cmd_port" (default 5001)

func WithURLScheme

func WithURLScheme(scheme string) func(*IPCEndpoint)

WithURLScheme is an option to set the URL's scheme

Types

type EndpointOption

type EndpointOption func(*IPCEndpoint)

EndpointOption allows configuration of the IPCEndpoint during construction

type GetOption

type GetOption func(url.URL) url.URL

GetOption is an option that can be passed to DoGet

func WithValues

func WithValues(values url.Values) GetOption

WithValues is an option to add url.Values to the GET request

type IPCEndpoint

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

IPCEndpoint is an endpoint that IPC requests will be sent to

func NewIPCEndpoint

func NewIPCEndpoint(config config.Component, endpointPath string, options ...EndpointOption) (*IPCEndpoint, error)

NewIPCEndpoint constructs a new IPC Endpoint using the given config, path, and options

func (*IPCEndpoint) DoGet

func (end *IPCEndpoint) DoGet(options ...GetOption) ([]byte, error)

DoGet sends GET method to the endpoint

type ReqOptions

type ReqOptions struct {
	Conn      ShouldCloseConnection
	Ctx       context.Context
	Authtoken string
}

ReqOptions are options when making a request

type ShouldCloseConnection

type ShouldCloseConnection int

ShouldCloseConnection is an option to DoGet to indicate whether to close the underlying connection after reading the response

const (
	// LeaveConnectionOpen keeps the underlying connection open after reading the request response
	LeaveConnectionOpen ShouldCloseConnection = iota
	// CloseConnection closes the underlying connection after reading the request response
	CloseConnection
)