users

type LocksmithUser struct {
	ID               string                          `bson:"id"`
	Username         string                          `json:"username" bson:"username"`
	Email            string                          `json:"email" bson:"email"`
	PasswordInfo     authentication.PasswordInfo     `json:"-" bson:"password"`
	WebAuthnSessions []webauthn.SessionData          `json:"-" bson:"websessions"`
	PasswordSessions authentication.PasswordSessions `json:"-" bson:"sessions"`
	Magics           magic.MagicAuthentications      `json:"-" bson:"magic"`
	Role             string                          `json:"role" bson:"role"`
	MagicPermissions []string                        `json:"-" bson:"-"`
	ImMagic          bool                            `json:"-" bson:"-"`
	ImRegular        bool                            `json:"-" bson:"-"`
	LastLogin        time.Time                       `json:"-" bson:"-"`
}

type LocksmithUserInterface interface {
	ValidatePassword(string) (bool, error)
	ValidateSessionToken(token string, db database.DatabaseAccessor) bool
	GeneratePasswordSession() (authentication.PasswordSession, error)
	SavePasswordSession(authentication.PasswordSession, database.DatabaseAccessor) error

	GetLastLoginDate() time.Time

	// Read from Database
	ReadFromMap(*LocksmithUserInterface, map[string]interface{})
	ToMap() map[string]interface{}

	// Convert to "public" interface
	// Slimmed down version of this interface
	// with less sensitive information
	ToPublic() (PublicLocksmithUserInterface, error)

	GetRole() (roles.Role, error)

	// Magic Auth stuff
	CleanupOldMagicTokens(database.DatabaseAccessor)
	SetMagicPermissions([]string) LocksmithUserInterface
	SetMagic() LocksmithUser // Denotes the user as a "magic only" user
	CreateMagicAuthenticationCode(database.DatabaseAccessor, magic.MagicAuthenticationVariables) (string, error)
	GetMagicPermissions() []string
	IsMagic() bool

	WebAuthnID() []byte
	WebAuthnDisplayName() string
	WebAuthnName() string
	WebAuthnCredentials() []webauthn.Credential

	// WebAuthnIcon is a deprecated option.
	// Deprecated: this has been removed from the specification recommendation. Suggest a blank string.
	WebAuthnIcon() string
	AddNewWebAuthnCredential(*webauthn.Credential)

	// Getters
	GetUsername() string
	GetEmail() string
	GetID() string
	GetPasswordInfo() authentication.PasswordInfo
	GetWebAuthnSessions() []webauthn.SessionData
	GetPasswordSessions() []authentication.PasswordSession
}

type PublicLocksmithUser struct {
	ID                 string `json:"id"`
	Username           string `json:"username"`
	Email              string `json:"email"`
	ActiveSessionCount int    `json:"sessions"`
	LastActive         int64  `json:"lastActive"`
	Role               string `json:"role"`
}

type PublicLocksmithUserInterface interface {
	FromRegular(LocksmithUserInterface) (PublicLocksmithUserInterface, error)
}