manager.go 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042
  1. package user
  2. import (
  3. "database/sql"
  4. "encoding/json"
  5. "errors"
  6. "fmt"
  7. _ "github.com/mattn/go-sqlite3" // SQLite driver
  8. "github.com/stripe/stripe-go/v74"
  9. "golang.org/x/crypto/bcrypt"
  10. "heckel.io/ntfy/log"
  11. "heckel.io/ntfy/util"
  12. "strings"
  13. "sync"
  14. "time"
  15. )
  16. const (
  17. bcryptCost = 10
  18. intentionalSlowDownHash = "$2a$10$YFCQvqQDwIIwnJM1xkAYOeih0dg17UVGanaTStnrSzC8NCWxcLDwy" // Cost should match bcryptCost
  19. userStatsQueueWriterInterval = 33 * time.Second
  20. tokenLength = 32
  21. tokenExpiryDuration = 72 * time.Hour // Extend tokens by this much
  22. syncTopicLength = 16
  23. tokenMaxCount = 10 // Only keep this many tokens in the table per user
  24. )
  25. var (
  26. errNoTokenProvided = errors.New("no token provided")
  27. errTopicOwnedByOthers = errors.New("topic owned by others")
  28. errNoRows = errors.New("no rows found")
  29. )
  30. // Manager-related queries
  31. const (
  32. createTablesQueriesNoTx = `
  33. CREATE TABLE IF NOT EXISTS tier (
  34. id INTEGER PRIMARY KEY AUTOINCREMENT,
  35. code TEXT NOT NULL,
  36. name TEXT NOT NULL,
  37. messages_limit INT NOT NULL,
  38. messages_expiry_duration INT NOT NULL,
  39. emails_limit INT NOT NULL,
  40. reservations_limit INT NOT NULL,
  41. attachment_file_size_limit INT NOT NULL,
  42. attachment_total_size_limit INT NOT NULL,
  43. attachment_expiry_duration INT NOT NULL,
  44. stripe_price_id TEXT
  45. );
  46. CREATE UNIQUE INDEX idx_tier_code ON tier (code);
  47. CREATE UNIQUE INDEX idx_tier_price_id ON tier (stripe_price_id);
  48. CREATE TABLE IF NOT EXISTS user (
  49. id INTEGER PRIMARY KEY AUTOINCREMENT,
  50. tier_id INT,
  51. user TEXT NOT NULL,
  52. pass TEXT NOT NULL,
  53. role TEXT CHECK (role IN ('anonymous', 'admin', 'user')) NOT NULL,
  54. prefs JSON NOT NULL DEFAULT '{}',
  55. sync_topic TEXT NOT NULL,
  56. stats_messages INT NOT NULL DEFAULT (0),
  57. stats_emails INT NOT NULL DEFAULT (0),
  58. stripe_customer_id TEXT,
  59. stripe_subscription_id TEXT,
  60. stripe_subscription_status TEXT,
  61. stripe_subscription_paid_until INT,
  62. stripe_subscription_cancel_at INT,
  63. created_by TEXT NOT NULL,
  64. created_at INT NOT NULL,
  65. last_seen INT NOT NULL,
  66. FOREIGN KEY (tier_id) REFERENCES tier (id)
  67. );
  68. CREATE UNIQUE INDEX idx_user ON user (user);
  69. CREATE UNIQUE INDEX idx_user_stripe_customer_id ON user (stripe_customer_id);
  70. CREATE UNIQUE INDEX idx_user_stripe_subscription_id ON user (stripe_subscription_id);
  71. CREATE TABLE IF NOT EXISTS user_access (
  72. user_id INT NOT NULL,
  73. topic TEXT NOT NULL,
  74. read INT NOT NULL,
  75. write INT NOT NULL,
  76. owner_user_id INT,
  77. PRIMARY KEY (user_id, topic),
  78. FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE,
  79. FOREIGN KEY (owner_user_id) REFERENCES user (id) ON DELETE CASCADE
  80. );
  81. CREATE TABLE IF NOT EXISTS user_token (
  82. user_id INT NOT NULL,
  83. token TEXT NOT NULL,
  84. expires INT NOT NULL,
  85. PRIMARY KEY (user_id, token),
  86. FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE
  87. );
  88. CREATE TABLE IF NOT EXISTS schemaVersion (
  89. id INT PRIMARY KEY,
  90. version INT NOT NULL
  91. );
  92. INSERT INTO user (id, user, pass, role, sync_topic, created_by, created_at, last_seen)
  93. VALUES (1, '*', '', 'anonymous', '', 'system', UNIXEPOCH(), 0)
  94. ON CONFLICT (id) DO NOTHING;
  95. `
  96. createTablesQueries = `BEGIN; ` + createTablesQueriesNoTx + ` COMMIT;`
  97. builtinStartupQueries = `
  98. PRAGMA foreign_keys = ON;
  99. `
  100. selectUserByNameQuery = `
  101. SELECT u.user, u.pass, u.role, u.prefs, u.sync_topic, u.stats_messages, u.stats_emails, u.stripe_customer_id, u.stripe_subscription_id, u.stripe_subscription_status, u.stripe_subscription_paid_until, u.stripe_subscription_cancel_at, p.code, p.name, 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, p.stripe_price_id
  102. FROM user u
  103. LEFT JOIN tier p on p.id = u.tier_id
  104. WHERE user = ?
  105. `
  106. selectUserByTokenQuery = `
  107. SELECT u.user, u.pass, u.role, u.prefs, u.sync_topic, u.stats_messages, u.stats_emails, u.stripe_customer_id, u.stripe_subscription_id, u.stripe_subscription_status, u.stripe_subscription_paid_until, u.stripe_subscription_cancel_at, p.code, p.name, 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, p.stripe_price_id
  108. FROM user u
  109. JOIN user_token t on u.id = t.user_id
  110. LEFT JOIN tier p on p.id = u.tier_id
  111. WHERE t.token = ? AND t.expires >= ?
  112. `
  113. selectUserByStripeCustomerIDQuery = `
  114. SELECT u.user, u.pass, u.role, u.prefs, u.sync_topic, u.stats_messages, u.stats_emails, u.stripe_customer_id, u.stripe_subscription_id, u.stripe_subscription_status, u.stripe_subscription_paid_until, u.stripe_subscription_cancel_at, p.code, p.name, 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, p.stripe_price_id
  115. FROM user u
  116. LEFT JOIN tier p on p.id = u.tier_id
  117. WHERE u.stripe_customer_id = ?
  118. `
  119. selectTopicPermsQuery = `
  120. SELECT read, write
  121. FROM user_access a
  122. JOIN user u ON u.id = a.user_id
  123. WHERE (u.user = ? OR u.user = ?) AND ? LIKE a.topic
  124. ORDER BY u.user DESC
  125. `
  126. insertUserQuery = `
  127. INSERT INTO user (user, pass, role, sync_topic, created_by, created_at, last_seen)
  128. VALUES (?, ?, ?, ?, ?, ?, ?)
  129. `
  130. selectUsernamesQuery = `
  131. SELECT user
  132. FROM user
  133. ORDER BY
  134. CASE role
  135. WHEN 'admin' THEN 1
  136. WHEN 'anonymous' THEN 3
  137. ELSE 2
  138. END, user
  139. `
  140. updateUserPassQuery = `UPDATE user SET pass = ? WHERE user = ?`
  141. updateUserRoleQuery = `UPDATE user SET role = ? WHERE user = ?`
  142. updateUserPrefsQuery = `UPDATE user SET prefs = ? WHERE user = ?`
  143. updateUserStatsQuery = `UPDATE user SET stats_messages = ?, stats_emails = ? WHERE user = ?`
  144. updateUserStatsResetAllQuery = `UPDATE user SET stats_messages = 0, stats_emails = 0`
  145. deleteUserQuery = `DELETE FROM user WHERE user = ?`
  146. upsertUserAccessQuery = `
  147. INSERT INTO user_access (user_id, topic, read, write, owner_user_id)
  148. VALUES ((SELECT id FROM user WHERE user = ?), ?, ?, ?, (SELECT IIF(?='',NULL,(SELECT id FROM user WHERE user=?))))
  149. ON CONFLICT (user_id, topic)
  150. DO UPDATE SET read=excluded.read, write=excluded.write, owner_user_id=excluded.owner_user_id
  151. `
  152. selectUserAccessQuery = `
  153. SELECT topic, read, write
  154. FROM user_access
  155. WHERE user_id = (SELECT id FROM user WHERE user = ?)
  156. ORDER BY write DESC, read DESC, topic
  157. `
  158. selectUserReservationsQuery = `
  159. SELECT a_user.topic, a_user.read, a_user.write, a_everyone.read AS everyone_read, a_everyone.write AS everyone_write
  160. FROM user_access a_user
  161. LEFT JOIN user_access a_everyone ON a_user.topic = a_everyone.topic AND a_everyone.user_id = (SELECT id FROM user WHERE user = ?)
  162. WHERE a_user.user_id = a_user.owner_user_id
  163. AND a_user.owner_user_id = (SELECT id FROM user WHERE user = ?)
  164. ORDER BY a_user.topic
  165. `
  166. selectUserReservationsCountQuery = `
  167. SELECT COUNT(*)
  168. FROM user_access
  169. WHERE user_id = owner_user_id AND owner_user_id = (SELECT id FROM user WHERE user = ?)
  170. `
  171. selectUserHasReservationQuery = `
  172. SELECT COUNT(*)
  173. FROM user_access
  174. WHERE user_id = owner_user_id
  175. AND owner_user_id = (SELECT id FROM user WHERE user = ?)
  176. AND topic = ?
  177. `
  178. selectOtherAccessCountQuery = `
  179. SELECT COUNT(*)
  180. FROM user_access
  181. WHERE (topic = ? OR ? LIKE topic)
  182. AND (owner_user_id IS NULL OR owner_user_id != (SELECT id FROM user WHERE user = ?))
  183. `
  184. deleteAllAccessQuery = `DELETE FROM user_access`
  185. deleteUserAccessQuery = `
  186. DELETE FROM user_access
  187. WHERE user_id = (SELECT id FROM user WHERE user = ?)
  188. OR owner_user_id = (SELECT id FROM user WHERE user = ?)
  189. `
  190. deleteTopicAccessQuery = `
  191. DELETE FROM user_access
  192. WHERE (user_id = (SELECT id FROM user WHERE user = ?) OR owner_user_id = (SELECT id FROM user WHERE user = ?))
  193. AND topic = ?
  194. `
  195. selectTokenCountQuery = `SELECT COUNT(*) FROM user_token WHERE (SELECT id FROM user WHERE user = ?)`
  196. insertTokenQuery = `INSERT INTO user_token (user_id, token, expires) VALUES ((SELECT id FROM user WHERE user = ?), ?, ?)`
  197. updateTokenExpiryQuery = `UPDATE user_token SET expires = ? WHERE user_id = (SELECT id FROM user WHERE user = ?) AND token = ?`
  198. deleteTokenQuery = `DELETE FROM user_token WHERE user_id = (SELECT id FROM user WHERE user = ?) AND token = ?`
  199. deleteExpiredTokensQuery = `DELETE FROM user_token WHERE expires < ?`
  200. deleteExcessTokensQuery = `
  201. DELETE FROM user_token
  202. WHERE (user_id, token) NOT IN (
  203. SELECT user_id, token
  204. FROM user_token
  205. WHERE user_id = (SELECT id FROM user WHERE user = ?)
  206. ORDER BY expires DESC
  207. LIMIT ?
  208. )
  209. `
  210. insertTierQuery = `
  211. INSERT INTO tier (code, name, messages_limit, messages_expiry_duration, emails_limit, reservations_limit, attachment_file_size_limit, attachment_total_size_limit, attachment_expiry_duration)
  212. VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)
  213. `
  214. selectTierIDQuery = `SELECT id FROM tier WHERE code = ?`
  215. selectTierByCodeQuery = `
  216. SELECT code, name, messages_limit, messages_expiry_duration, emails_limit, reservations_limit, attachment_file_size_limit, attachment_total_size_limit, attachment_expiry_duration, stripe_price_id
  217. FROM tier
  218. WHERE code = ?
  219. `
  220. selectTierByPriceIDQuery = `
  221. SELECT code, name, messages_limit, messages_expiry_duration, emails_limit, reservations_limit, attachment_file_size_limit, attachment_total_size_limit, attachment_expiry_duration, stripe_price_id
  222. FROM tier
  223. WHERE stripe_price_id = ?
  224. `
  225. updateUserTierQuery = `UPDATE user SET tier_id = ? WHERE user = ?`
  226. deleteUserTierQuery = `UPDATE user SET tier_id = null WHERE user = ?`
  227. updateBillingQuery = `
  228. UPDATE user
  229. SET stripe_customer_id = ?, stripe_subscription_id = ?, stripe_subscription_status = ?, stripe_subscription_paid_until = ?, stripe_subscription_cancel_at = ?
  230. WHERE user = ?
  231. `
  232. )
  233. // Schema management queries
  234. const (
  235. currentSchemaVersion = 2
  236. insertSchemaVersion = `INSERT INTO schemaVersion VALUES (1, ?)`
  237. updateSchemaVersion = `UPDATE schemaVersion SET version = ? WHERE id = 1`
  238. selectSchemaVersionQuery = `SELECT version FROM schemaVersion WHERE id = 1`
  239. // 1 -> 2 (complex migration!)
  240. migrate1To2RenameUserTableQueryNoTx = `
  241. ALTER TABLE user RENAME TO user_old;
  242. `
  243. migrate1To2InsertFromOldTablesAndDropNoTx = `
  244. INSERT INTO user (user, pass, role, sync_topic, created_by, created_at, last_seen)
  245. SELECT user, pass, role, '', 'admin', UNIXEPOCH(), UNIXEPOCH() FROM user_old;
  246. INSERT INTO user_access (user_id, topic, read, write)
  247. SELECT u.id, a.topic, a.read, a.write
  248. FROM user u
  249. JOIN access a ON u.user = a.user;
  250. DROP TABLE access;
  251. DROP TABLE user_old;
  252. `
  253. migrate1To2SelectAllUsersIDsNoTx = `SELECT id FROM user`
  254. migrate1To2UpdateSyncTopicNoTx = `UPDATE user SET sync_topic = ? WHERE id = ?`
  255. )
  256. // Manager is an implementation of Manager. It stores users and access control list
  257. // in a SQLite database.
  258. type Manager struct {
  259. db *sql.DB
  260. defaultAccess Permission // Default permission if no ACL matches
  261. statsQueue map[string]*User // Username -> User, for "unimportant" user updates
  262. mu sync.Mutex
  263. }
  264. var _ Auther = (*Manager)(nil)
  265. // NewManager creates a new Manager instance
  266. func NewManager(filename, startupQueries string, defaultAccess Permission) (*Manager, error) {
  267. return newManager(filename, startupQueries, defaultAccess, userStatsQueueWriterInterval)
  268. }
  269. // NewManager creates a new Manager instance
  270. func newManager(filename, startupQueries string, defaultAccess Permission, statsWriterInterval time.Duration) (*Manager, error) {
  271. db, err := sql.Open("sqlite3", filename)
  272. if err != nil {
  273. return nil, err
  274. }
  275. if err := setupDB(db); err != nil {
  276. return nil, err
  277. }
  278. if err := runStartupQueries(db, startupQueries); err != nil {
  279. return nil, err
  280. }
  281. manager := &Manager{
  282. db: db,
  283. defaultAccess: defaultAccess,
  284. statsQueue: make(map[string]*User),
  285. }
  286. go manager.userStatsQueueWriter(statsWriterInterval)
  287. return manager, nil
  288. }
  289. // Authenticate checks username and password and returns a User if correct. The method
  290. // returns in constant-ish time, regardless of whether the user exists or the password is
  291. // correct or incorrect.
  292. func (a *Manager) Authenticate(username, password string) (*User, error) {
  293. if username == Everyone {
  294. return nil, ErrUnauthenticated
  295. }
  296. user, err := a.User(username)
  297. if err != nil {
  298. log.Trace("authentication of user %s failed (1): %s", username, err.Error())
  299. bcrypt.CompareHashAndPassword([]byte(intentionalSlowDownHash), []byte("intentional slow-down to avoid timing attacks"))
  300. return nil, ErrUnauthenticated
  301. }
  302. if err := bcrypt.CompareHashAndPassword([]byte(user.Hash), []byte(password)); err != nil {
  303. log.Trace("authentication of user %s failed (2): %s", username, err.Error())
  304. return nil, ErrUnauthenticated
  305. }
  306. return user, nil
  307. }
  308. // AuthenticateToken checks if the token exists and returns the associated User if it does.
  309. // The method sets the User.Token value to the token that was used for authentication.
  310. func (a *Manager) AuthenticateToken(token string) (*User, error) {
  311. if len(token) != tokenLength {
  312. return nil, ErrUnauthenticated
  313. }
  314. user, err := a.userByToken(token)
  315. if err != nil {
  316. return nil, ErrUnauthenticated
  317. }
  318. user.Token = token
  319. return user, nil
  320. }
  321. // CreateToken generates a random token for the given user and returns it. The token expires
  322. // after a fixed duration unless ExtendToken is called. This function also prunes tokens for the
  323. // given user, if there are too many of them.
  324. func (a *Manager) CreateToken(user *User) (*Token, error) {
  325. token, expires := util.RandomString(tokenLength), time.Now().Add(tokenExpiryDuration)
  326. tx, err := a.db.Begin()
  327. if err != nil {
  328. return nil, err
  329. }
  330. defer tx.Rollback()
  331. if _, err := tx.Exec(insertTokenQuery, user.Name, token, expires.Unix()); err != nil {
  332. return nil, err
  333. }
  334. rows, err := tx.Query(selectTokenCountQuery, user.Name)
  335. if err != nil {
  336. return nil, err
  337. }
  338. defer rows.Close()
  339. if !rows.Next() {
  340. return nil, errNoRows
  341. }
  342. var tokenCount int
  343. if err := rows.Scan(&tokenCount); err != nil {
  344. return nil, err
  345. }
  346. if tokenCount >= tokenMaxCount {
  347. // This pruning logic is done in two queries for efficiency. The SELECT above is a lookup
  348. // on two indices, whereas the query below is a full table scan.
  349. if _, err := tx.Exec(deleteExcessTokensQuery, user.Name, tokenMaxCount); err != nil {
  350. return nil, err
  351. }
  352. }
  353. if err := tx.Commit(); err != nil {
  354. return nil, err
  355. }
  356. return &Token{
  357. Value: token,
  358. Expires: expires,
  359. }, nil
  360. }
  361. // ExtendToken sets the new expiry date for a token, thereby extending its use further into the future.
  362. func (a *Manager) ExtendToken(user *User) (*Token, error) {
  363. if user.Token == "" {
  364. return nil, errNoTokenProvided
  365. }
  366. newExpires := time.Now().Add(tokenExpiryDuration)
  367. if _, err := a.db.Exec(updateTokenExpiryQuery, newExpires.Unix(), user.Name, user.Token); err != nil {
  368. return nil, err
  369. }
  370. return &Token{
  371. Value: user.Token,
  372. Expires: newExpires,
  373. }, nil
  374. }
  375. // RemoveToken deletes the token defined in User.Token
  376. func (a *Manager) RemoveToken(user *User) error {
  377. if user.Token == "" {
  378. return ErrUnauthorized
  379. }
  380. if _, err := a.db.Exec(deleteTokenQuery, user.Name, user.Token); err != nil {
  381. return err
  382. }
  383. return nil
  384. }
  385. // RemoveExpiredTokens deletes all expired tokens from the database
  386. func (a *Manager) RemoveExpiredTokens() error {
  387. if _, err := a.db.Exec(deleteExpiredTokensQuery, time.Now().Unix()); err != nil {
  388. return err
  389. }
  390. return nil
  391. }
  392. // ChangeSettings persists the user settings
  393. func (a *Manager) ChangeSettings(user *User) error {
  394. prefs, err := json.Marshal(user.Prefs)
  395. if err != nil {
  396. return err
  397. }
  398. if _, err := a.db.Exec(updateUserPrefsQuery, string(prefs), user.Name); err != nil {
  399. return err
  400. }
  401. return nil
  402. }
  403. // ResetStats resets all user stats in the user database. This touches all users.
  404. func (a *Manager) ResetStats() error {
  405. a.mu.Lock()
  406. defer a.mu.Unlock()
  407. if _, err := a.db.Exec(updateUserStatsResetAllQuery); err != nil {
  408. return err
  409. }
  410. a.statsQueue = make(map[string]*User)
  411. return nil
  412. }
  413. // EnqueueStats adds the user to a queue which writes out user stats (messages, emails, ..) in
  414. // batches at a regular interval
  415. func (a *Manager) EnqueueStats(user *User) {
  416. a.mu.Lock()
  417. defer a.mu.Unlock()
  418. a.statsQueue[user.Name] = user
  419. }
  420. func (a *Manager) userStatsQueueWriter(interval time.Duration) {
  421. ticker := time.NewTicker(interval)
  422. for range ticker.C {
  423. if err := a.writeUserStatsQueue(); err != nil {
  424. log.Warn("User Manager: Writing user stats queue failed: %s", err.Error())
  425. }
  426. }
  427. }
  428. func (a *Manager) writeUserStatsQueue() error {
  429. a.mu.Lock()
  430. if len(a.statsQueue) == 0 {
  431. a.mu.Unlock()
  432. log.Trace("User Manager: No user stats updates to commit")
  433. return nil
  434. }
  435. statsQueue := a.statsQueue
  436. a.statsQueue = make(map[string]*User)
  437. a.mu.Unlock()
  438. tx, err := a.db.Begin()
  439. if err != nil {
  440. return err
  441. }
  442. defer tx.Rollback()
  443. log.Debug("User Manager: Writing user stats queue for %d user(s)", len(statsQueue))
  444. for username, u := range statsQueue {
  445. log.Trace("User Manager: Updating stats for user %s: messages=%d, emails=%d", username, u.Stats.Messages, u.Stats.Emails)
  446. if _, err := tx.Exec(updateUserStatsQuery, u.Stats.Messages, u.Stats.Emails, username); err != nil {
  447. return err
  448. }
  449. }
  450. return tx.Commit()
  451. }
  452. // Authorize returns nil if the given user has access to the given topic using the desired
  453. // permission. The user param may be nil to signal an anonymous user.
  454. func (a *Manager) Authorize(user *User, topic string, perm Permission) error {
  455. if user != nil && user.Role == RoleAdmin {
  456. return nil // Admin can do everything
  457. }
  458. username := Everyone
  459. if user != nil {
  460. username = user.Name
  461. }
  462. // Select the read/write permissions for this user/topic combo. The query may return two
  463. // rows (one for everyone, and one for the user), but prioritizes the user.
  464. rows, err := a.db.Query(selectTopicPermsQuery, Everyone, username, topic)
  465. if err != nil {
  466. return err
  467. }
  468. defer rows.Close()
  469. if !rows.Next() {
  470. return a.resolvePerms(a.defaultAccess, perm)
  471. }
  472. var read, write bool
  473. if err := rows.Scan(&read, &write); err != nil {
  474. return err
  475. } else if err := rows.Err(); err != nil {
  476. return err
  477. }
  478. return a.resolvePerms(NewPermission(read, write), perm)
  479. }
  480. func (a *Manager) resolvePerms(base, perm Permission) error {
  481. if perm == PermissionRead && base.IsRead() {
  482. return nil
  483. } else if perm == PermissionWrite && base.IsWrite() {
  484. return nil
  485. }
  486. return ErrUnauthorized
  487. }
  488. // AddUser adds a user with the given username, password and role
  489. func (a *Manager) AddUser(username, password string, role Role, createdBy string) error {
  490. if !AllowedUsername(username) || !AllowedRole(role) {
  491. return ErrInvalidArgument
  492. }
  493. hash, err := bcrypt.GenerateFromPassword([]byte(password), bcryptCost)
  494. if err != nil {
  495. return err
  496. }
  497. syncTopic, now := util.RandomString(syncTopicLength), time.Now().Unix()
  498. if _, err = a.db.Exec(insertUserQuery, username, hash, role, syncTopic, createdBy, now, now); err != nil {
  499. return err
  500. }
  501. return nil
  502. }
  503. // RemoveUser deletes the user with the given username. The function returns nil on success, even
  504. // if the user did not exist in the first place.
  505. func (a *Manager) RemoveUser(username string) error {
  506. if !AllowedUsername(username) {
  507. return ErrInvalidArgument
  508. }
  509. // Rows in user_access, user_token, etc. are deleted via foreign keys
  510. if _, err := a.db.Exec(deleteUserQuery, username); err != nil {
  511. return err
  512. }
  513. return nil
  514. }
  515. // Users returns a list of users. It always also returns the Everyone user ("*").
  516. func (a *Manager) Users() ([]*User, error) {
  517. rows, err := a.db.Query(selectUsernamesQuery)
  518. if err != nil {
  519. return nil, err
  520. }
  521. defer rows.Close()
  522. usernames := make([]string, 0)
  523. for rows.Next() {
  524. var username string
  525. if err := rows.Scan(&username); err != nil {
  526. return nil, err
  527. } else if err := rows.Err(); err != nil {
  528. return nil, err
  529. }
  530. usernames = append(usernames, username)
  531. }
  532. rows.Close()
  533. users := make([]*User, 0)
  534. for _, username := range usernames {
  535. user, err := a.User(username)
  536. if err != nil {
  537. return nil, err
  538. }
  539. users = append(users, user)
  540. }
  541. return users, nil
  542. }
  543. // User returns the user with the given username if it exists, or ErrUserNotFound otherwise.
  544. // You may also pass Everyone to retrieve the anonymous user and its Grant list.
  545. func (a *Manager) User(username string) (*User, error) {
  546. rows, err := a.db.Query(selectUserByNameQuery, username)
  547. if err != nil {
  548. return nil, err
  549. }
  550. return a.readUser(rows)
  551. }
  552. func (a *Manager) UserByStripeCustomer(stripeCustomerID string) (*User, error) {
  553. rows, err := a.db.Query(selectUserByStripeCustomerIDQuery, stripeCustomerID)
  554. if err != nil {
  555. return nil, err
  556. }
  557. return a.readUser(rows)
  558. }
  559. func (a *Manager) userByToken(token string) (*User, error) {
  560. rows, err := a.db.Query(selectUserByTokenQuery, token, time.Now().Unix())
  561. if err != nil {
  562. return nil, err
  563. }
  564. return a.readUser(rows)
  565. }
  566. func (a *Manager) readUser(rows *sql.Rows) (*User, error) {
  567. defer rows.Close()
  568. var username, hash, role, prefs, syncTopic string
  569. var stripeCustomerID, stripeSubscriptionID, stripeSubscriptionStatus, stripePriceID, tierCode, tierName sql.NullString
  570. var messages, emails int64
  571. var messagesLimit, messagesExpiryDuration, emailsLimit, reservationsLimit, attachmentFileSizeLimit, attachmentTotalSizeLimit, attachmentExpiryDuration, stripeSubscriptionPaidUntil, stripeSubscriptionCancelAt sql.NullInt64
  572. if !rows.Next() {
  573. return nil, ErrUserNotFound
  574. }
  575. if err := rows.Scan(&username, &hash, &role, &prefs, &syncTopic, &messages, &emails, &stripeCustomerID, &stripeSubscriptionID, &stripeSubscriptionStatus, &stripeSubscriptionPaidUntil, &stripeSubscriptionCancelAt, &tierCode, &tierName, &messagesLimit, &messagesExpiryDuration, &emailsLimit, &reservationsLimit, &attachmentFileSizeLimit, &attachmentTotalSizeLimit, &attachmentExpiryDuration, &stripePriceID); err != nil {
  576. return nil, err
  577. } else if err := rows.Err(); err != nil {
  578. return nil, err
  579. }
  580. user := &User{
  581. Name: username,
  582. Hash: hash,
  583. Role: Role(role),
  584. Prefs: &Prefs{},
  585. SyncTopic: syncTopic,
  586. Stats: &Stats{
  587. Messages: messages,
  588. Emails: emails,
  589. },
  590. Billing: &Billing{
  591. StripeCustomerID: stripeCustomerID.String, // May be empty
  592. StripeSubscriptionID: stripeSubscriptionID.String, // May be empty
  593. StripeSubscriptionStatus: stripe.SubscriptionStatus(stripeSubscriptionStatus.String), // May be empty
  594. StripeSubscriptionPaidUntil: time.Unix(stripeSubscriptionPaidUntil.Int64, 0), // May be zero
  595. StripeSubscriptionCancelAt: time.Unix(stripeSubscriptionCancelAt.Int64, 0), // May be zero
  596. },
  597. }
  598. if err := json.Unmarshal([]byte(prefs), user.Prefs); err != nil {
  599. return nil, err
  600. }
  601. if tierCode.Valid {
  602. // See readTier() when this is changed!
  603. user.Tier = &Tier{
  604. Code: tierCode.String,
  605. Name: tierName.String,
  606. Paid: stripePriceID.Valid, // If there is a price, it's a paid tier
  607. MessagesLimit: messagesLimit.Int64,
  608. MessagesExpiryDuration: time.Duration(messagesExpiryDuration.Int64) * time.Second,
  609. EmailsLimit: emailsLimit.Int64,
  610. ReservationsLimit: reservationsLimit.Int64,
  611. AttachmentFileSizeLimit: attachmentFileSizeLimit.Int64,
  612. AttachmentTotalSizeLimit: attachmentTotalSizeLimit.Int64,
  613. AttachmentExpiryDuration: time.Duration(attachmentExpiryDuration.Int64) * time.Second,
  614. StripePriceID: stripePriceID.String,
  615. }
  616. }
  617. return user, nil
  618. }
  619. // Grants returns all user-specific access control entries
  620. func (a *Manager) Grants(username string) ([]Grant, error) {
  621. rows, err := a.db.Query(selectUserAccessQuery, username)
  622. if err != nil {
  623. return nil, err
  624. }
  625. defer rows.Close()
  626. grants := make([]Grant, 0)
  627. for rows.Next() {
  628. var topic string
  629. var read, write bool
  630. if err := rows.Scan(&topic, &read, &write); err != nil {
  631. return nil, err
  632. } else if err := rows.Err(); err != nil {
  633. return nil, err
  634. }
  635. grants = append(grants, Grant{
  636. TopicPattern: fromSQLWildcard(topic),
  637. Allow: NewPermission(read, write),
  638. })
  639. }
  640. return grants, nil
  641. }
  642. // Reservations returns all user-owned topics, and the associated everyone-access
  643. func (a *Manager) Reservations(username string) ([]Reservation, error) {
  644. rows, err := a.db.Query(selectUserReservationsQuery, Everyone, username)
  645. if err != nil {
  646. return nil, err
  647. }
  648. defer rows.Close()
  649. reservations := make([]Reservation, 0)
  650. for rows.Next() {
  651. var topic string
  652. var ownerRead, ownerWrite bool
  653. var everyoneRead, everyoneWrite sql.NullBool
  654. if err := rows.Scan(&topic, &ownerRead, &ownerWrite, &everyoneRead, &everyoneWrite); err != nil {
  655. return nil, err
  656. } else if err := rows.Err(); err != nil {
  657. return nil, err
  658. }
  659. reservations = append(reservations, Reservation{
  660. Topic: topic,
  661. Owner: NewPermission(ownerRead, ownerWrite),
  662. Everyone: NewPermission(everyoneRead.Bool, everyoneWrite.Bool), // false if null
  663. })
  664. }
  665. return reservations, nil
  666. }
  667. // HasReservation returns true if the given topic access is owned by the user
  668. func (a *Manager) HasReservation(username, topic string) (bool, error) {
  669. rows, err := a.db.Query(selectUserHasReservationQuery, username, topic)
  670. if err != nil {
  671. return false, err
  672. }
  673. defer rows.Close()
  674. if !rows.Next() {
  675. return false, errNoRows
  676. }
  677. var count int64
  678. if err := rows.Scan(&count); err != nil {
  679. return false, err
  680. }
  681. return count > 0, nil
  682. }
  683. // ReservationsCount returns the number of reservations owned by this user
  684. func (a *Manager) ReservationsCount(username string) (int64, error) {
  685. rows, err := a.db.Query(selectUserReservationsCountQuery, username)
  686. if err != nil {
  687. return 0, err
  688. }
  689. defer rows.Close()
  690. if !rows.Next() {
  691. return 0, errNoRows
  692. }
  693. var count int64
  694. if err := rows.Scan(&count); err != nil {
  695. return 0, err
  696. }
  697. return count, nil
  698. }
  699. // ChangePassword changes a user's password
  700. func (a *Manager) ChangePassword(username, password string) error {
  701. hash, err := bcrypt.GenerateFromPassword([]byte(password), bcryptCost)
  702. if err != nil {
  703. return err
  704. }
  705. if _, err := a.db.Exec(updateUserPassQuery, hash, username); err != nil {
  706. return err
  707. }
  708. return nil
  709. }
  710. // ChangeRole changes a user's role. When a role is changed from RoleUser to RoleAdmin,
  711. // all existing access control entries (Grant) are removed, since they are no longer needed.
  712. func (a *Manager) ChangeRole(username string, role Role) error {
  713. if !AllowedUsername(username) || !AllowedRole(role) {
  714. return ErrInvalidArgument
  715. }
  716. if _, err := a.db.Exec(updateUserRoleQuery, string(role), username); err != nil {
  717. return err
  718. }
  719. if role == RoleAdmin {
  720. if _, err := a.db.Exec(deleteUserAccessQuery, username, username); err != nil {
  721. return err
  722. }
  723. }
  724. return nil
  725. }
  726. // ChangeTier changes a user's tier using the tier code
  727. func (a *Manager) ChangeTier(username, tier string) error {
  728. if !AllowedUsername(username) {
  729. return ErrInvalidArgument
  730. }
  731. rows, err := a.db.Query(selectTierIDQuery, tier)
  732. if err != nil {
  733. return err
  734. }
  735. defer rows.Close()
  736. if !rows.Next() {
  737. return ErrInvalidArgument
  738. }
  739. var tierID int64
  740. if err := rows.Scan(&tierID); err != nil {
  741. return err
  742. }
  743. rows.Close()
  744. if _, err := a.db.Exec(updateUserTierQuery, tierID, username); err != nil {
  745. return err
  746. }
  747. return nil
  748. }
  749. // CheckAllowAccess tests if a user may create an access control entry for the given topic.
  750. // If there are any ACL entries that are not owned by the user, an error is returned.
  751. func (a *Manager) CheckAllowAccess(username string, topic string) error {
  752. if (!AllowedUsername(username) && username != Everyone) || !AllowedTopic(topic) {
  753. return ErrInvalidArgument
  754. }
  755. rows, err := a.db.Query(selectOtherAccessCountQuery, topic, topic, username)
  756. if err != nil {
  757. return err
  758. }
  759. defer rows.Close()
  760. if !rows.Next() {
  761. return errNoRows
  762. }
  763. var otherCount int
  764. if err := rows.Scan(&otherCount); err != nil {
  765. return err
  766. }
  767. if otherCount > 0 {
  768. return errTopicOwnedByOthers
  769. }
  770. return nil
  771. }
  772. // AllowAccess adds or updates an entry in th access control list for a specific user. It controls
  773. // read/write access to a topic. The parameter topicPattern may include wildcards (*). The ACL entry
  774. // owner may either be a user (username), or the system (empty).
  775. func (a *Manager) AllowAccess(owner, username string, topicPattern string, read bool, write bool) error {
  776. if !AllowedUsername(username) && username != Everyone {
  777. return ErrInvalidArgument
  778. } else if owner != "" && !AllowedUsername(owner) {
  779. return ErrInvalidArgument
  780. } else if !AllowedTopicPattern(topicPattern) {
  781. return ErrInvalidArgument
  782. }
  783. if _, err := a.db.Exec(upsertUserAccessQuery, username, toSQLWildcard(topicPattern), read, write, owner, owner); err != nil {
  784. return err
  785. }
  786. return nil
  787. }
  788. // ResetAccess removes an access control list entry for a specific username/topic, or (if topic is
  789. // empty) for an entire user. The parameter topicPattern may include wildcards (*).
  790. func (a *Manager) ResetAccess(username string, topicPattern string) error {
  791. if !AllowedUsername(username) && username != Everyone && username != "" {
  792. return ErrInvalidArgument
  793. } else if !AllowedTopicPattern(topicPattern) && topicPattern != "" {
  794. return ErrInvalidArgument
  795. }
  796. if username == "" && topicPattern == "" {
  797. _, err := a.db.Exec(deleteAllAccessQuery, username)
  798. return err
  799. } else if topicPattern == "" {
  800. _, err := a.db.Exec(deleteUserAccessQuery, username, username)
  801. return err
  802. }
  803. _, err := a.db.Exec(deleteTopicAccessQuery, username, username, toSQLWildcard(topicPattern))
  804. return err
  805. }
  806. // ResetTier removes the tier from the given user
  807. func (a *Manager) ResetTier(username string) error {
  808. if !AllowedUsername(username) && username != Everyone && username != "" {
  809. return ErrInvalidArgument
  810. }
  811. _, err := a.db.Exec(deleteUserTierQuery, username)
  812. return err
  813. }
  814. // DefaultAccess returns the default read/write access if no access control entry matches
  815. func (a *Manager) DefaultAccess() Permission {
  816. return a.defaultAccess
  817. }
  818. // CreateTier creates a new tier in the database
  819. func (a *Manager) CreateTier(tier *Tier) error {
  820. if _, err := a.db.Exec(insertTierQuery, tier.Code, tier.Name, tier.MessagesLimit, int64(tier.MessagesExpiryDuration.Seconds()), tier.EmailsLimit, tier.ReservationsLimit, tier.AttachmentFileSizeLimit, tier.AttachmentTotalSizeLimit, int64(tier.AttachmentExpiryDuration.Seconds())); err != nil {
  821. return err
  822. }
  823. return nil
  824. }
  825. func (a *Manager) ChangeBilling(user *User) error {
  826. if _, err := a.db.Exec(updateBillingQuery, nullString(user.Billing.StripeCustomerID), nullString(user.Billing.StripeSubscriptionID), nullString(string(user.Billing.StripeSubscriptionStatus)), nullInt64(user.Billing.StripeSubscriptionPaidUntil.Unix()), nullInt64(user.Billing.StripeSubscriptionCancelAt.Unix()), user.Name); err != nil {
  827. return err
  828. }
  829. return nil
  830. }
  831. func (a *Manager) Tier(code string) (*Tier, error) {
  832. rows, err := a.db.Query(selectTierByCodeQuery, code)
  833. if err != nil {
  834. return nil, err
  835. }
  836. return a.readTier(rows)
  837. }
  838. func (a *Manager) TierByStripePrice(priceID string) (*Tier, error) {
  839. rows, err := a.db.Query(selectTierByPriceIDQuery, priceID)
  840. if err != nil {
  841. return nil, err
  842. }
  843. return a.readTier(rows)
  844. }
  845. func (a *Manager) readTier(rows *sql.Rows) (*Tier, error) {
  846. defer rows.Close()
  847. var code, name string
  848. var stripePriceID sql.NullString
  849. var messagesLimit, messagesExpiryDuration, emailsLimit, reservationsLimit, attachmentFileSizeLimit, attachmentTotalSizeLimit, attachmentExpiryDuration sql.NullInt64
  850. if !rows.Next() {
  851. return nil, ErrTierNotFound
  852. }
  853. if err := rows.Scan(&code, &name, &messagesLimit, &messagesExpiryDuration, &emailsLimit, &reservationsLimit, &attachmentFileSizeLimit, &attachmentTotalSizeLimit, &attachmentExpiryDuration, &stripePriceID); err != nil {
  854. return nil, err
  855. } else if err := rows.Err(); err != nil {
  856. return nil, err
  857. }
  858. // When changed, note readUser() as well
  859. return &Tier{
  860. Code: code,
  861. Name: name,
  862. Paid: stripePriceID.Valid, // If there is a price, it's a paid tier
  863. MessagesLimit: messagesLimit.Int64,
  864. MessagesExpiryDuration: time.Duration(messagesExpiryDuration.Int64) * time.Second,
  865. EmailsLimit: emailsLimit.Int64,
  866. ReservationsLimit: reservationsLimit.Int64,
  867. AttachmentFileSizeLimit: attachmentFileSizeLimit.Int64,
  868. AttachmentTotalSizeLimit: attachmentTotalSizeLimit.Int64,
  869. AttachmentExpiryDuration: time.Duration(attachmentExpiryDuration.Int64) * time.Second,
  870. StripePriceID: stripePriceID.String, // May be empty!
  871. }, nil
  872. }
  873. func toSQLWildcard(s string) string {
  874. return strings.ReplaceAll(s, "*", "%")
  875. }
  876. func fromSQLWildcard(s string) string {
  877. return strings.ReplaceAll(s, "%", "*")
  878. }
  879. func runStartupQueries(db *sql.DB, startupQueries string) error {
  880. if _, err := db.Exec(startupQueries); err != nil {
  881. return err
  882. }
  883. if _, err := db.Exec(builtinStartupQueries); err != nil {
  884. return err
  885. }
  886. return nil
  887. }
  888. func setupDB(db *sql.DB) error {
  889. // If 'schemaVersion' table does not exist, this must be a new database
  890. rowsSV, err := db.Query(selectSchemaVersionQuery)
  891. if err != nil {
  892. return setupNewDB(db)
  893. }
  894. defer rowsSV.Close()
  895. // If 'schemaVersion' table exists, read version and potentially upgrade
  896. schemaVersion := 0
  897. if !rowsSV.Next() {
  898. return errors.New("cannot determine schema version: database file may be corrupt")
  899. }
  900. if err := rowsSV.Scan(&schemaVersion); err != nil {
  901. return err
  902. }
  903. rowsSV.Close()
  904. // Do migrations
  905. if schemaVersion == currentSchemaVersion {
  906. return nil
  907. } else if schemaVersion == 1 {
  908. return migrateFrom1(db)
  909. }
  910. return fmt.Errorf("unexpected schema version found: %d", schemaVersion)
  911. }
  912. func setupNewDB(db *sql.DB) error {
  913. if _, err := db.Exec(createTablesQueries); err != nil {
  914. return err
  915. }
  916. if _, err := db.Exec(insertSchemaVersion, currentSchemaVersion); err != nil {
  917. return err
  918. }
  919. return nil
  920. }
  921. func migrateFrom1(db *sql.DB) error {
  922. log.Info("Migrating user database schema: from 1 to 2")
  923. tx, err := db.Begin()
  924. if err != nil {
  925. return err
  926. }
  927. defer tx.Rollback()
  928. if _, err := tx.Exec(migrate1To2RenameUserTableQueryNoTx); err != nil {
  929. return err
  930. }
  931. if _, err := tx.Exec(createTablesQueriesNoTx); err != nil {
  932. return err
  933. }
  934. if _, err := tx.Exec(migrate1To2InsertFromOldTablesAndDropNoTx); err != nil {
  935. return err
  936. }
  937. rows, err := tx.Query(migrate1To2SelectAllUsersIDsNoTx)
  938. if err != nil {
  939. return err
  940. }
  941. defer rows.Close()
  942. syncTopics := make(map[int]string)
  943. for rows.Next() {
  944. var userID int
  945. if err := rows.Scan(&userID); err != nil {
  946. return err
  947. }
  948. syncTopics[userID] = util.RandomString(syncTopicLength)
  949. }
  950. if err := rows.Close(); err != nil {
  951. return err
  952. }
  953. for userID, syncTopic := range syncTopics {
  954. if _, err := tx.Exec(migrate1To2UpdateSyncTopicNoTx, syncTopic, userID); err != nil {
  955. return err
  956. }
  957. }
  958. if _, err := tx.Exec(updateSchemaVersion, 2); err != nil {
  959. return err
  960. }
  961. if err := tx.Commit(); err != nil {
  962. return err
  963. }
  964. return nil // Update this when a new version is added
  965. }
  966. func nullString(s string) sql.NullString {
  967. if s == "" {
  968. return sql.NullString{}
  969. }
  970. return sql.NullString{String: s, Valid: true}
  971. }
  972. func nullInt64(v int64) sql.NullInt64 {
  973. if v == 0 {
  974. return sql.NullInt64{}
  975. }
  976. return sql.NullInt64{Int64: v, Valid: true}
  977. }