service

Documentation

Overview

Package service contains common functions used by the whole application

Index

• func DelMem2FA(authID uint64)
• func GetClaims(c *gin.Context) middleware.MyCustomClaims
• func GetUserByEmail(email string) (*model.Auth, error)
• func IsTokenAllowed(jti string) bool
• func JWTBlacklistChecker() gin.HandlerFunc
• func Postmark(params PostmarkParams) (postmark.EmailResponse, error)
• func SendEmail(email string, emailType int) bool
• func Validate2FA(encryptedMessage []byte, issuer string, userInput string) ([]byte, string, error)
• func ValidateUserID(authID uint64, email string) bool
• type PostmarkParams

Functions

func DelMem2FA

func DelMem2FA(authID uint64)

DelMem2FA - delete secrets from memory

func GetClaims

func GetClaims(c *gin.Context) middleware.MyCustomClaims

GetClaims - get JWT custom claims

func GetUserByEmail

func GetUserByEmail(email string) (*model.Auth, error)

GetUserByEmail ...

func IsTokenAllowed

func IsTokenAllowed(jti string) bool

IsTokenAllowed returns true when the token is not in the blacklist Dependency: JWT, Redis database + enable 'INVALIDATE_JWT' in .env

func JWTBlacklistChecker

func JWTBlacklistChecker() gin.HandlerFunc

JWTBlacklistChecker validates a token against the blacklist

func Postmark

func Postmark(params PostmarkParams) (postmark.EmailResponse, error)

Postmark email delivery service using HTML templates

https://postmarkapp.com/developer/api/email-api

https://postmarkapp.com/developer/api/templates-api

https://account.postmarkapp.com/servers/{ServerID}/templates

func SendEmail

func SendEmail(email string, emailType int) bool

SendEmail sends a verification/password recovery email if - required by the application - an external email service is configured - a redis database is configured

func Validate2FA

func Validate2FA(encryptedMessage []byte, issuer string, userInput string) ([]byte, string, error)

Validate2FA validates user-provided OTP

func ValidateUserID

func ValidateUserID(authID uint64, email string) bool

ValidateUserID - check whether authID or email is missing

Types

type PostmarkParams

type PostmarkParams struct {
	ServerToken   string
	TemplateID    int64
	From          string
	To            string
	Tag           string
	TrackOpens    bool
	TrackLinks    string
	MessageStream string
	HTMLModel     map[string]interface{}
}

PostmarkParams - parameters for postmark email delivery service