auth

README

auth

go get github.com/go-gorf/auth

Documentation

Index

• Variables
• func LoginRequiredMiddleware(ctx *gin.Context)
• func Urls(r *gin.Engine)
• func UserLogin(ctx *gin.Context)
• func UserProfile(ctx *gin.Context)
• func UserSignUp(ctx *gin.Context)
• type AuthAppSettings
• type AuthEmailVerificationBackend
• type AuthState
• type User
  • func GetUser(ctx *gin.Context) (User, error)
  • func (user *User) FullName() string

Variables

var AuthApp = gorf.GorfBaseApp{
	Name:         "auth",
	RouteHandler: Urls,
	SetUpHandler: setup,
}

var AuthSettings = AuthAppSettings{
	NewUserState:      activateUserOnCreation,
	EmailVerification: skipEmailVerification,
	NewUserAdminState: defaultAdminStatus,
}

Functions

func LoginRequiredMiddleware

func LoginRequiredMiddleware(ctx *gin.Context)

func Urls

func Urls(r *gin.Engine)

func UserLogin

func UserLogin(ctx *gin.Context)

func UserProfile

func UserProfile(ctx *gin.Context)

func UserSignUp

func UserSignUp(ctx *gin.Context)

Types

type AuthAppSettings

type AuthAppSettings struct {
	NewUserState             AuthState
	NewUserAdminState        AuthState
	EmailVerification        AuthState
	EmailVerificationBackend AuthEmailVerificationBackend
}

type AuthEmailVerificationBackend

type AuthEmailVerificationBackend interface {
	PrepareMail(user *User) error
	SendMail() error
}

type AuthState

type AuthState bool

type User

type User struct {
	gorm.Model
	FirstName string `json:"first_name" binding:"required"`
	LastName  string `json:"last_name" binding:"required"`
	Email     string `json:"email" binding:"required" gorm:"unique;not null"`
	Password  string `json:"-" binding:"required"`
	Active    bool   `json:"active"`
	Admin     bool   `json:"admin"`
}

func GetUser

func GetUser(ctx *gin.Context) (User, error)

func (*User) FullName

func (user *User) FullName() string