handlers

package
v0.4.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 25, 2024 License: Apache-2.0 Imports: 50 Imported by: 0

Documentation

Overview

Package handlers contains custom handler functions

Index

Constants

This section is empty.

Variables

View Source 
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")

	// ErrNotFound is returned when the requested object is not found
	ErrNotFound = errors.New("object not found in the database")

	// ErrMissingField is returned when a field is missing duh
	ErrMissingField = errors.New("missing required field")

	// ErrInvalidCredentials is returned when the password is invalid or missing
	ErrInvalidCredentials = errors.New("datum credentials are missing or invalid")

	// ErrUnverifiedUser is returned when email_verified on the user is false
	ErrUnverifiedUser = errors.New("user is not verified")

	// ErrUnableToVerifyEmail is returned when user's email is not able to be verified
	ErrUnableToVerifyEmail = errors.New("could not verify email")

	// ErrMaxAttempts is returned when user has requested the max retry attempts to verify their email
	ErrMaxAttempts = errors.New("max attempts verifying email address")

	// ErrNoEmailFound is returned when using an oauth provider and the email address cannot be determined
	ErrNoEmailFound = errors.New("no email found from oauth provider")

	// ErrInvalidProvider is returned when registering a user with an unsupported oauth provider
	ErrInvalidProvider = errors.New("oauth2 provider not supported")

	// ErrNoAuthUser is returned when the user couldn't be identified by the request
	ErrNoAuthUser = errors.New("could not identify authenticated user in request")

	// ErrPassWordResetTokenInvalid is returned when the provided token and secret do not match the stored
	ErrPassWordResetTokenInvalid = errors.New("password reset token invalid")

	// ErrNonUniquePassword is returned when the password was already used
	ErrNonUniquePassword = errors.New("password was already used, please try again")

	// ErrPasswordTooWeak is returned when the password is too weak
	ErrPasswordTooWeak = errors.New("password is too weak: use a combination of upper and lower case letters, numbers, and special characters")

	// ErrMaxDeviceLimit is returned when the user has reached the max device limit
	ErrMaxDeviceLimit = errors.New("max device limit reached")

	// ErrDeviceAlreadyRegistered is returned when the device is already registered
	ErrDeviceAlreadyRegistered = errors.New("device already registered")

	// ErrSubscriberNotFound is returned when the subscriber is not found
	ErrSubscriberNotFound = errors.New("subscriber not found")

	// ErrExpiredToken is returned when the token has expired
	ErrExpiredToken = errors.New("token has expired")
)

Functions

func IsConstraintError added in v0.2.2 

func IsConstraintError(err error) bool

IsConstraintError returns true if the error resulted from a database constraint violation.

func IsForeignKeyConstraintError added in v0.2.2 

func IsForeignKeyConstraintError(err error) bool

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 

func IsUniqueConstraintError(err error) bool

IsUniqueConstraintError reports if the error resulted from a DB uniqueness constraint violation. e.g. duplicate value in unique index.

Types

type CheckFunc 

type CheckFunc func(ctx context.Context) error

CheckFunc is a function that can be used to check the status of a service

type Checks 

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

func (*Checks) ReadyHandler 

func (c *Checks) ReadyHandler(ctx echo.Context) error

type ForgotPasswordReply added in v0.3.2 

type ForgotPasswordReply struct {
	rout.Reply
	Message string `json:"message,omitempty"`
}

ForgotPasswordReply contains fields for a forgot password response

type ForgotPasswordRequest added in v0.2.3 

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

ForgotPasswordRequest contains fields for a forgot password request

type Handler 

