Skip to content

Faraday 0.2.0

Pre-release
Pre-release

Choose a tag to compare

@bitcoinpasada bitcoinpasada released this 11 Nov 12:09
· 1089 commits to main since this release
1988ac1

Faraday 0.2.0, a pre-release. Faraday's initial feature set is complete, which is why the version goes to 0.2.0. One outside audit, AI-assisted, has read its code and was answered in 0.1.8; no person outside the project has reviewed its code, its cryptography or its builds, and no second builder has reproduced the builds. Use at your own risk.

A stick or card needs 256 MB or more. The layout is the one of 0.1.7 to 0.1.10: a 64 MiB boot partition and a data partition of at least 128 MiB. Faraday's boot file takes part of the stick's boot partition; the rest is room for later versions, and the data partition holds your files. A stick the Starter writes gets a data partition that fills the stick (a stick written with dd keeps the image's 128 MiB). A stick made with 0.1.6 to 0.1.10 keeps its files with the Starter's Replace Faraday, keep data. The vault is the KeePass (KDBX 4) file of 0.1.10. A stick made with a release before 0.1.6 has a 48 MB boot partition, and the Starter refuses it: copy its files off first, then write 0.2.0 whole. A Pi card is written whole.

Faraday Starter

  • Faraday-Starter-0.2.0-Windows.exe: Faraday Starter for Windows (x86-64). It is not code-signed: Windows shows "Windows protected your PC" the first time; check it against SHA256SUMS, then More info, Run anyway.
  • Faraday-Starter-0.2.0-Linux.tar.gz: Faraday Starter for Linux (x86-64), one file inside, Faraday-Starter-0.2.0-Linux. Ubuntu 20.04 and later, Debian 11 and later, Fedora 32 and later, Arch.

Faraday Starter makes a Faraday stick or a Raspberry Pi card and checks what it wrote, then shows how to start this computer from the stick, step by step for its maker, and how to set it back. It also moves files and text to and from the device by QR code and prints blank templates for copying seeds and Krux codes by hand. It carries no images: download the Starter and the image for your hardware (see Other downloads); the Starter looks for the images in the Downloads folder and in files dropped on its window, checks each against the image list built into it, and offers what it found. Hardware whose image it did not find is listed with the file to download. It downloads nothing itself. Open Faraday Demo on its Home runs Faraday Demo inside the Starter's own window, for trying Faraday on an online computer; Back returns to Home and ends the session. Faraday Demo opens in Practice; Testnet, Signet and Regtest are on its mode pill. It has no mainnet. Never type a seed that holds real bitcoin into it. Its sticks are folders in faraday-sticks in the home folder (BOOTSTICK is the boot stick, empty at first).

Other downloads

  • faraday-stick-0.2.0-x86_64-uefi.img.xz: the USB stick image for a PC (UEFI, x86-64). Its kernel's command line carries efi=disable_early_pci_dma.
  • faraday-pi-0.2.0.img.xz: the microSD card image for a Raspberry Pi 3B, 3B+ or Zero 2 W, one file for every screen. At start it looks for an HDMI monitor, and if none is connected for the Waveshare 2.8-inch DPI panel, and starts on what it finds. It takes USB keyboards, mice, touchscreens and USB sticks as well as the panel's touch. What has been tried on a Pi is below.
  • faraday-0.2.0-BOOTX64.EFI: the stick's boot program, EFI/BOOT/BOOTX64.EFI byte for byte, unsigned, for a person with their own Secure Boot keys to sign on Faraday with SHA256SUMS and SHA256SUMS.asc beside it (README, "With Secure Boot").
  • IMAGES: the release's image list, one line per image: its file, the SHA-256 of the .xz and of the .img inside it, the platform, screen, the boards it starts, the .img's size, its build ID and, for the stick, its boot partition's SHA-256. The Starters are built with it.
  • crosscheck-0.2.0.txt: the record of the fresh cross-check run at the release's commit (tools/crosscheck/README.md; see Checks before this release).
  • SHA256SUMS, SHA256SUMS.asc: the files' SHA-256 sums and the commit they were built from, with a detached signature. Each .img.xz is listed with the .img inside it, and the .tar.gz with the file inside it. Each image's boot partition is listed under the image's name with -boot.vfat, so a card or stick already in use can be checked (sudo sha256sum /dev/sdX1; README, "Verifying a release").

The release tag is no longer signed, and there is no .tag file: the signed SHA256SUMS names the release's commit on its first line, and git rev-parse v0.2.0^{commit} gives the commit to compare it with (README, "Verifying a release"). Tags up to v0.1.10 stay signed.

Sizes: the stick image 15.3 MB, the Pi image 15.6 MB, the boot file 15.4 MB, the Starter for Linux 9.0 MB and for Windows 16.1 MB.

The Pi image starts the Pi 3B, 3B+ and Zero 2 W: it carries the three boards' device trees and the firmware loads the board's own. It now runs Raspberry Pi's 6.18 kernel, with the kernel patches listed in docs/KERNEL-PATCHES.md. Development builds of it have been started on a Pi 3B+ with the 2.8-inch panel and with an HDMI monitor, and showed the app on both. Whether the HDMI signal loss seen in a 0.1.10 test still happens is not known. A USB mouse is not yet tried on a Pi, and nobody has started it on a 3B or Zero 2 W. The PC stick has been started on a PC and in QEMU. Reports from any of these are wanted. The Pi 4 and Pi 5 and macOS are not built for now.

Raspberry Pi Imager and balenaEtcher take an .img.xz as it is; other tools need it decompressed (xz -d on Linux, 7-Zip on Windows).

New since 0.1.10

New tools

  • Read a Bitcoin Core wallet (Tools, Wallets) reads a wallet.dat from Files, with its passphrase if it is encrypted, and says whether the wallet is whole: its network, the Bitcoin Core version that wrote it, its encryption, how many private keys were checked, its labels and transactions, and each descriptor as Core's listdescriptors lists it, with its origin, active mark and range. A record that fails is named with what failed. The private keys are checked and wiped, never shown, loaded or kept. Take adds the active descriptors to Wallets. A file that is not SQLite, is damaged, has a journal beside it or is not as Bitcoin Core writes it is refused with a plain message.
  • Check a timestamp (Tools, Messages) checks an OpenTimestamps proof: the proof and the file from Files (or the file's SHA-256 typed), and a block header typed, pasted, scanned or chosen from Files. The result names a path through SHA-256 or RIPEMD-160 that reaches the header, with the block hash, height and time, or says none does; paths through SHA-1 or Keccak-256, pending attestations and other chains' attestations are named and not counted. Practice has a sample. A Learn page, Timestamps, says what the check shows and what it does not.
  • Decode a Lightning invoice (Tools, Transactions) reads a BOLT #11 invoice or a BOLT #12 offer, typed, pasted or scanned, and shows its fields. Nothing is paid, signed or stored.
  • Compare two PSBTs (Tools, and Compare in Files' ⋮ menu) lists how two PSBTs or finished transactions differ, inputs by outpoint and outputs by script. Sign a transaction's review shows a Fee bump line for each other transaction in Files that spends the same inputs, and says "Only the fee is raised" where that is so.
  • Krux code (Tools) makes a Krux encrypted code (KEF) of a typed text or a loaded wallet's descriptor under a passphrase, with Check my code. A Krux code scanned, pasted or read from a picture opens with its passphrase, as a seed, a text, a note or hex. A seed's Krux code can also be an item of a backup, on a stick or on paper.
  • QR vault (Tools) seals a typed note, or a loaded key of 12 or 24 English words, as one QR code under a passphrase (an OpenPGP message that Sequoia's sq opens without Faraday), and opens one scanned or taken from Files. A seed, codex32 share, BIP-39 passphrase or note in an open vault has Save as a QR vault.
  • Vanity address grinds a BIP-352 silent payment code as well as the four address kinds, and Silent payments' Address card shows the address's BIP-353 DNS record.
  • Lightning node key gives Core Lightning's node key: from an hsm_secret in Files (plain, encrypted or in its words form), from a loaded BIP-39 key, or from typed English words.

Make a new wallet and backups

  • Make a new wallet asks who signs first: Kind offers Single key and Multisig, with the address types and MuSig2 under More kinds. A single key of any address type then has a Backup card, Words (BIP-39) or Shares (codex32), nothing ticked. New key for its slot makes the key in that form. A multisig cosigner's slot makes BIP-39 words only. The kind "Single key, backup in shares" is gone into this choice.
  • Make codex32 shares for a wallet's key asks the scheme on its own Scheme card. A codex32 set made on the device never takes an identifier another set on it carries.
  • Create offers BIP-87's multisig path (m/87'/coin'/account') beside BIP-48's, and a wallet at BIP-87 gives its own keys' ur:crypto-account code and signed BIP 129 key record.
  • Create refuses two slots that hold the same key, whatever their origins; the Descriptor checksum tool and Restore warn of a descriptor that repeats a key.
  • Back opens the step before in Make a new wallet, Back up a wallet, the backup flow, Compare two PSBTs and Check a signer, and Forward opens the step Back left.
  • A saved backup plan shows while one of its seeds is not loaded, the seed marked absent.

Vaults

  • Create a vault no longer asks a size: a vault starts small and grows at each seal. Before a vault is read, unlocked or sealed, the memory it needs is checked against what is free; a vault too large is listed with what it needs and is not read. The Lock sheet names a vault that could not be sealed for memory, and nothing is let go without a press.
  • A vault can be opened and made with a KeePass key file and a YubiKey's secret as well as its passphrase. Create a vault can make a key file or take one from Files, and an open vault's ⋮ menu adds or removes them.
  • An item in an open vault can be copied or moved to another vault: an open one, a locked one, or a new one made with it.
  • A seal reads back what it wrote before it gives the file. An attachment that nothing refers to any longer leaves the file at the next seal.
  • A vault KeeWeb saved opens.
  • A vault's passphrase, a KeePass export's and a BIP-39 passphrase typed for a key are entered twice, and the action waits until the two match.
  • Saving a second passphrase of one seed asks nothing; the Load sheet labels each passphrase by the key it makes.

Spending and signing

  • Nonce history (Settings, on by default): an open vault remembers each signature the nonce check found valid, and a signature whose key used the same nonce before on another message is refused, with no way past. Such a spend cannot be finished, saved or shown until it is closed.
  • Sign a message takes its text from a scan, and Home's Scan of a text offers Sign this message while a single-key wallet is loaded. A secret or any code that is not plain text is refused.
  • A large PSBT opens, merges and signs far sooner: at 3,200 inputs, opening a spend takes 0.6 s instead of 11.7 s and a Collect 1.1 s instead of 16.6 s. Collect, signing and opening a PSBT run off the main thread.
  • A cosigner's MuSig2 partial signature the device cannot confirm reads "In file, unconfirmed". A MuSig2 wallet two of whose keys come from one seed is refused when it is added.
  • A true Schnorr signature on a taproot leaf Faraday does not run no longer makes Collect refuse the file. A hash preimage on a script leaf reads as a preimage, not an unchecked signature.
  • Sign on the Sign card opens the first step not done instead of signing before it.
  • A file put in the Outbox no longer replaces a different file of its name: it goes beside it as name-2.

Keys and secrets

  • A GPG key's paperkey can be shown as one QR code, for moving the key to a vault on another machine. Tools' GPG key tile with no vault open offers Make a key and Restore from a paperkey.
  • Convert a seed's Check my copy scans a SeedQR or CompactSeedQR result back and compares it word by word.
  • A press that needs the system's randomness before it has arrived reads "Waiting for randomness" and goes on by itself when it arrives; after a minute with none, it says "The system gives no randomness".
  • Seed words of any BIP-39 list are found whether typed composed, decomposed or without accents.
  • A secret showing on a vault's item page hides when a device that can capture the screen arrives.

Screens and devices

  • A stick is shown in Files: its arrival opens Files on the stick's pane, and the rail and the bar keep five fixed destinations (Home, Wallets, Files, Vaults, Tools). The Stick visit tile is gone.
  • The PC stick converts a frame's changed rows in one pass over several threads: at 3200 × 1800 with every row changed a frame is written in 5.7 ms instead of 12.4 ms. A fade's blend is split across the cores, so fades keep their steps on large screens. Fades are timed apart from drawn frames, and one slow theme change no longer turns fades off.
  • The Pi sends its frame to the screen with no colour conversion, writes the screen on a thread of its own while the next frame is drawn, and waits for the screen's refresh. Long screens scroll by moving the rows already drawn on both the stick and the Pi.
  • On a Pi's HDMI screen the first start has fades off; a choice in Settings still wins.
  • The camera is asked for 1920 × 1080, then 1280 × 720 and 640 × 480 if no frame comes, so dense QR codes (version 23 at the highest error correction) read. A frame crafted to stall the QR search ends in bounded time with no read.
  • The Pi says "card or stick" where it said "SD card".
  • On the small panel, text and controls that shared a line no longer run into each other, chosen chips show whole, labels wrap instead of ending in "...", and Home scrolls to Lock and Power off in full. The mode pill stands on the top bar's second line, so a page's name keeps the first.
  • The list of USB devices plugged in at start has an X, and Escape from a trusted keyboard dismisses it.

Randomness at start

  • The Pi credits neither its hardware generator nor the firmware's seed; both are still mixed in. Measured on a development Pi, the app's first read of /dev/random waited 7.65 s and returned 11.52 s after the kernel started. On a PC, the stick's first read returned 4.03 s after the kernel started, after waiting 240 ms. docs/OWN-RANDOMNESS.md §3.4 has both.

Faraday Starter and Faraday Demo

  • Transfer has a Send text card: text typed or pasted is shown as codes for the device's camera, except a secret, which is refused by name (seed words in any form, keys, otpauth URIs, bare hex of a seed's length and more). Text over 16 KiB is refused.
  • The Starter's and Faraday Demo's windows carry their app's name and icon, on Linux (Wayland and X11) and on Windows.
  • Blank templates has a Krux code form, one sheet per size (25 × 25 to 37 × 37).
  • The mouse's forward button opens again the page Back left.
  • In a virtual machine, the Written screen greys Start this computer from the stick, as Home does. Which stick? adds the serial to rows that would read the same, such as two identical sticks.
  • In Faraday Demo, every passphrase prompt says "In Practice, the sample passphrase is faraday" as soon as it opens.

Fixes

  • A keyboard or mouse unplugged and plugged back within two seconds is read again; before, a machine with only a mouse needed a restart.
  • A Pi with the 2.8-inch panel no longer panics about 13 s after power-on.
  • A KeePass export, or a seal made at a lock, no longer replaces a file of the same name waiting in the Outbox.
  • An idle lock that sealed a vault at its old memory step, for lack of memory, says so on the next Locked sheet.
  • Faraday reads a descriptor's creation time in a Core wallet as the unsigned number Bitcoin Core writes; a time with its top bit set was listed negative.
  • A vault's last-sealed time is read only when it names a real moment.
  • On the Pi the screen's device nodes are root's alone, as intended; before, they fell to the default rule.

User guide and Learn

  • docs/GUIDE.md covers the new tools, the vault's key files, Copy and Move, Make a new wallet's Backup card and the stick in Files, with pictures drawn again from the current app. Learn has pages on timestamps, Lightning invoices, Krux codes, the QR vault and the nonce history.

Removed

  • The kind "Single key, backup in shares", replaced by the Backup card; Make SLIP-39 shares in a cosigner's slot; "None, the secret alone" as a codex32 scheme for a wallet's key.
  • The vault size choice in Create a vault.
  • Home's Stick visit tile and the Pi's Card or stick button: a stick opens in Files.
  • The release tag's signature and the .tag files.

Cross-check, tests and builds

  • The cross-check judges more with programs Faraday did not write: a Core wallet.dat against Bitcoin Core's own reading, OpenTimestamps proofs against python-opentimestamps, Krux codes against Krux's own code, the QR vault against Sequoia's sq, rPGP and PyCA, SQLite files, BOLT 12 offers against Core Lightning, Decode's transaction ids and addresses against Bitcoin Core, and taproot final inputs against btclib's script engine. Areas added: core_wallet, kef, ots, qrvault and sqlite (37 areas; 0.1.10 had 32).
  • A release's cross-check may be made of runs at one fresh seed and scale, taking the areas whose inputs did not change from an earlier full run (just crosscheck --combine).
  • Named costly operations (a 24-word mnemonic's parse and seed, a Seed XOR combine, a PSBT's read and sign) are held by an instruction count in the check (just lint-op-cost).
  • Fuzzing: 73 targets (0.1.10 had 64). The fuzz README lists every target, and a lint fails on one missing.
  • docs/KERNEL-PATCHES.md lists every kernel patch the images carry, with what it does, why, its security trade-off and when it can go.
  • The check on GitHub caches compiled dependencies (never Faraday's own crates); a release commit's check runs uncached.

Downloads

Every file of the release:

  • crosscheck-0.2.0.txt
  • faraday-0.2.0-BOOTX64.EFI
  • faraday-pi-0.2.0.img.xz
  • Faraday-Starter-0.2.0-Linux.tar.gz
  • Faraday-Starter-0.2.0-Windows.exe
  • faraday-stick-0.2.0-x86_64-uefi.img.xz
  • IMAGES
  • SHA256SUMS
  • SHA256SUMS.asc: the signature

Checks before this release

  • just crosscheck --fresh on the release's tree (commit d05df0ed; the run's record names tree 3e36bd2f8edf77e486b482488fc116bc7d26c811, the release's tree without docs/crypto/actions.toml and actions.lock, whose fingerprints are stamped from the run's result), seed 5be11ec606a76d2767f225b8992c45fe, ten times the random cases, 37 areas (listed in tools/crosscheck/README.md): every answer agreed, 4,473,115 answers over 592,300 cases, 63,267 of them known differences, in 1,828.0 s. Its record is crosscheck-0.2.0.txt, signed with the release.
  • Earlier runs found one difference that was Faraday's: a Core wallet descriptor's creation time with its top bit set was read as a signed number (see Fixes). The others were in the cross-check's own judges.
  • The fuzz run on GitHub's runners (.github/workflows/fuzz.yml), 73 targets, 600 s each:
Fuzz run before a release
Date: 2026-11-11
Commit: 1988ac1e with the version bump
Toolchain: rustc 1.101.0-nightly (e9bbadf68 2026-10-12)
cargo-fuzz: 0.13.2
Starting corpus: faraday-fuzz-corpus, commit d3f07ceb
Time per target: 600 s

target            seconds   executions    corpus        bytes  result
address               601     24968108       533        69962  no crashes
aezeed                602    117845528        20          262  no crashes
app_scanned           601        10610      2020       585682  no crashes
bip39_words           601       659533       958       450155  no crashes
bolt11                601     50870081       290        12357  no crashes
bolt12                602     25035668       815        64960  no crashes
bsms                  601     16756103      2995       873545  no crashes
classify              601      2146379      3391       526116  no crashes
classify_file         601       529164      6534      8660515  no crashes
contents              601      4418190      9374      1847011  no crashes
core_text             601       560167       757       214154  no crashes
core_wallet_records      602        11297       396      2604925  no crashes
decode_luma           601        28808       646       985072  no crashes
decode_tx             601      6947418       611       415756  no crashes
edid                  601     49182167       152        50001  no crashes
encodings             601      9750676       324        20303  no crashes
fat                   601    149439876        19         9217  no crashes
files_proto           601       154508       673       147247  no crashes
gpt                   602      1980257      1064      5166602  no crashes
hex_decode            601     64557509        41        16092  no crashes
hid_ranges            602     53423554       553       224033  no crashes
image_list            601     72796098       448       191665  no crashes
inbox_found           601        13270      1678      1347211  no crashes
json                  602      5375870      3808      5444577  no crashes
kdbx_body             601       133920       498        76400  no crashes
kdbx_file             601       148328       569       167645  no crashes
kdbx_xml              601      4061261      4524      2253098  no crashes
kef                   601     12263397      1323       168561  no crashes
key_file              601      3042326      3791      2421422  no crashes
keyfile               601     22366004      1425       190142  no crashes
master_key            601     97287575        53          857  no crashes
memory_kept           601        13886       378         9015  no crashes
message_verify        602      4605083       539       134913  no crashes
multisig_config       601      6291173      1187       935575  no crashes
musig                 601     15557670      1796       934462  no crashes
ots                   601      6584828       498       263069  no crashes
pe_image              601       216190       791      1122431  no crashes
pe_transplant         601      4407912      1728      4280070  no crashes
pgp_armor             602       540260       617       153149  no crashes
pgp_message           602    109330958       211       134694  no crashes
pgp_paperkey          601     16428708       480       123518  no crashes
pgp_qr_vault          601       109867       158        24200  no crashes
pgp_restore           601       440855       546       194980  no crashes
pgp_secret            601       211389       419        75393  no crashes
pgp_verify            601      1444261       475       124089  no crashes
plist                 602     25925207      2041       715440  no crashes
png_qr                601       556872      1232       305513  no crashes
policy                601      9441178      3943      2150474  no crashes
psbt_parse            601      4159981      2360      1516296  no crashes
psbt_v2               601      7322044      1343       999339  no crashes
qr_assembler          601      1199582      4327      9664705  no crashes
qr_specter            601    129860223        97         5697  no crashes
raw_hex               602    219501993        20          383  no crashes
read_wallet           601      2707346      7015      5841741  no crashes
recovery_key          601    183523961       146         6623  no crashes
release_sums          601       752673       489       152973  no crashes
seed_parts            601       269711       503       327609  no crashes
seedqr                601    143146309        16          704  no crashes
signer_check          602       410730      2675      5838535  no crashes
silent                601     48488033       724       143657  no crashes
sqlite                601      3788000       381      6950362  no crashes
starter_udisks        602      5691512      3065      1753285  no crashes
starter_windows       602      6565765      2719       983926  no crashes
storage_read_parts      602        10999        45          360  no crashes
transaction           601      3519679      1296       692215  no crashes
ur_receive            602     16518259      1455      1177594  no crashes
ur_registry           601      5461850      1630       298186  no crashes
ur_single             601     81293751       164        66550  no crashes
v4l2_luma             601    174634053       102        30921  no crashes
vault_entries         601      1346422      3679      5912992  no crashes
vault_header          601     71527393       416       130100  no crashes
vault_parts           602     22887889        25        37675  no crashes
xkey                  601     28583931        42          905  no crashes

Result: 73 targets, no crashes

The corpora the run grew, minimized, are at https://github.com/bitcoinpasada/faraday-fuzz-corpus, tag v0.2.0.