internal

Documentation

Overview

Package internal contains internal functions used by server/auth package.

Index

• func RegisterClientFactory(f ClientFactory)
• func SplitAuthHeader(header string) (typ string, token string)
• func WithTestTransport(ctx context.Context, cb TestTransportCallback) context.Context
• type ClientFactory
• type MergedContext
  • func (mc *MergedContext) Deadline() (time.Time, bool)
  • func (mc *MergedContext) Done() <-chan struct{}
  • func (mc *MergedContext) Err() error
  • func (mc *MergedContext) Value(key any) any
• type Request
  • func (r *Request) Do(ctx context.Context) error
• type TestTransportCallback

Functions

func RegisterClientFactory

func RegisterClientFactory(f ClientFactory)

RegisterClientFactory allows external module to provide implementation of the ClientFactory.

This is needed to resolve module dependency cycle between server/auth and server/auth/internal.

See init() in server/auth/client.go.

If client factory is not set, Do(...) uses http.DefaultClient. This happens in unit tests for various auth/* subpackages.

func SplitAuthHeader

func SplitAuthHeader(header string) (typ string, token string)

SplitAuthHeader takes "Bearer <token>" and returns ("bearer", "<token>").

If there's only one word, return ("", "<token>"). If there are more than two words, returns ("bearer", "<token> <more>").

Strips spaces. Lower-cases the `typ`.

func WithTestTransport

func WithTestTransport(ctx context.Context, cb TestTransportCallback) context.Context

WithTestTransport puts a testing transport in the context to use for fetches.

Types

type ClientFactory

type ClientFactory func(ctx context.Context, scopes []string) (*http.Client, error)

ClientFactory knows how to produce http.Client that attach proper OAuth headers.

If 'scopes' is empty, the factory should return a client that makes anonymous requests.

type MergedContext

type MergedContext struct {
	Root     context.Context
	Fallback context.Context
}

MergedContext is a context that inherits everything from Root, except values are additionally inherited from Fallback.

func (*MergedContext) Deadline

func (mc *MergedContext) Deadline() (time.Time, bool)

func (*MergedContext) Done

func (mc *MergedContext) Done() <-chan struct{}

func (*MergedContext) Err

func (mc *MergedContext) Err() error

func (*MergedContext) Value

func (mc *MergedContext) Value(key any) any

type Request

type Request struct {
	Method  string            // HTTP method to use
	URL     string            // URL to access
	Scopes  []string          // OAuth2 scopes to authenticate with or anonymous call if empty
	Headers map[string]string // optional map with request headers
	Body    any               // object to convert to JSON and send as body or []byte with the body
	Out     any               // where to deserialize the response to
}

Request represents one JSON REST API request.

func (*Request) Do

func (r *Request) Do(ctx context.Context) error

Do performs an HTTP request with retries on transient errors.

It can be used to make GET or DELETE requests (if Body is nil) or POST or PUT requests (if Body is not nil). In latter case the body will be serialized to JSON.

Respects context's deadline and cancellation.

type TestTransportCallback

type TestTransportCallback func(r *http.Request, body string) (code int, response string)

TestTransportCallback is used from unit tests.