type Handler struct {
	// IsTest is a flag to determine if the application is running in test mode and will mock external calls
	IsTest bool
	// DBClient to interact with the generated ent schema
	DBClient *ent.Client
	// RedisClient to interact with redis
	RedisClient *redis.Client
	// TM contains the token manager in order to validate auth requests
	TM *tokens.TokenManager
	// 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
	// SessionConfig to handle sessions
	SessionConfig *sessions.SessionConfig
	// EmailManager to handle sending emails
	EmailManager *emails.EmailManager
	// TaskMan manages tasks in a separate goroutine to allow for non blocking operations
	TaskMan *marionette.TaskManager
	// AnalyticsClient is the client used to send analytics events
	AnalyticsClient *analytics.EventManager
	// OauthProvider contains the configuration settings for all supported Oauth2 providers
	OauthProvider OauthProviderConfig
	// AuthMiddleware contains the middleware to be used for authenticated endpoints
	AuthMiddleware []echo.MiddlewareFunc
	// WebAuthn contains the configuration settings for the webauthn provider
	WebAuthn *webauthn.WebAuthn
	// OTPManager contains the configuration settings for the OTP provider
	OTPManager *totp.Manager
}

Handler contains configuration options for handlers

func (*Handler) AddReadinessCheck 

func (h *Handler) AddReadinessCheck(name string, f CheckFunc)

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) BeginWebauthnLogin added in v0.3.0 

func (h *Handler) BeginWebauthnLogin(ctx echo.Context) error

BeginWebauthnLogin is the request to begin a webauthn login

func (*Handler) BeginWebauthnRegistration added in v0.3.0 

func (h *Handler) BeginWebauthnRegistration(ctx echo.Context) error

BeginWebauthnRegistration is the request to begin a webauthn login

func (*Handler) CheckAndCreateUser added in v0.3.0 

func (h *Handler) CheckAndCreateUser(ctx context.Context, name, email string, provider enums.AuthProvider) (*ent.User, error)

CheckAndCreateUser takes a user with an OauthTooToken set in the context and checks if the user is already created if the user already exists, update last seen

func (*Handler) FinishWebauthnLogin added in v0.3.0 

func (h *Handler) FinishWebauthnLogin(ctx echo.Context) error

FinishWebauthnLogin is the request to finish a webauthn login

func (*Handler) FinishWebauthnRegistration added in v0.3.0 

func (h *Handler) FinishWebauthnRegistration(ctx echo.Context) error

FinishWebauthnRegistration is the request to finish a webauthn registration - this is where we get the credential created by the user back

func (*Handler) ForgotPassword added in v0.2.3 

func (h *Handler) ForgotPassword(ctx echo.Context) error

ForgotPassword will send an forgot password email if the provided email exists

func (*Handler) GetGitHubLoginHandlers added in v0.2.7 

func (h *Handler) GetGitHubLoginHandlers() (http.Handler, http.Handler)

GetGitHubLoginHandlers returns the github login and callback handlers

func (*Handler) GetGoogleLoginHandlers added in v0.2.7 

func (h *Handler) GetGoogleLoginHandlers() (http.Handler, http.Handler)

GetGoogleLoginHandlers returns the google login and callback handlers

func (*Handler) IsAuthenticated added in v0.2.7 

func (h *Handler) IsAuthenticated(req *http.Request) bool

IsAuthenticated checks the sessions to a valid session cookie

func (*Handler) LoginHandler 

func (h *Handler) LoginHandler(ctx echo.Context) error

LoginHandler validates the user credentials and returns a valid cookie this handler only supports username password login

func (*Handler) Logout added in v0.2.7 

func (h *Handler) Logout(ctx echo.Context) error

func (*Handler) OauthRegister added in v0.3.1 

func (h *Handler) OauthRegister(ctx echo.Context) error

OauthRegister returns the TokenResponse for a verified authenticated external oauth user

func (*Handler) OpenIDConfiguration added in v0.3.0 

func (h *Handler) OpenIDConfiguration(ctx echo.Context) error

OpenIDConfiguration returns a JSON document with the OpenID configuration as defined by the OpenID Connect standard: https://connect2id.com/learn/openid-connect. This document helps clients understand how to authenticate with Datum.

func (*Handler) OrganizationInviteAccept added in v0.2.6 

func (h *Handler) OrganizationInviteAccept(ctx echo.Context) error

OrganizationInviteAccept is responsible for handling the invitation of a user to an organization. It receives a request with the user's invitation details, validates the request, and creates organization membership for the user On success, it returns a response with the organization information

