koan_core/db/queries/
auth.rs

1//! Auth queries: user CRUD, refresh token management.
2
3use rusqlite::{Connection, params};
4
5use crate::auth::{self, Role};
6
7// ---------------------------------------------------------------------------
8// Row types
9// ---------------------------------------------------------------------------
10
11#[derive(Debug, Clone)]
12pub struct UserRow {
13    pub id: i64,
14    pub username: String,
15    pub password_hash: String,
16    pub role: Role,
17    pub created_at: Option<String>,
18}
19
20#[derive(Debug, Clone)]
21pub struct RefreshTokenRow {
22    pub id: String,
23    pub user_id: i64,
24    pub expires_at: i64,
25    pub revoked: bool,
26    pub created_at: Option<String>,
27}
28
29// ---------------------------------------------------------------------------
30// Whose data
31// ---------------------------------------------------------------------------
32
33/// The user a caller with no account acts as: the macOS app, the TUI, a server
34/// with auth disabled, the Subsonic shared secret.
35///
36/// Favourites, playlists and play history are per user. An install with no
37/// admin account keeps them under this id; once there is one, the first admin
38/// owns them and this id [resolves](resolve_user) to theirs, so a single-user
39/// server and a local library behave the same.
40pub const LOCAL_USER: i64 = 0;
41
42/// The first admin account, which answers for [`LOCAL_USER`].
43pub fn first_admin(conn: &Connection) -> Result<Option<i64>, rusqlite::Error> {
44    conn.query_row("SELECT MIN(id) FROM users WHERE role = 'admin'", [], |r| {
45        r.get(0)
46    })
47}
48
49/// The id whose rows `user` reads and writes: `user` itself for an account,
50/// the first admin (or [`LOCAL_USER`] while there is none) for the implicit user.
51pub fn resolve_user(conn: &Connection, user: i64) -> Result<i64, rusqlite::Error> {
52    if user != LOCAL_USER {
53        return Ok(user);
54    }
55    Ok(first_admin(conn)?.unwrap_or(LOCAL_USER))
56}
57
58/// Whether `user` is the one [`LOCAL_USER`] resolves to: whose favourites and
59/// playlists this koan syncs with an upstream server.
60pub fn is_local_user(conn: &Connection, user: i64) -> Result<bool, rusqlite::Error> {
61    Ok(resolve_user(conn, user)? == resolve_user(conn, LOCAL_USER)?)
62}
63
64/// Hand the implicit user's rows to the first admin, once there is one.
65///
66/// Where a row would duplicate one the admin already has, theirs is kept.
67pub fn adopt_local_rows(conn: &Connection) -> Result<(), rusqlite::Error> {
68    let Some(admin) = first_admin(conn)? else {
69        return Ok(());
70    };
71    for table in [
72        "favourites",
73        "favourite_albums",
74        "favourite_artists",
75        "play_history",
76        "playlists",
77        "shares",
78    ] {
79        // Runs on every open: a read, so it takes no write lock when there is
80        // nothing to hand over.
81        let pending: bool = conn.query_row(
82            &format!("SELECT EXISTS(SELECT 1 FROM {table} WHERE user_id = ?1)"),
83            params![LOCAL_USER],
84            |r| r.get(0),
85        )?;
86        if !pending {
87            continue;
88        }
89        conn.execute(
90            &format!("UPDATE OR IGNORE {table} SET user_id = ?1 WHERE user_id = ?2"),
91            params![admin, LOCAL_USER],
92        )?;
93        conn.execute(
94            &format!("DELETE FROM {table} WHERE user_id = ?1"),
95            params![LOCAL_USER],
96        )?;
97    }
98    Ok(())
99}
100
101// ---------------------------------------------------------------------------
102// User CRUD
103// ---------------------------------------------------------------------------
104
105/// Store the password sealed for Subsonic token auth (see `auth::seal_password`).
106pub fn set_sealed_password(
107    conn: &Connection,
108    username: &str,
109    sealed: &[u8],
110) -> Result<(), rusqlite::Error> {
111    conn.execute(
112        "UPDATE users SET sealed_password = ?2 WHERE username = ?1",
113        params![username, sealed],
114    )?;
115    Ok(())
116}
117
118pub fn sealed_password(
119    conn: &Connection,
120    username: &str,
121) -> Result<Option<Vec<u8>>, rusqlite::Error> {
122    use rusqlite::OptionalExtension;
123    Ok(conn
124        .query_row(
125            "SELECT sealed_password FROM users WHERE username = ?1",
126            params![username],
127            |r| r.get::<_, Option<Vec<u8>>>(0),
128        )
129        .optional()?
130        .flatten())
131}
132
133/// Seal `password` under the server's key and store it, so the account can
134/// use Subsonic token auth. Call only with a password known to be the user's.
135pub fn remember_password(
136    conn: &Connection,
137    username: &str,
138    password: &str,
139) -> Result<(), Box<dyn std::error::Error>> {
140    let key = auth::subsonic_key()?;
141    set_sealed_password(
142        conn,
143        username,
144        &auth::seal_password(&key, username, password)?,
145    )?;
146    Ok(())
147}
148
149/// Create a new user. Returns the user ID.
150pub fn create_user(
151    conn: &Connection,
152    username: &str,
153    password: &str,
154    role: Role,
155) -> Result<i64, rusqlite::Error> {
156    let hash = auth::hash_password(password)
157        .map_err(|e| rusqlite::Error::ToSqlConversionFailure(e.into()))?;
158    conn.execute(
159        "INSERT INTO users (username, password_hash, role) VALUES (?1, ?2, ?3)",
160        params![username, hash, role.as_str()],
161    )?;
162    let id = conn.last_insert_rowid();
163    adopt_local_rows(conn)?;
164    Ok(id)
165}
166
167/// Get a user by username.
168pub fn get_user_by_username(
169    conn: &Connection,
170    username: &str,
171) -> Result<Option<UserRow>, rusqlite::Error> {
172    let mut stmt = conn.prepare(
173        "SELECT id, username, password_hash, role, created_at FROM users WHERE username = ?1",
174    )?;
175    let mut rows = stmt.query_map(params![username], |row| {
176        let role_str: String = row.get(3)?;
177        Ok(UserRow {
178            id: row.get(0)?,
179            username: row.get(1)?,
180            password_hash: row.get(2)?,
181            role: role_str.parse().unwrap_or(Role::Readonly),
182            created_at: row.get(4)?,
183        })
184    })?;
185    match rows.next() {
186        Some(Ok(user)) => Ok(Some(user)),
187        Some(Err(e)) => Err(e),
188        None => Ok(None),
189    }
190}
191
192/// Get a user by ID.
193pub fn get_user_by_id(conn: &Connection, user_id: i64) -> Result<Option<UserRow>, rusqlite::Error> {
194    let mut stmt = conn
195        .prepare("SELECT id, username, password_hash, role, created_at FROM users WHERE id = ?1")?;
196    let mut rows = stmt.query_map(params![user_id], |row| {
197        let role_str: String = row.get(3)?;
198        Ok(UserRow {
199            id: row.get(0)?,
200            username: row.get(1)?,
201            password_hash: row.get(2)?,
202            role: role_str.parse().unwrap_or(Role::Readonly),
203            created_at: row.get(4)?,
204        })
205    })?;
206    match rows.next() {
207        Some(Ok(user)) => Ok(Some(user)),
208        Some(Err(e)) => Err(e),
209        None => Ok(None),
210    }
211}
212
213/// List all users (no password hashes).
214pub fn list_users(conn: &Connection) -> Result<Vec<UserRow>, rusqlite::Error> {
215    let mut stmt = conn
216        .prepare("SELECT id, username, password_hash, role, created_at FROM users ORDER BY id")?;
217    let rows = stmt.query_map([], |row| {
218        let role_str: String = row.get(3)?;
219        Ok(UserRow {
220            id: row.get(0)?,
221            username: row.get(1)?,
222            password_hash: row.get(2)?,
223            role: role_str.parse().unwrap_or(Role::Readonly),
224            created_at: row.get(4)?,
225        })
226    })?;
227    rows.collect()
228}
229
230/// Delete a user by ID. Returns true if a row was deleted.
231pub fn delete_user(conn: &Connection, user_id: i64) -> Result<bool, rusqlite::Error> {
232    let count = conn.execute("DELETE FROM users WHERE id = ?1", params![user_id])?;
233    Ok(count > 0)
234}
235
236/// Update a user's password. Revokes all their refresh tokens.
237pub fn update_password(
238    conn: &Connection,
239    username: &str,
240    new_password: &str,
241) -> Result<bool, Box<dyn std::error::Error>> {
242    let hash = crate::auth::hash_password(new_password)?;
243    let updated = conn.execute(
244        "UPDATE users SET password_hash = ?1 WHERE username = ?2",
245        params![hash, username],
246    )?;
247    if updated > 0 {
248        // Revoke all existing tokens for this user.
249        if let Some(user) = get_user_by_username(conn, username)? {
250            revoke_all_user_tokens(conn, user.id)?;
251        }
252    }
253    Ok(updated > 0)
254}
255
256/// Update a user's role.
257pub fn update_role(
258    conn: &Connection,
259    username: &str,
260    role: crate::auth::Role,
261) -> Result<bool, rusqlite::Error> {
262    let updated = conn.execute(
263        "UPDATE users SET role = ?1 WHERE username = ?2",
264        params![role.as_str(), username],
265    )?;
266    adopt_local_rows(conn)?;
267    Ok(updated > 0)
268}
269
270/// Check if any users exist (for first-run detection).
271pub fn has_users(conn: &Connection) -> Result<bool, rusqlite::Error> {
272    let count: i64 = conn.query_row("SELECT COUNT(*) FROM users", [], |row| row.get(0))?;
273    Ok(count > 0)
274}
275
276/// Count users with admin role.
277pub fn admin_count(conn: &Connection) -> Result<i64, rusqlite::Error> {
278    conn.query_row(
279        "SELECT COUNT(*) FROM users WHERE role = 'admin'",
280        [],
281        |row| row.get(0),
282    )
283}
284
285// ---------------------------------------------------------------------------
286// Refresh tokens
287// ---------------------------------------------------------------------------
288
289/// Store a refresh token. Only `sha256(token)` is persisted — the raw token is
290/// a bearer credential and read access to the database must not yield one.
291pub fn store_refresh_token(
292    conn: &Connection,
293    token_id: &str,
294    user_id: i64,
295    expires_at: i64,
296) -> Result<(), rusqlite::Error> {
297    conn.execute(
298        "INSERT INTO refresh_tokens (id, user_id, expires_at) VALUES (?1, ?2, ?3)",
299        params![auth::sha256_hex(token_id), user_id, expires_at],
300    )?;
301    Ok(())
302}
303
304/// Look up a refresh token. Returns None if not found, expired, or revoked.
305pub fn get_valid_refresh_token(
306    conn: &Connection,
307    token_id: &str,
308) -> Result<Option<RefreshTokenRow>, rusqlite::Error> {
309    let now = auth::now_unix() as i64;
310    let mut stmt = conn.prepare(
311        "SELECT id, user_id, expires_at, revoked, created_at
312         FROM refresh_tokens
313         WHERE id = ?1 AND revoked = 0 AND expires_at > ?2",
314    )?;
315    let mut rows = stmt.query_map(params![auth::sha256_hex(token_id), now], |row| {
316        Ok(RefreshTokenRow {
317            id: row.get(0)?,
318            user_id: row.get(1)?,
319            expires_at: row.get(2)?,
320            revoked: row.get::<_, i32>(3)? != 0,
321            created_at: row.get(4)?,
322        })
323    })?;
324    match rows.next() {
325        Some(Ok(token)) => Ok(Some(token)),
326        Some(Err(e)) => Err(e),
327        None => Ok(None),
328    }
329}
330
331/// Atomically consume a valid refresh token: revoke it and return the row in one
332/// statement. Returns `None` if the token doesn't exist, is already revoked, or
333/// has expired. This prevents TOCTOU races in refresh-token rotation.
334pub fn consume_refresh_token(
335    conn: &Connection,
336    token_id: &str,
337) -> Result<Option<RefreshTokenRow>, rusqlite::Error> {
338    let now = auth::now_unix() as i64;
339    let mut stmt = conn.prepare(
340        "UPDATE refresh_tokens SET revoked = 1
341         WHERE id = ?1 AND revoked = 0 AND expires_at > ?2
342         RETURNING id, user_id, expires_at, revoked, created_at",
343    )?;
344    let mut rows = stmt.query_map(params![auth::sha256_hex(token_id), now], |row| {
345        Ok(RefreshTokenRow {
346            id: row.get(0)?,
347            user_id: row.get(1)?,
348            expires_at: row.get(2)?,
349            revoked: row.get::<_, i32>(3)? != 0,
350            created_at: row.get(4)?,
351        })
352    })?;
353    match rows.next() {
354        Some(Ok(token)) => Ok(Some(token)),
355        Some(Err(e)) => Err(e),
356        None => Ok(None),
357    }
358}
359
360/// Revoke a single refresh token (logout).
361pub fn revoke_refresh_token(conn: &Connection, token_id: &str) -> Result<bool, rusqlite::Error> {
362    let count = conn.execute(
363        "UPDATE refresh_tokens SET revoked = 1 WHERE id = ?1",
364        params![auth::sha256_hex(token_id)],
365    )?;
366    Ok(count > 0)
367}
368
369/// Revoke all refresh tokens for a user (password change, account delete).
370pub fn revoke_all_user_tokens(conn: &Connection, user_id: i64) -> Result<usize, rusqlite::Error> {
371    let count = conn.execute(
372        "UPDATE refresh_tokens SET revoked = 1 WHERE user_id = ?1 AND revoked = 0",
373        params![user_id],
374    )?;
375    Ok(count)
376}
377
378/// Clean up expired/revoked refresh tokens (housekeeping).
379pub fn cleanup_expired_tokens(conn: &Connection) -> Result<usize, rusqlite::Error> {
380    let now = auth::now_unix() as i64;
381    let count = conn.execute(
382        "DELETE FROM refresh_tokens WHERE revoked = 1 OR expires_at <= ?1",
383        params![now],
384    )?;
385    Ok(count)
386}
387
388// ---------------------------------------------------------------------------
389// Tests
390// ---------------------------------------------------------------------------
391
392#[cfg(test)]
393mod tests {
394    use super::*;
395    use crate::db::connection::Database;
396    use tempfile::TempDir;
397
398    fn test_db() -> (Database, TempDir) {
399        let tmp = TempDir::new().unwrap();
400        let db_path = tmp.path().join("test.db");
401        let db = Database::open(&db_path).unwrap();
402        (db, tmp)
403    }
404
405    #[test]
406    fn create_and_get_user() {
407        let (db, _tmp) = test_db();
408        let id = create_user(&db.conn, "alice", "password123", Role::Admin).unwrap();
409        assert!(id > 0);
410
411        let user = get_user_by_username(&db.conn, "alice").unwrap().unwrap();
412        assert_eq!(user.username, "alice");
413        assert_eq!(user.role, Role::Admin);
414        assert!(user.password_hash.starts_with("$argon2"));
415    }
416
417    #[test]
418    fn duplicate_username_rejected() {
419        let (db, _tmp) = test_db();
420        create_user(&db.conn, "bob", "pass1", Role::User).unwrap();
421        let result = create_user(&db.conn, "bob", "pass2", Role::User);
422        assert!(result.is_err());
423    }
424
425    #[test]
426    fn list_and_delete_users() {
427        let (db, _tmp) = test_db();
428        let id1 = create_user(&db.conn, "user1", "pass", Role::Admin).unwrap();
429        create_user(&db.conn, "user2", "pass", Role::User).unwrap();
430
431        let users = list_users(&db.conn).unwrap();
432        assert_eq!(users.len(), 2);
433
434        assert!(delete_user(&db.conn, id1).unwrap());
435        let users = list_users(&db.conn).unwrap();
436        assert_eq!(users.len(), 1);
437        assert_eq!(users[0].username, "user2");
438    }
439
440    #[test]
441    fn has_users_empty_and_populated() {
442        let (db, _tmp) = test_db();
443        assert!(!has_users(&db.conn).unwrap());
444        create_user(&db.conn, "first", "pass", Role::Admin).unwrap();
445        assert!(has_users(&db.conn).unwrap());
446    }
447
448    #[test]
449    fn refresh_token_lifecycle() {
450        let (db, _tmp) = test_db();
451        let uid = create_user(&db.conn, "user", "pass", Role::User).unwrap();
452
453        let future_ts = auth::now_unix() as i64 + 86400;
454        store_refresh_token(&db.conn, "tok-123", uid, future_ts).unwrap();
455
456        // Valid lookup.
457        let tok = get_valid_refresh_token(&db.conn, "tok-123")
458            .unwrap()
459            .unwrap();
460        assert_eq!(tok.user_id, uid);
461
462        // Revoke.
463        assert!(revoke_refresh_token(&db.conn, "tok-123").unwrap());
464        assert!(
465            get_valid_refresh_token(&db.conn, "tok-123")
466                .unwrap()
467                .is_none()
468        );
469    }
470
471    #[test]
472    fn expired_token_not_returned() {
473        let (db, _tmp) = test_db();
474        let uid = create_user(&db.conn, "user", "pass", Role::User).unwrap();
475
476        // Already expired.
477        store_refresh_token(&db.conn, "tok-old", uid, 0).unwrap();
478        assert!(
479            get_valid_refresh_token(&db.conn, "tok-old")
480                .unwrap()
481                .is_none()
482        );
483    }
484
485    #[test]
486    fn cleanup_removes_expired_and_revoked() {
487        let (db, _tmp) = test_db();
488        let uid = create_user(&db.conn, "user", "pass", Role::User).unwrap();
489
490        let future = auth::now_unix() as i64 + 86400;
491        store_refresh_token(&db.conn, "active", uid, future).unwrap();
492        store_refresh_token(&db.conn, "expired", uid, 0).unwrap();
493        store_refresh_token(&db.conn, "revoked", uid, future).unwrap();
494        revoke_refresh_token(&db.conn, "revoked").unwrap();
495
496        let cleaned = cleanup_expired_tokens(&db.conn).unwrap();
497        assert_eq!(cleaned, 2);
498
499        // Active token still there.
500        assert!(
501            get_valid_refresh_token(&db.conn, "active")
502                .unwrap()
503                .is_some()
504        );
505    }
506
507    // -- Per-user data ------------------------------------------------------
508
509    use crate::db::queries::{self, sample_meta, upsert_track};
510    use std::path::Path;
511
512    fn count(db: &Database, sql: &str) -> i64 {
513        db.conn.query_row(sql, [], |r| r.get(0)).unwrap()
514    }
515
516    #[test]
517    fn two_users_star_the_same_track_independently() {
518        let (db, _tmp) = test_db();
519        let admin = create_user(&db.conn, "owner", "pw", Role::Admin).unwrap();
520        let mate = create_user(&db.conn, "mate", "pw", Role::User).unwrap();
521        let path = Path::new("/music/a.flac");
522
523        queries::add_favourite(&db.conn, admin, path).unwrap();
524        queries::add_favourite(&db.conn, mate, path).unwrap();
525        queries::remove_favourite(&db.conn, admin, path).unwrap();
526
527        assert!(
528            queries::load_favourites(&db.conn, admin)
529                .unwrap()
530                .is_empty()
531        );
532        assert!(
533            queries::load_favourites(&db.conn, mate)
534                .unwrap()
535                .contains(path)
536        );
537        assert!(queries::toggle_favourite_album(&db.conn, mate, "Coil", "Scatology").unwrap());
538        assert!(queries::toggle_favourite_album(&db.conn, admin, "Coil", "Scatology").unwrap());
539        assert_eq!(count(&db, "SELECT COUNT(*) FROM favourite_albums"), 2);
540    }
541
542    #[test]
543    fn the_local_user_is_the_first_admin_once_there_is_one() {
544        let (db, _tmp) = test_db();
545        let path = Path::new("/music/a.flac");
546        let track = upsert_track(&db.conn, &sample_meta("T", "A", "B")).unwrap();
547        queries::add_favourite(&db.conn, LOCAL_USER, path).unwrap();
548        queries::record_play(&db.conn, LOCAL_USER, track, None).unwrap();
549        let list = queries::create_playlist(&db.conn, LOCAL_USER, "Mine", None).unwrap();
550        assert_eq!(resolve_user(&db.conn, LOCAL_USER).unwrap(), LOCAL_USER);
551
552        create_user(&db.conn, "mate", "pw", Role::User).unwrap();
553        assert_eq!(resolve_user(&db.conn, LOCAL_USER).unwrap(), LOCAL_USER);
554        let admin = create_user(&db.conn, "owner", "pw", Role::Admin).unwrap();
555
556        assert_eq!(resolve_user(&db.conn, LOCAL_USER).unwrap(), admin);
557        assert!(
558            queries::load_favourites(&db.conn, admin)
559                .unwrap()
560                .contains(path)
561        );
562        assert_eq!(queries::play_count(&db.conn, admin, track).unwrap(), 1);
563        assert_eq!(
564            queries::get_playlist(&db.conn, list)
565                .unwrap()
566                .unwrap()
567                .user_id,
568            admin
569        );
570        assert_eq!(
571            count(&db, "SELECT COUNT(*) FROM favourites WHERE user_id = 0"),
572            0
573        );
574    }
575
576    #[test]
577    fn playlists_are_the_owners_plus_everyones_public_ones() {
578        let (db, _tmp) = test_db();
579        let admin = create_user(&db.conn, "owner", "pw", Role::Admin).unwrap();
580        let mate = create_user(&db.conn, "mate", "pw", Role::User).unwrap();
581        let private = queries::create_playlist(&db.conn, admin, "Private", None).unwrap();
582        let public = queries::create_playlist(&db.conn, admin, "Public", None).unwrap();
583        db.conn
584            .execute("UPDATE playlists SET public = 1 WHERE id = ?1", [public])
585            .unwrap();
586        let own = queries::create_playlist(&db.conn, mate, "Mate's", None).unwrap();
587
588        let ids = |user| -> Vec<i64> {
589            let mut ids: Vec<i64> = queries::list_playlists(&db.conn, user)
590                .unwrap()
591                .into_iter()
592                .map(|p| p.id)
593                .collect();
594            ids.sort_unstable();
595            ids
596        };
597        assert_eq!(ids(mate), vec![public, own]);
598        assert_eq!(ids(admin), vec![private, public]);
599        // The implicit user is the first admin.
600        assert_eq!(ids(LOCAL_USER), vec![private, public]);
601
602        let row = queries::get_playlist(&db.conn, public).unwrap().unwrap();
603        assert!(row.readable_by(mate) && !row.editable_by(mate));
604        assert_eq!(row.owner.as_deref(), Some("owner"));
605        let row = queries::get_playlist(&db.conn, private).unwrap().unwrap();
606        assert!(!row.readable_by(mate));
607    }
608
609    #[test]
610    fn deleting_an_account_takes_its_data_with_it() {
611        let (db, _tmp) = test_db();
612        let admin = create_user(&db.conn, "owner", "pw", Role::Admin).unwrap();
613        let mate = create_user(&db.conn, "mate", "pw", Role::User).unwrap();
614        let track = upsert_track(&db.conn, &sample_meta("T", "A", "B")).unwrap();
615        for user in [admin, mate] {
616            queries::add_favourite(&db.conn, user, Path::new("/music/a.flac")).unwrap();
617            queries::set_favourite_album(&db.conn, user, "A", "B", true).unwrap();
618            queries::set_favourite_artist(&db.conn, user, "A", true).unwrap();
619            queries::record_play(&db.conn, user, track, None).unwrap();
620            queries::create_playlist(&db.conn, user, "List", None).unwrap();
621            queries::shares::create_share(
622                &db.conn,
623                user,
624                queries::shares::Slice::TRACKS,
625                &[track],
626                None,
627                0,
628                None,
629            )
630            .unwrap();
631        }
632
633        assert!(delete_user(&db.conn, mate).unwrap());
634
635        for table in [
636            "favourites",
637            "favourite_albums",
638            "favourite_artists",
639            "play_history",
640            "playlists",
641            "shares",
642        ] {
643            assert_eq!(
644                count(
645                    &db,
646                    &format!("SELECT COUNT(*) FROM {table} WHERE user_id = {mate}")
647                ),
648                0,
649                "{table} kept the deleted account's rows"
650            );
651            assert_eq!(
652                count(
653                    &db,
654                    &format!("SELECT COUNT(*) FROM {table} WHERE user_id = {admin}")
655                ),
656                1,
657                "{table} lost another account's rows"
658            );
659        }
660    }
661}
koan_core/db/queries/auth.rs

koan_core/db/queries/
auth.rs
