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(client fsClient, corpus string) Authenticator
  • func NewAuthenticatorDB(ctx context.Context) (Authenticator, error)
• type AuthenticatorDBImpl
  • func (a *AuthenticatorDBImpl) ChangePassword(ctx context.Context, userInfo UserInfo, oldPassword, password string) ChangePasswordResult
  • func (a *AuthenticatorDBImpl) CheckLogin(ctx context.Context, username, password string) ([]UserInfo, error)
  • func (a *AuthenticatorDBImpl) CheckSession(ctx context.Context, sessionid string) SessionInfo
  • func (a *AuthenticatorDBImpl) GetUser(ctx context.Context, username string) ([]UserInfo, error)
  • func (a *AuthenticatorDBImpl) Logout(ctx context.Context, sessionid string)
  • func (a *AuthenticatorDBImpl) RequestPasswordReset(ctx context.Context, email string) RequestResetResult
  • func (a *AuthenticatorDBImpl) ResetPassword(ctx context.Context, token, password string) bool
  • func (a *AuthenticatorDBImpl) SaveSession(ctx context.Context, sessionid string, userInfo UserInfo, authenticated int) SessionInfo
  • func (a *AuthenticatorDBImpl) UpdateSession(ctx context.Context, sessionid string, userInfo UserInfo, authenticated int) SessionInfo
• type ChangePasswordResult
  • func OldPasswordDoesNotMatch() ChangePasswordResult
• type RequestResetRecord
• type RequestResetResult
• type SessionInfo
  • func InvalidSession() SessionInfo
• type SessionRecord
• 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 interface {
	ChangePassword(ctx context.Context, userInfo UserInfo, oldPassword, password string) ChangePasswordResult
	CheckLogin(ctx context.Context, username, password string) ([]UserInfo, error)
	CheckSession(ctx context.Context, sessionid string) SessionInfo
	GetUser(ctx context.Context, username string) ([]UserInfo, error)
	Logout(ctx context.Context, sessionid string)
	RequestPasswordReset(ctx context.Context, email string) RequestResetResult
	ResetPassword(ctx context.Context, token, password string) bool
	SaveSession(ctx context.Context, sessionid string, userInfo UserInfo, authenticated int) SessionInfo
	UpdateSession(ctx context.Context, sessionid string, userInfo UserInfo, authenticated int) SessionInfo
}

func NewAuthenticator

func NewAuthenticator(client fsClient, corpus string) Authenticator

Create a new Authenticator with a Firestore client

func NewAuthenticatorDB

func NewAuthenticatorDB(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

type AuthenticatorDBImpl

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

Authenticator holds stateful items needed for user authentication.

func (*AuthenticatorDBImpl) ChangePassword

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

ChangePassword enables the user to change passwords.

func (*AuthenticatorDBImpl) CheckLogin

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

CheckLogin checks the password when the user logs in.

func (*AuthenticatorDBImpl) CheckSession

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

CheckSession checks the session when the user requests a page.

func (*AuthenticatorDBImpl) GetUser

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

GetUser gets the user information.

func (*AuthenticatorDBImpl) Logout

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

Logout logs the user out of the current session.

func (*AuthenticatorDBImpl) RequestPasswordReset

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

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

func (*AuthenticatorDBImpl) ResetPassword

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

ResetPassword resets a password.

func (*AuthenticatorDBImpl) SaveSession

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

SaveSession saves an authenticated session to the database

func (*AuthenticatorDBImpl) UpdateSession

func (a *AuthenticatorDBImpl) 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 RequestResetRecord

type RequestResetRecord struct {
	EmailValid          bool   `firestore:"email_valid"`
	RequestResetSuccess bool   `firestore:"request_reset_success"`
	Email               string `firestore:"email"`
	UserName            string `firestore:"username"`
	Token               string `firestore:"token"`
}

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 SessionRecord

type SessionRecord struct {
	Authenticated int    `firestore:"authenticated"`
	Valid         bool   `firestore:"valid"`
	UserName      string `firestore:"username"`
}

type UserInfo

type UserInfo struct {
	UserID   int    `firestore:"userid"`
	UserName string `firestore:"username"`
	Email    string `firestore:"email"`
	FullName string `firestore:"fullname"`
	Role     string `firestore:"role"`
	Password string `firestore:"password"`
}

func InvalidUser

func InvalidUser() UserInfo

Empty session struct for an unauthenticated session