Merge concurrent saves on the server, with vaults created from the web

Why: the point of a sync server is that two people can work at once. Picking
a winner was all this one could do while it could not read a vault.

What, end to end:
- A vault is created at /web or with `keeporg vault -create`: the server
  builds an empty KDBX 4 file, encrypts it with the password from the form,
  and stores it as version 1. An existing database can adopt a stored key
  with `keeporg db -id <id> -store-password`, which is verified against the
  stored file before it is accepted.
- A stale push to a `merge` vault is no longer refused. The server opens the
  stored version and the pushed one in memory, folds them together, and
  stores the re-encrypted result. Clients push as usual and pull what comes
  back. Any failure answers 409 merge_failed and the client keeps its copy
  aside, so a failed merge still loses nothing.
- At rest: vault contents stay KDBX-encrypted as always. A merge vault's
  password is kept AES-256-GCM-wrapped under a master key that lives outside
  the data directory, bound to the vault id, never returned by the API. A
  stolen data directory is ciphertext; a stolen data directory plus the
  master key is not. The server runs without a master key and simply refuses
  to create or merge vaults.

This moves the server inside the trust boundary for vaults it can merge,
which is inherent to merging and is stated plainly in the README, the
handover notes and the web form itself. Key-less strategies are unchanged and
remain the default for a database created without a password.

Proved: two clients editing the same version are merged rather than refused,
the newer edit of one entry wins, a merge failure leaves the stored vault
untouched, `merge` is refused without a stored key, the wrapped key never
appears in state.json or the API, and the web interface rejects a form
without its CSRF token, withholds its cookie over plain http, and only offers
groups the user administers. Checked by hand against the real thing: a vault
created in a browser, edited by keepassxc-cli on two sides from the same
version, merged by the server, and both entries read back out with
keepassxc-cli. make check, make test-race, android lint and both .deb builds
are clean.
This commit is contained in:
2026-10-29 17:34:47 +01:00
parent 4d2f0b047b
commit a9308a3e89
33 changed files with 2168 additions and 88 deletions
@@ -41,7 +41,14 @@ data class DeviceStart(
val expiresIn: Int,
)
data class PushResult(val version: Long, val sha256: String, val unchanged: Boolean)
data class PushResult(
val version: Long,
val sha256: String,
val unchanged: Boolean,
/** Set when the server folded this push into another edit. */
val merged: Boolean = false,
val mergeSummary: String = "",
)
/**
* The KeepOrg HTTP API over the platform's own HTTP client. The server
@@ -131,7 +138,13 @@ class Api(baseUrl: String, var token: String?) {
val status = c.responseCode
if (status != 200) throw errorOf(c, status)
val o = JSONObject(c.inputStream.use { it.readAllBytesCompat() }.decodeToString())
return PushResult(o.getLong("version"), o.optString("sha256"), o.optBoolean("unchanged"))
return PushResult(
o.getLong("version"),
o.optString("sha256"),
o.optBoolean("unchanged"),
o.optBoolean("merged"),
o.optString("merge_summary"),
)
} finally {
c.disconnect()
}
@@ -20,7 +20,7 @@ import java.util.Locale
*/
class Mirror(private val context: Context, private val api: Api, private val prefs: Prefs) {
enum class Action { NOTHING, PULL, PUSH, FORCE_PUSH, SERVER_WINS, RESTORE, MANUAL }
enum class Action { NOTHING, PULL, PUSH, PUSH_FOR_MERGE, FORCE_PUSH, SERVER_WINS, RESTORE, MANUAL }
/** The mirror directory, private to the app. */
val dir: File = File(context.filesDir, "databases").apply { mkdirs() }
@@ -79,7 +79,7 @@ class Mirror(private val context: Context, private val api: Api, private val pre
Action.PULL -> pull(db, st, file)
Action.PUSH -> push(db, st, file, local, force = false)
Action.PUSH, Action.PUSH_FOR_MERGE -> push(db, st, file, local, force = false)
Action.FORCE_PUSH -> push(db, st, file, local, force = true)
@@ -118,6 +118,16 @@ class Mirror(private val context: Context, private val api: Api, private val pre
val res = api.push(db.id, st.version, data, force)
st.version = res.version
st.sha256 = res.sha256
if (res.merged) {
// The result is neither copy: take what the server holds.
pull(db, st, file)
prefs.putStatus(db.id, "merged: ${res.mergeSummary}")
return
}
if (res.sha256 != digest(data)) {
pull(db, st, file)
return
}
prefs.putStatus(db.id, if (res.unchanged) "in sync" else "pushed version ${res.version}")
} catch (e: ApiException) {
when {
@@ -210,6 +220,9 @@ class Mirror(private val context: Context, private val api: Api, private val pre
!localChanged && remoteChanged -> Action.PULL
localChanged && remoteChanged -> when {
!canWrite -> Action.RESTORE
// The server holds this vault's key and merges both
// copies, so send ours and take what comes back.
strategy == "merge" -> Action.PUSH_FOR_MERGE
strategy == "client-wins" -> Action.FORCE_PUSH
strategy == "manual" -> if (conflictSeen) Action.NOTHING else Action.MANUAL
else -> Action.SERVER_WINS
@@ -16,12 +16,15 @@ Description: |-
Keepass2Android opens them as ordinary files.
Each save is pushed to the server, and changes other people push are applied
here. When two people save at once, the database's merge strategy decides
the outcome; the losing copy is always kept beside the file so nothing is
here. When two people save at once, a merge vault has both edits folded
together by the server; on any other setting the database's conflict
strategy decides, and the losing copy is kept beside the file so nothing is
lost silently.
The app never opens a database and never sees a master password. It moves
encrypted bytes and nothing else.
The app itself never opens a database and never sees a master password. It
moves encrypted bytes and nothing else. Note that merging requires the
server to hold that vault's key, which is a choice made per vault when it
is created.
Sign in with a password and the server's built-in time-based second factor,
or approve the device in a browser, which is also how single sign-on works.
@@ -38,7 +41,15 @@ Builds:
- yes
output: android/app/build/outputs/apk/release/app-release-unsigned.apk
- versionName: 0.2.0
versionCode: 2
commit: v0.2.0-android
subdir: android/app
gradle:
- yes
output: android/app/build/outputs/apk/release/app-release-unsigned.apk
AutoUpdateMode: None
UpdateCheckMode: Tags
CurrentVersion: 0.1.0
CurrentVersionCode: 1
CurrentVersion: 0.2.0
CurrentVersionCode: 2