users

Documentation

Index

• Constants
• func GetIPAddressForRequest(r *http.Request) string
• func IsPrivateSubnet(ipAddress net.IP) bool
• type AuthenticatedFunc
• type AuthenticatedRequest
  • func (r *AuthenticatedRequest) AuthFailed() bool
  • func (r *AuthenticatedRequest) IsAuthenticated() bool
• type Authenticator
  • func NewAuthenticator(retriever Retriever) *Authenticator
  • func (a *Authenticator) GetWalletID(r *http.Request) (string, error)
  • func (a *Authenticator) Wrap(wrapped AuthenticatedFunc) http.HandlerFunc
• type Query
• type RemoteUser
• type Retriever
• type TestUserRetriever
  • func (r *TestUserRetriever) Retrieve(q Query) (*models.User, error)
• type UserService
  • func NewUserService() *UserService
  • func (s *UserService) Retrieve(q Query) (*models.User, error)
• type WalletService
  • func NewWalletService() *WalletService
  • func (s *WalletService) LogErrorAndReturn(log *logrus.Entry, message string, a ...interface{}) error
  • func (s *WalletService) Retrieve(q Query) (*models.User, error)

Constants

const GenericRetrievalErr = "unable to retrieve user"

const TokenHeader string = "X-Lbry-Auth-Token"

TokenHeader is the name of HTTP header which is supplied by client and should contain internal-api auth_token.

Functions

func GetIPAddressForRequest

func GetIPAddressForRequest(r *http.Request) string

GetIPAddressForRequest returns the real IP address of the request

func IsPrivateSubnet

func IsPrivateSubnet(ipAddress net.IP) bool

IsPrivateSubnet checks if this ip is in a private subnet

Types

type AuthenticatedFunc

type AuthenticatedFunc func(http.ResponseWriter, *AuthenticatedRequest)

type AuthenticatedRequest

type AuthenticatedRequest struct {
	*http.Request
	WalletID  string
	AuthError error
}

func (*AuthenticatedRequest) AuthFailed

func (r *AuthenticatedRequest) AuthFailed() bool

AuthFailed is a helper to see if there was an error authenticating user.

func (*AuthenticatedRequest) IsAuthenticated

func (r *AuthenticatedRequest) IsAuthenticated() bool

IsAuthenticated is a helper to see if a user was authenticated. If it is false, AuthError might be provided (in case user retriever has errored) or be nil if no auth token was present in headers.

type Authenticator

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

func NewAuthenticator

func NewAuthenticator(retriever Retriever) *Authenticator

NewAuthenticator provides HTTP handler wrapping methods and should be initialized with an object that allows user retrieval.

func (*Authenticator) GetWalletID

func (a *Authenticator) GetWalletID(r *http.Request) (string, error)

GetWalletID retrieves user token from HTTP headers and subsequently an SDK account ID from Retriever.

func (*Authenticator) Wrap

func (a *Authenticator) Wrap(wrapped AuthenticatedFunc) http.HandlerFunc

Wrap result can be supplied to all functions that accept http.HandleFunc, supplied function will be wrapped and called with AuthenticatedRequest instead of http.Request.

type Query

type Query struct {
	Token        string
	MetaRemoteIP string
}

Query contains queried user details and optional metadata about the request

type RemoteUser

type RemoteUser struct {
	ID    int
	Email string
}

RemoteUser encapsulates internal-apis user data

type Retriever

type Retriever interface {
	Retrieve(query Query) (*models.User, error)
}

Retriever is an interface for user retrieval by internal-apis auth token

type TestUserRetriever

type TestUserRetriever struct {
	WalletID string
	Token    string
}

TestUserRetriever is a helper allowing to test API endpoints that require authentication without actually creating DB records.

func (*TestUserRetriever) Retrieve

func (r *TestUserRetriever) Retrieve(q Query) (*models.User, error)

Retrieve returns WalletID set during TestUserRetriever creation, checking it against TestUserRetriever's Token field if one was supplied.

type UserService

type UserService struct {
	Logger monitor.ModuleLogger
}

UserService stores manipulated user data

func NewUserService

func NewUserService() *UserService

NewUserService returns UserService instance for retrieving or creating user records and accounts. Deprecated: NewWalletService should be used instead

func (*UserService) Retrieve

func (s *UserService) Retrieve(q Query) (*models.User, error)

Retrieve authenticates user with internal-api and retrieves/creates locally stored user. Deprecated: WalletService.Retrieve should be used instead

type WalletService

type WalletService struct {
	UserService
}

func NewWalletService

func NewWalletService() *WalletService

NewWalletService returns UserService instance for retrieving or creating wallet-based user records and accounts.

func (*WalletService) LogErrorAndReturn

func (s *WalletService) LogErrorAndReturn(log *logrus.Entry, message string, a ...interface{}) error

LogErrorAndReturn logs error with rich context and returns an error object so it can be returned from the function

func (*WalletService) Retrieve

func (s *WalletService) Retrieve(q Query) (*models.User, error)