func (*Handler) RefreshHandler 

func (h *Handler) RefreshHandler(ctx echo.Context) error

RefreshHandler allows users to refresh their access token using their refresh token.

func (*Handler) RegisterHandler added in v0.2.2 

func (h *Handler) RegisterHandler(ctx echo.Context) error

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 [MermaidChart: 5a357443-f959-4f16-a07f-ec504f67f0eb]

func (*Handler) RequireLogin added in v0.2.7 

func (h *Handler) RequireLogin(next http.Handler) http.Handler

RequireLogin redirects unauthenticated users to the login route

func (*Handler) ResendEmail added in v0.2.3 

func (h *Handler) ResendEmail(ctx echo.Context) error

ResendEmail will resend an email verification email if the provided email exists

func (*Handler) ResetPassword added in v0.2.4 

func (h *Handler) ResetPassword(ctx echo.Context) error

ResetPassword allows the user (after requesting a password reset) to set a new password - the password reset token needs to be set in the request and not expired. If the request is successful, a confirmation of the reset is sent to the user and a 204 no content is returned

func (*Handler) SendOrgInvitationEmail added in v0.2.6 

func (h *Handler) SendOrgInvitationEmail(i *emails.Invite) error

SendOrgInvitationEmail sends an email inviting a user to join Datum and an existing organization

func (*Handler) SendPasswordResetRequestEmail added in v0.2.2 

func (h *Handler) SendPasswordResetRequestEmail(user *User) error

SendPasswordResetRequestEmail Send an email to a user to request them to reset their password

func (*Handler) SendPasswordResetSuccessEmail added in v0.2.2 

func (h *Handler) SendPasswordResetSuccessEmail(user *User) error

SendPasswordResetSuccessEmail Send an email to a user to inform them that their password has been reset

func (*Handler) SendSubscriberEmail added in v0.3.6 

func (h *Handler) SendSubscriberEmail(user *User, orgName string) error

SendSubscriberEmail sends an email to confirm a user's subscription

func (*Handler) SendVerificationEmail added in v0.2.2 

func (h *Handler) SendVerificationEmail(user *User) error

SendVerificationEmail sends an email to a user to verify their email address

func (*Handler) SubscribeHandler added in v0.3.6 

func (h *Handler) SubscribeHandler(ctx echo.Context) error

SubscribeHandler is responsible for handling requests to the `/subscribe` endpoint It creates a new subscriber and sends a verification email to the subscriber this current only supports email subscriptions

func (*Handler) UnsubscribeHandler added in v0.3.6 

func (h *Handler) UnsubscribeHandler(ctx echo.Context) error

UnsubscribeHandler is responsible for handling requests to the `/unsubscribe` endpoint and removes subscribers from the mailing list

func (*Handler) UserInfo added in v0.3.1 

func (h *Handler) UserInfo(ctx echo.Context) error

UserInfo returns the user information for the authenticated user

func (*Handler) VerifyEmail added in v0.2.3 

func (h *Handler) VerifyEmail(ctx echo.Context) error

VerifyEmail is the handler for the email verification endpoint

func (*Handler) VerifySubscriptionHandler added in v0.3.6 

func (h *Handler) VerifySubscriptionHandler(ctx echo.Context) error

VerifySubscriptionHandler is the handler for the subscription verification endpoint

type Invite added in v0.2.6 

type Invite struct {
	Token     string
	UserID    ulid.ULID
	Email     string
	DestOrgID ulid.ULID
	Role      enums.Role
	InviteToken
}

Invite holds the Token, InviteToken references, and the additional user input to // complete acceptance of the invitation

func (*Invite) GetInviteExpires added in v0.2.6 

func (i *Invite) GetInviteExpires() (time.Time, error)

GetInviteExpires returns the expiration time of invite token

func (*Invite) GetInviteToken added in v0.2.6 

func (i *Invite) GetInviteToken() string

GetInviteToken returns the invitation token if its valid

type InviteReply added in v0.2.6 

