ntfy/user/manager.go

918 lines
29 KiB
Go
Raw Normal View History

package user
2022-01-23 08:02:16 +03:00
2022-01-31 19:44:58 +03:00
import (
2022-12-26 06:29:55 +03:00
"database/sql"
"encoding/json"
2022-01-31 19:44:58 +03:00
"errors"
2022-12-26 06:29:55 +03: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 19:44:58 +03:00
)
2022-01-23 08:02:16 +03:00
2022-12-26 06:29:55 +03:00
const (
bcryptCost = 10
intentionalSlowDownHash = "$2a$10$YFCQvqQDwIIwnJM1xkAYOeih0dg17UVGanaTStnrSzC8NCWxcLDwy" // Cost should match bcryptCost
userStatsQueueWriterInterval = 33 * time.Second
2023-01-06 04:22:34 +03:00
tokenLength = 32
tokenExpiryDuration = 72 * time.Hour // Extend tokens by this much
2023-01-10 05:53:21 +03:00
syncTopicLength = 16
tokenMaxCount = 10 // Only keep this many tokens in the table per user
2022-12-26 06:29:55 +03:00
)
2022-12-31 18:16:14 +03:00
var (
2023-01-01 23:21:43 +03:00
errNoTokenProvided = errors.New("no token provided")
errTopicOwnedByOthers = errors.New("topic owned by others")
2023-01-06 04:22:34 +03:00
errNoRows = errors.New("no rows found")
2022-12-31 18:16:14 +03:00
)
2022-12-26 06:29:55 +03:00
// Manager-related queries
const (
2022-12-29 21:08:47 +03:00
createTablesQueriesNoTx = `
CREATE TABLE IF NOT EXISTS tier (
id INTEGER PRIMARY KEY AUTOINCREMENT,
2022-12-26 06:29:55 +03:00
code TEXT NOT NULL,
2023-01-09 23:40:46 +03:00
name TEXT NOT NULL,
paid INT NOT NULL,
2022-12-26 06:29:55 +03:00
messages_limit INT NOT NULL,
messages_expiry_duration INT NOT NULL,
2022-12-26 06:29:55 +03:00
emails_limit INT NOT NULL,
reservations_limit INT NOT NULL,
2022-12-26 06:29:55 +03:00
attachment_file_size_limit INT NOT NULL,
attachment_total_size_limit INT NOT NULL,
attachment_expiry_duration INT NOT NULL
2022-12-26 06:29:55 +03:00
);
CREATE TABLE IF NOT EXISTS user (
id INTEGER PRIMARY KEY AUTOINCREMENT,
tier_id INT,
2022-12-26 06:29:55 +03:00
user TEXT NOT NULL,
pass TEXT NOT NULL,
2023-01-10 05:53:21 +03:00
role TEXT CHECK (role IN ('anonymous', 'admin', 'user')) NOT NULL,
prefs JSON NOT NULL DEFAULT '{}',
sync_topic TEXT NOT NULL,
stats_messages INT NOT NULL DEFAULT (0),
stats_emails INT NOT NULL DEFAULT (0),
created_by TEXT NOT NULL,
created_at INT NOT NULL,
last_seen INT NOT NULL,
last_stats_reset INT NOT NULL DEFAULT (0),
FOREIGN KEY (tier_id) REFERENCES tier (id)
2022-12-26 06:29:55 +03:00
);
CREATE UNIQUE INDEX idx_user ON user (user);
CREATE TABLE IF NOT EXISTS user_access (
user_id INT NOT NULL,
2022-12-26 06:29:55 +03:00
topic TEXT NOT NULL,
read INT NOT NULL,
write INT NOT NULL,
2023-01-01 23:21:43 +03:00
owner_user_id INT,
2022-12-26 06:29:55 +03:00
PRIMARY KEY (user_id, topic),
2023-01-05 23:20:44 +03:00
FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE,
FOREIGN KEY (owner_user_id) REFERENCES user (id) ON DELETE CASCADE
2023-01-01 23:21:43 +03:00
);
2022-12-26 06:29:55 +03: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
);
2023-01-10 05:53:21 +03:00
INSERT INTO user (id, user, pass, role, sync_topic, created_by, created_at, last_seen)
VALUES (1, '*', '', 'anonymous', '', 'system', UNIXEPOCH(), 0)
ON CONFLICT (id) DO NOTHING;
2022-12-26 06:29:55 +03:00
`
2022-12-29 21:08:47 +03:00
createTablesQueries = `BEGIN; ` + createTablesQueriesNoTx + ` COMMIT;`
2023-01-05 23:20:44 +03:00
builtinStartupQueries = `
PRAGMA foreign_keys = ON;
`
2022-12-26 06:29:55 +03:00
selectUserByNameQuery = `
2023-01-10 05:53:21 +03:00
SELECT u.user, u.pass, u.role, u.prefs, u.sync_topic, u.stats_messages, u.stats_emails, p.code, p.name, p.paid, p.messages_limit, p.messages_expiry_duration, p.emails_limit, p.reservations_limit, p.attachment_file_size_limit, p.attachment_total_size_limit, p.attachment_expiry_duration
2022-12-26 06:29:55 +03:00
FROM user u
LEFT JOIN tier p on p.id = u.tier_id
2022-12-26 06:29:55 +03:00
WHERE user = ?
`
selectUserByTokenQuery = `
2023-01-10 05:53:21 +03:00
SELECT u.user, u.pass, u.role, u.prefs, u.sync_topic, u.stats_messages, u.stats_emails, p.code, p.name, p.paid, p.messages_limit, p.messages_expiry_duration, p.emails_limit, p.reservations_limit, p.attachment_file_size_limit, p.attachment_total_size_limit, p.attachment_expiry_duration
2022-12-26 06:29:55 +03:00
FROM user u
JOIN user_token t on u.id = t.user_id
LEFT JOIN tier p on p.id = u.tier_id
2022-12-29 19:09:45 +03:00
WHERE t.token = ? AND t.expires >= ?
2022-12-26 06:29:55 +03:00
`
selectTopicPermsQuery = `
SELECT read, write
FROM user_access a
JOIN user u ON u.id = a.user_id
2023-01-03 04:08:37 +03:00
WHERE (u.user = ? OR u.user = ?) AND ? LIKE a.topic
ORDER BY u.user DESC
2022-12-26 06:29:55 +03:00
`
2022-01-26 06:30:53 +03:00
2023-01-10 05:53:21 +03:00
insertUserQuery = `
INSERT INTO user (user, pass, role, sync_topic, created_by, created_at, last_seen)
VALUES (?, ?, ?, ?, ?, ?, ?)
`
2022-12-28 21:28:28 +03:00
selectUsernamesQuery = `
SELECT user
FROM user
ORDER BY
CASE role
WHEN 'admin' THEN 1
WHEN 'anonymous' THEN 3
ELSE 2
END, user
`
2023-01-10 05:53:21 +03:00
updateUserPassQuery = `UPDATE user SET pass = ? WHERE user = ?`
updateUserRoleQuery = `UPDATE user SET role = ? WHERE user = ?`
updateUserPrefsQuery = `UPDATE user SET prefs = ? WHERE user = ?`
updateUserStatsQuery = `UPDATE user SET stats_messages = ?, stats_emails = ? WHERE user = ?`
deleteUserQuery = `DELETE FROM user WHERE user = ?`
2022-12-26 06:29:55 +03:00
2022-12-28 21:28:28 +03:00
upsertUserAccessQuery = `
2023-01-01 23:21:43 +03: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 21:28:28 +03:00
ON CONFLICT (user_id, topic)
2023-01-01 23:21:43 +03:00
DO UPDATE SET read=excluded.read, write=excluded.write, owner_user_id=excluded.owner_user_id
`
selectUserAccessQuery = `
2023-01-03 04:08:37 +03:00
SELECT topic, read, write
2023-01-01 23:21:43 +03:00
FROM user_access
WHERE user_id = (SELECT id FROM user WHERE user = ?)
ORDER BY write DESC, read DESC, topic
`
2023-01-03 04:08:37 +03: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-06 05:15:10 +03:00
selectUserReservationsCountQuery = `
SELECT COUNT(*)
FROM user_access
WHERE user_id = owner_user_id AND owner_user_id = (SELECT id FROM user WHERE user = ?)
`
2023-01-06 18:45:38 +03:00
selectUserHasReservationQuery = `
SELECT COUNT(*)
FROM user_access
WHERE user_id = owner_user_id
AND owner_user_id = (SELECT id FROM user WHERE user = ?)
AND topic = ?
`
2023-01-01 23:21:43 +03:00
selectOtherAccessCountQuery = `
2023-01-06 04:22:34 +03:00
SELECT COUNT(*)
2023-01-01 23:21:43 +03:00
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 21:28:28 +03:00
`
2023-01-09 23:40:46 +03:00
deleteAllAccessQuery = `DELETE FROM user_access`
deleteUserAccessQuery = `
DELETE FROM user_access
WHERE user_id = (SELECT id FROM user WHERE user = ?)
OR owner_user_id = (SELECT id FROM user WHERE user = ?)
`
deleteTopicAccessQuery = `
DELETE FROM user_access
WHERE (user_id = (SELECT id FROM user WHERE user = ?) OR owner_user_id = (SELECT id FROM user WHERE user = ?))
AND topic = ?
`
2022-12-26 06:29:55 +03:00
2023-01-06 04:22:34 +03:00
selectTokenCountQuery = `SELECT COUNT(*) FROM user_token WHERE (SELECT id FROM user WHERE user = ?)`
2022-12-26 06:29:55 +03:00
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 < ?`
2023-01-06 04:22:34 +03:00
deleteExcessTokensQuery = `
DELETE FROM user_token
WHERE (user_id, token) NOT IN (
SELECT user_id, token
FROM user_token
WHERE user_id = (SELECT id FROM user WHERE user = ?)
ORDER BY expires DESC
LIMIT ?
)
`
insertTierQuery = `
2023-01-09 23:40:46 +03:00
INSERT INTO tier (code, name, paid, messages_limit, messages_expiry_duration, emails_limit, reservations_limit, attachment_file_size_limit, attachment_total_size_limit, attachment_expiry_duration)
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
`
selectTierIDQuery = `SELECT id FROM tier WHERE code = ?`
updateUserTierQuery = `UPDATE user SET tier_id = ? WHERE user = ?`
2023-01-09 23:40:46 +03:00
deleteUserTierQuery = `UPDATE user SET tier_id = null WHERE user = ?`
2022-12-26 06:29:55 +03:00
)
2022-12-03 23:20:59 +03:00
2022-12-26 06:29:55 +03:00
// Schema management queries
const (
2022-12-29 21:08:47 +03:00
currentSchemaVersion = 2
2022-12-26 06:29:55 +03:00
insertSchemaVersion = `INSERT INTO schemaVersion VALUES (1, ?)`
2022-12-29 21:08:47 +03:00
updateSchemaVersion = `UPDATE schemaVersion SET version = ? WHERE id = 1`
2022-12-26 06:29:55 +03:00
selectSchemaVersionQuery = `SELECT version FROM schemaVersion WHERE id = 1`
2022-12-29 21:08:47 +03:00
// 1 -> 2 (complex migration!)
migrate1To2RenameUserTableQueryNoTx = `
ALTER TABLE user RENAME TO user_old;
`
migrate1To2InsertFromOldTablesAndDropNoTx = `
2023-01-10 05:53:21 +03:00
INSERT INTO user (user, pass, role, sync_topic, created_by, created_at, last_seen)
SELECT user, pass, role, '', 'admin', UNIXEPOCH(), UNIXEPOCH() FROM user_old;
2022-12-29 21:08:47 +03:00
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;
`
2023-01-10 23:41:08 +03:00
migrate1To2SelectAllUsersIDsNoTx = `SELECT id FROM user`
migrate1To2UpdateSyncTopicNoTx = `UPDATE user SET sync_topic = ? WHERE id = ?`
2022-12-26 06:29:55 +03:00
)
2022-01-23 08:02:16 +03:00
2022-12-28 06:14:14 +03:00
// Manager is an implementation of Manager. It stores users and access control list
2022-12-26 06:29:55 +03:00
// in a SQLite database.
2022-12-28 06:14:14 +03:00
type Manager struct {
2023-01-06 04:22:34 +03:00
db *sql.DB
defaultAccess Permission // Default permission if no ACL matches
statsQueue map[string]*User // Username -> User, for "unimportant" user updates
mu sync.Mutex
2022-12-26 06:29:55 +03:00
}
2022-01-26 06:30:53 +03:00
2022-12-28 06:14:14 +03:00
var _ Auther = (*Manager)(nil)
2022-12-26 06:29:55 +03:00
2022-12-28 06:14:14 +03:00
// NewManager creates a new Manager instance
2023-01-05 23:20:44 +03:00
func NewManager(filename, startupQueries string, defaultAccess Permission) (*Manager, error) {
2023-01-06 04:22:34 +03:00
return newManager(filename, startupQueries, defaultAccess, userStatsQueueWriterInterval)
2022-12-29 19:09:45 +03:00
}
// NewManager creates a new Manager instance
2023-01-06 04:22:34 +03:00
func newManager(filename, startupQueries string, defaultAccess Permission, statsWriterInterval time.Duration) (*Manager, error) {
2022-12-26 06:29:55 +03:00
db, err := sql.Open("sqlite3", filename)
if err != nil {
return nil, err
}
2022-12-29 21:08:47 +03:00
if err := setupDB(db); err != nil {
2022-12-26 06:29:55 +03:00
return nil, err
}
2023-01-05 23:20:44 +03:00
if err := runStartupQueries(db, startupQueries); err != nil {
return nil, err
}
2022-12-28 06:14:14 +03:00
manager := &Manager{
2023-01-06 04:22:34 +03:00
db: db,
defaultAccess: defaultAccess,
statsQueue: make(map[string]*User),
2022-12-26 06:29:55 +03:00
}
2022-12-29 19:09:45 +03:00
go manager.userStatsQueueWriter(statsWriterInterval)
2022-12-26 06:29:55 +03:00
return manager, nil
}
2022-01-26 06:30:53 +03:00
2022-12-28 21:28:28 +03:00
// Authenticate checks username and password and returns a User if correct. The method
2022-12-26 06:29:55 +03:00
// returns in constant-ish time, regardless of whether the user exists or the password is
// correct or incorrect.
2022-12-28 06:14:14 +03:00
func (a *Manager) Authenticate(username, password string) (*User, error) {
2022-12-26 06:29:55 +03:00
if username == Everyone {
return nil, ErrUnauthenticated
}
user, err := a.User(username)
if err != nil {
2023-01-05 23:20:44 +03:00
log.Trace("authentication of user %s failed (1): %s", username, err.Error())
bcrypt.CompareHashAndPassword([]byte(intentionalSlowDownHash), []byte("intentional slow-down to avoid timing attacks"))
2022-12-26 06:29:55 +03:00
return nil, ErrUnauthenticated
}
if err := bcrypt.CompareHashAndPassword([]byte(user.Hash), []byte(password)); err != nil {
2023-01-05 23:20:44 +03:00
log.Trace("authentication of user %s failed (2): %s", username, err.Error())
2022-12-26 06:29:55 +03:00
return nil, ErrUnauthenticated
}
return user, nil
}
2022-01-26 06:30:53 +03:00
2022-12-28 21:28:28 +03: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 06:14:14 +03:00
func (a *Manager) AuthenticateToken(token string) (*User, error) {
2022-12-28 21:46:18 +03:00
if len(token) != tokenLength {
return nil, ErrUnauthenticated
}
2022-12-26 06:29:55 +03:00
user, err := a.userByToken(token)
if err != nil {
return nil, ErrUnauthenticated
}
user.Token = token
return user, nil
}
2022-01-26 06:30:53 +03:00
2022-12-28 21:28:28 +03:00
// CreateToken generates a random token for the given user and returns it. The token expires
2023-01-06 04:22:34 +03:00
// after a fixed duration unless ExtendToken is called. This function also prunes tokens for the
// given user, if there are too many of them.
2022-12-28 06:14:14 +03:00
func (a *Manager) CreateToken(user *User) (*Token, error) {
2023-01-06 04:22:34 +03:00
token, expires := util.RandomString(tokenLength), time.Now().Add(tokenExpiryDuration)
tx, err := a.db.Begin()
if err != nil {
return nil, err
}
defer tx.Rollback()
if _, err := tx.Exec(insertTokenQuery, user.Name, token, expires.Unix()); err != nil {
return nil, err
}
rows, err := tx.Query(selectTokenCountQuery, user.Name)
if err != nil {
return nil, err
}
defer rows.Close()
if !rows.Next() {
return nil, errNoRows
}
var tokenCount int
if err := rows.Scan(&tokenCount); err != nil {
return nil, err
}
if tokenCount >= tokenMaxCount {
// This pruning logic is done in two queries for efficiency. The SELECT above is a lookup
// on two indices, whereas the query below is a full table scan.
if _, err := tx.Exec(deleteExcessTokensQuery, user.Name, tokenMaxCount); err != nil {
return nil, err
}
}
if err := tx.Commit(); err != nil {
2022-12-26 06:29:55 +03:00
return nil, err
}
return &Token{
Value: token,
2022-12-28 21:46:18 +03:00
Expires: expires,
2022-12-26 06:29:55 +03:00
}, nil
}
2022-01-26 06:30:53 +03:00
2022-12-28 21:28:28 +03:00
// ExtendToken sets the new expiry date for a token, thereby extending its use further into the future.
2022-12-28 06:14:14 +03:00
func (a *Manager) ExtendToken(user *User) (*Token, error) {
2022-12-31 18:16:14 +03:00
if user.Token == "" {
return nil, errNoTokenProvided
}
2023-01-06 04:22:34 +03:00
newExpires := time.Now().Add(tokenExpiryDuration)
2022-12-26 06:29:55 +03:00
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 21:46:18 +03:00
Expires: newExpires,
2022-12-26 06:29:55 +03:00
}, nil
}
2022-01-26 06:30:53 +03:00
2022-12-28 21:28:28 +03:00
// RemoveToken deletes the token defined in User.Token
2022-12-28 06:14:14 +03:00
func (a *Manager) RemoveToken(user *User) error {
2022-12-26 06:29:55 +03: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 06:30:53 +03:00
2022-12-28 21:28:28 +03:00
// RemoveExpiredTokens deletes all expired tokens from the database
2022-12-28 06:14:14 +03:00
func (a *Manager) RemoveExpiredTokens() error {
2022-12-26 06:29:55 +03:00
if _, err := a.db.Exec(deleteExpiredTokensQuery, time.Now().Unix()); err != nil {
return err
}
return nil
}
2022-01-26 06:30:53 +03:00
2022-12-28 23:51:09 +03:00
// ChangeSettings persists the user settings
2022-12-28 06:14:14 +03:00
func (a *Manager) ChangeSettings(user *User) error {
2023-01-10 05:53:21 +03:00
prefs, err := json.Marshal(user.Prefs)
2022-12-26 06:29:55 +03:00
if err != nil {
return err
}
2023-01-10 05:53:21 +03:00
if _, err := a.db.Exec(updateUserPrefsQuery, string(prefs), user.Name); err != nil {
2022-12-26 06:29:55 +03:00
return err
}
return nil
2022-01-23 08:54:18 +03:00
}
2022-12-28 23:51:09 +03:00
// EnqueueStats adds the user to a queue which writes out user stats (messages, emails, ..) in
// batches at a regular interval
2022-12-28 06:14:14 +03:00
func (a *Manager) EnqueueStats(user *User) {
2022-12-26 06:29:55 +03:00
a.mu.Lock()
defer a.mu.Unlock()
a.statsQueue[user.Name] = user
2022-12-08 05:26:18 +03:00
}
2022-12-29 19:09:45 +03:00
func (a *Manager) userStatsQueueWriter(interval time.Duration) {
ticker := time.NewTicker(interval)
2022-12-26 06:29:55 +03:00
for range ticker.C {
if err := a.writeUserStatsQueue(); err != nil {
log.Warn("User Manager: Writing user stats queue failed: %s", err.Error())
2022-12-26 06:29:55 +03:00
}
}
}
2022-12-28 06:14:14 +03:00
func (a *Manager) writeUserStatsQueue() error {
2022-12-26 06:29:55 +03:00
a.mu.Lock()
if len(a.statsQueue) == 0 {
a.mu.Unlock()
log.Trace("User Manager: No user stats updates to commit")
2022-12-26 06:29:55 +03:00
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("User Manager: Writing user stats queue for %d user(s)", len(statsQueue))
2022-12-26 06:29:55 +03:00
for username, u := range statsQueue {
log.Trace("User Manager: Updating stats for user %s: messages=%d, emails=%d", username, u.Stats.Messages, u.Stats.Emails)
2022-12-26 06:29:55 +03:00
if _, err := tx.Exec(updateUserStatsQuery, u.Stats.Messages, u.Stats.Emails, username); err != nil {
return err
}
}
return tx.Commit()
2022-12-08 05:26:18 +03:00
}
2022-12-26 06:29:55 +03: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 06:14:14 +03:00
func (a *Manager) Authorize(user *User, topic string, perm Permission) error {
2022-12-26 06:29:55 +03: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 23:21:43 +03:00
// rows (one for everyone, and one for the user), but prioritizes the user.
2023-01-03 04:08:37 +03:00
rows, err := a.db.Query(selectTopicPermsQuery, Everyone, username, topic)
2022-12-26 06:29:55 +03:00
if err != nil {
return err
}
defer rows.Close()
if !rows.Next() {
return a.resolvePerms(a.defaultAccess, perm)
2022-12-26 06:29:55 +03:00
}
var read, write bool
if err := rows.Scan(&read, &write); err != nil {
return err
} else if err := rows.Err(); err != nil {
return err
}
return a.resolvePerms(NewPermission(read, write), perm)
2022-12-26 06:29:55 +03:00
}
2022-12-18 22:35:05 +03:00
func (a *Manager) resolvePerms(base, perm Permission) error {
if perm == PermissionRead && base.IsRead() {
2022-12-26 06:29:55 +03:00
return nil
} else if perm == PermissionWrite && base.IsWrite() {
2022-12-26 06:29:55 +03:00
return nil
}
return ErrUnauthorized
}
2022-12-18 22:35:05 +03:00
// AddUser adds a user with the given username, password and role
2023-01-10 05:53:21 +03:00
func (a *Manager) AddUser(username, password string, role Role, createdBy string) error {
2022-12-26 06:29:55 +03:00
if !AllowedUsername(username) || !AllowedRole(role) {
return ErrInvalidArgument
}
hash, err := bcrypt.GenerateFromPassword([]byte(password), bcryptCost)
if err != nil {
return err
}
2023-01-10 05:53:21 +03:00
syncTopic, now := util.RandomString(syncTopicLength), time.Now().Unix()
if _, err = a.db.Exec(insertUserQuery, username, hash, role, syncTopic, createdBy, now, now); err != nil {
2022-12-26 06:29:55 +03:00
return err
}
return nil
2022-12-17 23:17:52 +03:00
}
2022-12-26 06:29:55 +03: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 06:14:14 +03:00
func (a *Manager) RemoveUser(username string) error {
2022-12-26 06:29:55 +03:00
if !AllowedUsername(username) {
return ErrInvalidArgument
}
2023-01-05 23:20:44 +03:00
// Rows in user_access, user_token, etc. are deleted via foreign keys
if _, err := a.db.Exec(deleteUserQuery, username); err != nil {
2022-12-29 21:08:47 +03:00
return err
}
2023-01-05 23:20:44 +03:00
return nil
2022-12-08 05:26:18 +03:00
}
2022-12-26 06:29:55 +03:00
// Users returns a list of users. It always also returns the Everyone user ("*").
2022-12-28 06:14:14 +03:00
func (a *Manager) Users() ([]*User, error) {
2022-12-26 06:29:55 +03: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 07:02:39 +03:00
}
2022-12-26 06:29:55 +03: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 06:14:14 +03:00
func (a *Manager) User(username string) (*User, error) {
2022-12-26 06:29:55 +03:00
rows, err := a.db.Query(selectUserByNameQuery, username)
if err != nil {
return nil, err
}
return a.readUser(rows)
}
2022-12-28 06:14:14 +03:00
func (a *Manager) userByToken(token string) (*User, error) {
2022-12-29 19:09:45 +03:00
rows, err := a.db.Query(selectUserByTokenQuery, token, time.Now().Unix())
2022-12-26 06:29:55 +03:00
if err != nil {
return nil, err
}
return a.readUser(rows)
2022-01-23 08:02:16 +03:00
}
2022-12-28 06:14:14 +03:00
func (a *Manager) readUser(rows *sql.Rows) (*User, error) {
2022-12-26 06:29:55 +03:00
defer rows.Close()
2023-01-10 05:53:21 +03:00
var username, hash, role, prefs, syncTopic string
var tierCode, tierName sql.NullString
2023-01-09 23:40:46 +03:00
var paid sql.NullBool
2022-12-26 06:29:55 +03:00
var messages, emails int64
var messagesLimit, messagesExpiryDuration, emailsLimit, reservationsLimit, attachmentFileSizeLimit, attachmentTotalSizeLimit, attachmentExpiryDuration sql.NullInt64
2022-12-26 06:29:55 +03:00
if !rows.Next() {
return nil, ErrNotFound
}
2023-01-10 05:53:21 +03:00
if err := rows.Scan(&username, &hash, &role, &prefs, &syncTopic, &messages, &emails, &tierCode, &tierName, &paid, &messagesLimit, &messagesExpiryDuration, &emailsLimit, &reservationsLimit, &attachmentFileSizeLimit, &attachmentTotalSizeLimit, &attachmentExpiryDuration); err != nil {
2022-12-26 06:29:55 +03:00
return nil, err
} else if err := rows.Err(); err != nil {
return nil, err
}
user := &User{
2023-01-10 05:53:21 +03:00
Name: username,
Hash: hash,
Role: Role(role),
Prefs: &Prefs{},
SyncTopic: syncTopic,
2022-12-26 06:29:55 +03:00
Stats: &Stats{
Messages: messages,
Emails: emails,
},
}
2023-01-10 05:53:21 +03:00
if err := json.Unmarshal([]byte(prefs), user.Prefs); err != nil {
return nil, err
2022-12-26 06:29:55 +03:00
}
if tierCode.Valid {
user.Tier = &Tier{
Code: tierCode.String,
2023-01-09 23:40:46 +03:00
Name: tierName.String,
Paid: paid.Bool,
2022-12-26 06:29:55 +03:00
MessagesLimit: messagesLimit.Int64,
2023-01-09 23:40:46 +03:00
MessagesExpiryDuration: time.Duration(messagesExpiryDuration.Int64) * time.Second,
2022-12-26 06:29:55 +03:00
EmailsLimit: emailsLimit.Int64,
ReservationsLimit: reservationsLimit.Int64,
2022-12-26 06:29:55 +03:00
AttachmentFileSizeLimit: attachmentFileSizeLimit.Int64,
AttachmentTotalSizeLimit: attachmentTotalSizeLimit.Int64,
2023-01-09 23:40:46 +03:00
AttachmentExpiryDuration: time.Duration(attachmentExpiryDuration.Int64) * time.Second,
2022-12-26 06:29:55 +03:00
}
}
return user, nil
}
2022-01-23 08:02:16 +03:00
2023-01-03 04:08:37 +03:00
// Grants returns all user-specific access control entries
func (a *Manager) Grants(username string) ([]Grant, error) {
2022-12-26 06:29:55 +03: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 04:08:37 +03:00
var read, write bool
if err := rows.Scan(&topic, &read, &write); err != nil {
2022-12-26 06:29:55 +03:00
return nil, err
} else if err := rows.Err(); err != nil {
return nil, err
}
grants = append(grants, Grant{
TopicPattern: fromSQLWildcard(topic),
Allow: NewPermission(read, write),
2022-12-26 06:29:55 +03:00
})
}
return grants, nil
}
2022-01-23 08:02:16 +03:00
2023-01-03 04:08:37 +03: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
var ownerRead, ownerWrite bool
2023-01-03 04:08:37 +03:00
var everyoneRead, everyoneWrite sql.NullBool
if err := rows.Scan(&topic, &ownerRead, &ownerWrite, &everyoneRead, &everyoneWrite); err != nil {
2023-01-03 04:08:37 +03:00
return nil, err
} else if err := rows.Err(); err != nil {
return nil, err
}
reservations = append(reservations, Reservation{
Topic: topic,
Owner: NewPermission(ownerRead, ownerWrite),
Everyone: NewPermission(everyoneRead.Bool, everyoneWrite.Bool), // false if null
2023-01-03 04:08:37 +03:00
})
}
return reservations, nil
}
2023-01-06 18:45:38 +03:00
// HasReservation returns true if the given topic access is owned by the user
func (a *Manager) HasReservation(username, topic string) (bool, error) {
rows, err := a.db.Query(selectUserHasReservationQuery, username, topic)
if err != nil {
return false, err
}
defer rows.Close()
if !rows.Next() {
return false, errNoRows
}
var count int64
if err := rows.Scan(&count); err != nil {
return false, err
}
return count > 0, nil
}
2023-01-06 05:15:10 +03:00
// ReservationsCount returns the number of reservations owned by this user
func (a *Manager) ReservationsCount(username string) (int64, error) {
rows, err := a.db.Query(selectUserReservationsCountQuery, username)
if err != nil {
return 0, err
}
defer rows.Close()
if !rows.Next() {
return 0, errNoRows
}
var count int64
if err := rows.Scan(&count); err != nil {
return 0, err
}
return count, nil
}
2022-12-26 06:29:55 +03:00
// ChangePassword changes a user's password
2022-12-28 06:14:14 +03:00
func (a *Manager) ChangePassword(username, password string) error {
2022-12-26 06:29:55 +03: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 08:02:16 +03:00
2022-12-26 06:29:55 +03: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 06:14:14 +03:00
func (a *Manager) ChangeRole(username string, role Role) error {
2022-12-26 06:29:55 +03:00
if !AllowedUsername(username) || !AllowedRole(role) {
return ErrInvalidArgument
}
if _, err := a.db.Exec(updateUserRoleQuery, string(role), username); err != nil {
return err
}
if role == RoleAdmin {
2023-01-09 23:40:46 +03:00
if _, err := a.db.Exec(deleteUserAccessQuery, username, username); err != nil {
2022-12-26 06:29:55 +03:00
return err
}
}
return nil
}
2022-01-23 23:30:30 +03:00
// ChangeTier changes a user's tier using the tier code
func (a *Manager) ChangeTier(username, tier string) error {
if !AllowedUsername(username) {
return ErrInvalidArgument
}
rows, err := a.db.Query(selectTierIDQuery, tier)
if err != nil {
return err
}
defer rows.Close()
if !rows.Next() {
return ErrInvalidArgument
}
var tierID int64
if err := rows.Scan(&tierID); err != nil {
return err
}
rows.Close()
if _, err := a.db.Exec(updateUserTierQuery, tierID, username); err != nil {
return err
}
return nil
}
2023-01-01 23:21:43 +03: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() {
2023-01-06 04:22:34 +03:00
return errNoRows
2023-01-01 23:21:43 +03:00
}
var otherCount int
if err := rows.Scan(&otherCount); err != nil {
return err
}
if otherCount > 0 {
return errTopicOwnedByOthers
}
return nil
}
2022-12-26 06:29:55 +03:00
// AllowAccess adds or updates an entry in th access control list for a specific user. It controls
2023-01-01 23:21:43 +03: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 06:29:55 +03:00
return ErrInvalidArgument
}
2023-01-01 23:21:43 +03:00
if _, err := a.db.Exec(upsertUserAccessQuery, username, toSQLWildcard(topicPattern), read, write, owner, owner); err != nil {
2022-12-26 06:29:55 +03:00
return err
}
return nil
}
2022-01-31 19:44:58 +03:00
2022-12-26 06:29:55 +03: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 06:14:14 +03:00
func (a *Manager) ResetAccess(username string, topicPattern string) error {
2022-12-26 06:29:55 +03: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 == "" {
2023-01-09 23:40:46 +03:00
_, err := a.db.Exec(deleteUserAccessQuery, username, username)
2022-12-26 06:29:55 +03:00
return err
}
2023-01-09 23:40:46 +03:00
_, err := a.db.Exec(deleteTopicAccessQuery, username, username, toSQLWildcard(topicPattern))
return err
}
// ResetTier removes the tier from the given user
func (a *Manager) ResetTier(username string) error {
if !AllowedUsername(username) && username != Everyone && username != "" {
return ErrInvalidArgument
}
_, err := a.db.Exec(deleteUserTierQuery, username)
2022-12-26 06:29:55 +03:00
return err
2022-01-23 23:30:30 +03:00
}
2022-12-26 06:29:55 +03:00
// DefaultAccess returns the default read/write access if no access control entry matches
func (a *Manager) DefaultAccess() Permission {
return a.defaultAccess
2022-01-31 19:44:58 +03:00
}
// CreateTier creates a new tier in the database
func (a *Manager) CreateTier(tier *Tier) error {
2023-01-09 23:40:46 +03:00
if _, err := a.db.Exec(insertTierQuery, tier.Code, tier.Name, tier.Paid, tier.MessagesLimit, int64(tier.MessagesExpiryDuration.Seconds()), tier.EmailsLimit, tier.ReservationsLimit, tier.AttachmentFileSizeLimit, tier.AttachmentTotalSizeLimit, int64(tier.AttachmentExpiryDuration.Seconds())); err != nil {
return err
}
return nil
}
2022-12-26 06:29:55 +03:00
func toSQLWildcard(s string) string {
return strings.ReplaceAll(s, "*", "%")
2022-01-31 19:44:58 +03:00
}
2022-12-26 06:29:55 +03:00
func fromSQLWildcard(s string) string {
return strings.ReplaceAll(s, "%", "*")
}
2023-01-05 23:20:44 +03:00
func runStartupQueries(db *sql.DB, startupQueries string) error {
if _, err := db.Exec(startupQueries); err != nil {
return err
}
if _, err := db.Exec(builtinStartupQueries); err != nil {
return err
}
return nil
}
2022-12-29 21:08:47 +03:00
func setupDB(db *sql.DB) error {
2022-12-26 06:29:55 +03:00
// If 'schemaVersion' table does not exist, this must be a new database
rowsSV, err := db.Query(selectSchemaVersionQuery)
if err != nil {
2022-12-29 21:08:47 +03:00
return setupNewDB(db)
2022-12-26 06:29:55 +03: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 21:08:47 +03:00
} else if schemaVersion == 1 {
return migrateFrom1(db)
2022-12-26 06:29:55 +03:00
}
return fmt.Errorf("unexpected schema version found: %d", schemaVersion)
}
2022-12-29 21:08:47 +03:00
func setupNewDB(db *sql.DB) error {
if _, err := db.Exec(createTablesQueries); err != nil {
2022-12-26 06:29:55 +03:00
return err
}
if _, err := db.Exec(insertSchemaVersion, currentSchemaVersion); err != nil {
return err
}
return nil
}
2022-12-29 21:08:47 +03: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
}
2023-01-10 23:41:08 +03:00
rows, err := tx.Query(migrate1To2SelectAllUsersIDsNoTx)
if err != nil {
return err
}
defer rows.Close()
syncTopics := make(map[int]string)
for rows.Next() {
var userID int
if err := rows.Scan(&userID); err != nil {
return err
}
syncTopics[userID] = util.RandomString(syncTopicLength)
}
if err := rows.Close(); err != nil {
return err
}
for userID, syncTopic := range syncTopics {
if _, err := tx.Exec(migrate1To2UpdateSyncTopicNoTx, syncTopic, userID); err != nil {
return err
}
}
2022-12-29 21:08:47 +03:00
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
}