users

Documentation

Index

• Variables
• type AuthedUser
  • func LoggedIn(accessToken string) (*AuthedUser, error)
• type User
  • func NewDefaultUser(username, organization string) (*User, error)
  • func (u User) AccessToken() (string, error)
  • func (u User) Credentials(password string) error
  • func (u *User) HashAndSalt(password string) error
  • func (u *User) UUID() error
• type UserRepo

Variables

var (
	ErrMissingFields    = fmt.Errorf("not all fields are provided")
	ErrInvalidOrgnName  = fmt.Errorf("organization name does not follow policies")
	ErrWrongCredentials = fmt.Errorf("user credentials are not matching with db record")

	ErrInvalidJWT = fmt.Errorf("jwt is no longer valid")
	ErrJWTParse   = fmt.Errorf("could not parse jwt token")
	ErrCorruptJWT = fmt.Errorf("jwt could not be parsed (JWT might be corrupted)")
	ErrExpiredJWT = fmt.Errorf("provided JWT has expired")
)

Types

type AuthedUser

type AuthedUser struct {
	Uuid         string
	Organization string
	Username     string
}

func LoggedIn

func LoggedIn(accessToken string) (*AuthedUser, error)

type User

type User struct {
	Uuid         string `bson:"_id"`
	Username     string `bson:"username" required:"yes"`
	Organization string `bson:"organization" required:"yes"`
	Password     string `bson:"password"`
}

func NewDefaultUser

func NewDefaultUser(username, organization string) (*User, error)

func (User) AccessToken

func (u User) AccessToken() (string, error)

AccessToken generates a JWT based on the User information

func (User) Credentials

func (u User) Credentials(password string) error

func (*User) HashAndSalt

func (u *User) HashAndSalt(password string) error

HashAndSalt hashes the plain text user password

func (*User) UUID

func (u *User) UUID() error

UUID assigns a new unique identifier to the User struct

type UserRepo

type UserRepo interface {
	UsernameTaken(ctx context.Context, username string) (bool, error)
	Store(ctx context.Context, user User) error
	GetByUsername(ctx context.Context, username string, stored interface{}) error
}