core

Documentation

Index

• Constants
• func MustGetAAD(ctx context.Context) string
• type AAD
• type Auth
• type AuthRequest
• type HttpMiddlewareAuth
  • func NewHttpMiddlewareAuth(auth Auth, logger log.Logger, next rpc.HttpMiddleware) *HttpMiddlewareAuth
  • func (m *HttpMiddlewareAuth) ServeHTTP(req *http.Request) (interface{}, error)
• type MultiAuth
  • func (m *MultiAuth) Add(a Auth)
  • func (m *MultiAuth) Authenticate(req *http.Request) (*http.Request, error)
  • func (*MultiAuth) Name() string
  • func (m *MultiAuth) SetLogger(l log.Logger)
  • func (m *MultiAuth) Stats() stats.Metrics
  • func (m *MultiAuth) Verify(ctx context.Context, data AuthRequest) error
• type MultiError
  • func (e MultiError) Error() string
• type NilAuth
  • func (a *NilAuth) Authenticate(req *http.Request) (*http.Request, error)
  • func (a *NilAuth) Name() string
  • func (a *NilAuth) SetLogger(log.Logger)
  • func (a *NilAuth) Stats() stats.Metrics
  • func (a *NilAuth) Verify(ctx context.Context, req AuthRequest) error
• type Session

Constants

const (
	RequestHeaderSessionKey string = "X-OASIS-SESSION-KEY"
)

Functions

func MustGetAAD

func MustGetAAD(ctx context.Context) string

Types

type AAD

type AAD struct{}

type Auth

type Auth interface {
	Name() string
	Stats() stats.Metrics

	// Authenticate the user from the http request. This should return:
	// - the expected AAD
	// - the authentication error
	Authenticate(req *http.Request) (*http.Request, error)

	// Verify that a specific payload complies with
	// the expected format and has the authentication data required
	Verify(ctx context.Context, req AuthRequest) error

	// Sets the logger for the authentication plugin.
	SetLogger(log.Logger)
}

type AuthRequest

type AuthRequest struct {
	API     string
	Address string
	AAD     []byte
	PK      []byte
	Data    string
}

type HttpMiddlewareAuth

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

func NewHttpMiddlewareAuth

func NewHttpMiddlewareAuth(auth Auth, logger log.Logger, next rpc.HttpMiddleware) *HttpMiddlewareAuth

func (*HttpMiddlewareAuth) ServeHTTP

func (m *HttpMiddlewareAuth) ServeHTTP(req *http.Request) (interface{}, error)

type MultiAuth

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

func (*MultiAuth) Add

func (m *MultiAuth) Add(a Auth)

func (*MultiAuth) Authenticate

func (m *MultiAuth) Authenticate(req *http.Request) (*http.Request, error)

func (*MultiAuth) Name

func (*MultiAuth) Name() string

func (*MultiAuth) SetLogger

func (m *MultiAuth) SetLogger(l log.Logger)

func (*MultiAuth) Stats

func (m *MultiAuth) Stats() stats.Metrics

func (*MultiAuth) Verify

func (m *MultiAuth) Verify(ctx context.Context, data AuthRequest) error

type MultiError

type MultiError struct {
	Errors []error
}

func (MultiError) Error

func (e MultiError) Error() string

type NilAuth

type NilAuth struct{}

func (*NilAuth) Authenticate

func (a *NilAuth) Authenticate(req *http.Request) (*http.Request, error)

func (*NilAuth) Name

func (a *NilAuth) Name() string

func (*NilAuth) SetLogger

func (a *NilAuth) SetLogger(log.Logger)

func (*NilAuth) Stats

func (a *NilAuth) Stats() stats.Metrics

func (*NilAuth) Verify

func (a *NilAuth) Verify(ctx context.Context, req AuthRequest) error

type Session

type Session struct{}