Documentation
¶
Overview ¶
Package handlers contains custom handler functions
Index ¶
- Variables
- func IsConstraintError(err error) bool
- func IsForeignKeyConstraintError(err error) bool
- func IsUniqueConstraintError(err error) bool
- type CheckFunc
- type Checks
- type Handler
- func (h *Handler) AddReadinessCheck(name string, f CheckFunc)
- func (h *Handler) JWKSWellKnownHandler(ctx echo.Context) error
- func (h *Handler) LoginHandler(ctx echo.Context) error
- func (h *Handler) NewEmailManager() error
- func (h *Handler) RefreshHandler(ctx echo.Context) error
- func (h *Handler) RegisterHandler(ctx echo.Context) error
- func (h *Handler) SendPasswordResetRequestEmail(user *User) error
- func (h *Handler) SendPasswordResetSuccessEmail(user *User) error
- func (h *Handler) SendVerificationEmail(user *User) error
- type InvalidEmailConfigError
- type MissingRequiredFieldError
- type RefreshRequest
- type RegisterReply
- type RegisterRequest
- type Response
- type URLConfig
- type User
Constants ¶
This section is empty.
Variables ¶
var ( // ErrBadRequest is returned when the request cannot be processed ErrBadRequest = errors.New("invalid request") // ErrProcessingRequest is returned when the request cannot be processed ErrProcessingRequest = errors.New("error processing request, please try again") // ErrMissingRequiredFields is returned when the login request has an empty username or password ErrMissingRequiredFields = errors.New("invalid request, missing username and/or password") // ErrDuplicate is returned when the request violates the unique constraints ErrDuplicate = errors.New("unique constraint violated on model") // ErrMissingRelation is returned when a foreign key restricted is violated ErrMissingRelation = errors.New("foreign key relation violated on model") // ErrNotNull is returned when a field is required but not provided ErrNotNull = errors.New("not null constraint violated on model") // ErrConstraint is returned when a database constraint is violted ErrConstraint = errors.New("database constraint violated") // ErrNotFound is returned when the requested object is not found ErrNotFound = errors.New("object not found in the database") )
Functions ¶
func IsConstraintError ¶ added in v0.2.2
IsConstraintError returns true if the error resulted from a database constraint violation.
func IsForeignKeyConstraintError ¶ added in v0.2.2
IsForeignKeyConstraintError reports if the error resulted from a database foreign-key constraint violation. e.g. parent row does not exist.
func IsUniqueConstraintError ¶ added in v0.2.2
IsUniqueConstraintError reports if the error resulted from a DB uniqueness constraint violation. e.g. duplicate value in unique index.
Types ¶
type Handler ¶
type Handler struct {
// DBClient to interact with the generated ent schema
DBClient *ent.Client
// TM contains the token manager in order to validate auth requests
TM *tokens.TokenManager
// CookieDomain is the domain set in cookie for authenticated requests, defaults to datum.net
CookieDomain string
// Logger provides the zap logger to do logging things from the handlers
Logger *zap.SugaredLogger
// ReadyChecks is a set of checkFuncs to determine if the application is "ready" upon startup
ReadyChecks Checks
// JWTKeys contains the set of valid JWT authentication key
JWTKeys jwk.Set
// SendGridConfig containing the email configuration
SendGridConfig *emails.Config
// EmailURL contains the urls used within emails
EmailURL URLConfig
// contains filtered or unexported fields
}
Handler contains configuration options for handlers
func (*Handler) AddReadinessCheck ¶
AddReadinessCheck will accept a function to be ran during calls to /readyz These functions should accept a context and only return an error. When adding a readiness check a name is also provided, this name will be used when returning the state of all the checks
func (*Handler) JWKSWellKnownHandler ¶
JWKSWellKnownHandler provides the JWK used to verify all Datum-issued JWTs
func (*Handler) LoginHandler ¶
LoginHandler validates the user credentials and returns a valid cookie this only supports username password login today (not oauth)
func (*Handler) NewEmailManager ¶ added in v0.2.2
NewEmailManager is responsible for initializing and configuring the email manager used for sending emails
func (*Handler) RefreshHandler ¶
RefreshHandler allows users to refresh their access token using their refresh token.
func (*Handler) RegisterHandler ¶ added in v0.2.2
RegisterHandler handles the registration of a new datum user, creating the user, personal organization and sending an email verification to the email address in the request the user will not be able to authenticate until the email is verified
func (*Handler) SendPasswordResetRequestEmail ¶ added in v0.2.2
SendPasswordResetRequestEmail Send an email to a user to request them to reset their password TODO: implement handler to use this and send password reset email
func (*Handler) SendPasswordResetSuccessEmail ¶ added in v0.2.2
SendPasswordResetSuccessEmail Send an email to a user to inform them that their password has been reset
func (*Handler) SendVerificationEmail ¶ added in v0.2.2
type InvalidEmailConfigError ¶ added in v0.2.2
type InvalidEmailConfigError struct {
// RequiredField that is missing
RequiredField string
}
InvalidEmailConfigError is returned when an invalid url configuration was provided
func (*InvalidEmailConfigError) Error ¶ added in v0.2.2
func (e *InvalidEmailConfigError) Error() string
Error returns the InvalidEmailConfigError in string format
type MissingRequiredFieldError ¶ added in v0.2.2
type MissingRequiredFieldError struct {
// RequiredField that is missing
RequiredField string
}
MissingRequiredFieldError is returned when a required field was not provided in a request
func (*MissingRequiredFieldError) Error ¶ added in v0.2.2
func (e *MissingRequiredFieldError) Error() string
Error returns the InvalidEmailConfigError in string format
type RefreshRequest ¶
type RefreshRequest struct {
RefreshToken string `json:"refresh_token"`
}
type RegisterReply ¶ added in v0.2.2
type RegisterReply struct {
ID string `json:"user_id"`
Email string `json:"email"`
Message string `json:"message"`
Token string `json:"token"`
}
RegisterReply holds the fields that are sent on a response to the `/register` endpoint
type RegisterRequest ¶ added in v0.2.2
type RegisterRequest struct {
FirstName string `json:"first_name"`
LastName string `json:"last_name"`
Email string `json:"email"`
Password string `json:"password"`
}
RegisterRequest holds the fields that should be included on a request to the `/register` endpoint
func (*RegisterRequest) Validate ¶ added in v0.2.2
func (r *RegisterRequest) Validate() error
Validate the register request ensuring that the required fields are available and that the password is valid - an error is returned if the request is not correct. This method also performs some basic data cleanup, trimming whitespace
type URLConfig ¶ added in v0.2.2
type URLConfig struct {
Base string `split_words:"true" default:"https://app.datum.net"`
Verify string `split_words:"true" default:"/verify"`
Invite string `split_words:"true" default:"/invite"`
Reset string `split_words:"true" default:"/reset"`
}
URLConfig for the datum registration TODO: move this to the same config setup as everything else
type User ¶
type User struct {
Username string `json:"username"`
Password string `json:"password"`
FirstName string
LastName string
Name string
Email string
EmailVerificationExpires sql.NullString
EmailVerificationToken sql.NullString
EmailVerificationSecret []byte
// contains filtered or unexported fields
}
User holds data specific to the datum user for the REST handlers for login, registration, verification, etc
func (*User) CreateResetToken ¶ added in v0.2.2
CreateResetToken creates a new reset token for the user
func (*User) CreateVerificationToken ¶ added in v0.2.2
CreateVerificationToken creates a new email verification token for the user
func (*User) GetVerificationExpires ¶ added in v0.2.2
GetVerificationExpires returns the expiration time of email verification token
func (*User) GetVerificationToken ¶ added in v0.2.2
GetVerificationToken returns the verification token if its valid
Source Files