maddy

 1/*
 2Maddy Mail Server - Composable all-in-one email server.
 3Copyright © 2019-2020 Max Mazurov <fox.cpp@disroot.org>, Maddy Mail Server contributors
 4
 5This program is free software: you can redistribute it and/or modify
 6it under the terms of the GNU General Public License as published by
 7the Free Software Foundation, either version 3 of the License, or
 8(at your option) any later version.
 9
10This program is distributed in the hope that it will be useful,
11but WITHOUT ANY WARRANTY; without even the implied warranty of
12MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13GNU General Public License for more details.
14
15You should have received a copy of the GNU General Public License
16along with this program.  If not, see <https://www.gnu.org/licenses/>.
17*/
18
19package module
20
21import "errors"
22
23// ErrUnknownCredentials should be returned by auth. provider if supplied
24// credentials are valid for it but are not recognized (e.g. not found in
25// used DB).
26var ErrUnknownCredentials = errors.New("unknown credentials")
27
28// PlainAuth is the interface implemented by modules providing authentication using
29// username:password pairs.
30//
31// Modules implementing this interface should be registered with "auth." prefix in name.
32type PlainAuth interface {
33	AuthPlain(username, password string) error
34}
35
36// PlainUserDB is a local credentials store that can be managed using maddy command
37// utility.
38type PlainUserDB interface {
39	PlainAuth
40	ListUsers() ([]string, error)
41	CreateUser(username, password string) error
42	SetUserPassword(username, password string) error
43	DeleteUser(username string) error
44}