core

Documentation

Index

• Constants
• func GenerateRandomPassword(length int) string
• func GenerateToken(numberBytes int) string
• func GenerateTokenDefaultLength() string
• type CustomValidationError
  • func (v CustomValidationError) Error() string
  • func (v CustomValidationError) Format(f string) string
  • func (v CustomValidationError) GetFieldName() string
  • func (v CustomValidationError) GetFieldTypeName() string
  • func (v CustomValidationError) GetFieldValue() string
  • func (v CustomValidationError) GetIdentifier() valtruc.ValidatorIdentifier
  • func (v CustomValidationError) GetStructName() string
• type Cypher
• type DomainError
  • func (err DomainError) Error() string
  • func (err DomainError) IsPresent() bool
  • func (err DomainError) Wrap(other error) DomainError
  • func (err DomainError) Wrapf(format string, a ...any) DomainError
• type Hasher
• type ModelState
• type Role
• type ValidationError

Constants

const (
	Size64 int = 64
	Size32 int = 32
	Size16 int = 16
	Size8  int = 8
)

const DefaultTokenBytes int = Size32

DefaultTokenBytes defines the default length of token bytes to generate a token. This is used in the function "GenerateTokenDefaultLength"

const (
	IntBase10 int = 10
)

const OneDayDuration time.Duration = 24 * time.Hour

Functions

func GenerateRandomPassword

func GenerateRandomPassword(length int) string

Generates a random password with the requested length.

func GenerateToken

func GenerateToken(numberBytes int) string

Generates a crypto random token with a number of bytes. The returned token is encoded in URL base64.

func GenerateTokenDefaultLength

func GenerateTokenDefaultLength() string

Generates a crypto random token with the default length. See the function "GenerateToken" and the constant "DefaultTokenBytes"

Types

type CustomValidationError

type CustomValidationError struct {
	ErrorMessage  string
	StructName    string
	FieldName     string
	FieldTypeName string
	FieldValue    string
	Identifier    valtruc.ValidatorIdentifier
}

func (CustomValidationError) Error

func (v CustomValidationError) Error() string

func (CustomValidationError) Format

func (v CustomValidationError) Format(f string) string

func (CustomValidationError) GetFieldName

func (v CustomValidationError) GetFieldName() string

func (CustomValidationError) GetFieldTypeName

func (v CustomValidationError) GetFieldTypeName() string

func (CustomValidationError) GetFieldValue

func (v CustomValidationError) GetFieldValue() string

func (CustomValidationError) GetIdentifier

func (v CustomValidationError) GetIdentifier() valtruc.ValidatorIdentifier

func (CustomValidationError) GetStructName

func (v CustomValidationError) GetStructName() string

type Cypher

type Cypher interface {
	Encrypt(data []byte) ([]byte, error)
	Decrypt(data []byte) ([]byte, error)
}

Cypher is anything that implements a symmetric encription

type DomainError

type DomainError struct {
	Code    int
	Message string
	// contains filtered or unexported fields
}

DomainError models an error generated by business logic layer of your application

func (DomainError) Error

func (err DomainError) Error() string

func (DomainError) IsPresent

func (err DomainError) IsPresent() bool

func (DomainError) Wrap

func (err DomainError) Wrap(other error) DomainError

func (DomainError) Wrapf

func (err DomainError) Wrapf(format string, a ...any) DomainError

type Hasher

type Hasher interface {
	Hash(value string) (string, error)
	Check(a, b string) bool
}

Hasher is anything that implements a hash algorithm. Normally a cryptographic hash to hash passwords (eg Bcrypt)

type ModelState

type ModelState struct {
	Valid  bool
	Errors map[string][]ValidationError
}

ModelState represent the validation state of a ViewModel. Normally you want to let owl to generate it via the context API:

func handler(ctx owl.Ctx) error {
	var vm ViewModel
	ctx.ParseForm(&vm)
	ctx.Validate(vm)
	if ctx.ModelState.Valid {
		...
	}
}

The validate function fills the ModelState depending of the rules you define in the struct tags using the library 'valtruc'.

type Role

type Role int64

Role defines a user role

const (
	RoleAdmin Role = 1
	RoleUser  Role = 2
)

type ValidationError

type ValidationError interface {
	Error() string
	Format(f string) string
	GetStructName() string
	GetFieldName() string
	GetFieldTypeName() string
	GetFieldValue() string
	GetIdentifier() valtruc.ValidatorIdentifier
}

ValidationError represents an infraction of validation rules defined in tags of a struct. Show 'ModelState'.