authcore

Documentation

Index

• Variables
• type AuthCore
  • func (ac *AuthCore) AssertConfigured()
• type AuthCredentials
• type AuthDatasource
• type AuthEncoder
• type AuthNotifier
• type AuthRecoveryPasswordRequest
• type AuthRecoveryPasswordResponse
• type AuthResetPasswordRequest
• type AuthResetPasswordResponse
• type AuthStore
• type AuthTokenErrorResponse
• type AuthTokenResponse
• type PID
• type Token

Variables

var ErrBadRequest = errors.New("bad request")

var ErrInternalServerError = errors.New("internal server error")

var ErrInvalidPID = errors.New("invalid PID")

var ErrInvalidToken = errors.New("invalid token")

var ErrMissingUsernameOrPassword = errors.New("missing username or password")

var ErrNotFound = errors.New("not found")

var ErrUnauthorized = errors.New("unauthorized")

Types

type AuthCore

type AuthCore struct {
	DS           AuthDatasource
	TokenEncoder AuthEncoder
	Store        AuthStore
	Notifier     AuthNotifier
}

func (*AuthCore) AssertConfigured

func (ac *AuthCore) AssertConfigured()

type AuthCredentials

type AuthCredentials struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

type AuthDatasource

type AuthDatasource interface {
	FindPIDByValidCredentials(username string, password string) (PID, error)
	FindPIDByEmail(email string) (PID, error)
	ResetPassword(pid PID, password string) error
}

type AuthEncoder

type AuthEncoder interface {
	GenerateTokenFromPID(pid PID) (*Token, error)
}

type AuthNotifier

type AuthNotifier interface {
	NotifyResetPasswordToken(email string, token *Token, pid PID) error
	NotifyPasswordReseted(email string, pid PID) error
}

type AuthRecoveryPasswordRequest

type AuthRecoveryPasswordRequest struct {
	Email string `json:"email"`
}

type AuthRecoveryPasswordResponse

type AuthRecoveryPasswordResponse struct {
	Status bool    `json:"status"`
	Error  *string `json:"error,omitempty"`
}

type AuthResetPasswordRequest

type AuthResetPasswordRequest struct {
	Token    string `json:"token"`
	Password string `json:"password"`
}

type AuthResetPasswordResponse

type AuthResetPasswordResponse struct {
	Status bool    `json:"status"`
	Error  *string `json:"error,omitempty"`
}

type AuthStore

type AuthStore interface {
	StoreAuthToken(token *Token, pid PID) error
	GetAuthTokenPID(token string) (PID, error)
	DeleteAuthToken(token string) error
	StoreResetPasswordToken(token *Token, pid PID) error
	GetResetPasswordTokenPID(token string) (PID, error)
	DeleteResetPasswordToken(token string) error
}

type AuthTokenErrorResponse

type AuthTokenErrorResponse struct {
	Error string `json:"error"`
}

type AuthTokenResponse

type AuthTokenResponse struct {
	Token *Token `json:"token"`
}

type PID

type PID interface{}

type Token

type Token struct {
	Value      string     `json:"value"`
	Expiration *time.Time `json:"expiration"`
}