Skip to content

Wallos: Open-source, self-hostable personal subscription tracker. Visualize your recurring expenses, manage your budget, and save money.

fix(auth): do not report 2FA as enabled when the enrolment did not complete (#1194)

thorstenhornung189c97df8b5bc
diff --git a/endpoints/user/enable_totp.php b/endpoints/user/enable_totp.php
index d8487c3..06c295e 100644
--- a/endpoints/user/enable_totp.php
+++ b/endpoints/user/enable_totp.php
@@ -94,26 +94,67 @@ if ($action === 'verify') {
$backupCodes[] = $backupCode;
}
- // Remove old TOTP data
- $stmt = $db->prepare("DELETE FROM totp WHERE user_id = :user_id");
- $stmt->bindValue(':user_id', $userId, SQLITE3_INTEGER);
- $stmt->execute();
-
- $stmt = $db->prepare("INSERT INTO totp (user_id, totp_secret, backup_codes, last_totp_used) VALUES (:user_id, :totp_secret, :backup_codes, :last_totp_used)");
- $stmt->bindValue(':user_id', $userId, SQLITE3_INTEGER);
- $stmt->bindValue(':totp_secret', $secret, SQLITE3_TEXT);
- $stmt->bindValue(':backup_codes', json_encode($backupCodes), SQLITE3_TEXT);
- // Store the current TOTP time-step (not a raw timestamp): the code
- // just verified above counts as used, so it cannot be replayed as the
- // first login code. totp.php compares against this same step counter.
- $stmt->bindValue(':last_totp_used', intdiv(time(), 30), SQLITE3_INTEGER);
- $stmt->execute();
+ // The enrolment row and the flag on the account have to agree, so
+ // the three writes are one unit of work and each result is read.
+ //
+ // The state to avoid is totp_enabled = 1 with no row in totp: an
+ // account in it cannot be logged into by any credential at all.
+ // login.php sends the person to totp.php, which then has no secret
+ // and no backup codes to check against, so neither an authenticator
+ // code nor any of the ten backup codes they have just been shown
+ // will ever work again. Before this, all three writes were
+ // discarded and success was reported unconditionally, so that
+ // account was told 2FA was on and given the codes to prove it.
+ $enrolled = $db->exec('BEGIN') !== false;
+
+ if ($enrolled) {
+ $stmt = $db->prepare("DELETE FROM totp WHERE user_id = :user_id");
+ $enrolled = $stmt !== false;
+
+ if ($enrolled) {
+ $stmt->bindValue(':user_id', $userId, SQLITE3_INTEGER);
+ $enrolled = $stmt->execute() !== false;
+ }
+ }
+
+ if ($enrolled) {
+ $stmt = $db->prepare("INSERT INTO totp (user_id, totp_secret, backup_codes, last_totp_used) VALUES (:user_id, :totp_secret, :backup_codes, :last_totp_used)");
+ $enrolled = $stmt !== false;
+
+ if ($enrolled) {
+ $stmt->bindValue(':user_id', $userId, SQLITE3_INTEGER);
+ $stmt->bindValue(':totp_secret', $secret, SQLITE3_TEXT);
+ $stmt->bindValue(':backup_codes', json_encode($backupCodes), SQLITE3_TEXT);
+ // Store the current TOTP time-step (not a raw timestamp): the code
+ // just verified above counts as used, so it cannot be replayed as the
+ // first login code. totp.php compares against this same step counter.
+ $stmt->bindValue(':last_totp_used', intdiv(time(), 30), SQLITE3_INTEGER);
+ $enrolled = $stmt->execute() !== false;
+ }
+ }
// Update user totp_enabled
+ if ($enrolled) {
+ $stmt = $db->prepare("UPDATE user SET totp_enabled = 1 WHERE id = :user_id");
+ $enrolled = $stmt !== false;
+
+ if ($enrolled) {
+ $stmt->bindValue(':user_id', $userId, SQLITE3_INTEGER);
+ $enrolled = $stmt->execute() !== false;
+ }
+ }
- $stmt = $db->prepare("UPDATE user SET totp_enabled = 1 WHERE id = :user_id");
- $stmt->bindValue(':user_id', $userId, SQLITE3_INTEGER);
- $stmt->execute();
+ if (!$enrolled || $db->exec('COMMIT') === false) {
+ $db->exec('ROLLBACK');
+
+ error_log('Wallos: could not enable 2FA for user ' . (int) $userId
+ . ', nothing was changed: ' . $db->lastErrorMsg());
+
+ die(json_encode([
+ "success" => false,
+ "message" => translate('error', $i18n)
+ ]));
+ }
die(json_encode([
"success" => true,
diff --git a/tests/cases/totp_enrolment_test.php b/tests/cases/totp_enrolment_test.php
new file mode 100644
index 0000000..b6a942e
--- /dev/null
+++ b/tests/cases/totp_enrolment_test.php
@@ -0,0 +1,94 @@
+<?php
+/*
+ Enabling 2FA is one unit of work, or it is nothing.
+
+ The state this exists to prevent is `user.totp_enabled = 1` with no row in
+ `totp`. An account in it cannot be logged into by any credential: login.php
+ sends the person to totp.php, which then has no secret and no backup codes to
+ check against. Neither an authenticator code nor any of the ten backup codes
+ they were just shown will ever work.
+
+ Before the fix all three writes were discarded and `success: true` was
+ reported unconditionally, so the account that had just been locked out was
+ told 2FA was on and handed the codes to prove it.
+*/
+
+/**
+ * The enrolment endpoint's source.
+ *
+ * @return string
+ */
+function totp_enrolment_source()
+{
+ return file_get_contents(WALLOS_ROOT . '/endpoints/user/enable_totp.php');
+}
+
+wallos_test('the enrolment writes are one transaction', function () {
+ $source = totp_enrolment_source();
+
+ assert_contains("'BEGIN'", $source, 'the enrolment opens a transaction');
+ assert_contains("'COMMIT'", $source, 'and commits it');
+ assert_contains("'ROLLBACK'", $source, 'and rolls back when a write fails');
+});
+
+wallos_test('no write in the enrolment is discarded', function () {
+ // The defect was not a missing transaction alone. Each of the three writes
+ // returned a result nobody read, so a transaction that was never told to
+ // roll back would have committed the broken state just as happily.
+ $source = totp_enrolment_source();
+ $lines = preg_split('/\R/', $source);
+ $discarded = [];
+
+ foreach ($lines as $number => $line) {
+ // A result is used when it is assigned, compared or returned. A
+ // statement on a line of its own is a result thrown away.
+ if (preg_match('/^\s*\$stmt->execute\(\)\s*;\s*$/', $line) === 1) {
+ $discarded[] = $number + 1;
+ }
+ }
+
+ assert_same([], $discarded,
+ 'every execute() in enable_totp.php is read (lines with a discarded one: '
+ . implode(', ', $discarded) . ')');
+});
+
+wallos_test('a rolled back enrolment leaves the account exactly as it was', function () {
+ // The guarantee the fix rests on, checked against the real schema rather
+ // than assumed: the rollback has to cover both tables, or the account is
+ // left in the state above.
+ $db = wallos_test_open_database();
+ wallos_test_create_user($db, 1, 'alice');
+
+ $db->exec('BEGIN');
+
+ $stmt = $db->prepare('DELETE FROM totp WHERE user_id = :userId');
+ $stmt->bindValue(':userId', 1, SQLITE3_INTEGER);
+ $stmt->execute();
+
+ $stmt = $db->prepare('INSERT INTO totp (user_id, totp_secret, backup_codes, last_totp_used)
+ VALUES (:userId, :secret, :codes, :step)');
+ $stmt->bindValue(':userId', 1, SQLITE3_INTEGER);
+ $stmt->bindValue(':secret', 'SECRET', SQLITE3_TEXT);
+ $stmt->bindValue(':codes', json_encode(['a', 'b']), SQLITE3_TEXT);
+ $stmt->bindValue(':step', intdiv(time(), 30), SQLITE3_INTEGER);
+ $stmt->execute();
+
+ $stmt = $db->prepare('UPDATE user SET totp_enabled = 1 WHERE id = :userId');
+ $stmt->bindValue(':userId', 1, SQLITE3_INTEGER);
+ $stmt->execute();
+
+ // Both halves are in place inside the transaction.
+ assert_same(1, (int) $db->querySingle('SELECT COUNT(*) FROM totp WHERE user_id = 1'),
+ 'the enrolment row exists before the rollback');
+ assert_same(1, (int) $db->querySingle('SELECT totp_enabled FROM user WHERE id = 1'),
+ 'and so does the flag');
+
+ $db->exec('ROLLBACK');
+
+ assert_same(0, (int) $db->querySingle('SELECT COUNT(*) FROM totp WHERE user_id = 1'),
+ 'the enrolment row is gone again');
+ assert_same(0, (int) $db->querySingle('SELECT totp_enabled FROM user WHERE id = 1'),
+ 'and the flag with it, neither half survives alone');
+
+ $db->close();
+});