package domain

import "github.com/go-arrower/arrower/contexts/auth/internal/domain"

Index ¶

• Variables
• type AuthenticationService
• func NewAuthenticationService(settings setting.Settings) *AuthenticationService
• func (s *AuthenticationService) Authenticate(ctx context.Context, user User, password string) bool
• type Birthday
• func NewBirthday(day Day, month Month, year Year) (Birthday, error)
• func (b Birthday) String() string
• type BoolFlag
• func FALSE() BoolFlag
• func TRUE() BoolFlag
• func (t BoolFlag) At() time.Time
• func (t BoolFlag) IsFalse() bool
• func (t BoolFlag) IsTrue() bool
• func (t BoolFlag) SetFalse() BoolFlag
• func (t BoolFlag) SetTrue() BoolFlag
• type Day
• type Descriptor
• type Device
• func NewDevice(userAgent string) Device
• func (d Device) Name() string
• func (d Device) OS() string
• func (d Device) String() string
• func (d Device) UserAgent() string
• type Filter
• type ID
• func NewID() ID
• type IPResolver
• type Locale
• type Login
• type Month
• type Name
• func NewName(firstName string, lastName string, displayName string) Name
• func (name Name) DisplayName() string
• func (name Name) FirstName() string
• func (name Name) LastName() string
• type PasswordHash
• func NewPasswordHash(password string) (PasswordHash, error)
• func NewStrongPasswordHash(password string) (PasswordHash, error)
• func (pw PasswordHash) Matches(checkPW string) bool
• func (pw PasswordHash) String() string
• type Profile
• type RegistrationService
• func NewRegistrationService(settingsService setting.Settings, repo Repository) *RegistrationService
• func (s *RegistrationService) RegisterNewUser( ctx context.Context, registerEmail string, password string, ) (User, error)
• type Repository
• type ResolvedIP
• type Session
• type TimeZone
• type URL
• func NewURL(_ string) (URL, error)
• type User
• func NewUser(registerEmail string, password string) (User, error)
• func (u *User) Block()
• func (u *User) Descriptor() Descriptor
• func (u *User) IsBlocked() bool
• func (u *User) IsSuperuser() bool
• func (u *User) IsVerified() bool
• func (u *User) Unblock()
• type VerificationOpt
• func WithValidFor(validTime time.Duration) VerificationOpt
• type VerificationService
• func NewVerificationService(repo Repository, opts ...VerificationOpt) *VerificationService
• func (s *VerificationService) NewVerificationToken(ctx context.Context, user User) (VerificationToken, error)
• func (s *VerificationService) Verify(ctx context.Context, user *User, rawToken uuid.UUID) error
• type VerificationToken
• func NewVerificationToken(token uuid.UUID, userID ID, validUntilUTC time.Time) VerificationToken
• func (t VerificationToken) Token() uuid.UUID
• func (t VerificationToken) UserID() ID
• func (t VerificationToken) ValidUntilUTC() time.Time
• type Year

Variables ¶

var (
	ErrRegistrationFailed = errors.New("registration failed")
	ErrUserAlreadyExists  = fmt.Errorf("%w: user already exists", ErrRegistrationFailed)
)

var (
	ErrInvalidUserDetails = errors.New("invalid user details")
	ErrInvalidBirthday    = errors.New("invalid birthday")
)

var (
	ErrNotFound          = errors.New("not found")
	ErrPersistenceFailed = errors.New("persistence operation failed")
)

var ErrVerificationFailed = errors.New("verification failed")

Types ¶

type AuthenticationService ¶

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

func NewAuthenticationService ¶

func NewAuthenticationService(settings setting.Settings) *AuthenticationService

func (*AuthenticationService) Authenticate ¶

func (s *AuthenticationService) Authenticate(ctx context.Context, user User, password string) bool

type Birthday ¶

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

func NewBirthday ¶

func NewBirthday(day Day, month Month, year Year) (Birthday, error)

func (Birthday) String ¶

func (b Birthday) String() string

type BoolFlag ¶

type BoolFlag time.Time

func FALSE ¶

func FALSE() BoolFlag

func TRUE ¶

func TRUE() BoolFlag

func (BoolFlag) At ¶

func (t BoolFlag) At() time.Time

func (BoolFlag) IsFalse ¶

func (t BoolFlag) IsFalse() bool

func (BoolFlag) IsTrue ¶

func (t BoolFlag) IsTrue() bool

func (BoolFlag) SetFalse ¶

func (t BoolFlag) SetFalse() BoolFlag

func (BoolFlag) SetTrue ¶

func (t BoolFlag) SetTrue() BoolFlag

type Day ¶

type Day uint8

type Descriptor ¶

type Descriptor struct {
	ID    ID
	Login Login
}

Descriptor is a short representation of the User.

type Device ¶

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

Device contains human friendly information about the device the user is using.

func NewDevice ¶

func NewDevice(userAgent string) Device

func (Device) Name ¶

func (d Device) Name() string

func (Device) OS ¶

func (d Device) OS() string

func (Device) String ¶

func (d Device) String() string

func (Device) UserAgent ¶

func (d Device) UserAgent() string

type Filter ¶

type Filter struct {
	Offset Login
	Limit  uint
}

type ID ¶

type ID string

ID is the primary identifier of a User.

func NewID ¶

func NewID() ID

NewID generates a new ID for a User.

type IPResolver ¶

type IPResolver interface {
	ResolveIP(ip string) (ResolvedIP, error)
}

type Locale ¶

