2022-12-25 17:41:38 +01:00
|
|
|
package user
|
2022-01-23 06:02:16 +01:00
|
|
|
|
2022-01-31 17:44:58 +01:00
|
|
|
import (
|
2022-12-26 04:29:55 +01:00
|
|
|
"database/sql"
|
|
|
|
"encoding/json"
|
2022-01-31 17:44:58 +01:00
|
|
|
"errors"
|
2022-12-26 04:29:55 +01:00
|
|
|
"fmt"
|
|
|
|
_ "github.com/mattn/go-sqlite3" // SQLite driver
|
|
|
|
"golang.org/x/crypto/bcrypt"
|
|
|
|
"heckel.io/ntfy/log"
|
|
|
|
"heckel.io/ntfy/util"
|
|
|
|
"strings"
|
|
|
|
"sync"
|
|
|
|
"time"
|
2022-01-31 17:44:58 +01:00
|
|
|
)
|
2022-01-23 06:02:16 +01:00
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
const (
|
|
|
|
tokenLength = 32
|
|
|
|
bcryptCost = 10
|
|
|
|
intentionalSlowDownHash = "$2a$10$YFCQvqQDwIIwnJM1xkAYOeih0dg17UVGanaTStnrSzC8NCWxcLDwy" // Cost should match bcryptCost
|
|
|
|
userStatsQueueWriterInterval = 33 * time.Second
|
|
|
|
userTokenExpiryDuration = 72 * time.Hour
|
|
|
|
)
|
|
|
|
|
2022-12-31 16:16:14 +01:00
|
|
|
var (
|
2023-01-01 21:21:43 +01:00
|
|
|
errNoTokenProvided = errors.New("no token provided")
|
|
|
|
errTopicOwnedByOthers = errors.New("topic owned by others")
|
2022-12-31 16:16:14 +01:00
|
|
|
)
|
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
// Manager-related queries
|
|
|
|
const (
|
2022-12-29 19:08:47 +01:00
|
|
|
createTablesQueriesNoTx = `
|
2022-12-26 04:29:55 +01:00
|
|
|
CREATE TABLE IF NOT EXISTS plan (
|
|
|
|
id INT NOT NULL,
|
|
|
|
code TEXT NOT NULL,
|
|
|
|
messages_limit INT NOT NULL,
|
|
|
|
emails_limit INT NOT NULL,
|
2023-01-02 02:42:33 +01:00
|
|
|
topics_limit INT NOT NULL,
|
2022-12-26 04:29:55 +01:00
|
|
|
attachment_file_size_limit INT NOT NULL,
|
|
|
|
attachment_total_size_limit INT NOT NULL,
|
|
|
|
PRIMARY KEY (id)
|
|
|
|
);
|
|
|
|
CREATE TABLE IF NOT EXISTS user (
|
|
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
|
|
plan_id INT,
|
|
|
|
user TEXT NOT NULL,
|
|
|
|
pass TEXT NOT NULL,
|
|
|
|
role TEXT NOT NULL,
|
|
|
|
messages INT NOT NULL DEFAULT (0),
|
|
|
|
emails INT NOT NULL DEFAULT (0),
|
|
|
|
settings JSON,
|
|
|
|
FOREIGN KEY (plan_id) REFERENCES plan (id)
|
|
|
|
);
|
|
|
|
CREATE UNIQUE INDEX idx_user ON user (user);
|
|
|
|
CREATE TABLE IF NOT EXISTS user_access (
|
2022-12-31 15:31:46 +01:00
|
|
|
user_id INT NOT NULL,
|
2022-12-26 04:29:55 +01:00
|
|
|
topic TEXT NOT NULL,
|
|
|
|
read INT NOT NULL,
|
|
|
|
write INT NOT NULL,
|
2023-01-01 21:21:43 +01:00
|
|
|
owner_user_id INT,
|
2022-12-26 04:29:55 +01:00
|
|
|
PRIMARY KEY (user_id, topic),
|
|
|
|
FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE
|
2023-01-01 21:21:43 +01:00
|
|
|
);
|
2022-12-26 04:29:55 +01:00
|
|
|
CREATE TABLE IF NOT EXISTS user_token (
|
|
|
|
user_id INT NOT NULL,
|
|
|
|
token TEXT NOT NULL,
|
|
|
|
expires INT NOT NULL,
|
|
|
|
PRIMARY KEY (user_id, token),
|
|
|
|
FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE
|
|
|
|
);
|
|
|
|
CREATE TABLE IF NOT EXISTS schemaVersion (
|
|
|
|
id INT PRIMARY KEY,
|
|
|
|
version INT NOT NULL
|
|
|
|
);
|
|
|
|
INSERT INTO user (id, user, pass, role) VALUES (1, '*', '', 'anonymous') ON CONFLICT (id) DO NOTHING;
|
|
|
|
`
|
2022-12-29 19:08:47 +01:00
|
|
|
createTablesQueries = `BEGIN; ` + createTablesQueriesNoTx + ` COMMIT;`
|
2022-12-26 04:29:55 +01:00
|
|
|
selectUserByNameQuery = `
|
2023-01-02 02:42:33 +01:00
|
|
|
SELECT u.user, u.pass, u.role, u.messages, u.emails, u.settings, p.code, p.messages_limit, p.emails_limit, p.topics_limit, p.attachment_file_size_limit, p.attachment_total_size_limit
|
2022-12-26 04:29:55 +01:00
|
|
|
FROM user u
|
|
|
|
LEFT JOIN plan p on p.id = u.plan_id
|
|
|
|
WHERE user = ?
|
|
|
|
`
|
|
|
|
selectUserByTokenQuery = `
|
2023-01-02 02:42:33 +01:00
|
|
|
SELECT u.user, u.pass, u.role, u.messages, u.emails, u.settings, p.code, p.messages_limit, p.emails_limit, p.topics_limit, p.attachment_file_size_limit, p.attachment_total_size_limit
|
2022-12-26 04:29:55 +01:00
|
|
|
FROM user u
|
|
|
|
JOIN user_token t on u.id = t.user_id
|
|
|
|
LEFT JOIN plan p on p.id = u.plan_id
|
2022-12-29 17:09:45 +01:00
|
|
|
WHERE t.token = ? AND t.expires >= ?
|
2022-12-26 04:29:55 +01:00
|
|
|
`
|
|
|
|
selectTopicPermsQuery = `
|
2022-12-27 03:27:07 +01:00
|
|
|
SELECT read, write
|
|
|
|
FROM user_access a
|
|
|
|
JOIN user u ON u.id = a.user_id
|
2023-01-03 02:08:37 +01:00
|
|
|
WHERE (u.user = ? OR u.user = ?) AND ? LIKE a.topic
|
2022-12-27 03:27:07 +01:00
|
|
|
ORDER BY u.user DESC
|
2022-12-26 04:29:55 +01:00
|
|
|
`
|
|
|
|
)
|
2022-01-26 04:30:53 +01:00
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
// Manager-related queries
|
|
|
|
const (
|
2022-12-28 19:28:28 +01:00
|
|
|
insertUserQuery = `INSERT INTO user (user, pass, role) VALUES (?, ?, ?)`
|
|
|
|
selectUsernamesQuery = `
|
|
|
|
SELECT user
|
|
|
|
FROM user
|
|
|
|
ORDER BY
|
|
|
|
CASE role
|
|
|
|
WHEN 'admin' THEN 1
|
|
|
|
WHEN 'anonymous' THEN 3
|
|
|
|
ELSE 2
|
|
|
|
END, user
|
|
|
|
`
|
2022-12-26 04:29:55 +01:00
|
|
|
updateUserPassQuery = `UPDATE user SET pass = ? WHERE user = ?`
|
|
|
|
updateUserRoleQuery = `UPDATE user SET role = ? WHERE user = ?`
|
|
|
|
updateUserSettingsQuery = `UPDATE user SET settings = ? WHERE user = ?`
|
|
|
|
updateUserStatsQuery = `UPDATE user SET messages = ?, emails = ? WHERE user = ?`
|
|
|
|
deleteUserQuery = `DELETE FROM user WHERE user = ?`
|
|
|
|
|
2022-12-28 19:28:28 +01:00
|
|
|
upsertUserAccessQuery = `
|
2023-01-01 21:21:43 +01:00
|
|
|
INSERT INTO user_access (user_id, topic, read, write, owner_user_id)
|
|
|
|
VALUES ((SELECT id FROM user WHERE user = ?), ?, ?, ?, (SELECT IIF(?='',NULL,(SELECT id FROM user WHERE user=?))))
|
2022-12-28 19:28:28 +01:00
|
|
|
ON CONFLICT (user_id, topic)
|
2023-01-01 21:21:43 +01:00
|
|
|
DO UPDATE SET read=excluded.read, write=excluded.write, owner_user_id=excluded.owner_user_id
|
|
|
|
`
|
|
|
|
selectUserAccessQuery = `
|
2023-01-03 02:08:37 +01:00
|
|
|
SELECT topic, read, write
|
2023-01-01 21:21:43 +01:00
|
|
|
FROM user_access
|
|
|
|
WHERE user_id = (SELECT id FROM user WHERE user = ?)
|
|
|
|
ORDER BY write DESC, read DESC, topic
|
|
|
|
`
|
2023-01-03 02:08:37 +01:00
|
|
|
selectUserReservationsQuery = `
|
|
|
|
SELECT a_user.topic, a_user.read, a_user.write, a_everyone.read AS everyone_read, a_everyone.write AS everyone_write
|
|
|
|
FROM user_access a_user
|
|
|
|
LEFT JOIN user_access a_everyone ON a_user.topic = a_everyone.topic AND a_everyone.user_id = (SELECT id FROM user WHERE user = ?)
|
|
|
|
WHERE a_user.user_id = a_user.owner_user_id
|
|
|
|
AND a_user.owner_user_id = (SELECT id FROM user WHERE user = ?)
|
|
|
|
ORDER BY a_user.topic
|
|
|
|
`
|
2023-01-01 21:21:43 +01:00
|
|
|
selectOtherAccessCountQuery = `
|
|
|
|
SELECT count(*)
|
|
|
|
FROM user_access
|
|
|
|
WHERE (topic = ? OR ? LIKE topic)
|
|
|
|
AND (owner_user_id IS NULL OR owner_user_id != (SELECT id FROM user WHERE user = ?))
|
2022-12-28 19:28:28 +01:00
|
|
|
`
|
2022-12-26 04:29:55 +01:00
|
|
|
deleteAllAccessQuery = `DELETE FROM user_access`
|
|
|
|
deleteUserAccessQuery = `DELETE FROM user_access WHERE user_id = (SELECT id FROM user WHERE user = ?)`
|
|
|
|
deleteTopicAccessQuery = `DELETE FROM user_access WHERE user_id = (SELECT id FROM user WHERE user = ?) AND topic = ?`
|
|
|
|
|
|
|
|
insertTokenQuery = `INSERT INTO user_token (user_id, token, expires) VALUES ((SELECT id FROM user WHERE user = ?), ?, ?)`
|
|
|
|
updateTokenExpiryQuery = `UPDATE user_token SET expires = ? WHERE user_id = (SELECT id FROM user WHERE user = ?) AND token = ?`
|
|
|
|
deleteTokenQuery = `DELETE FROM user_token WHERE user_id = (SELECT id FROM user WHERE user = ?) AND token = ?`
|
|
|
|
deleteExpiredTokensQuery = `DELETE FROM user_token WHERE expires < ?`
|
|
|
|
deleteUserTokensQuery = `DELETE FROM user_token WHERE user_id = (SELECT id FROM user WHERE user = ?)`
|
|
|
|
)
|
2022-12-03 21:20:59 +01:00
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
// Schema management queries
|
|
|
|
const (
|
2022-12-29 19:08:47 +01:00
|
|
|
currentSchemaVersion = 2
|
2022-12-26 04:29:55 +01:00
|
|
|
insertSchemaVersion = `INSERT INTO schemaVersion VALUES (1, ?)`
|
2022-12-29 19:08:47 +01:00
|
|
|
updateSchemaVersion = `UPDATE schemaVersion SET version = ? WHERE id = 1`
|
2022-12-26 04:29:55 +01:00
|
|
|
selectSchemaVersionQuery = `SELECT version FROM schemaVersion WHERE id = 1`
|
2022-12-29 19:08:47 +01:00
|
|
|
|
|
|
|
// 1 -> 2 (complex migration!)
|
|
|
|
migrate1To2RenameUserTableQueryNoTx = `
|
|
|
|
ALTER TABLE user RENAME TO user_old;
|
|
|
|
`
|
|
|
|
migrate1To2InsertFromOldTablesAndDropNoTx = `
|
|
|
|
INSERT INTO user (user, pass, role)
|
|
|
|
SELECT user, pass, role FROM user_old;
|
|
|
|
|
|
|
|
INSERT INTO user_access (user_id, topic, read, write)
|
|
|
|
SELECT u.id, a.topic, a.read, a.write
|
|
|
|
FROM user u
|
|
|
|
JOIN access a ON u.user = a.user;
|
|
|
|
|
|
|
|
DROP TABLE access;
|
|
|
|
DROP TABLE user_old;
|
|
|
|
`
|
2022-12-26 04:29:55 +01:00
|
|
|
)
|
2022-01-23 06:02:16 +01:00
|
|
|
|
2022-12-28 04:14:14 +01:00
|
|
|
// Manager is an implementation of Manager. It stores users and access control list
|
2022-12-26 04:29:55 +01:00
|
|
|
// in a SQLite database.
|
2022-12-28 04:14:14 +01:00
|
|
|
type Manager struct {
|
2022-12-29 17:09:45 +01:00
|
|
|
db *sql.DB
|
2023-01-03 03:12:42 +01:00
|
|
|
defaultAccess Permission // Default permission if no ACL matches
|
2022-12-29 17:09:45 +01:00
|
|
|
statsQueue map[string]*User // Username -> User, for "unimportant" user updates
|
|
|
|
tokenExpiryInterval time.Duration // Duration after which tokens expire, and by which tokens are extended
|
|
|
|
mu sync.Mutex
|
2022-12-26 04:29:55 +01:00
|
|
|
}
|
2022-01-26 04:30:53 +01:00
|
|
|
|
2022-12-28 04:14:14 +01:00
|
|
|
var _ Auther = (*Manager)(nil)
|
2022-12-26 04:29:55 +01:00
|
|
|
|
2022-12-28 04:14:14 +01:00
|
|
|
// NewManager creates a new Manager instance
|
2023-01-03 03:12:42 +01:00
|
|
|
func NewManager(filename string, defaultAccess Permission) (*Manager, error) {
|
|
|
|
return newManager(filename, defaultAccess, userTokenExpiryDuration, userStatsQueueWriterInterval)
|
2022-12-29 17:09:45 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// NewManager creates a new Manager instance
|
2023-01-03 03:12:42 +01:00
|
|
|
func newManager(filename string, defaultAccess Permission, tokenExpiryDuration, statsWriterInterval time.Duration) (*Manager, error) {
|
2022-12-26 04:29:55 +01:00
|
|
|
db, err := sql.Open("sqlite3", filename)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2022-12-29 19:08:47 +01:00
|
|
|
if err := setupDB(db); err != nil {
|
2022-12-26 04:29:55 +01:00
|
|
|
return nil, err
|
|
|
|
}
|
2022-12-28 04:14:14 +01:00
|
|
|
manager := &Manager{
|
2022-12-29 17:09:45 +01:00
|
|
|
db: db,
|
2023-01-03 03:12:42 +01:00
|
|
|
defaultAccess: defaultAccess,
|
2022-12-29 17:09:45 +01:00
|
|
|
statsQueue: make(map[string]*User),
|
|
|
|
tokenExpiryInterval: tokenExpiryDuration,
|
2022-12-26 04:29:55 +01:00
|
|
|
}
|
2022-12-29 17:09:45 +01:00
|
|
|
go manager.userStatsQueueWriter(statsWriterInterval)
|
2022-12-26 04:29:55 +01:00
|
|
|
return manager, nil
|
|
|
|
}
|
2022-01-26 04:30:53 +01:00
|
|
|
|
2022-12-28 19:28:28 +01:00
|
|
|
// Authenticate checks username and password and returns a User if correct. The method
|
2022-12-26 04:29:55 +01:00
|
|
|
// returns in constant-ish time, regardless of whether the user exists or the password is
|
|
|
|
// correct or incorrect.
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) Authenticate(username, password string) (*User, error) {
|
2022-12-26 04:29:55 +01:00
|
|
|
if username == Everyone {
|
|
|
|
return nil, ErrUnauthenticated
|
|
|
|
}
|
|
|
|
user, err := a.User(username)
|
|
|
|
if err != nil {
|
|
|
|
bcrypt.CompareHashAndPassword([]byte(intentionalSlowDownHash),
|
|
|
|
[]byte("intentional slow-down to avoid timing attacks"))
|
|
|
|
return nil, ErrUnauthenticated
|
|
|
|
}
|
|
|
|
if err := bcrypt.CompareHashAndPassword([]byte(user.Hash), []byte(password)); err != nil {
|
|
|
|
return nil, ErrUnauthenticated
|
|
|
|
}
|
|
|
|
return user, nil
|
|
|
|
}
|
2022-01-26 04:30:53 +01:00
|
|
|
|
2022-12-28 19:28:28 +01:00
|
|
|
// AuthenticateToken checks if the token exists and returns the associated User if it does.
|
|
|
|
// The method sets the User.Token value to the token that was used for authentication.
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) AuthenticateToken(token string) (*User, error) {
|
2022-12-28 19:46:18 +01:00
|
|
|
if len(token) != tokenLength {
|
|
|
|
return nil, ErrUnauthenticated
|
|
|
|
}
|
2022-12-26 04:29:55 +01:00
|
|
|
user, err := a.userByToken(token)
|
|
|
|
if err != nil {
|
|
|
|
return nil, ErrUnauthenticated
|
|
|
|
}
|
|
|
|
user.Token = token
|
|
|
|
return user, nil
|
|
|
|
}
|
2022-01-26 04:30:53 +01:00
|
|
|
|
2022-12-28 19:28:28 +01:00
|
|
|
// CreateToken generates a random token for the given user and returns it. The token expires
|
|
|
|
// after a fixed duration unless ExtendToken is called.
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) CreateToken(user *User) (*Token, error) {
|
2022-12-28 19:28:28 +01:00
|
|
|
token, expires := util.RandomString(tokenLength), time.Now().Add(userTokenExpiryDuration)
|
2022-12-26 04:29:55 +01:00
|
|
|
if _, err := a.db.Exec(insertTokenQuery, user.Name, token, expires.Unix()); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return &Token{
|
|
|
|
Value: token,
|
2022-12-28 19:46:18 +01:00
|
|
|
Expires: expires,
|
2022-12-26 04:29:55 +01:00
|
|
|
}, nil
|
|
|
|
}
|
2022-01-26 04:30:53 +01:00
|
|
|
|
2022-12-28 19:28:28 +01:00
|
|
|
// ExtendToken sets the new expiry date for a token, thereby extending its use further into the future.
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) ExtendToken(user *User) (*Token, error) {
|
2022-12-31 16:16:14 +01:00
|
|
|
if user.Token == "" {
|
|
|
|
return nil, errNoTokenProvided
|
|
|
|
}
|
2022-12-26 04:29:55 +01:00
|
|
|
newExpires := time.Now().Add(userTokenExpiryDuration)
|
|
|
|
if _, err := a.db.Exec(updateTokenExpiryQuery, newExpires.Unix(), user.Name, user.Token); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return &Token{
|
|
|
|
Value: user.Token,
|
2022-12-28 19:46:18 +01:00
|
|
|
Expires: newExpires,
|
2022-12-26 04:29:55 +01:00
|
|
|
}, nil
|
|
|
|
}
|
2022-01-26 04:30:53 +01:00
|
|
|
|
2022-12-28 19:28:28 +01:00
|
|
|
// RemoveToken deletes the token defined in User.Token
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) RemoveToken(user *User) error {
|
2022-12-26 04:29:55 +01:00
|
|
|
if user.Token == "" {
|
|
|
|
return ErrUnauthorized
|
|
|
|
}
|
|
|
|
if _, err := a.db.Exec(deleteTokenQuery, user.Name, user.Token); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
2022-01-26 04:30:53 +01:00
|
|
|
|
2022-12-28 19:28:28 +01:00
|
|
|
// RemoveExpiredTokens deletes all expired tokens from the database
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) RemoveExpiredTokens() error {
|
2022-12-26 04:29:55 +01:00
|
|
|
if _, err := a.db.Exec(deleteExpiredTokensQuery, time.Now().Unix()); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
2022-01-26 04:30:53 +01:00
|
|
|
|
2022-12-28 21:51:09 +01:00
|
|
|
// ChangeSettings persists the user settings
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) ChangeSettings(user *User) error {
|
2022-12-26 04:29:55 +01:00
|
|
|
settings, err := json.Marshal(user.Prefs)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if _, err := a.db.Exec(updateUserSettingsQuery, string(settings), user.Name); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil
|
2022-01-23 06:54:18 +01:00
|
|
|
}
|
|
|
|
|
2022-12-28 21:51:09 +01:00
|
|
|
// EnqueueStats adds the user to a queue which writes out user stats (messages, emails, ..) in
|
|
|
|
// batches at a regular interval
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) EnqueueStats(user *User) {
|
2022-12-26 04:29:55 +01:00
|
|
|
a.mu.Lock()
|
|
|
|
defer a.mu.Unlock()
|
|
|
|
a.statsQueue[user.Name] = user
|
2022-12-08 03:26:18 +01:00
|
|
|
}
|
|
|
|
|
2022-12-29 17:09:45 +01:00
|
|
|
func (a *Manager) userStatsQueueWriter(interval time.Duration) {
|
|
|
|
ticker := time.NewTicker(interval)
|
2022-12-26 04:29:55 +01:00
|
|
|
for range ticker.C {
|
|
|
|
if err := a.writeUserStatsQueue(); err != nil {
|
|
|
|
log.Warn("UserManager: Writing user stats queue failed: %s", err.Error())
|
|
|
|
}
|
|
|
|
}
|
2022-12-25 17:41:38 +01:00
|
|
|
}
|
|
|
|
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) writeUserStatsQueue() error {
|
2022-12-26 04:29:55 +01:00
|
|
|
a.mu.Lock()
|
|
|
|
if len(a.statsQueue) == 0 {
|
|
|
|
a.mu.Unlock()
|
|
|
|
log.Trace("UserManager: No user stats updates to commit")
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
statsQueue := a.statsQueue
|
|
|
|
a.statsQueue = make(map[string]*User)
|
|
|
|
a.mu.Unlock()
|
|
|
|
tx, err := a.db.Begin()
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
defer tx.Rollback()
|
|
|
|
log.Debug("UserManager: Writing user stats queue for %d user(s)", len(statsQueue))
|
|
|
|
for username, u := range statsQueue {
|
|
|
|
log.Trace("UserManager: Updating stats for user %s: messages=%d, emails=%d", username, u.Stats.Messages, u.Stats.Emails)
|
|
|
|
if _, err := tx.Exec(updateUserStatsQuery, u.Stats.Messages, u.Stats.Emails, username); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return tx.Commit()
|
2022-12-08 03:26:18 +01:00
|
|
|
}
|
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
// Authorize returns nil if the given user has access to the given topic using the desired
|
|
|
|
// permission. The user param may be nil to signal an anonymous user.
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) Authorize(user *User, topic string, perm Permission) error {
|
2022-12-26 04:29:55 +01:00
|
|
|
if user != nil && user.Role == RoleAdmin {
|
|
|
|
return nil // Admin can do everything
|
|
|
|
}
|
|
|
|
username := Everyone
|
|
|
|
if user != nil {
|
|
|
|
username = user.Name
|
|
|
|
}
|
|
|
|
// Select the read/write permissions for this user/topic combo. The query may return two
|
2023-01-01 21:21:43 +01:00
|
|
|
// rows (one for everyone, and one for the user), but prioritizes the user.
|
2023-01-03 02:08:37 +01:00
|
|
|
rows, err := a.db.Query(selectTopicPermsQuery, Everyone, username, topic)
|
2022-12-26 04:29:55 +01:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
defer rows.Close()
|
|
|
|
if !rows.Next() {
|
2023-01-03 03:12:42 +01:00
|
|
|
return a.resolvePerms(a.defaultAccess, perm)
|
2022-12-26 04:29:55 +01:00
|
|
|
}
|
|
|
|
var read, write bool
|
|
|
|
if err := rows.Scan(&read, &write); err != nil {
|
|
|
|
return err
|
|
|
|
} else if err := rows.Err(); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2023-01-03 03:12:42 +01:00
|
|
|
return a.resolvePerms(NewPermission(read, write), perm)
|
2022-12-26 04:29:55 +01:00
|
|
|
}
|
2022-12-18 20:35:05 +01:00
|
|
|
|
2023-01-03 03:12:42 +01:00
|
|
|
func (a *Manager) resolvePerms(base, perm Permission) error {
|
|
|
|
if perm == PermissionRead && base.IsRead() {
|
2022-12-26 04:29:55 +01:00
|
|
|
return nil
|
2023-01-03 03:12:42 +01:00
|
|
|
} else if perm == PermissionWrite && base.IsWrite() {
|
2022-12-26 04:29:55 +01:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return ErrUnauthorized
|
|
|
|
}
|
2022-12-18 20:35:05 +01:00
|
|
|
|
2022-12-29 01:55:11 +01:00
|
|
|
// AddUser adds a user with the given username, password and role
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) AddUser(username, password string, role Role) error {
|
2022-12-26 04:29:55 +01:00
|
|
|
if !AllowedUsername(username) || !AllowedRole(role) {
|
|
|
|
return ErrInvalidArgument
|
|
|
|
}
|
|
|
|
hash, err := bcrypt.GenerateFromPassword([]byte(password), bcryptCost)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if _, err = a.db.Exec(insertUserQuery, username, hash, role); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil
|
2022-12-17 21:17:52 +01:00
|
|
|
}
|
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
// RemoveUser deletes the user with the given username. The function returns nil on success, even
|
|
|
|
// if the user did not exist in the first place.
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) RemoveUser(username string) error {
|
2022-12-26 04:29:55 +01:00
|
|
|
if !AllowedUsername(username) {
|
|
|
|
return ErrInvalidArgument
|
|
|
|
}
|
2022-12-29 19:08:47 +01:00
|
|
|
tx, err := a.db.Begin()
|
|
|
|
if err != nil {
|
2022-12-26 04:29:55 +01:00
|
|
|
return err
|
|
|
|
}
|
2022-12-29 19:08:47 +01:00
|
|
|
defer tx.Rollback()
|
|
|
|
if _, err := tx.Exec(deleteUserAccessQuery, username); err != nil {
|
2022-12-26 04:29:55 +01:00
|
|
|
return err
|
|
|
|
}
|
2022-12-29 19:08:47 +01:00
|
|
|
if _, err := tx.Exec(deleteUserTokensQuery, username); err != nil {
|
2022-12-26 04:29:55 +01:00
|
|
|
return err
|
|
|
|
}
|
2022-12-29 19:08:47 +01:00
|
|
|
if _, err := tx.Exec(deleteUserQuery, username); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return tx.Commit()
|
2022-12-08 03:26:18 +01:00
|
|
|
}
|
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
// Users returns a list of users. It always also returns the Everyone user ("*").
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) Users() ([]*User, error) {
|
2022-12-26 04:29:55 +01:00
|
|
|
rows, err := a.db.Query(selectUsernamesQuery)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
defer rows.Close()
|
|
|
|
usernames := make([]string, 0)
|
|
|
|
for rows.Next() {
|
|
|
|
var username string
|
|
|
|
if err := rows.Scan(&username); err != nil {
|
|
|
|
return nil, err
|
|
|
|
} else if err := rows.Err(); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
usernames = append(usernames, username)
|
|
|
|
}
|
|
|
|
rows.Close()
|
|
|
|
users := make([]*User, 0)
|
|
|
|
for _, username := range usernames {
|
|
|
|
user, err := a.User(username)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
users = append(users, user)
|
|
|
|
}
|
|
|
|
return users, nil
|
2022-01-24 05:02:39 +01:00
|
|
|
}
|
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
// User returns the user with the given username if it exists, or ErrNotFound otherwise.
|
|
|
|
// You may also pass Everyone to retrieve the anonymous user and its Grant list.
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) User(username string) (*User, error) {
|
2022-12-26 04:29:55 +01:00
|
|
|
rows, err := a.db.Query(selectUserByNameQuery, username)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return a.readUser(rows)
|
2022-12-21 03:18:33 +01:00
|
|
|
}
|
|
|
|
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) userByToken(token string) (*User, error) {
|
2022-12-29 17:09:45 +01:00
|
|
|
rows, err := a.db.Query(selectUserByTokenQuery, token, time.Now().Unix())
|
2022-12-26 04:29:55 +01:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return a.readUser(rows)
|
2022-01-23 06:02:16 +01:00
|
|
|
}
|
|
|
|
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) readUser(rows *sql.Rows) (*User, error) {
|
2022-12-26 04:29:55 +01:00
|
|
|
defer rows.Close()
|
|
|
|
var username, hash, role string
|
|
|
|
var settings, planCode sql.NullString
|
|
|
|
var messages, emails int64
|
2023-01-02 02:42:33 +01:00
|
|
|
var messagesLimit, emailsLimit, topicsLimit, attachmentFileSizeLimit, attachmentTotalSizeLimit sql.NullInt64
|
2022-12-26 04:29:55 +01:00
|
|
|
if !rows.Next() {
|
|
|
|
return nil, ErrNotFound
|
|
|
|
}
|
2023-01-02 02:42:33 +01:00
|
|
|
if err := rows.Scan(&username, &hash, &role, &messages, &emails, &settings, &planCode, &messagesLimit, &emailsLimit, &topicsLimit, &attachmentFileSizeLimit, &attachmentTotalSizeLimit); err != nil {
|
2022-12-26 04:29:55 +01:00
|
|
|
return nil, err
|
|
|
|
} else if err := rows.Err(); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
user := &User{
|
2023-01-03 02:08:37 +01:00
|
|
|
Name: username,
|
|
|
|
Hash: hash,
|
|
|
|
Role: Role(role),
|
2022-12-26 04:29:55 +01:00
|
|
|
Stats: &Stats{
|
|
|
|
Messages: messages,
|
|
|
|
Emails: emails,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
if settings.Valid {
|
|
|
|
user.Prefs = &Prefs{}
|
|
|
|
if err := json.Unmarshal([]byte(settings.String), user.Prefs); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if planCode.Valid {
|
|
|
|
user.Plan = &Plan{
|
|
|
|
Code: planCode.String,
|
|
|
|
Upgradable: true, // FIXME
|
|
|
|
MessagesLimit: messagesLimit.Int64,
|
|
|
|
EmailsLimit: emailsLimit.Int64,
|
2023-01-02 02:42:33 +01:00
|
|
|
TopicsLimit: topicsLimit.Int64,
|
2022-12-26 04:29:55 +01:00
|
|
|
AttachmentFileSizeLimit: attachmentFileSizeLimit.Int64,
|
|
|
|
AttachmentTotalSizeLimit: attachmentTotalSizeLimit.Int64,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return user, nil
|
|
|
|
}
|
2022-01-23 06:02:16 +01:00
|
|
|
|
2023-01-03 02:08:37 +01:00
|
|
|
// Grants returns all user-specific access control entries
|
|
|
|
func (a *Manager) Grants(username string) ([]Grant, error) {
|
2022-12-26 04:29:55 +01:00
|
|
|
rows, err := a.db.Query(selectUserAccessQuery, username)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
defer rows.Close()
|
|
|
|
grants := make([]Grant, 0)
|
|
|
|
for rows.Next() {
|
|
|
|
var topic string
|
2023-01-03 02:08:37 +01:00
|
|
|
var read, write bool
|
|
|
|
if err := rows.Scan(&topic, &read, &write); err != nil {
|
2022-12-26 04:29:55 +01:00
|
|
|
return nil, err
|
|
|
|
} else if err := rows.Err(); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
grants = append(grants, Grant{
|
|
|
|
TopicPattern: fromSQLWildcard(topic),
|
2023-01-03 03:12:42 +01:00
|
|
|
Allow: NewPermission(read, write),
|
2022-12-26 04:29:55 +01:00
|
|
|
})
|
|
|
|
}
|
|
|
|
return grants, nil
|
|
|
|
}
|
2022-01-23 06:02:16 +01:00
|
|
|
|
2023-01-03 02:08:37 +01:00
|
|
|
// Reservations returns all user-owned topics, and the associated everyone-access
|
|
|
|
func (a *Manager) Reservations(username string) ([]Reservation, error) {
|
|
|
|
rows, err := a.db.Query(selectUserReservationsQuery, Everyone, username)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
defer rows.Close()
|
|
|
|
reservations := make([]Reservation, 0)
|
|
|
|
for rows.Next() {
|
|
|
|
var topic string
|
2023-01-03 03:12:42 +01:00
|
|
|
var ownerRead, ownerWrite bool
|
2023-01-03 02:08:37 +01:00
|
|
|
var everyoneRead, everyoneWrite sql.NullBool
|
2023-01-03 03:12:42 +01:00
|
|
|
if err := rows.Scan(&topic, &ownerRead, &ownerWrite, &everyoneRead, &everyoneWrite); err != nil {
|
2023-01-03 02:08:37 +01:00
|
|
|
return nil, err
|
|
|
|
} else if err := rows.Err(); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
reservations = append(reservations, Reservation{
|
2023-01-03 03:12:42 +01:00
|
|
|
Topic: topic,
|
|
|
|
Owner: NewPermission(ownerRead, ownerWrite),
|
|
|
|
Everyone: NewPermission(everyoneRead.Bool, everyoneWrite.Bool), // false if null
|
2023-01-03 02:08:37 +01:00
|
|
|
})
|
|
|
|
}
|
|
|
|
return reservations, nil
|
|
|
|
}
|
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
// ChangePassword changes a user's password
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) ChangePassword(username, password string) error {
|
2022-12-26 04:29:55 +01:00
|
|
|
hash, err := bcrypt.GenerateFromPassword([]byte(password), bcryptCost)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if _, err := a.db.Exec(updateUserPassQuery, hash, username); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
2022-01-23 06:02:16 +01:00
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
// ChangeRole changes a user's role. When a role is changed from RoleUser to RoleAdmin,
|
|
|
|
// all existing access control entries (Grant) are removed, since they are no longer needed.
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) ChangeRole(username string, role Role) error {
|
2022-12-26 04:29:55 +01:00
|
|
|
if !AllowedUsername(username) || !AllowedRole(role) {
|
|
|
|
return ErrInvalidArgument
|
|
|
|
}
|
|
|
|
if _, err := a.db.Exec(updateUserRoleQuery, string(role), username); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if role == RoleAdmin {
|
|
|
|
if _, err := a.db.Exec(deleteUserAccessQuery, username); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
2022-01-23 21:30:30 +01:00
|
|
|
|
2023-01-01 21:21:43 +01:00
|
|
|
// CheckAllowAccess tests if a user may create an access control entry for the given topic.
|
|
|
|
// If there are any ACL entries that are not owned by the user, an error is returned.
|
|
|
|
func (a *Manager) CheckAllowAccess(username string, topic string) error {
|
|
|
|
if (!AllowedUsername(username) && username != Everyone) || !AllowedTopic(topic) {
|
|
|
|
return ErrInvalidArgument
|
|
|
|
}
|
|
|
|
rows, err := a.db.Query(selectOtherAccessCountQuery, topic, topic, username)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
defer rows.Close()
|
|
|
|
if !rows.Next() {
|
|
|
|
return errors.New("no rows found")
|
|
|
|
}
|
|
|
|
var otherCount int
|
|
|
|
if err := rows.Scan(&otherCount); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if otherCount > 0 {
|
|
|
|
return errTopicOwnedByOthers
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
// AllowAccess adds or updates an entry in th access control list for a specific user. It controls
|
2023-01-01 21:21:43 +01:00
|
|
|
// read/write access to a topic. The parameter topicPattern may include wildcards (*). The ACL entry
|
|
|
|
// owner may either be a user (username), or the system (empty).
|
|
|
|
func (a *Manager) AllowAccess(owner, username string, topicPattern string, read bool, write bool) error {
|
|
|
|
if !AllowedUsername(username) && username != Everyone {
|
|
|
|
return ErrInvalidArgument
|
|
|
|
} else if owner != "" && !AllowedUsername(owner) {
|
|
|
|
return ErrInvalidArgument
|
|
|
|
} else if !AllowedTopicPattern(topicPattern) {
|
2022-12-26 04:29:55 +01:00
|
|
|
return ErrInvalidArgument
|
|
|
|
}
|
2023-01-01 21:21:43 +01:00
|
|
|
if _, err := a.db.Exec(upsertUserAccessQuery, username, toSQLWildcard(topicPattern), read, write, owner, owner); err != nil {
|
2022-12-26 04:29:55 +01:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
2022-01-31 17:44:58 +01:00
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
// ResetAccess removes an access control list entry for a specific username/topic, or (if topic is
|
|
|
|
// empty) for an entire user. The parameter topicPattern may include wildcards (*).
|
2022-12-28 04:14:14 +01:00
|
|
|
func (a *Manager) ResetAccess(username string, topicPattern string) error {
|
2022-12-26 04:29:55 +01:00
|
|
|
if !AllowedUsername(username) && username != Everyone && username != "" {
|
|
|
|
return ErrInvalidArgument
|
|
|
|
} else if !AllowedTopicPattern(topicPattern) && topicPattern != "" {
|
|
|
|
return ErrInvalidArgument
|
|
|
|
}
|
|
|
|
if username == "" && topicPattern == "" {
|
|
|
|
_, err := a.db.Exec(deleteAllAccessQuery, username)
|
|
|
|
return err
|
|
|
|
} else if topicPattern == "" {
|
|
|
|
_, err := a.db.Exec(deleteUserAccessQuery, username)
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
_, err := a.db.Exec(deleteTopicAccessQuery, username, toSQLWildcard(topicPattern))
|
|
|
|
return err
|
2022-01-23 21:30:30 +01:00
|
|
|
}
|
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
// DefaultAccess returns the default read/write access if no access control entry matches
|
2023-01-03 03:12:42 +01:00
|
|
|
func (a *Manager) DefaultAccess() Permission {
|
|
|
|
return a.defaultAccess
|
2022-01-31 17:44:58 +01:00
|
|
|
}
|
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
func toSQLWildcard(s string) string {
|
|
|
|
return strings.ReplaceAll(s, "*", "%")
|
2022-01-31 17:44:58 +01:00
|
|
|
}
|
|
|
|
|
2022-12-26 04:29:55 +01:00
|
|
|
func fromSQLWildcard(s string) string {
|
|
|
|
return strings.ReplaceAll(s, "%", "*")
|
|
|
|
}
|
|
|
|
|
2022-12-29 19:08:47 +01:00
|
|
|
func setupDB(db *sql.DB) error {
|
2022-12-26 04:29:55 +01:00
|
|
|
// If 'schemaVersion' table does not exist, this must be a new database
|
|
|
|
rowsSV, err := db.Query(selectSchemaVersionQuery)
|
|
|
|
if err != nil {
|
2022-12-29 19:08:47 +01:00
|
|
|
return setupNewDB(db)
|
2022-12-26 04:29:55 +01:00
|
|
|
}
|
|
|
|
defer rowsSV.Close()
|
|
|
|
|
|
|
|
// If 'schemaVersion' table exists, read version and potentially upgrade
|
|
|
|
schemaVersion := 0
|
|
|
|
if !rowsSV.Next() {
|
|
|
|
return errors.New("cannot determine schema version: database file may be corrupt")
|
|
|
|
}
|
|
|
|
if err := rowsSV.Scan(&schemaVersion); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
rowsSV.Close()
|
|
|
|
|
|
|
|
// Do migrations
|
|
|
|
if schemaVersion == currentSchemaVersion {
|
|
|
|
return nil
|
2022-12-29 19:08:47 +01:00
|
|
|
} else if schemaVersion == 1 {
|
|
|
|
return migrateFrom1(db)
|
2022-12-26 04:29:55 +01:00
|
|
|
}
|
|
|
|
return fmt.Errorf("unexpected schema version found: %d", schemaVersion)
|
|
|
|
}
|
|
|
|
|
2022-12-29 19:08:47 +01:00
|
|
|
func setupNewDB(db *sql.DB) error {
|
|
|
|
if _, err := db.Exec(createTablesQueries); err != nil {
|
2022-12-26 04:29:55 +01:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
if _, err := db.Exec(insertSchemaVersion, currentSchemaVersion); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
2022-12-29 19:08:47 +01:00
|
|
|
|
|
|
|
func migrateFrom1(db *sql.DB) error {
|
|
|
|
log.Info("Migrating user database schema: from 1 to 2")
|
|
|
|
tx, err := db.Begin()
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
defer tx.Rollback()
|
|
|
|
if _, err := tx.Exec(migrate1To2RenameUserTableQueryNoTx); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if _, err := tx.Exec(createTablesQueriesNoTx); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if _, err := tx.Exec(migrate1To2InsertFromOldTablesAndDropNoTx); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if _, err := tx.Exec(updateSchemaVersion, 2); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := tx.Commit(); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil // Update this when a new version is added
|
|
|
|
}
|