rest

Documentation

Index

• func CopyBody(req *http.Request) ([]byte, error)
• func Decode(body io.ReadCloser, v interface{}) error
• func ExponentialBackoff(retry int)
• func IsClosedConnectionErr(err error) bool
• func NewClientAssertion(tokenUrl string, clientId string, clientCert string, signingKey string, ...) (string, error)
• func NewHTTPClient(proxyUrl string) (*http.Client, error)
• func NewRequest(ctx context.Context, verb string, endpoint *url.URL, body interface{}, ...) (*http.Request, error)
• func ParseAud(accessToken string) (string, error)
• func ParseBody(accessToken string) (map[string]interface{}, error)
• type AuthStrategy
• type Authenticator
  • func NewGenericAuthenticator(config config.Config, auth *url.URL, api *url.URL) *Authenticator
  • func NewManagedIdentityAuthenticator(config config.Config, auth *url.URL, api *url.URL, http *http.Client) *Authenticator
  • func (s *Authenticator) AddAuthenticationToRequest(restClient *restClient, req *http.Request) (*http.Request, error)
• type GenericAuthStrategy
• type IntOrStringInt
  • func (ios *IntOrStringInt) UnmarshalJSON(data []byte) error
• type ManagedIdentityAuthStrategy
• type RestClient
  • func NewRestClient(apiUrl string, config config.Config) (RestClient, error)
• type Token
  • func (s Token) IsExpired() bool
  • func (s Token) String() string
  • func (s *Token) UnmarshalJSON(data []byte) error

Functions

func CopyBody

func CopyBody(req *http.Request) ([]byte, error)

func Decode

func Decode(body io.ReadCloser, v interface{}) error

func ExponentialBackoff

func ExponentialBackoff(retry int)

func IsClosedConnectionErr

func IsClosedConnectionErr(err error) bool

func NewClientAssertion

func NewClientAssertion(tokenUrl string, clientId string, clientCert string, signingKey string, keyPassphrase string) (string, error)

func NewHTTPClient

func NewHTTPClient(proxyUrl string) (*http.Client, error)

func NewRequest

func NewRequest(
	ctx context.Context,
	verb string,
	endpoint *url.URL,
	body interface{},
	params map[string]string,
	headers map[string]string,
) (*http.Request, error)

func ParseAud

func ParseAud(accessToken string) (string, error)

func ParseBody

func ParseBody(accessToken string) (map[string]interface{}, error)

Types

type AuthStrategy

type AuthStrategy interface {
	// contains filtered or unexported methods
}

AuthStrategy is an interface that defines the methods that an authentication strategy must implement

type Authenticator

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

Authenticator manages the authentication process, using a specific AuthStrategy

func NewGenericAuthenticator

func NewGenericAuthenticator(config config.Config, auth *url.URL, api *url.URL) *Authenticator

NewGenericAuthenticator creates a new Authenticator using the GenericAuthStrategy (The collection of pre-existing authentication methods)

func NewManagedIdentityAuthenticator

func NewManagedIdentityAuthenticator(config config.Config, auth *url.URL, api *url.URL, http *http.Client) *Authenticator

NewManagedIdentityAuthenticator creates a new Authenticator using the ManagedIdentityAuthStrategy

func (*Authenticator) AddAuthenticationToRequest

func (s *Authenticator) AddAuthenticationToRequest(restClient *restClient, req *http.Request) (*http.Request, error)

Authenticate if needed and add authentication to the request

type GenericAuthStrategy

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

GenericAuthStrategy is an authentication strategy that uses a bunch of pre-existing authentication methods (TODO: Break this up)

type IntOrStringInt

type IntOrStringInt int

Authentication response expires_in may be a string of digits or just an int

func (*IntOrStringInt) UnmarshalJSON

func (ios *IntOrStringInt) UnmarshalJSON(data []byte) error

type ManagedIdentityAuthStrategy

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

ManagedIdentityAuthStrategy is an authentication strategy that uses Azure Managed Identity

type RestClient

type RestClient interface {
	Delete(ctx context.Context, path string, body interface{}, params query.Params, headers map[string]string) (*http.Response, error)
	Get(ctx context.Context, path string, params query.Params, headers map[string]string) (*http.Response, error)
	Patch(ctx context.Context, path string, body interface{}, params query.Params, headers map[string]string) (*http.Response, error)
	Post(ctx context.Context, path string, body interface{}, params query.Params, headers map[string]string) (*http.Response, error)
	Put(ctx context.Context, path string, body interface{}, params query.Params, headers map[string]string) (*http.Response, error)
	Send(req *http.Request) (*http.Response, error)
	AddAuthenticationToRequest(req *http.Request) (*http.Request, error)
	CloseIdleConnections()
}

func NewRestClient

func NewRestClient(apiUrl string, config config.Config) (RestClient, error)

type Token

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

func (Token) IsExpired

func (s Token) IsExpired() bool

func (Token) String

func (s Token) String() string

func (*Token) UnmarshalJSON

func (s *Token) UnmarshalJSON(data []byte) error