models

Documentation

Index

• Constants
• func CheckIncident(inc *Incident) (err error)
• func NewArrayFromScannableSource[T any](src IScannableSequence) (values []T, err error)
• func NewNonNullValueFromScannableSource[T any](src IScannable) (T, error)
• func NewValueFromScannableSource[T any](src IScannable) (*T, error)
• type CaptchaAnswer
• type CaptchaId
• type Email
• type IApplication
• type IPAS
• type IScannable
• type IScannableSequence
• type IServer
• type ISettings
• type Incident
• type IncidentType
  • func (it IncidentType) IsValid() (ok bool)
• type Module
• type Name
• type Password
• type Path
  • func NormalisePath(path Path) Path
• type RequestId
• type ScheduledFn
• type Scheduler
  • func NewScheduler(srv IServer, funcs60 []ScheduledFn) (s *Scheduler)
  • func (s *Scheduler) Run()
• type StepNumber
• type UserParameters
  • func NewUserParameters() (up *UserParameters)
  • func NewUserParametersFromScannableSource(src IScannable) (up *UserParameters, err error)
• type UserRoles
  • func NewUserRoles() (ur *UserRoles)
  • func NewUserRolesFromScannableSource(src IScannable) (ur *UserRoles, err error)
• type VerificationCode
• type WebTokenString
  • func GetToken(req *http.Request) (token *WebTokenString, err error)

Constants

const (
	ErrIncidentIsNotSet  = "incident is not set"
	ErrIncidentTypeError = "incident type error"
)

const (
	IncidentType_IllegalAccessAttempt            = 1
	IncidentType_FakeToken                       = 2
	IncidentType_VerificationCodeMismatch        = 3
	IncidentType_DoubleLogInAttempt              = 4
	IncidentType_PreSessionHacking               = 5
	IncidentType_CaptchaAnswerMismatch           = 6
	IncidentType_PasswordMismatch                = 7
	IncidentType_PasswordChangeHacking           = 8
	IncidentType_EmailChangeHacking              = 9
	IncidentType_FakeIPA                         = 10
	IncidentType_ReadingNotificationOfOtherUsers = 11
	IncidentType_WrongDKey                       = 12
)

const (
	Module_ACM  = Module(1)
	Module_GWM  = Module(2)
	Module_MM   = Module(3)
	Module_NM   = Module(4)
	Module_RCS  = Module(5)
	Module_SM   = Module(6)
	Module_SMTP = Module(7)
)

const (
	CookieName_Token = "token"
)

const (
	IncidentTypesCount = 12
)

Functions

func CheckIncident

func CheckIncident(inc *Incident) (err error)

func NewArrayFromScannableSource

func NewArrayFromScannableSource[T any](src IScannableSequence) (values []T, err error)

func NewNonNullValueFromScannableSource

func NewNonNullValueFromScannableSource[T any](src IScannable) (T, error)

func NewValueFromScannableSource

func NewValueFromScannableSource[T any](src IScannable) (*T, error)

Types

type CaptchaAnswer

type CaptchaAnswer = cmb.Text

type CaptchaId

type CaptchaId = cmb.Text

type Email

type Email = cmb.Text

type IApplication

type IApplication interface {
	Use() error
}

type IPAS

type IPAS = cmb.Text

IPAS is an Internet Protocol Address String.

type IScannable

type IScannable interface {
	Scan(dest ...any) error
}

type IScannableSequence

type IScannableSequence interface {
	IScannable
	Next() bool // = HasNextValue()
}

type IServer

type IServer interface {
	Start() error
	ReportStart()
	Stop() error
	GetStopChannel() *chan bool
	UseConstructor(ISettings) (IServer, error)
	GetSubRoutinesWG() *sync.WaitGroup
	GetMustStopAB() *atomic.Bool
}

type ISettings

type ISettings interface {
	Check() error
	UseConstructor(string, *ver.Versioneer) (ISettings, error)
}

type Incident

type Incident struct {
	Id      cmb.Id
	Module  Module
	Type    IncidentType
	Time    time.Time
	Email   Email
	UserIPA net.IP
}

type IncidentType

type IncidentType byte

func (IncidentType) IsValid

func (it IncidentType) IsValid() (ok bool)

type Module

type Module byte

type Name

type Name = cmb.Text

type Password

type Password = cmb.Text

type Path

type Path = cmb.Text

func NormalisePath

func NormalisePath(path Path) Path

type RequestId

type RequestId = cmb.Text

type ScheduledFn

type ScheduledFn = func() error

type Scheduler

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

func NewScheduler

func NewScheduler(srv IServer, funcs60 []ScheduledFn) (s *Scheduler)

func (*Scheduler) Run

func (s *Scheduler) Run()

type StepNumber

type StepNumber = cmb.Count

type UserParameters

type UserParameters struct {
	Id                cmb.Id     `json:"id"`
	PreRegTime        *time.Time `json:"preRegTime,omitempty"`
	Email             Email      `json:"email,omitempty"`
	Name              Name       `json:"name,omitempty"`
	ApprovalTime      *time.Time `json:"approvalTime,omitempty"`
	RegTime           *time.Time `json:"regTime,omitempty"`
	Roles             *UserRoles `json:"roles,omitempty"`
	LastBadLogInTime  *time.Time `json:"lastBadLogInTime,omitempty"`
	BanTime           *time.Time `json:"banTime,omitempty"`
	LastBadActionTime *time.Time `json:"lastBadActionTime,omitempty"`
}

func NewUserParameters

func NewUserParameters() (up *UserParameters)

func NewUserParametersFromScannableSource

func NewUserParametersFromScannableSource(src IScannable) (up *UserParameters, err error)

type UserRoles

type UserRoles struct {
	IsAdministrator cmb.Flag `json:"isAdministrator"`
	IsModerator     cmb.Flag `json:"isModerator"`
	IsAuthor        cmb.Flag `json:"isAuthor"`
	IsWriter        cmb.Flag `json:"isWriter"`
	IsReader        cmb.Flag `json:"isReader"`
	CanLogIn        cmb.Flag `json:"canLogIn"`
}

func NewUserRoles

func NewUserRoles() (ur *UserRoles)

func NewUserRolesFromScannableSource

func NewUserRolesFromScannableSource(src IScannable) (ur *UserRoles, err error)

type VerificationCode

type VerificationCode = cmb.Text

type WebTokenString

type WebTokenString = cmb.Text

func GetToken

func GetToken(req *http.Request) (token *WebTokenString, err error)

GetToken tries to read a token. If a token is not found, null is returned.