type InviteReply struct {
	rout.Reply
	ID          string `json:"user_id"`
	Email       string `json:"email"`
	Message     string `json:"message"`
	JoinedOrgID string `json:"joined_org_id"`
	Role        string `json:"role"`
}

InviteReply holds the fields that are sent on a response to an accepted invitation Note: there is no InviteRequest as this is handled via our graph interfaces

type InviteRequest added in v0.2.6 

type InviteRequest struct {
	Token string `query:"token"`
}

InviteRequest holds the fields that should be included on a request to the `/invite` endpoint

type InviteToken added in v0.2.6 

type InviteToken struct {
	Expires sql.NullString
	Token   sql.NullString
	Secret  []byte
}

InviteToken holds data specific to a future user of the system for invite logic

type LoginReply added in v0.3.2 

type LoginReply struct {
	rout.Reply
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token,omitempty"`
	TokenType    string `json:"token_type"`
	ExpiresIn    int64  `json:"expires_in"`
	Message      string `json:"message"`
}

LoginReply holds response to successful authentication

type LoginRequest added in v0.2.3 

type LoginRequest struct {
	Username string `json:"username"`
	Password string `json:"password"`
	OTPCode  string `json:"otp_code,omitempty"`
}

LoginRequest to authenticate with the Datum Sever

type OauthProviderConfig added in v0.2.7 

type OauthProviderConfig struct {
	// RedirectURL is the URL that the OAuth2 client will redirect to after authentication with datum
	RedirectURL string `json:"redirectUrl" koanf:"redirectUrl" default:"http://localhost:3001/api/auth/callback/datum"`
	// Github contains the configuration settings for the Github Oauth Provider
	Github github.ProviderConfig `json:"github" koanf:"github"`
	// Google contains the configuration settings for the Google Oauth Provider
	Google google.ProviderConfig `json:"google" koanf:"google"`
	// Webauthn contains the configuration settings for the Webauthn Oauth Provider
	Webauthn webauthn.ProviderConfig `json:"webauthn" koanf:"webauthn"`
}

OauthProviderConfig represents the configuration for OAuth providers such as Github and Google

type OauthTokenRequest added in v0.3.1 

type OauthTokenRequest struct {
	Name             string `json:"name"`
	Email            string `json:"email"`
	AuthProvider     string `json:"authProvider"`
	ExternalUserID   string `json:"externalUserId"`
	ExternalUserName string `json:"externalUserName"`
	ClientToken      string `json:"clientToken"`
}

OauthTokenRequest to authenticate an oauth user with the Datum Server

type RefreshReply added in v0.3.2 

type RefreshReply struct {
	rout.Reply
	Message string `json:"message,omitempty"`
}

RefreshReply holds the fields that are sent on a response to the `/refresh` endpoint

type RefreshRequest 

type RefreshRequest struct {
	RefreshToken string `json:"refresh_token"`
}

RefreshRequest holds the fields that should be included on a request to the `/refresh` endpoint

type RegisterReply added in v0.2.2 

