identity

Documentation

Overview

Package for working with corpora with private login required.

Index

• func IsAuthorized(user UserInfo, permission string) bool
• func NewSessionId() string
• func SendPasswordReset(toUser UserInfo, token string, c config.WebAppConfig) error
• type Authenticator
  • func NewAuthenticator(ctx context.Context) (*Authenticator, error)
  • func (a *Authenticator) ChangePassword(ctx context.Context, userInfo UserInfo, oldPassword, password string) ChangePasswordResult
  • func (a *Authenticator) CheckLogin(ctx context.Context, username, password string) ([]UserInfo, error)
  • func (a *Authenticator) CheckSession(ctx context.Context, sessionid string) SessionInfo
  • func (a *Authenticator) GetUser(ctx context.Context, username string) ([]UserInfo, error)
  • func (a *Authenticator) Logout(ctx context.Context, sessionid string)
  • func (a *Authenticator) RequestPasswordReset(ctx context.Context, email string) RequestResetResult
  • func (a *Authenticator) ResetPassword(ctx context.Context, token, password string) bool
  • func (a *Authenticator) SaveSession(ctx context.Context, sessionid string, userInfo UserInfo, authenticated int) SessionInfo
  • func (a *Authenticator) UpdateSession(ctx context.Context, sessionid string, userInfo UserInfo, authenticated int) SessionInfo
• type ChangePasswordResult
  • func OldPasswordDoesNotMatch() ChangePasswordResult
• type RequestResetResult
• type SessionInfo
  • func InvalidSession() SessionInfo
• type UserInfo
  • func InvalidUser() UserInfo

Functions

func IsAuthorized

func IsAuthorized(user UserInfo, permission string) bool

Generate a new session id after login

func NewSessionId

func NewSessionId() string

Generate a new session id after login

func SendPasswordReset

func SendPasswordReset(toUser UserInfo, token string, c config.WebAppConfig) error

Types

type Authenticator

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

Authenticator holds stateful items needed for user authentication.

func NewAuthenticator

func NewAuthenticator(ctx context.Context) (*Authenticator, error)

NewAuthenticator creates but does not initialize an Authenticator object.

Params:

isProtected - set this to true if only the site is password protected

func (*Authenticator) ChangePassword

func (a *Authenticator) ChangePassword(ctx context.Context, userInfo UserInfo,
	oldPassword, password string) ChangePasswordResult

ChangePassword enables the user to change passwords.

func (*Authenticator) CheckLogin

func (a *Authenticator) CheckLogin(ctx context.Context,
	username, password string) ([]UserInfo, error)

CheckLogin checks the password when the user logs in.

func (*Authenticator) CheckSession

func (a *Authenticator) CheckSession(ctx context.Context, sessionid string) SessionInfo

CheckSession checks the session when the user requests a page.

func (*Authenticator) GetUser

func (a *Authenticator) GetUser(ctx context.Context,
	username string) ([]UserInfo, error)

GetUser gets the user information.

func (*Authenticator) Logout

func (a *Authenticator) Logout(ctx context.Context, sessionid string)

Logout logs the user out of the current session.

func (*Authenticator) RequestPasswordReset

func (a *Authenticator) RequestPasswordReset(ctx context.Context,
	email string) RequestResetResult

RequestPasswordReset requests a password reset, to be sent by email.

func (*Authenticator) ResetPassword

func (a *Authenticator) ResetPassword(ctx context.Context, token, password string) bool

ResetPassword resets a password.

func (*Authenticator) SaveSession

func (a *Authenticator) SaveSession(ctx context.Context,
	sessionid string, userInfo UserInfo, authenticated int) SessionInfo

SaveSession saves an authenticated session to the database

func (*Authenticator) UpdateSession

func (a *Authenticator) UpdateSession(ctx context.Context,
	sessionid string, userInfo UserInfo, authenticated int) SessionInfo

UpdateSession logs a user in when they already have an unauthenticated session.

type ChangePasswordResult

type ChangePasswordResult struct {
	OldPasswordValid bool
	ChangeSuccessful bool
	ShowNewForm      bool
}

func OldPasswordDoesNotMatch

func OldPasswordDoesNotMatch() ChangePasswordResult

Old password does not match

type RequestResetResult

type RequestResetResult struct {
	EmailValid          bool
	RequestResetSuccess bool
	ShowNewForm         bool
	User                UserInfo
	Token               string
}

type SessionInfo

type SessionInfo struct {
	Authenticated int
	Valid         bool
	User          UserInfo
}

func InvalidSession

func InvalidSession() SessionInfo

InvalidSession creates an empty session struct.

type UserInfo

type UserInfo struct {
	UserID                          int
	UserName, Email, FullName, Role string
}

func InvalidUser

func InvalidUser() UserInfo

Empty session struct for an unauthenticated session