type Locale language.Tag

type Login ¶

type Login string

type Month ¶

type Month uint8

type Name ¶

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

Name represents the name of a User.

func NewName ¶

func NewName(firstName string, lastName string, displayName string) Name

NewName will be capitalised all values. If no displayName is given, it is concatenated from firstName and lastName.

func (Name) DisplayName ¶

func (name Name) DisplayName() string

func (Name) FirstName ¶

func (name Name) FirstName() string

func (Name) LastName ¶

func (name Name) LastName() string

type PasswordHash ¶

type PasswordHash string

func NewPasswordHash ¶

func NewPasswordHash(password string) (PasswordHash, error)

NewPasswordHash returns a PasswordHash. Consider NewStrongPasswordHash instead.

func NewStrongPasswordHash ¶

func NewStrongPasswordHash(password string) (PasswordHash, error)

NewStrongPasswordHash returns a PasswordHash or an error, if the password is too weak.

func (PasswordHash) Matches ¶

func (pw PasswordHash) Matches(checkPW string) bool

func (PasswordHash) String ¶

func (pw PasswordHash) String() string

String prevents a hash to exponentially leak by masking it in functions like fmt.

type Profile ¶

type Profile map[string]string

type RegistrationService ¶

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

func NewRegistrationService ¶

func NewRegistrationService(settingsService setting.Settings, repo Repository) *RegistrationService

func (*RegistrationService) RegisterNewUser ¶

func (s *RegistrationService) RegisterNewUser(
	ctx context.Context,
	registerEmail string,
	password string,
) (User, error)

type Repository ¶

type Repository interface {
	All(ctx context.Context, filter Filter) ([]User, error)

	FindByID(ctx context.Context, id ID) (User, error)
	FindByLogin(ctx context.Context, login Login) (User, error)
	ExistsByLogin(ctx context.Context, login Login) (bool, error)

	Count(ctx context.Context) (int, error)

	Save(ctx context.Context, user User) error

	Delete(ctx context.Context, user User) error
	DeleteByID(ctx context.Context, id ID) error
	DeleteByIDs(ctx context.Context, ids []ID) error
	DeleteAll(ctx context.Context) error

	CreateVerificationToken(ctx context.Context, token VerificationToken) error
	VerificationTokenByToken(ctx context.Context, token uuid.UUID) (VerificationToken, error)
}

type ResolvedIP ¶

type ResolvedIP struct {
	Country     string
	CountryCode string
	Region      string
	City        string
	IP          net.IP
}

type Session ¶

type Session struct {
	ID        string
	CreatedAt time.Time
	ExpiresAt time.Time
	Device    Device
}

type TimeZone ¶

type TimeZone string

type URL ¶

type URL string

func NewURL ¶

func NewURL(_ string) (URL, error)

type User ¶

type User struct {
	ID           ID
	Login        Login // UserName / email, or phone, or nickname, or whatever the developer wants to have as a login
	PasswordHash PasswordHash
	RegisteredAt time.Time

	Name              Name
	Birthday          Birthday
	Locale            Locale
	TimeZone          TimeZone
	ProfilePictureURL URL
	// a helper for simple stuff, if you have a complicated profile => do it in your Context, as it's the better place
	Profile Profile // limit the length of keys & values // { plan: 'silver', team_id: 'a111' }

	Verified  BoolFlag
	Blocked   BoolFlag
	Superuser BoolFlag

	Sessions []Session
}

User represents a user of the software, that can perform all the auth functionalities.

func NewUser ¶

func NewUser(registerEmail string, password string) (User, error)

func (*User) Block ¶

func (u *User) Block()

func (*User) Descriptor ¶

func (u *User) Descriptor() Descriptor

func (*User) IsBlocked ¶

func (u *User) IsBlocked() bool

func (*User) IsSuperuser ¶

func (u *User) IsSuperuser() bool

func (*User) IsVerified ¶

func (u *User) IsVerified() bool

func (*User) Unblock ¶

func (u *User) Unblock()

type VerificationOpt ¶

type VerificationOpt func(vs *VerificationService)

func WithValidFor ¶

func WithValidFor(validTime time.Duration) VerificationOpt

WithValidFor overwrites the time a VerificationToken is valid.

type VerificationService ¶

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

func NewVerificationService ¶

func NewVerificationService(repo Repository, opts ...VerificationOpt) *VerificationService

func (*VerificationService) NewVerificationToken ¶

func (s *VerificationService) NewVerificationToken(ctx context.Context, user User) (VerificationToken, error)

NewVerificationToken creates a new VerificationToken and persists it.

func (*VerificationService) Verify ¶

func (s *VerificationService) Verify(ctx context.Context, user *User, rawToken uuid.UUID) error

Verify verifies a User with the given Token. If it is valid, the user is updated and persisted.

type VerificationToken ¶

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

VerificationToken is a token a User receives (via email) and uses to verify his Login.

func NewVerificationToken ¶

func NewVerificationToken(token uuid.UUID, userID ID, validUntilUTC time.Time) VerificationToken

func (VerificationToken) Token ¶

func (t VerificationToken) Token() uuid.UUID

func (VerificationToken) UserID ¶

func (t VerificationToken) UserID() ID

func (VerificationToken) ValidUntilUTC ¶

func (t VerificationToken) ValidUntilUTC() time.Time

type Year ¶

type Year uint16

Source Files ¶

authenticate-user.business.go ip.business.go register-user.business.go user.business.go user.repository.go verify-user.business.go