type RegisterReply struct {
	rout.Reply
	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 ResendReply added in v0.2.3 

type ResendReply struct {
	rout.Reply
	Message string `json:"message"`
}

ResendReply holds the fields that are sent on a response to the `/resend` endpoint

type ResendRequest added in v0.2.3 

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

ResendRequest contains fields for a resend email verification request

type ResetPasswordReply added in v0.2.4 

type ResetPasswordReply struct {
	rout.Reply
	Message string `json:"message"`
}

ResetPasswordReply is the response returned from a non-successful password reset request on success, no content is returned (204)

type ResetPasswordRequest added in v0.2.4 

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

ResetPasswordRequest contains user input required to reset a user's password

type StatusReply added in v0.3.2 

type StatusReply struct {
	Status map[string]string `json:"status"`
}

StatusReply returns server status

type SubscribeReply added in v0.3.6 

type SubscribeReply struct {
	rout.Reply
	Message string `json:"message"`
}

SubscribeReply holds the fields that are sent on a response to the `/subscribe` endpoint

type SubscribeRequest added in v0.4.0 

type SubscribeRequest struct {
	Email          string `query:"email"`
	OrganizationID string `query:"organization_id" json:",omitempty"`
}

SubscribeRequest holds the fields that should be included on a request to the `/subscribe` endpoint

type URLToken added in v0.2.6 

type URLToken struct {
	Expires sql.NullString
	Token   sql.NullString
	Secret  []byte
}

URLToken holds data specific to a future user of the system for invite logic

type UnsubscribeReply added in v0.3.6 

type UnsubscribeReply struct {
	rout.Reply
	Message string `json:"message"`
}

UnsubscribeReply holds the fields that are sent on a response to the `/unsubscribe` endpoint

type UnsubscribeRequest added in v0.4.0 

type UnsubscribeRequest struct {
	Email          string `query:"email"`
	OrganizationID string `query:"organization_id" json:",omitempty"`
}

UnsubscribeRequest holds the fields that should be included on a request to the `/unsubscribe` endpoint

type User 

type User struct {
	ID                       string
	FirstName                string
	LastName                 string
	Name                     string
	Email                    string
	Password                 *string
	OTPSecret                string `json:"-"`
	EmailVerificationExpires sql.NullString
	EmailVerificationToken   sql.NullString
	EmailVerificationSecret  []byte
	PasswordResetExpires     sql.NullString
	PasswordResetToken       sql.NullString
	PasswordResetSecret      []byte
	URLToken
}

User holds data specific to the datum user for the REST handlers for login, registration, verification, etc

func (*User) CreatePasswordResetToken added in v0.2.4 

func (u *User) CreatePasswordResetToken() error

CreatePasswordResetToken creates a new reset token for the user

func (*User) CreateVerificationToken added in v0.2.2 

func (u *User) CreateVerificationToken() error

CreateVerificationToken creates a new email verification token for the user

func (*User) GetPasswordResetExpires added in v0.2.3 

func (u *User) GetPasswordResetExpires() (time.Time, error)

GetPasswordResetExpires returns the expiration time of password verification token

func (*User) GetPasswordResetToken added in v0.2.3 

func (u *User) GetPasswordResetToken() string

GetPasswordResetToken returns the password reset token if its valid

func (*User) GetVerificationExpires added in v0.2.2 

func (u *User) GetVerificationExpires() (time.Time, error)

GetVerificationExpires returns the expiration time of email verification token

func (*User) GetVerificationToken added in v0.2.2 

func (u *User) GetVerificationToken() string

GetVerificationToken returns the verification token if its valid

type VerifyReply added in v0.3.2 

type VerifyReply struct {
	rout.Reply
	ID           string `json:"user_id"`
	Email        string `json:"email"`
	Token        string `json:"token"`
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token,omitempty"`
	TokenType    string `json:"token_type"`
	ExpiresIn    int64  `json:"expires_in"`
	Message      string `json:"message,omitempty"`
}

VerifyReply holds the fields that are sent on a response to the `/verify` endpoint

type VerifyRequest added in v0.3.2 

type VerifyRequest struct {
	Token string `query:"token"`
}

VerifyRequest holds the fields that should be included on a request to the `/verify` endpoint

type VerifySubscribeReply added in v0.3.6 

type VerifySubscribeReply struct {
	rout.Reply
	Message string `json:"message,omitempty"`
}

VerifySubscribeReply holds the fields that are sent on a response to the `/subscribe/verify` endpoint

type VerifySubscribeRequest added in v0.4.0 

type VerifySubscribeRequest struct {
	Token string `query:"token"`
}

VerifySubscribeRequest holds the fields that should be included on a request to the `/subscribe/verify` endpoint

type WebauthnRegistrationRequest added in v0.3.5 

type WebauthnRegistrationRequest struct {
	Email string `json:"email"`
	Name  string `json:"name"`
}

WebauthnRegistrationRequest is the request to begin a webauthn login

type WebauthnRegistrationResponse added in v0.3.5 

type WebauthnRegistrationResponse struct {
	rout.Reply
	Message string `json:"message,omitempty"`
}

WebauthnRegistrationResponse is the response to begin a webauthn login

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.