model

Documentation

Index

• Constants
• func NewUserResource(ctx context.Context, user *User) register.UserResource
• type ErrUniqueConstraintViolation
  • func (e ErrUniqueConstraintViolation) Error() string
• type User
  • func CreateUser(ctx context.Context, username string, email string) (*User, error)
  • func LoadUserByUsername(ctx context.Context, username string) (*User, error)
  • func (u *User) RollPassword(ctx context.Context) error
  • func (u *User) Save(ctx context.Context) error

Constants

const (
	// SecretByteLen is the length in byte of the secret.
	SecretByteLen int = 64
	// PasswordByteLen is the length in byte of the secret.
	PasswordByteLen int = 16
)

Functions

func NewUserResource

func NewUserResource(
	ctx context.Context,
	user *User,
) register.UserResource

NewUserResource generates a new user resource.

Types

type ErrUniqueConstraintViolation

type ErrUniqueConstraintViolation struct {
	Err error
}

ErrUniqueConstraintViolation is returned when a object insertion violates a unique constraint.

func (ErrUniqueConstraintViolation) Error

func (e ErrUniqueConstraintViolation) Error() string

type User

type User struct {
	Token   string
	Created time.Time

	Status   register.UsrStatus
	Username string
	Email    string

	Secret   string
	Password string

	MintToken *string `db:"mint_token"`
}

User represents a user object. Users are not tied to a mint user until they are verified.

func CreateUser

func CreateUser(
	ctx context.Context,
	username string,
	email string,
) (*User, error)

CreateUser creates and stores a new User object.

func LoadUserByUsername

func LoadUserByUsername(
	ctx context.Context,
	username string,
) (*User, error)

LoadUserByUsername attempts to load a user with the given username.

func (*User) RollPassword

func (u *User) RollPassword(
	ctx context.Context,
) error

RollPassword generates a new password for the user.

func (*User) Save

func (u *User) Save(
	ctx context.Context,
) error

Save updates the object database representation with the in-memory values.