authenticator

Documentation

Index

• func RealIP(forwardIPs string) string
• func RealIPFromRequest(r *http.Request) string
• func Register(name string, factory FactoryFunc)
• func WithCredentials(ctx context.Context, credentials Credentials) context.Context
• type AnonymousCredentials
  • func (c *AnonymousCredentials) GetLogFields() []zap.Field
  • func (c *AnonymousCredentials) GetUserID() string
• type Authenticator
  • func New(config string) (Authenticator, error)
• type Credentials
  • func GetCredentials(ctx context.Context) Credentials
• type FactoryFunc

Functions

func RealIP

func RealIP(forwardIPs string) string

func RealIPFromRequest

func RealIPFromRequest(r *http.Request) string

func Register

func Register(name string, factory FactoryFunc)

func WithCredentials

func WithCredentials(ctx context.Context, credentials Credentials) context.Context

WithCredentials creates a child context containing in it the `Credentials` object.

Types

type AnonymousCredentials

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

func (*AnonymousCredentials) GetLogFields

func (c *AnonymousCredentials) GetLogFields() []zap.Field

func (*AnonymousCredentials) GetUserID

func (c *AnonymousCredentials) GetUserID() string

type Authenticator

type Authenticator interface {
	IsAuthenticationTokenRequired() bool
	Check(ctx context.Context, token, ipAddress string) (context.Context, error)
}

func New

func New(config string) (Authenticator, error)

type Credentials

type Credentials interface {
	GetLogFields() []zap.Field
	GetUserID() string
}

func GetCredentials

func GetCredentials(ctx context.Context) Credentials

GetCredentials extracts `Credentials` object from context if it exists, returning it if present and `nil` if not found.

type FactoryFunc

type FactoryFunc func(config string) (Authenticator, error)