apix

Documentation

Overview

Package apix provide API-related helpers.

Package apix is a generated GoMock package.

Index

• Variables
• func FromContext(ctx Ctx) (remote, methodName string, auth dom.Auth)
• type AccessToken
  • func AccessTokenFromContext(ctx Ctx) (accessToken AccessToken)
  • func (s AccessToken) Format(f fmt.State, c rune)
  • func (s AccessToken) MarshalJSON() ([]byte, error)
  • func (s AccessToken) MarshalText() ([]byte, error)
• type Authn
  • func NewAuthnClient(ctx Ctx, reg *prometheus.Registry, service string, ca *x509.CertPool, ...) (Authn, error)
• type Ctx
  • func GRPCNewContext(ctx Ctx, fullMethod string, authn Authn) (_ Ctx, auth dom.Auth, err error)
• type JSONRPC2Ctx
  • func (c *JSONRPC2Ctx) NewContext(authn Authn, service string) (ctx Ctx, log *structlog.Logger, methodName string, auth dom.Auth, err error)
• type MockAuthn
  • func NewMockAuthn(ctrl *gomock.Controller) *MockAuthn
  • func (m *MockAuthn) Authenticate(arg0 Ctx, arg1 AccessToken) (dom.Auth, error)
  • func (m *MockAuthn) EXPECT() *MockAuthnMockRecorder
• type MockAuthnMockRecorder
  • func (mr *MockAuthnMockRecorder) Authenticate(arg0, arg1 interface{}) *gomock.Call

Variables

var (
	ErrAccessTokenInvalid = errors.New("invalid AccessToken")
)

Errors.

Functions

func FromContext

func FromContext(ctx Ctx) (remote, methodName string, auth dom.Auth)

FromContext returns values describing request stored in ctx, if any.

Types

type AccessToken

type AccessToken string

AccessToken is an access token.

func AccessTokenFromContext

func AccessTokenFromContext(ctx Ctx) (accessToken AccessToken)

AccessTokenFromContext returns AccessToken stored in ctx, if any.

func (AccessToken) Format

func (s AccessToken) Format(f fmt.State, c rune)

Format wraps sensitive.String.

func (AccessToken) MarshalJSON

func (s AccessToken) MarshalJSON() ([]byte, error)

MarshalJSON wraps sensitive.String.

func (AccessToken) MarshalText

func (s AccessToken) MarshalText() ([]byte, error)

MarshalText wraps sensitive.String.

type Authn

type Authn interface {
	// Authenticate validates AccessToken and returns corresponding
	// Auth. If validation fails returns zero Auth with error.
	//
	// Errors: ErrAccessTokenInvalid.
	Authenticate(Ctx, AccessToken) (dom.Auth, error)
}

Authn validates AccessToken.

func NewAuthnClient

func NewAuthnClient(
	ctx Ctx,
	reg *prometheus.Registry,
	service string,
	ca *x509.CertPool,
	addr string,
) (Authn, error)

NewAuthnClient returns Authn implementation using gRPC AuthIntSvc at addr.

type Ctx

type Ctx = context.Context

func GRPCNewContext

func GRPCNewContext(ctx Ctx, fullMethod string, authn Authn) (_ Ctx, auth dom.Auth, err error)

GRPCNewContext returns a new context.Context that carries values describing this request without any deadline, plus result of authn.Authenticate.

type JSONRPC2Ctx

type JSONRPC2Ctx struct {
	AccessToken string
	jsonrpc2.Ctx
}

JSONRPC2Ctx describe JSON-RPC 2.0 Ctx param used by all API methods.

func (*JSONRPC2Ctx) NewContext

func (c *JSONRPC2Ctx) NewContext(
	authn Authn,
	service string,
) (
	ctx Ctx,
	log *structlog.Logger,
	methodName string,
	auth dom.Auth,
	err error,
)

NewContext returns a new context.Context that carries values describing this request without any deadline, plus some of the values.

type MockAuthn

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

MockAuthn is a mock of Authn interface

func NewMockAuthn

func NewMockAuthn(ctrl *gomock.Controller) *MockAuthn

NewMockAuthn creates a new mock instance

func (*MockAuthn) Authenticate

func (m *MockAuthn) Authenticate(arg0 Ctx, arg1 AccessToken) (dom.Auth, error)

Authenticate mocks base method

func (*MockAuthn) EXPECT

func (m *MockAuthn) EXPECT() *MockAuthnMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

type MockAuthnMockRecorder

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

MockAuthnMockRecorder is the mock recorder for MockAuthn

func (*MockAuthnMockRecorder) Authenticate

func (mr *MockAuthnMockRecorder) Authenticate(arg0, arg1 interface{}) *gomock.Call

Authenticate indicates an expected call of Authenticate