Help › Guide
Encrypted sync
Reqlyn 0.5.1 is not released yet. This help describes it ahead of release.
Your definitions (requests, folders, operations with their sources and cases, credentials' settings, environments, checks) can be kept the same on several computers. They are sealed with a workspace key that only your devices hold, and go through a Reqlyn server or a folder you synchronize yourself (OneDrive, Dropbox, a share). The server or folder holds ciphertext it cannot read. Secret values are never synchronized: each computer keeps its own in its secret store.
What exactly is and is not encrypted, and the cryptography, are in SYNC_SECURITY.md. The formats await an independent cryptographic review before real data is synchronized.
The workspace key
In Settings > General, "Workspace key":
- "Make the workspace key…" shows a recovery kit: 56 characters in fourteen groups of four. It is shown once. Write it down and keep it offline; Reqlyn keeps no copy.
- "I have saved it" makes the key from that kit. "Cancel" makes nothing.
The key is kept in this computer's secret store, never in Reqlyn's files. Settings then says "Workspace <id>, epoch N, made <date>. This device: <digest>."
From the command line: reqlyn workspace-key create, and reqlyn workspace-key for its state.
Through a server
With a server linked:
- The first computer: "Put it on the server" (
reqlyn remote workspace-key publish). The server holds public keys and ciphertext only. - Another computer: give the workspace id shown on a device that holds the key, and press "Join" (
reqlyn remote workspace-key join <workspace>). It shows, for each approved device, the twelve-digit code that device should show for it. - On an approved device: the waiting device is listed with its code. When the codes on both screens match, press "The codes match: approve" (
reqlyn remote workspace-key approve <device> --code <code>). - Back on the joining device: "The codes match: take the key" (
reqlyn remote workspace-key accept --code <code>). The approval's signature is checked before the key is opened.
Comparing the code is what makes this safe: a server cannot put its own device in between without the codes differing.
"Sync now" (reqlyn remote workspace-key sync) takes what other devices sent since the last time, then sends what changed here, each sealed: "Synchronized: N taken, M sent, sealed with the workspace key."
Through a folder
Under the Workspace key row, "Choose a folder…" picks a folder you synchronize yourself. The same steps follow: "Put the key in this folder", "Join it", the codes compared, "Sync now". While Reqlyn is open it synchronizes every 5 minutes. With no server to check signatures, each device checks every approval itself.
From the command line: reqlyn workspace-key folder <path> publish | join <workspace> | devices | approve <device> --code <code> | accept --code <code> | sync.
When both sides changed
A definition changed here and on another device since it was last synchronized is kept both ways and not sent. Settings lists it: "<kind> <name>: changed here and on another device", THIS COMPUTER beside THE OTHER DEVICE, with "Keep mine" (yours goes as the next revision) and "Take theirs" (theirs is saved here). From the command line: reqlyn workspace-key conflicts, keep <id>, take <id>.
History
With the key and a server linked, a saved request or operation shows "History": every synchronized revision the server keeps (the last fifty), newest first, each compared with the one before, and "Restore this" on earlier ones. A restored revision goes as the next revision at the next synchronizing. From the command line: reqlyn remote workspace-key history <name or id> and restore <name or id> <revision>.
Removing a device
On an approved device, "Remove…" beside another device, then "Remove it: re-key for the others". A new epoch's key goes to every device that stays and to the recovery kit; the removed device cannot open anything sealed after, and keeps what it already held. Its access to the server is a separate thing: revoke its token or membership too. reqlyn remote workspace-key revoke <device>, or reqlyn workspace-key folder <path> revoke <device>.
A device takes a new key only from a device it can trace, by signed approvals, to its own: a server or folder that lists a device is not believed for that alone.
When every device is lost
On a new computer: join as usual, then "Or, if every device was lost, recover with the recovery kit:" type the kit into the masked field and press "Recover with the kit". The kit is cleared at once and kept nowhere. From the command line, reqlyn remote workspace-key recover reads it from standard input, never from an argument. Then remove the lost devices.
What is not synchronized
Secret values, request history, run evidence, and deletions: Reqlyn deletes no request, operation or folder through sync, and a deleted environment or credential is not sent as deleted. A check's overrides and reviews stay on each device.
Help for Reqlyn 0.5.1. All help topics