contracts

type Authentication interface {

	// SMTP returns object what process authentication for SMTP protocol.
	SMTP() SmtpAuthentication

	// Dashboard returns object what process authentication for UI dashboard.
	Dashboard() DashboardAuthentication

	// UsersStorage returns object what manipulate users in application.
	UsersStorage() UsersStorage
}

type AuthenticationConfig struct {
	Smtp struct {
		IpsAllowList struct {
			Enabled bool `yaml:"enabled"`
		} `yaml:"ips_allowlist"`
		ViaIpAuthentication struct {
			Enabled bool `yaml:"enabled"`
		} `yaml:"via_ip"`
		ViaPasswordAuthentication struct {
			Enabled bool `yaml:"enabled"`
		} `yaml:"via_password"`
	} `yaml:"smtp"`
	Dashboard struct {
		ViaEmailAuthentication struct {
			Enabled bool `yaml:"enabled"`
		} `yaml:"via_email"`
		ViaPasswordAuthentication struct {
			Enabled bool `yaml:"enabled"`
		} `yaml:"via_password"`
	} `yaml:"dashboard"`
}

type DashboardAuthentication interface {

	// RequiresAuthentication define is need authentication for dashboard.
	RequiresAuthentication() bool

	// ViaPasswordAuthentication returns object what can manage password for authentication.
	ViaPasswordAuthentication() ViaPasswordAuthentication

	// ViaEmailAuthentication returns object what can manage emails what can be authenticated without password.
	ViaEmailAuthentication() ViaEmailAuthentication
}

type DbConnectionConfig map[string]interface{}

type DbConnectionsConfig struct {
	Connections map[string]DbConnectionConfig `yaml:"connections"`
}

type IpsAllowList interface {

	// Enabled shows is allowlist flow enabled.
	Enabled() bool

	// Allowed check is IP in allowlist for specific user.
	Allowed(username string, ip string) bool

	// AddIp to auth allowlist storage related to specific user.
	AddIp(username string, ip string) error
	// DeleteIp from auth allowlist storage related to specific user.
	DeleteIp(username string, ip string) error
	// ClearAllIps from auth allowlist storage related to specific user.
	ClearAllIps(username string) error
}

type MessageSharing interface {
	// Add new sharing record to storage.
	Add(emailSharingRecord *SharedMessageRecord) (*SharedMessageRecord, error)

	// Find single record by ID.
	Find(id string) (*SharedMessageRecord, error)

	// DeleteExpired will iterate over all shared records and delete all expired records.
	DeleteExpired() (bool, error)
}

type MessagesRepo interface {
	// Store `message` to specific `room`.
	Store(message *smtpMessage.SmtpMessage) (smtpMessage.MessageID, error)
	// List retrieve list of messages based on `query` starting with `offset` index and count limited by `limit`.
	// `query` - represents of key->value map, where key is search parameter.
	List(query SearchQuery, offset, limit int) ([]smtpMessage.SmtpMessage, int, error)
	// Count total messages in storage.
	Count() int
	// Delete delete specific message from storage by `messageId`.
	Delete(messageId smtpMessage.MessageID) error
	// Load find specific message from storage by `messageId`.
	Load(messageId smtpMessage.MessageID) (*smtpMessage.SmtpMessage, error)
}

type MessagesStorage interface {
	// RoomsRepo returns room repository
	RoomsRepo() RoomsRepo

	// MessagesRepo returns messages repository related to specific room
	MessagesRepo(room Room) MessagesRepo
}

type MessagesStorageConfiguration struct {
	PerRoomLimit int `yaml:"per_room_limit"`
}

type Room string

type RoomsRepo interface {
	// List of rooms in system.
	List(offset, limit int) ([]Room, error)
	// Count total count rooms in storage.
	Count() int
	// Delete all messages in room from storage.
	Delete(room Room) error
}

type SearchParam = string

type SearchQuery = map[string]string

type SharedMessageRecord struct {
	Id        string
	Room      Room
	MessageId smtpMessage.MessageID
	ExpiredAt time.Time
}

type SmtpAuthentication interface {

	// RequiresAuthentication define is need authentication for SMTP
	RequiresAuthentication() bool

	// IpsAllowList returns object what can manage IPs allowlist.
	IpsAllowList() IpsAllowList

	// ViaPasswordAuthentication returns object what can manage password for authentication.
	ViaPasswordAuthentication() ViaPasswordAuthentication

	// ViaIpAuthentication returns object what can manage IPs what can be authenticated without password.
	ViaIpAuthentication() ViaIpAuthentication
}

type UserResource struct {
	Username            string
	DashboardAuthEmails []string
	SmtpAuthIPs         []string
	SmtpAllowListedIPs  []string
}

type UsersStorage interface {

	// Exists check is username exists in storage.
	Exists(username string) bool

	// Add to auth storage.
	Add(username string) error

	// Delete from auth storage.
	Delete(username string) error

	// List from auth storage.
	List(searchQuery string, offset, limit int) ([]UserResource, int, error)
}

type ViaEmailAuthentication interface {

	// Enabled shows is authentication via email flow enabled.
	Enabled() bool

	// SendToken to email.
	SendToken(username string, email string) error

	// Authenticate user by token sent to email.
	Authenticate(username string, email string, token string) bool

	// AddEmail for login to auth storage related to user
	AddEmail(username string, email string) error
	// DeleteEmail for login from auth storage related to user
	DeleteEmail(username string, email string) error
	// ClearAllEmails for login from auth storage related to user
	ClearAllEmails(username string) error
}

type ViaIpAuthentication interface {

	// Enabled shows is authentication via IP flow enabled.
	Enabled() bool

	// Authenticate check is application can bypass password and authenticate client just by username and IP.
	Authenticate(username string, ip string) bool

	// AddIp for "IP auth" to auth storage related to user.
	AddIp(username string, ip string) error
	// DeleteIp for "IP auth" from auth storage related to user.
	DeleteIp(username string, ip string) error
	// ClearAllIps for "IP auth" from auth storage related to user.
	ClearAllIps(username string) error
}

type ViaPasswordAuthentication interface {

	// Enabled shows is authentication via email flow enabled.
	Enabled() bool

	// Authenticate check is credentials (login/password) are valid.
	Authenticate(username string, password string) bool

	// SetPassword to auth storage related to user.
	SetPassword(username string, password string) error
}