Compare commits
5 Commits
8f908ce5b2
...
982d881de9
| Author | SHA1 | Date | |
|---|---|---|---|
| 982d881de9 | |||
| fb9e8f5542 | |||
| 3e5d6323ce | |||
| 12acf4dc8c | |||
| f455b0ae7f |
96
README.md
96
README.md
@@ -123,12 +123,17 @@ unavailable). The suite lives in `tests/e2e/` and is driven by
|
|||||||
`playwright-core`, whose version must stay matched to the container's Playwright
|
`playwright-core`, whose version must stay matched to the container's Playwright
|
||||||
version — the browsers ship inside the image.
|
version — the browsers ship inside the image.
|
||||||
|
|
||||||
It covers popup load, wallet creation through the UI, the Add Token screen and
|
It covers popup load, WebAssembly compilation under the shipped CSP (see
|
||||||
the transaction detail screen for an ERC-20 transfer. All outbound network is
|
[Content Security Policy](#content-security-policy)), wallet creation through
|
||||||
intercepted at the browser level and served from fixtures in
|
the UI, the Add Token screen, the transaction detail screen for an ERC-20
|
||||||
`tests/e2e/network.js`, so the run is deterministic and fully offline;
|
transfer, and the recovery phrase screen — which wallet types are offered it,
|
||||||
unrecognised outbound requests are reported as failures rather than silently
|
that it holds nothing before the password is accepted, that a wrong password
|
||||||
allowed.
|
reveals nothing, that leaving it by either route wipes it — including a leave
|
||||||
|
taken while the decrypt is still running — and that reopening the popup does not
|
||||||
|
land on it. All outbound network is intercepted at the browser level and served
|
||||||
|
from fixtures in `tests/e2e/network.js`, so the run is deterministic and fully
|
||||||
|
offline; unrecognised outbound requests are reported as failures rather than
|
||||||
|
silently allowed.
|
||||||
|
|
||||||
That reporting has one bound worth knowing. Observation ends when the browser
|
That reporting has one bound worth knowing. Observation ends when the browser
|
||||||
context is torn down, and nothing can watch traffic after that, so the run keeps
|
context is torn down, and nothing can watch traffic after that, so the run keeps
|
||||||
@@ -406,8 +411,11 @@ runtime debug mode is on, or when the active network is a testnet. They are not
|
|||||||
repeated in the element lists below.
|
repeated in the element lists below.
|
||||||
|
|
||||||
Closing and reopening the popup returns to the screen the user was last on only
|
Closing and reopening the popup returns to the screen the user was last on only
|
||||||
for the views listed in `RESTORABLE_VIEWS` (`src/popup/index.js`). Every other
|
for the views listed in `RESTORABLE_VIEWS` (`src/popup/restorableViews.js`).
|
||||||
screen, including ExportPrivKey, falls back to Home.
|
Every other screen falls back to Home. The screens that display a secret —
|
||||||
|
ExportPrivKey and ShowRecoveryPhrase — are deliberately absent from that list,
|
||||||
|
so the popup can never reopen onto one of them with no password prompt in front
|
||||||
|
of it.
|
||||||
|
|
||||||
#### Welcome (`welcome`)
|
#### Welcome (`welcome`)
|
||||||
|
|
||||||
@@ -707,8 +715,9 @@ screen, including ExportPrivKey, falls back to Home.
|
|||||||
- **When**: User tapped the Settings gear.
|
- **When**: User tapped the Settings gear.
|
||||||
- **Elements**:
|
- **Elements**:
|
||||||
- "Back" button, "Settings" heading
|
- "Back" button, "Settings" heading
|
||||||
- Wallets: one row per wallet with its name (tap to rename inline) and an
|
- Wallets: one row per wallet with its name (tap to rename inline), a
|
||||||
`[x]` delete button, plus a "+ Add wallet" button
|
`[recovery phrase]` button on HD wallets only, and an `[x]` delete button,
|
||||||
|
plus a "+ Add wallet" button
|
||||||
- Tracked Tokens: one row per tracked token with an `[x]` remove button,
|
- Tracked Tokens: one row per tracked token with an `[x]` remove button,
|
||||||
plus a "+ Add token" button
|
plus a "+ Add token" button
|
||||||
- Display: "Show tracked tokens with zero balance" checkbox and a Theme
|
- Display: "Show tracked tokens with zero balance" checkbox and a Theme
|
||||||
@@ -733,6 +742,7 @@ screen, including ExportPrivKey, falls back to Home.
|
|||||||
- **Transitions**:
|
- **Transitions**:
|
||||||
- "+ Add wallet" → **AddWallet**
|
- "+ Add wallet" → **AddWallet**
|
||||||
- "+ Add token" → **SettingsAddToken**
|
- "+ Add token" → **SettingsAddToken**
|
||||||
|
- `[recovery phrase]` on an HD wallet → **ShowRecoveryPhrase**
|
||||||
- `[x]` on a wallet → **DeleteWallet**
|
- `[x]` on a wallet → **DeleteWallet**
|
||||||
- Tap wallet name → inline rename field (no screen change)
|
- Tap wallet name → inline rename field (no screen change)
|
||||||
- `[x]` on a tracked token or a site → removes it in place (no screen
|
- `[x]` on a tracked token or a site → removes it in place (no screen
|
||||||
@@ -740,6 +750,33 @@ screen, including ExportPrivKey, falls back to Home.
|
|||||||
- Ten clicks on the version → reveals the Debug well (no screen change)
|
- Ten clicks on the version → reveals the Debug well (no screen change)
|
||||||
- "Back" (or Settings gear again) → previous screen (Home)
|
- "Back" (or Settings gear again) → previous screen (Home)
|
||||||
|
|
||||||
|
#### ShowRecoveryPhrase (`show-phrase`)
|
||||||
|
|
||||||
|
- **When**: User tapped `[recovery phrase]` on a wallet row in Settings. HD
|
||||||
|
wallets only: key and xprv wallets have no recovery phrase, so their rows do
|
||||||
|
not offer the action at all.
|
||||||
|
- **Elements**:
|
||||||
|
- "Back" button, "Recovery Phrase" heading
|
||||||
|
- Wallet name
|
||||||
|
- Warning box stating that anyone holding these words can take everything in
|
||||||
|
the wallet, from any device, without the password
|
||||||
|
- Error line
|
||||||
|
- Password input + "Reveal" button, shown until the password is accepted
|
||||||
|
- The recovery phrase itself, in full and click-to-copy, shown only after a
|
||||||
|
correct password and in place of the password prompt
|
||||||
|
- **Transitions**:
|
||||||
|
- "Reveal" (correct password) → the phrase replaces the password prompt (no
|
||||||
|
screen change)
|
||||||
|
- "Reveal" (wrong password) → full-sentence error, nothing revealed (no
|
||||||
|
screen change)
|
||||||
|
- "Back" → previous screen (Settings)
|
||||||
|
- **Secret handling**: nothing is decrypted or written into the page until the
|
||||||
|
password is accepted; the phrase is never stored in state, and it is wiped
|
||||||
|
from the page whenever the screen is left by any route, including the Settings
|
||||||
|
gear. A decrypt still running when the screen is left is discarded rather than
|
||||||
|
written. The screen is not restorable, so reopening the popup lands on Home
|
||||||
|
rather than back on the phrase.
|
||||||
|
|
||||||
#### DeleteWallet (`delete-wallet-confirm`)
|
#### DeleteWallet (`delete-wallet-confirm`)
|
||||||
|
|
||||||
- **When**: User tapped the `[x]` next to a wallet in Settings.
|
- **When**: User tapped the `[x]` next to a wallet in Settings.
|
||||||
@@ -947,6 +984,36 @@ battle-tested.
|
|||||||
Exceptions require explicit authorization in a code comment referencing this
|
Exceptions require explicit authorization in a code comment referencing this
|
||||||
policy, but as of now there are none.
|
policy, but as of now there are none.
|
||||||
|
|
||||||
|
### Content Security Policy
|
||||||
|
|
||||||
|
Both manifests declare the same policy for extension pages —
|
||||||
|
`script-src 'self' 'wasm-unsafe-eval'; object-src 'self'` — as an object under
|
||||||
|
`content_security_policy.extension_pages` in `manifest/chrome.json` (MV3) and as
|
||||||
|
a bare string in `manifest/firefox.json` (MV2).
|
||||||
|
|
||||||
|
`'wasm-unsafe-eval'` is there for one reason: libsodium. It ships a WebAssembly
|
||||||
|
build and a `wasm2js` translation of it in one file, tries WASM first, and
|
||||||
|
silently falls back to the translation if instantiation throws. Under a plain
|
||||||
|
`script-src 'self'` the fallback was taken on every popup load, announced by
|
||||||
|
nothing but an uncaught `CompileError`. Measured on the same Argon2id parameters
|
||||||
|
the vault uses (`OPSLIMIT_INTERACTIVE`, `MEMLIMIT_INTERACTIVE`), WASM derives a
|
||||||
|
key in 141-198ms and `wasm2js` in 3204-3660ms. The work factor is identical — it
|
||||||
|
is set by the ops and memory parameters, not by wall time — so the fallback
|
||||||
|
bought nothing and cost about three and a half seconds on every operation that
|
||||||
|
asks for the password, which is every signature.
|
||||||
|
|
||||||
|
The keyword permits compiling WebAssembly and nothing else: not `eval()` of
|
||||||
|
strings, not inline script, not remote script. Using it requires already
|
||||||
|
executing script in an extension page, which is complete compromise on its own.
|
||||||
|
`'unsafe-eval'` is a different proposition and is not granted.
|
||||||
|
|
||||||
|
The grant is pinned in both directions. `tests/manifest.test.js` asserts the
|
||||||
|
exact token set in both manifests, so dropping `'wasm-unsafe-eval'` (a silent
|
||||||
|
20x regression on the key derivation) and adding anything beyond it both fail
|
||||||
|
`make check`. `tests/vaultBackend.test.js` asserts the unit tests run the WASM
|
||||||
|
backend, and `make test-e2e` compiles a WebAssembly module inside the real popup
|
||||||
|
under the real manifest.
|
||||||
|
|
||||||
### DEBUG Mode Policy
|
### DEBUG Mode Policy
|
||||||
|
|
||||||
The `DEBUG` constant in the popup JS enables a red "DEBUG / INSECURE" banner and
|
The `DEBUG` constant in the popup JS enables a red "DEBUG / INSECURE" banner and
|
||||||
@@ -1108,7 +1175,8 @@ indexes it as a real token transfer.
|
|||||||
it. AutistMask hides transactions below a configurable dust threshold
|
it. AutistMask hides transactions below a configurable dust threshold
|
||||||
(default: 100,000 gwei / 0.0001 ETH). This is high enough to filter poisoning
|
(default: 100,000 gwei / 0.0001 ETH). This is high enough to filter poisoning
|
||||||
dust while low enough to preserve any transfer a user would plausibly care
|
dust while low enough to preserve any transfer a user would plausibly care
|
||||||
about. The threshold is user-configurable in Settings.
|
about. The threshold is user-configurable in Settings; a threshold of `0`
|
||||||
|
hides nothing, exactly as clearing the checkbox does.
|
||||||
|
|
||||||
- **User-configurable**: All of the above filters (known symbol verification,
|
- **User-configurable**: All of the above filters (known symbol verification,
|
||||||
low-holder threshold, fraud contract blocklist, dust threshold) are settings
|
low-holder threshold, fraud contract blocklist, dust threshold) are settings
|
||||||
@@ -1181,7 +1249,7 @@ Currently supported:
|
|||||||
|
|
||||||
- [x] Delete wallet (with confirmation)
|
- [x] Delete wallet (with confirmation)
|
||||||
- [ ] Delete address from HD wallet (with confirmation)
|
- [ ] Delete address from HD wallet (with confirmation)
|
||||||
- [ ] Show wallet's recovery phrase (requires password)
|
- [x] Show wallet's recovery phrase (requires password)
|
||||||
|
|
||||||
### Transactions
|
### Transactions
|
||||||
|
|
||||||
@@ -1189,8 +1257,8 @@ Currently supported:
|
|||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
- [ ] Tests for mnemonic generation and address derivation
|
- [x] Tests for mnemonic generation and address derivation
|
||||||
- [ ] Tests for xpub derivation and child address generation
|
- [x] Tests for xpub derivation and child address generation
|
||||||
- [ ] Test on Firefox (Manifest V2)
|
- [ ] Test on Firefox (Manifest V2)
|
||||||
|
|
||||||
### Scam List
|
### Scam List
|
||||||
|
|||||||
21
TODO.md
21
TODO.md
@@ -44,6 +44,24 @@ undefined identifiers, which is how
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-08-11: libsodium runs on WebAssembly in the shipped builds —
|
||||||
|
`'wasm-unsafe-eval'` added to both manifest CSPs after measuring the wasm2js
|
||||||
|
fallback at 20x the Argon2id cost, pinned in both directions by
|
||||||
|
`tests/manifest.test.js` and observed in the real popup by the e2e suite
|
||||||
|
([#182](https://git.eeqj.de/sneak/AutistMask/issues/182)).
|
||||||
|
- 2026-08-11: `script/verify-build` now walks `dist/` NUL-delimited and asserts
|
||||||
|
`dist/` is a real directory, so a path with a trailing space or a newline can
|
||||||
|
no longer carry a debug marker past the unlisted-bundle check
|
||||||
|
([#223](https://git.eeqj.de/sneak/AutistMask/issues/223)).
|
||||||
|
- 2026-08-11: A dust threshold of `0` now means "hide nothing" instead of
|
||||||
|
falling back to the 100,000 gwei default, and every address comparison in
|
||||||
|
`src/shared/transactions.js` goes through one case-normalising helper so a
|
||||||
|
checksummed genuine contract is no longer read as a spoof
|
||||||
|
([#179](https://git.eeqj.de/sneak/AutistMask/issues/179)).
|
||||||
|
- 2026-08-11: Password-gated recovery phrase display for HD wallets, reached
|
||||||
|
from the wallet row in Settings, wiped on leaving the screen and excluded from
|
||||||
|
the views the popup can reopen onto
|
||||||
|
([#161](https://git.eeqj.de/sneak/AutistMask/issues/161)).
|
||||||
- 2026-08-11: Policy compliance sweep — conditional verbose test rerun, local
|
- 2026-08-11: Policy compliance sweep — conditional verbose test rerun, local
|
||||||
Tailwind binary instead of `npx`, `--frozen-lockfile` on `make install`, and
|
Tailwind binary instead of `npx`, `--frozen-lockfile` on `make install`, and
|
||||||
the Makefile-only targets documented in the README
|
the Makefile-only targets documented in the README
|
||||||
@@ -54,6 +72,9 @@ undefined identifiers, which is how
|
|||||||
lives only in `build.js`, and the unlisted-bundle scan hard-fails when it
|
lives only in `build.js`, and the unlisted-bundle scan hard-fails when it
|
||||||
cannot enumerate `dist/`
|
cannot enumerate `dist/`
|
||||||
([#180](https://git.eeqj.de/sneak/AutistMask/issues/180)).
|
([#180](https://git.eeqj.de/sneak/AutistMask/issues/180)).
|
||||||
|
- 2026-08-11: Known-answer test coverage for the crypto core — BIP-39/BIP-32
|
||||||
|
derivation in `wallet.js` and the Argon2id vault in `vault.js`
|
||||||
|
([#159](https://git.eeqj.de/sneak/AutistMask/issues/159)).
|
||||||
- 2026-08-11: Three `README.md` claims corrected against the code — blocklist
|
- 2026-08-11: Three `README.md` claims corrected against the code — blocklist
|
||||||
attribution, token-display rule, navigation model
|
attribution, token-display rule, navigation model
|
||||||
([#213](https://git.eeqj.de/sneak/AutistMask/issues/213)).
|
([#213](https://git.eeqj.de/sneak/AutistMask/issues/213)).
|
||||||
|
|||||||
@@ -5,6 +5,9 @@
|
|||||||
"description": "Minimal Ethereum wallet for Chrome",
|
"description": "Minimal Ethereum wallet for Chrome",
|
||||||
"permissions": ["storage", "activeTab"],
|
"permissions": ["storage", "activeTab"],
|
||||||
"host_permissions": ["<all_urls>"],
|
"host_permissions": ["<all_urls>"],
|
||||||
|
"content_security_policy": {
|
||||||
|
"extension_pages": "script-src 'self' 'wasm-unsafe-eval'; object-src 'self'"
|
||||||
|
},
|
||||||
"action": {
|
"action": {
|
||||||
"default_popup": "src/popup/index.html"
|
"default_popup": "src/popup/index.html"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -4,6 +4,7 @@
|
|||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"description": "Minimal Ethereum wallet for Firefox",
|
"description": "Minimal Ethereum wallet for Firefox",
|
||||||
"permissions": ["storage", "activeTab", "<all_urls>"],
|
"permissions": ["storage", "activeTab", "<all_urls>"],
|
||||||
|
"content_security_policy": "script-src 'self' 'wasm-unsafe-eval'; object-src 'self'",
|
||||||
"browser_action": {
|
"browser_action": {
|
||||||
"default_popup": "src/popup/index.html"
|
"default_popup": "src/popup/index.html"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -22,6 +22,18 @@ set -eu
|
|||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
# Absolute path to this script, resolved before anything cd's anywhere.
|
||||||
|
# check_unlisted_bundles re-invokes it through xargs, and $0 on its own may be
|
||||||
|
# relative to a directory we are about to leave.
|
||||||
|
SELF="$(cd "$(dirname "$0")" && pwd -P)/$(basename "$0")"
|
||||||
|
|
||||||
|
# Internal re-entry flag; see scan_dist_paths.
|
||||||
|
SCAN_FLAG="--scan-dist-paths"
|
||||||
|
|
||||||
|
# A literal newline, for the is_listed guard.
|
||||||
|
NEWLINE='
|
||||||
|
'
|
||||||
|
|
||||||
MANIFEST="dist/constants-bundles.txt"
|
MANIFEST="dist/constants-bundles.txt"
|
||||||
MARKER_ON="autistmask-build-debug=on"
|
MARKER_ON="autistmask-build-debug=on"
|
||||||
MARKER_OFF="autistmask-build-debug=off"
|
MARKER_OFF="autistmask-build-debug=off"
|
||||||
@@ -29,11 +41,20 @@ MARKER_OFF="autistmask-build-debug=off"
|
|||||||
# Set by read_marker.
|
# Set by read_marker.
|
||||||
MARKER=""
|
MARKER=""
|
||||||
|
|
||||||
|
# Temporary file holding the NUL-delimited dist/ listing, removed by the EXIT
|
||||||
|
# trap because fail() exits from wherever it is called.
|
||||||
|
LISTING=""
|
||||||
|
|
||||||
fail() {
|
fail() {
|
||||||
echo "verify-build: FAIL: $*" >&2
|
echo "verify-build: FAIL: $*" >&2
|
||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
cleanup() {
|
||||||
|
[ -z "$LISTING" ] || rm -f "$LISTING"
|
||||||
|
}
|
||||||
|
trap cleanup EXIT
|
||||||
|
|
||||||
# Is the literal $1 present in the file $2? Match (grep exit 0) and no-match
|
# Is the literal $1 present in the file $2? Match (grep exit 0) and no-match
|
||||||
# (exit 1) are answers about the emitted output. Anything else (exit 2: the
|
# (exit 1) are answers about the emitted output. Anything else (exit 2: the
|
||||||
# file could not be read) is not an answer at all, and must not be reported as
|
# file could not be read) is not an answer at all, and must not be reported as
|
||||||
@@ -58,7 +79,17 @@ has_marker() {
|
|||||||
# manifest could not be read and is not an answer at all. Without this, an
|
# manifest could not be read and is not an answer at all. Without this, an
|
||||||
# unreadable manifest reads as "this file is not listed" and every emitted
|
# unreadable manifest reads as "this file is not listed" and every emitted
|
||||||
# bundle gets reported as an unlisted one.
|
# bundle gets reported as an unlisted one.
|
||||||
|
#
|
||||||
|
# A path containing a newline is answered without asking grep, because grep
|
||||||
|
# would read the pattern as two patterns and report a match on either. That is
|
||||||
|
# how such a path escaped this check even once the walk stopped splitting it:
|
||||||
|
# the half before the newline matched a listed line and the file was skipped.
|
||||||
|
# The manifest is line-delimited, so it cannot name such a path at all, and
|
||||||
|
# "not listed" is the only true answer.
|
||||||
is_listed() {
|
is_listed() {
|
||||||
|
case "$1" in
|
||||||
|
*"$NEWLINE"*) return 1 ;;
|
||||||
|
esac
|
||||||
_il_status=0
|
_il_status=0
|
||||||
grep -q -x -F -e "$1" -- "$MANIFEST" || _il_status=$?
|
grep -q -x -F -e "$1" -- "$MANIFEST" || _il_status=$?
|
||||||
case "$_il_status" in
|
case "$_il_status" in
|
||||||
@@ -117,35 +148,66 @@ read_marker() {
|
|||||||
# an endsWith(".js") test; repeating that literal here would mean a bundle
|
# an endsWith(".js") test; repeating that literal here would mean a bundle
|
||||||
# emitted under some other extension escaped the manifest AND this check at
|
# emitted under some other extension escaped the manifest AND this check at
|
||||||
# once, which is the correlated blind spot the two-source design exists to
|
# once, which is the correlated blind spot the two-source design exists to
|
||||||
# avoid. Every file under dist/ is searched, so build.js's filter is the only
|
# avoid. Every regular file and every symlink under dist/ is searched — that
|
||||||
# place the assumption lives and this check is what catches it being wrong.
|
# is the whole of what a build emits — so build.js's filter is the only place
|
||||||
|
# the assumption lives and this check is what catches it being wrong.
|
||||||
#
|
#
|
||||||
# That claim only holds if the walk is exhaustive, so two things are enforced
|
# That claim only holds if the walk is exhaustive and every name survives it
|
||||||
# here rather than assumed:
|
# intact, so four things are enforced here rather than assumed:
|
||||||
#
|
#
|
||||||
|
# - the walk is NUL-delimited and the paths reach the check as arguments, so
|
||||||
|
# no name can be reshaped on the way in. Read line by line, a name with a
|
||||||
|
# trailing space lost it to read's field splitting and the remnant then
|
||||||
|
# matched a manifest line, and a name containing a newline arrived as a
|
||||||
|
# listed path plus an empty one. Both left a marker-carrying, unlisted file
|
||||||
|
# unchecked while the script still reported success. Delivering such a name
|
||||||
|
# intact is only half of it; is_listed also has to keep it out of grep's
|
||||||
|
# pattern, for the same reason.
|
||||||
# - find's exit status is checked. A subtree it cannot descend is reported on
|
# - find's exit status is checked. A subtree it cannot descend is reported on
|
||||||
# stderr and then simply missing from the listing, so an unchecked status
|
# stderr and then simply missing from the listing, so an unchecked status
|
||||||
# turns "could not look" into "nothing was there" — the same conflation
|
# turns "could not look" into "nothing was there" — the same conflation
|
||||||
# has_marker exists to prevent. The status cannot be read off a pipeline
|
# has_marker exists to prevent. The status cannot be read off a pipeline,
|
||||||
# ending in sort, so the sort is a separate step.
|
# so the listing lands in a file that xargs then reads back.
|
||||||
# - symlinks are walked too (-type l), not skipped. A marker-carrying bundle
|
# - symlinks are walked too (-type l), not skipped. A marker-carrying bundle
|
||||||
# reachable under an unlisted path in dist/ is a stale manifest whether the
|
# reachable under an unlisted path in dist/ is a stale manifest whether the
|
||||||
# path is a link or a file, and grep reads through the link. A link that
|
# path is a link or a file, and grep reads through the link. A link that
|
||||||
# cannot be read through — dangling, or pointing at a directory — fails
|
# cannot be read through — dangling, or pointing at a directory — fails
|
||||||
# hard via has_marker's exit-2 path, which is the fail-closed answer: the
|
# hard via has_marker's exit-2 path, which is the fail-closed answer: the
|
||||||
# build emits neither, so their DEBUG state is unproven, not fine.
|
# build emits neither, so their DEBUG state is unproven, not fine.
|
||||||
|
# - dist/ itself must be a directory and not a symlink, which main asserts
|
||||||
|
# before anything reads through it. find does not follow a symlink named on
|
||||||
|
# its own command line, so a linked dist/ collapses this walk to one entry
|
||||||
|
# and cross-checks nothing.
|
||||||
|
#
|
||||||
|
# Types other than regular files and symlinks are left out on purpose: a build
|
||||||
|
# emits none of them, and grep on a fifo would hang rather than fail.
|
||||||
check_unlisted_bundles() {
|
check_unlisted_bundles() {
|
||||||
|
LISTING="$(mktemp "${TMPDIR:-/tmp}/verify-build-dist.XXXXXX")" ||
|
||||||
|
fail "could not create a temporary file for the dist/ listing, so the
|
||||||
|
tree was never walked. Refusing to report success."
|
||||||
|
|
||||||
_find_status=0
|
_find_status=0
|
||||||
_listing="$(find dist \( -type f -o -type l \) -print)" || _find_status=$?
|
find dist \( -type f -o -type l \) -print0 >"$LISTING" || _find_status=$?
|
||||||
[ "$_find_status" -eq 0 ] ||
|
[ "$_find_status" -eq 0 ] ||
|
||||||
fail "find exited $_find_status enumerating dist/, so part of the tree
|
fail "find exited $_find_status enumerating dist/, so part of the tree
|
||||||
was never walked and nothing was established about the files in it. Any
|
was never walked and nothing was established about the files in it. Any
|
||||||
unlisted bundle there went unchecked. That is a permissions or I/O fault on
|
unlisted bundle there went unchecked. That is a permissions or I/O fault on
|
||||||
the artifact, not a stale manifest. Refusing to report success."
|
the artifact, not a stale manifest. Refusing to report success."
|
||||||
_listing="$(printf '%s\n' "$_listing" | sort)"
|
|
||||||
|
|
||||||
while read -r _file; do
|
_scan_status=0
|
||||||
[ -n "$_file" ] || continue
|
xargs -0 "$SELF" "$SCAN_FLAG" <"$LISTING" || _scan_status=$?
|
||||||
|
[ "$_scan_status" -eq 0 ] ||
|
||||||
|
fail "the unlisted-bundle scan exited $_scan_status: either a path
|
||||||
|
under dist/ failed the check reported above, or the scan could not be run
|
||||||
|
at all. Refusing to report success."
|
||||||
|
}
|
||||||
|
|
||||||
|
# The per-path half of check_unlisted_bundles. It runs in a re-invocation of
|
||||||
|
# this script, so it uses the same is_listed and has_marker as the rest of the
|
||||||
|
# file rather than a second copy of them that could drift. Paths arrive as
|
||||||
|
# arguments and are never split, joined or trimmed.
|
||||||
|
scan_dist_paths() {
|
||||||
|
for _file in "$@"; do
|
||||||
if is_listed "$_file"; then
|
if is_listed "$_file"; then
|
||||||
continue
|
continue
|
||||||
fi
|
fi
|
||||||
@@ -154,9 +216,7 @@ check_unlisted_bundles() {
|
|||||||
fail "$_file carries a debug marker but is absent from $MANIFEST,
|
fail "$_file carries a debug marker but is absent from $MANIFEST,
|
||||||
so the manifest no longer describes the emitted bundles."
|
so the manifest no longer describes the emitted bundles."
|
||||||
fi
|
fi
|
||||||
done <<EOF
|
done
|
||||||
$_listing
|
|
||||||
EOF
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# The requested mode, read from our own environment using build.js's exact
|
# The requested mode, read from our own environment using build.js's exact
|
||||||
@@ -173,9 +233,32 @@ expected_marker() {
|
|||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
|
|
||||||
|
# Internal re-entry from check_unlisted_bundles' xargs. Not part of the
|
||||||
|
# command-line interface: nothing else invokes it, and it is a distinct
|
||||||
|
# entry point rather than a mode flag threaded through the checks below.
|
||||||
|
if [ "${1-}" = "$SCAN_FLAG" ]; then
|
||||||
|
shift
|
||||||
|
scan_dist_paths "$@"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
expected="$(expected_marker)"
|
expected="$(expected_marker)"
|
||||||
echo "Verifying emitted bundles (expecting $expected)..."
|
echo "Verifying emitted bundles (expecting $expected)..."
|
||||||
|
|
||||||
|
# Asserted here rather than left to grep. A symlinked dist/ used to fail
|
||||||
|
# only because GNU grep exits 2 on a directory, so check_unlisted_bundles'
|
||||||
|
# single entry hit has_marker's I/O path by luck; under a grep that exits 1
|
||||||
|
# instead, the whole cross-check would have collapsed into a pass.
|
||||||
|
if [ -h dist ]; then
|
||||||
|
fail "dist is a symlink, not a directory. find does not follow a
|
||||||
|
symlink named on its own command line, so the unlisted-bundle cross-check
|
||||||
|
would see one entry instead of the emitted tree and establish nothing about
|
||||||
|
it. Refusing to report success."
|
||||||
|
fi
|
||||||
|
[ -d dist ] ||
|
||||||
|
fail "dist is not a directory, so there is no emitted tree to verify.
|
||||||
|
build.js writes it; run make build first."
|
||||||
|
|
||||||
[ -f "$MANIFEST" ] ||
|
[ -f "$MANIFEST" ] ||
|
||||||
fail "$MANIFEST is missing. build.js writes it at the end of a
|
fail "$MANIFEST is missing. build.js writes it at the end of a
|
||||||
successful build; run make build first."
|
successful build; run make build first."
|
||||||
|
|||||||
@@ -1098,6 +1098,52 @@
|
|||||||
</button>
|
</button>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<!-- ============ SHOW RECOVERY PHRASE ============ -->
|
||||||
|
<div id="view-show-phrase" class="view hidden">
|
||||||
|
<button
|
||||||
|
id="btn-show-phrase-back"
|
||||||
|
class="border border-border px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer mb-2"
|
||||||
|
>
|
||||||
|
< Back
|
||||||
|
</button>
|
||||||
|
<h2 class="font-bold mb-1">Recovery Phrase</h2>
|
||||||
|
<p class="text-xs mb-3" id="show-phrase-wallet-name"></p>
|
||||||
|
<div
|
||||||
|
class="text-xs mb-3 border border-border border-dashed p-2"
|
||||||
|
>
|
||||||
|
Anyone who has these words can take every coin and token in
|
||||||
|
this wallet, from any device, without your password. Never
|
||||||
|
type them into a website and never show them to anyone.
|
||||||
|
</div>
|
||||||
|
<div
|
||||||
|
id="show-phrase-flash"
|
||||||
|
class="text-xs text-red-500 mb-2 min-h-[1.25rem]"
|
||||||
|
style="visibility: hidden"
|
||||||
|
></div>
|
||||||
|
<div id="show-phrase-password-section" class="mb-2">
|
||||||
|
<label class="block mb-1">Password</label>
|
||||||
|
<input
|
||||||
|
type="password"
|
||||||
|
id="show-phrase-password"
|
||||||
|
class="border border-border p-1 w-full font-mono text-sm bg-bg text-fg"
|
||||||
|
placeholder="Enter your password to continue"
|
||||||
|
/>
|
||||||
|
<button
|
||||||
|
id="btn-show-phrase-reveal"
|
||||||
|
class="border border-border px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer mt-2"
|
||||||
|
>
|
||||||
|
Reveal
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
<div id="show-phrase-result" class="hidden">
|
||||||
|
<div
|
||||||
|
id="show-phrase-value"
|
||||||
|
class="bg-danger-well rounded p-2 font-mono text-xs break-all cursor-pointer mb-1"
|
||||||
|
title="Click to copy"
|
||||||
|
></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
<!-- ============ SETTINGS: ADD TOKEN ============ -->
|
<!-- ============ SETTINGS: ADD TOKEN ============ -->
|
||||||
<div id="view-settings-addtoken" class="view hidden">
|
<div id="view-settings-addtoken" class="view hidden">
|
||||||
<button
|
<button
|
||||||
|
|||||||
@@ -15,6 +15,10 @@ const {
|
|||||||
clearViewStack,
|
clearViewStack,
|
||||||
} = require("./views/helpers");
|
} = require("./views/helpers");
|
||||||
const { applyTheme } = require("./theme");
|
const { applyTheme } = require("./theme");
|
||||||
|
// Views that can be fully re-rendered from persisted state. All others fall
|
||||||
|
// back to the nearest restorable parent; see the module for why the
|
||||||
|
// secret-bearing views are absent.
|
||||||
|
const { RESTORABLE_VIEWS } = require("./restorableViews");
|
||||||
|
|
||||||
const home = require("./views/home");
|
const home = require("./views/home");
|
||||||
const welcome = require("./views/welcome");
|
const welcome = require("./views/welcome");
|
||||||
@@ -99,21 +103,6 @@ const ctx = {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
// Views that can be fully re-rendered from persisted state.
|
|
||||||
// All others fall back to the nearest restorable parent.
|
|
||||||
const RESTORABLE_VIEWS = new Set([
|
|
||||||
"main",
|
|
||||||
"address",
|
|
||||||
"address-token",
|
|
||||||
"receive",
|
|
||||||
"settings",
|
|
||||||
"settings-addtoken",
|
|
||||||
"confirm-tx",
|
|
||||||
"transaction",
|
|
||||||
"success-tx",
|
|
||||||
"error-tx",
|
|
||||||
]);
|
|
||||||
|
|
||||||
function needsAddress(view) {
|
function needsAddress(view) {
|
||||||
return (
|
return (
|
||||||
view === "address" ||
|
view === "address" ||
|
||||||
|
|||||||
29
src/popup/restorableViews.js
Normal file
29
src/popup/restorableViews.js
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
// Views the popup may reopen onto.
|
||||||
|
//
|
||||||
|
// The popup persists the current view so that reopening the toolbar popup
|
||||||
|
// lands the user back where they were. Only views that can be fully
|
||||||
|
// re-rendered from persisted state belong here; every other view falls back
|
||||||
|
// to the nearest restorable parent (src/popup/index.js restoreView()).
|
||||||
|
//
|
||||||
|
// A view that displays a secret must NEVER be listed. Restoring onto one
|
||||||
|
// would put a private key or a recovery phrase on screen with no password
|
||||||
|
// prompt in front of it, on a popup the user may have reopened by accident.
|
||||||
|
// That is why "export-privkey" and "show-phrase" are absent.
|
||||||
|
//
|
||||||
|
// Kept in its own module, with no dependencies, so tests can assert the
|
||||||
|
// exclusion directly rather than trusting a reading of the popup entry
|
||||||
|
// point, which cannot be required outside a browser.
|
||||||
|
const RESTORABLE_VIEWS = new Set([
|
||||||
|
"main",
|
||||||
|
"address",
|
||||||
|
"address-token",
|
||||||
|
"receive",
|
||||||
|
"settings",
|
||||||
|
"settings-addtoken",
|
||||||
|
"confirm-tx",
|
||||||
|
"transaction",
|
||||||
|
"success-tx",
|
||||||
|
"error-tx",
|
||||||
|
]);
|
||||||
|
|
||||||
|
module.exports = { RESTORABLE_VIEWS };
|
||||||
@@ -31,8 +31,20 @@ const VIEWS = [
|
|||||||
"approve-tx",
|
"approve-tx",
|
||||||
"approve-sign",
|
"approve-sign",
|
||||||
"export-privkey",
|
"export-privkey",
|
||||||
|
"show-phrase",
|
||||||
];
|
];
|
||||||
|
|
||||||
|
// Cleanup callbacks for views that hold a secret in the DOM. The view
|
||||||
|
// registers one for itself and showView() runs it whenever that view is
|
||||||
|
// navigated away from, so the secret is wiped no matter which control
|
||||||
|
// caused the navigation — "Back", the settings gear, or a jump from
|
||||||
|
// anywhere else. A per-button clear would only cover the one path.
|
||||||
|
const viewLeaveHandlers = new Map();
|
||||||
|
|
||||||
|
function onViewLeave(name, fn) {
|
||||||
|
viewLeaveHandlers.set(name, fn);
|
||||||
|
}
|
||||||
|
|
||||||
function $(id) {
|
function $(id) {
|
||||||
return document.getElementById(id);
|
return document.getElementById(id);
|
||||||
}
|
}
|
||||||
@@ -50,6 +62,11 @@ function hideError(id) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function showView(name) {
|
function showView(name) {
|
||||||
|
const leaving = state.currentView;
|
||||||
|
if (leaving && leaving !== name) {
|
||||||
|
const onLeave = viewLeaveHandlers.get(leaving);
|
||||||
|
if (onLeave) onLeave();
|
||||||
|
}
|
||||||
for (const v of VIEWS) {
|
for (const v of VIEWS) {
|
||||||
const el = document.getElementById(`view-${v}`);
|
const el = document.getElementById(`view-${v}`);
|
||||||
if (el) {
|
if (el) {
|
||||||
@@ -431,10 +448,12 @@ function flashCopyFeedback(el) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
|
VIEWS,
|
||||||
$,
|
$,
|
||||||
showError,
|
showError,
|
||||||
hideError,
|
hideError,
|
||||||
showView,
|
showView,
|
||||||
|
onViewLeave,
|
||||||
updateDebugBanner,
|
updateDebugBanner,
|
||||||
setRenderMain,
|
setRenderMain,
|
||||||
pushCurrentView,
|
pushCurrentView,
|
||||||
|
|||||||
@@ -14,6 +14,8 @@ const { NETWORKS, SUPPORTED_CHAIN_IDS } = require("../../shared/networks");
|
|||||||
const { onChainSwitch } = require("../../shared/chainSwitch");
|
const { onChainSwitch } = require("../../shared/chainSwitch");
|
||||||
const { log, debugFetch, setRuntimeDebug } = require("../../shared/log");
|
const { log, debugFetch, setRuntimeDebug } = require("../../shared/log");
|
||||||
const deleteWallet = require("./deleteWallet");
|
const deleteWallet = require("./deleteWallet");
|
||||||
|
const showPhrase = require("./showPhrase");
|
||||||
|
const { walletHasRecoveryPhrase } = require("../../shared/wallet");
|
||||||
const {
|
const {
|
||||||
BUILD_VERSION,
|
BUILD_VERSION,
|
||||||
BUILD_LICENSE,
|
BUILD_LICENSE,
|
||||||
@@ -99,7 +101,14 @@ function renderWalletListSettings() {
|
|||||||
const name = escapeHtml(wallet.name || "Wallet " + (idx + 1));
|
const name = escapeHtml(wallet.name || "Wallet " + (idx + 1));
|
||||||
html += `<div class="flex justify-between items-center text-xs py-1 border-b border-border-light">`;
|
html += `<div class="flex justify-between items-center text-xs py-1 border-b border-border-light">`;
|
||||||
html += `<span class="settings-wallet-name cursor-pointer underline decoration-dashed" data-idx="${idx}">${name}</span>`;
|
html += `<span class="settings-wallet-name cursor-pointer underline decoration-dashed" data-idx="${idx}">${name}</span>`;
|
||||||
|
html += `<span class="flex items-center gap-1 flex-shrink-0">`;
|
||||||
|
// Key and xprv wallets have no recovery phrase, so they are never
|
||||||
|
// offered the action at all.
|
||||||
|
if (walletHasRecoveryPhrase(wallet)) {
|
||||||
|
html += `<button class="btn-show-phrase border border-border px-1 hover:bg-fg hover:text-bg cursor-pointer" data-idx="${idx}" title="Show recovery phrase">[recovery phrase]</button>`;
|
||||||
|
}
|
||||||
html += `<button class="btn-delete-wallet border border-border px-1 hover:bg-fg hover:text-bg cursor-pointer" data-idx="${idx}">[x]</button>`;
|
html += `<button class="btn-delete-wallet border border-border px-1 hover:bg-fg hover:text-bg cursor-pointer" data-idx="${idx}">[x]</button>`;
|
||||||
|
html += `</span>`;
|
||||||
html += `</div>`;
|
html += `</div>`;
|
||||||
});
|
});
|
||||||
container.innerHTML = html;
|
container.innerHTML = html;
|
||||||
@@ -111,6 +120,15 @@ function renderWalletListSettings() {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
container.querySelectorAll(".btn-show-phrase").forEach((btn) => {
|
||||||
|
btn.addEventListener("click", () => {
|
||||||
|
const idx = parseInt(btn.dataset.idx, 10);
|
||||||
|
// No pushCurrentView() here: showPhrase.show() refuses
|
||||||
|
// non-HD wallets and pushes only when it navigates.
|
||||||
|
showPhrase.show(idx);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
// Inline rename on click
|
// Inline rename on click
|
||||||
container.querySelectorAll(".settings-wallet-name").forEach((span) => {
|
container.querySelectorAll(".settings-wallet-name").forEach((span) => {
|
||||||
span.addEventListener("click", () => {
|
span.addEventListener("click", () => {
|
||||||
@@ -191,6 +209,7 @@ function renderSiteLists() {
|
|||||||
|
|
||||||
function init(ctx) {
|
function init(ctx) {
|
||||||
deleteWallet.init(ctx);
|
deleteWallet.init(ctx);
|
||||||
|
showPhrase.init();
|
||||||
|
|
||||||
$("btn-save-rpc").addEventListener("click", async () => {
|
$("btn-save-rpc").addEventListener("click", async () => {
|
||||||
const url = $("settings-rpc").value.trim();
|
const url = $("settings-rpc").value.trim();
|
||||||
@@ -304,11 +323,17 @@ function init(ctx) {
|
|||||||
|
|
||||||
$("settings-dust-threshold").value = state.dustThresholdGwei;
|
$("settings-dust-threshold").value = state.dustThresholdGwei;
|
||||||
$("settings-dust-threshold").addEventListener("change", async () => {
|
$("settings-dust-threshold").addEventListener("change", async () => {
|
||||||
const val = parseInt($("settings-dust-threshold").value, 10);
|
const raw = $("settings-dust-threshold").value.trim();
|
||||||
if (!isNaN(val) && val >= 0) {
|
const val = Number(raw);
|
||||||
|
// 0 is accepted and means "hide nothing". Empty, negative,
|
||||||
|
// fractional and non-numeric input is rejected outright rather than
|
||||||
|
// coerced, and the field is put back to the stored threshold so it
|
||||||
|
// never shows a value the wallet is not using.
|
||||||
|
if (raw !== "" && Number.isInteger(val) && val >= 0) {
|
||||||
state.dustThresholdGwei = val;
|
state.dustThresholdGwei = val;
|
||||||
await saveState();
|
await saveState();
|
||||||
}
|
}
|
||||||
|
$("settings-dust-threshold").value = state.dustThresholdGwei;
|
||||||
});
|
});
|
||||||
|
|
||||||
$("settings-utc-timestamps").checked = state.utcTimestamps;
|
$("settings-utc-timestamps").checked = state.utcTimestamps;
|
||||||
|
|||||||
154
src/popup/views/showPhrase.js
Normal file
154
src/popup/views/showPhrase.js
Normal file
@@ -0,0 +1,154 @@
|
|||||||
|
// Recovery phrase display for HD wallets.
|
||||||
|
//
|
||||||
|
// The phrase is the secret that owns every address in the wallet, so it is
|
||||||
|
// handled under four rules:
|
||||||
|
//
|
||||||
|
// 1. Only an HD wallet reaches this screen (walletHasRecoveryPhrase).
|
||||||
|
// 2. Nothing is decrypted, and nothing is written into the DOM, until
|
||||||
|
// decryptWithPassword has accepted the password.
|
||||||
|
// 3. Leaving the screen by any path wipes it, via the onViewLeave hook,
|
||||||
|
// and a decrypt still in flight when that happens is discarded
|
||||||
|
// instead of written (revealGeneration).
|
||||||
|
// 4. The phrase never reaches the logger. This module deliberately does
|
||||||
|
// not import src/shared/log.js, and the failed-decrypt path reports a
|
||||||
|
// fixed sentence rather than the caught error.
|
||||||
|
//
|
||||||
|
// The phrase is also never assigned to `state`, so it cannot be persisted
|
||||||
|
// to extension storage, and "show-phrase" is excluded from RESTORABLE_VIEWS
|
||||||
|
// so the popup can never reopen onto it.
|
||||||
|
|
||||||
|
const {
|
||||||
|
$,
|
||||||
|
showView,
|
||||||
|
showFlash,
|
||||||
|
flashCopyFeedback,
|
||||||
|
goBack,
|
||||||
|
onViewLeave,
|
||||||
|
pushCurrentView,
|
||||||
|
} = require("./helpers");
|
||||||
|
const { state } = require("../../shared/state");
|
||||||
|
const { decryptWithPassword } = require("../../shared/vault");
|
||||||
|
const { walletHasRecoveryPhrase } = require("../../shared/wallet");
|
||||||
|
|
||||||
|
const VIEW = "show-phrase";
|
||||||
|
|
||||||
|
let walletIndex = null;
|
||||||
|
|
||||||
|
// Bumped by every clear(), which is what leaving the screen runs. reveal()
|
||||||
|
// captures it before awaiting the decrypt and refuses to touch the DOM if
|
||||||
|
// it has moved: a decrypt still in flight when the screen is left would
|
||||||
|
// otherwise write the phrase *after* the wipe, with nothing scheduled to
|
||||||
|
// wipe it again, leaving it in the hidden view for the life of the popup.
|
||||||
|
let revealGeneration = 0;
|
||||||
|
|
||||||
|
// True only if the reveal that captured `generation` is still the live one:
|
||||||
|
// the screen has not been left, cleared, or re-entered for another wallet
|
||||||
|
// since it started.
|
||||||
|
function isCurrentReveal(generation) {
|
||||||
|
return (
|
||||||
|
generation === revealGeneration &&
|
||||||
|
walletIndex !== null &&
|
||||||
|
state.currentView === VIEW
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function fail(message) {
|
||||||
|
$("show-phrase-flash").textContent = message;
|
||||||
|
$("show-phrase-flash").style.visibility = "visible";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wipe every trace of the phrase and drop the wallet selection. Safe to
|
||||||
|
// call when nothing was ever revealed, and safe to call twice.
|
||||||
|
function clear() {
|
||||||
|
walletIndex = null;
|
||||||
|
revealGeneration += 1;
|
||||||
|
$("show-phrase-value").textContent = "";
|
||||||
|
$("show-phrase-password").value = "";
|
||||||
|
$("show-phrase-result").classList.add("hidden");
|
||||||
|
$("show-phrase-password-section").classList.remove("hidden");
|
||||||
|
$("show-phrase-flash").textContent = "";
|
||||||
|
$("show-phrase-flash").style.visibility = "hidden";
|
||||||
|
}
|
||||||
|
|
||||||
|
function show(walletIdx) {
|
||||||
|
const wallet = state.wallets[walletIdx];
|
||||||
|
if (!walletHasRecoveryPhrase(wallet)) {
|
||||||
|
showFlash("This wallet does not have a recovery phrase.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
clear();
|
||||||
|
walletIndex = walletIdx;
|
||||||
|
$("show-phrase-wallet-name").textContent =
|
||||||
|
wallet.name || "Wallet " + (walletIdx + 1);
|
||||||
|
// Pushed here rather than by the caller: this function can return
|
||||||
|
// without navigating, and a push that happened anyway would leave an
|
||||||
|
// entry on the stack that no screen transition matches.
|
||||||
|
pushCurrentView();
|
||||||
|
showView(VIEW);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function reveal() {
|
||||||
|
const password = $("show-phrase-password").value;
|
||||||
|
if (!password) {
|
||||||
|
fail("Please enter your password.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (walletIndex === null) {
|
||||||
|
fail("No wallet is selected.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const wallet = state.wallets[walletIndex];
|
||||||
|
if (!walletHasRecoveryPhrase(wallet)) {
|
||||||
|
fail("This wallet does not have a recovery phrase.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const btn = $("btn-show-phrase-reveal");
|
||||||
|
btn.disabled = true;
|
||||||
|
btn.classList.add("text-muted");
|
||||||
|
const generation = revealGeneration;
|
||||||
|
try {
|
||||||
|
const phrase = await decryptWithPassword(
|
||||||
|
wallet.encryptedSecret,
|
||||||
|
password,
|
||||||
|
);
|
||||||
|
// The only suspension point in this view, and the only place a
|
||||||
|
// secret is written: if the screen was left while the decrypt ran,
|
||||||
|
// the wipe has already happened and this write must not land.
|
||||||
|
if (!isCurrentReveal(generation)) return;
|
||||||
|
$("show-phrase-password").value = "";
|
||||||
|
$("show-phrase-password-section").classList.add("hidden");
|
||||||
|
$("show-phrase-value").textContent = phrase;
|
||||||
|
$("show-phrase-result").classList.remove("hidden");
|
||||||
|
$("show-phrase-flash").textContent = "";
|
||||||
|
$("show-phrase-flash").style.visibility = "hidden";
|
||||||
|
} catch {
|
||||||
|
if (!isCurrentReveal(generation)) return;
|
||||||
|
// Deliberately not the caught error: the message is fixed so that
|
||||||
|
// nothing derived from the ciphertext or the attempt can surface.
|
||||||
|
fail("That password is not correct. Please try again.");
|
||||||
|
} finally {
|
||||||
|
btn.disabled = false;
|
||||||
|
btn.classList.remove("text-muted");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function init() {
|
||||||
|
onViewLeave(VIEW, clear);
|
||||||
|
|
||||||
|
$("btn-show-phrase-back").addEventListener("click", () => {
|
||||||
|
goBack();
|
||||||
|
});
|
||||||
|
|
||||||
|
$("btn-show-phrase-reveal").addEventListener("click", reveal);
|
||||||
|
|
||||||
|
$("show-phrase-value").addEventListener("click", () => {
|
||||||
|
const phrase = $("show-phrase-value").textContent;
|
||||||
|
if (!phrase) return;
|
||||||
|
navigator.clipboard.writeText(phrase);
|
||||||
|
showFlash("Copied!");
|
||||||
|
flashCopyFeedback($("show-phrase-value"));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { init, show };
|
||||||
@@ -10,6 +10,14 @@ const { formatEther, formatUnits } = require("ethers");
|
|||||||
const { log, debugFetch } = require("./log");
|
const { log, debugFetch } = require("./log");
|
||||||
const { KNOWN_SYMBOLS, TOKEN_BY_ADDRESS } = require("./tokenList");
|
const { KNOWN_SYMBOLS, TOKEN_BY_ADDRESS } = require("./tokenList");
|
||||||
|
|
||||||
|
// Ethereum addresses are case-insensitive: EIP-55 mixed case is a checksum
|
||||||
|
// over the address, not part of its identity. Every address comparison in
|
||||||
|
// this file goes through this helper, so an address arriving in checksummed
|
||||||
|
// or upper-case form can never be read as a different address.
|
||||||
|
function normalizeAddress(addr) {
|
||||||
|
return (addr || "").toLowerCase();
|
||||||
|
}
|
||||||
|
|
||||||
function formatTxValue(val) {
|
function formatTxValue(val) {
|
||||||
const parts = val.split(".");
|
const parts = val.split(".");
|
||||||
if (parts.length === 1) return val + ".0000";
|
if (parts.length === 1) return val + ".0000";
|
||||||
@@ -30,10 +38,10 @@ function parseTx(tx, addrLower) {
|
|||||||
let exactValue = formatEther(rawWei);
|
let exactValue = formatEther(rawWei);
|
||||||
let rawAmount = rawWei;
|
let rawAmount = rawWei;
|
||||||
let rawUnit = "wei";
|
let rawUnit = "wei";
|
||||||
let direction = from.toLowerCase() === addrLower ? "sent" : "received";
|
let direction = normalizeAddress(from) === addrLower ? "sent" : "received";
|
||||||
let directionLabel = direction === "sent" ? "Sent" : "Received";
|
let directionLabel = direction === "sent" ? "Sent" : "Received";
|
||||||
if (toIsContract && method && method !== "transfer") {
|
if (toIsContract && method && method !== "transfer") {
|
||||||
const token = TOKEN_BY_ADDRESS.get(to.toLowerCase());
|
const token = TOKEN_BY_ADDRESS.get(normalizeAddress(to));
|
||||||
if (token) {
|
if (token) {
|
||||||
symbol = token.symbol;
|
symbol = token.symbol;
|
||||||
}
|
}
|
||||||
@@ -87,7 +95,8 @@ function parseTokenTransfer(tt, addrLower) {
|
|||||||
const to = tt.to?.hash || "";
|
const to = tt.to?.hash || "";
|
||||||
const decimals = parseInt(tt.total?.decimals || "18", 10);
|
const decimals = parseInt(tt.total?.decimals || "18", 10);
|
||||||
const rawVal = tt.total?.value || "0";
|
const rawVal = tt.total?.value || "0";
|
||||||
const direction = from.toLowerCase() === addrLower ? "sent" : "received";
|
const direction =
|
||||||
|
normalizeAddress(from) === addrLower ? "sent" : "received";
|
||||||
const sym = tt.token?.symbol || "?";
|
const sym = tt.token?.symbol || "?";
|
||||||
return {
|
return {
|
||||||
hash: tt.transaction_hash,
|
hash: tt.transaction_hash,
|
||||||
@@ -104,11 +113,9 @@ function parseTokenTransfer(tt, addrLower) {
|
|||||||
direction: direction,
|
direction: direction,
|
||||||
directionLabel: direction === "sent" ? "Sent" : "Received",
|
directionLabel: direction === "sent" ? "Sent" : "Received",
|
||||||
isError: false,
|
isError: false,
|
||||||
contractAddress: (
|
contractAddress: normalizeAddress(
|
||||||
tt.token?.address_hash ||
|
tt.token?.address_hash || tt.token?.address || "",
|
||||||
tt.token?.address ||
|
),
|
||||||
""
|
|
||||||
).toLowerCase(),
|
|
||||||
holders: parseInt(tt.token?.holders_count || "0", 10),
|
holders: parseInt(tt.token?.holders_count || "0", 10),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -194,7 +201,7 @@ function mergeTransactions(txs, tokenTransfers) {
|
|||||||
|
|
||||||
async function fetchRecentTransactions(address, blockscoutUrl, count = 25) {
|
async function fetchRecentTransactions(address, blockscoutUrl, count = 25) {
|
||||||
log.debugf("fetchRecentTransactions", address);
|
log.debugf("fetchRecentTransactions", address);
|
||||||
const addrLower = address.toLowerCase();
|
const addrLower = normalizeAddress(address);
|
||||||
|
|
||||||
const [txResp, ttResp] = await Promise.all([
|
const [txResp, ttResp] = await Promise.all([
|
||||||
debugFetch(blockscoutUrl + "/addresses/" + address + "/transactions"),
|
debugFetch(blockscoutUrl + "/addresses/" + address + "/transactions"),
|
||||||
@@ -243,34 +250,38 @@ function isSpoofedSymbol(tx) {
|
|||||||
if (!KNOWN_SYMBOLS.has(symbol)) return false;
|
if (!KNOWN_SYMBOLS.has(symbol)) return false;
|
||||||
const legit = KNOWN_SYMBOLS.get(symbol);
|
const legit = KNOWN_SYMBOLS.get(symbol);
|
||||||
if (legit === null) return true; // "ETH" as ERC-20 is always fake
|
if (legit === null) return true; // "ETH" as ERC-20 is always fake
|
||||||
return tx.contractAddress !== legit;
|
return normalizeAddress(tx.contractAddress) !== normalizeAddress(legit);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Pure filter function. Takes raw transactions and filter settings,
|
// Pure filter function. Takes raw transactions and filter settings,
|
||||||
// returns { transactions, newFraudContracts }.
|
// returns { transactions, newFraudContracts }.
|
||||||
function filterTransactions(txs, filters = {}) {
|
function filterTransactions(txs, filters = {}) {
|
||||||
const fraudSet = new Set(
|
const fraudSet = new Set(
|
||||||
(filters.fraudContracts || []).map((a) => a.toLowerCase()),
|
(filters.fraudContracts || []).map(normalizeAddress),
|
||||||
);
|
);
|
||||||
|
// The dust threshold defaults only when it is unset (nullish): a
|
||||||
|
// threshold of 0 is a real value meaning "hide nothing", since no
|
||||||
|
// transaction has a value below 0 gwei. It is therefore equivalent to
|
||||||
|
// clearing the hide-dust checkbox, and the two controls cannot override
|
||||||
|
// each other in either direction.
|
||||||
|
const dustThresholdGwei = filters.dustThresholdGwei ?? 100000;
|
||||||
const newFraud = [];
|
const newFraud = [];
|
||||||
const filtered = [];
|
const filtered = [];
|
||||||
|
|
||||||
for (const tx of txs) {
|
for (const tx of txs) {
|
||||||
|
const contract = normalizeAddress(tx.contractAddress);
|
||||||
|
|
||||||
// Always filter spoofed known symbols and record the fraud contract
|
// Always filter spoofed known symbols and record the fraud contract
|
||||||
if (isSpoofedSymbol(tx)) {
|
if (isSpoofedSymbol(tx)) {
|
||||||
if (tx.contractAddress && !fraudSet.has(tx.contractAddress)) {
|
if (contract && !fraudSet.has(contract)) {
|
||||||
fraudSet.add(tx.contractAddress);
|
fraudSet.add(contract);
|
||||||
newFraud.push(tx.contractAddress);
|
newFraud.push(contract);
|
||||||
}
|
}
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Filter fraud contracts if setting is on
|
// Filter fraud contracts if setting is on
|
||||||
if (
|
if (filters.hideFraudContracts && contract && fraudSet.has(contract)) {
|
||||||
filters.hideFraudContracts &&
|
|
||||||
tx.contractAddress &&
|
|
||||||
fraudSet.has(tx.contractAddress)
|
|
||||||
) {
|
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -291,7 +302,7 @@ function filterTransactions(txs, filters = {}) {
|
|||||||
filters.hideDustTransactions &&
|
filters.hideDustTransactions &&
|
||||||
!tx.isContractCall &&
|
!tx.isContractCall &&
|
||||||
tx.valueGwei !== null &&
|
tx.valueGwei !== null &&
|
||||||
tx.valueGwei < (filters.dustThresholdGwei || 100000)
|
tx.valueGwei < dustThresholdGwei
|
||||||
) {
|
) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,14 +1,80 @@
|
|||||||
// Vault: password-based encryption of secrets using libsodium.
|
// Vault: password-based encryption of secrets using libsodium.
|
||||||
// Uses Argon2id for key derivation and XSalsa20-Poly1305 for encryption.
|
// Uses Argon2id for key derivation and XSalsa20-Poly1305 for encryption.
|
||||||
// All crypto operations are delegated to libsodium — no raw primitives.
|
// All crypto operations are delegated to libsodium — no raw primitives.
|
||||||
|
//
|
||||||
|
// Backend: WebAssembly, deliberately (#182).
|
||||||
|
//
|
||||||
|
// libsodium ships one file containing both a WebAssembly build and a
|
||||||
|
// wasm2js ("asm.js") translation of it. It tries WASM first and, if
|
||||||
|
// instantiation throws, silently swaps in the translation. An extension
|
||||||
|
// CSP of plain script-src 'self' refuses WASM, so every popup load used
|
||||||
|
// to take that fallback — announced by nothing but an uncaught
|
||||||
|
// CompileError in the console.
|
||||||
|
//
|
||||||
|
// Measured here, same Argon2id parameters (OPSLIMIT_INTERACTIVE,
|
||||||
|
// MEMLIMIT_INTERACTIVE = 2 passes over 64MiB), node 22 on this machine:
|
||||||
|
// WASM 141-198ms per derivation, wasm2js 3204-3660ms. The work factor is
|
||||||
|
// identical either way — it is set by the ops/mem parameters, not by wall
|
||||||
|
// time — so the fallback bought no security, it only made every password
|
||||||
|
// operation take three and a half seconds, and the wallet asks for the
|
||||||
|
// password on every signature.
|
||||||
|
//
|
||||||
|
// So both manifests declare 'wasm-unsafe-eval' for extension pages. That
|
||||||
|
// keyword permits compiling WebAssembly and nothing else: not eval() of
|
||||||
|
// strings, not inline script, not remote script. Reaching it requires
|
||||||
|
// already executing script in the extension page, which is total
|
||||||
|
// compromise on its own. 'unsafe-eval' would be a different matter and is
|
||||||
|
// not granted. tests/manifest.test.js pins both policies to exactly
|
||||||
|
// "'self' 'wasm-unsafe-eval'" so neither the grant nor the surrounding
|
||||||
|
// strictness can drift unnoticed.
|
||||||
|
//
|
||||||
|
// The fallback still exists, and a wallet that refuses to decrypt is
|
||||||
|
// worse than a slow one, so it is not disabled — it is made loud:
|
||||||
|
// cryptoBackend() reports which backend this realm can run, ensureReady()
|
||||||
|
// logs an error if it is not WASM, tests/vaultBackend.test.js asserts the
|
||||||
|
// unit tests exercise the WASM backend, and the end-to-end suite asserts
|
||||||
|
// it in the real popup under the real manifest.
|
||||||
|
|
||||||
const sodium = require("libsodium-wrappers-sumo");
|
const sodium = require("libsodium-wrappers-sumo");
|
||||||
|
const { log } = require("./log");
|
||||||
|
|
||||||
|
// An empty WebAssembly module: the 8-byte magic number and version header,
|
||||||
|
// no sections. Compiling it asks the cheapest possible form of the only
|
||||||
|
// question that matters here — may this realm compile WebAssembly at all —
|
||||||
|
// which is exactly what a CSP without 'wasm-unsafe-eval' refuses, and
|
||||||
|
// exactly what decides which backend libsodium ends up on.
|
||||||
|
const EMPTY_WASM_MODULE = new Uint8Array([
|
||||||
|
0x00, 0x61, 0x73, 0x6d, 0x01, 0x00, 0x00, 0x00,
|
||||||
|
]);
|
||||||
|
|
||||||
|
// "wasm" or "asmjs": whether this realm may compile WebAssembly, which is
|
||||||
|
// what decides libsodium's backend when the CSP is the reason it cannot —
|
||||||
|
// the case this codebase guards. It probes the realm, not libsodium, so a
|
||||||
|
// fallback taken for some other reason (allocation failure, corrupt module)
|
||||||
|
// would not be caught here; tests/vaultBackend.test.js checks libsodium's
|
||||||
|
// own marker directly.
|
||||||
|
async function cryptoBackend() {
|
||||||
|
try {
|
||||||
|
await WebAssembly.compile(EMPTY_WASM_MODULE);
|
||||||
|
return "wasm";
|
||||||
|
} catch (_) {
|
||||||
|
return "asmjs";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
let ready = false;
|
let ready = false;
|
||||||
|
|
||||||
async function ensureReady() {
|
async function ensureReady() {
|
||||||
if (!ready) {
|
if (!ready) {
|
||||||
await sodium.ready;
|
await sodium.ready;
|
||||||
|
if ((await cryptoBackend()) !== "wasm") {
|
||||||
|
log.errorf(
|
||||||
|
"libsodium is running on the wasm2js fallback: this realm " +
|
||||||
|
"refuses to compile WebAssembly, so every password " +
|
||||||
|
"derivation costs roughly 20x what it should. See the " +
|
||||||
|
"backend note in src/shared/vault.js.",
|
||||||
|
);
|
||||||
|
}
|
||||||
ready = true;
|
ready = true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -59,4 +125,4 @@ async function decryptWithPassword(encrypted, password) {
|
|||||||
return sodium.to_string(plaintext);
|
return sodium.to_string(plaintext);
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = { encryptWithPassword, decryptWithPassword };
|
module.exports = { cryptoBackend, decryptWithPassword, encryptWithPassword };
|
||||||
|
|||||||
@@ -74,6 +74,15 @@ function isValidMnemonic(mnemonic) {
|
|||||||
return Mnemonic.isValidMnemonic(mnemonic);
|
return Mnemonic.isValidMnemonic(mnemonic);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Only an HD wallet has a recovery phrase. A "key" wallet holds a bare
|
||||||
|
// private key and an "xprv" wallet an extended private key; neither can be
|
||||||
|
// turned back into words, so neither may ever be offered the phrase display.
|
||||||
|
// Written as an allowlist on purpose: a wallet type added later is excluded
|
||||||
|
// until someone decides otherwise.
|
||||||
|
function walletHasRecoveryPhrase(walletData) {
|
||||||
|
return !!walletData && walletData.type === "hd";
|
||||||
|
}
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
generateMnemonic,
|
generateMnemonic,
|
||||||
deriveAddressFromXpub,
|
deriveAddressFromXpub,
|
||||||
@@ -83,4 +92,5 @@ module.exports = {
|
|||||||
addressFromPrivateKey,
|
addressFromPrivateKey,
|
||||||
getSignerForAddress,
|
getSignerForAddress,
|
||||||
isValidMnemonic,
|
isValidMnemonic,
|
||||||
|
walletHasRecoveryPhrase,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -22,18 +22,12 @@ const EXT_PATH = path.join(REPO_ROOT, "dist", "chrome");
|
|||||||
// entry must name the issue that will remove it. This list is the one
|
// entry must name the issue that will remove it. This list is the one
|
||||||
// concession in an otherwise zero-tolerance policy: an uncaught error is
|
// concession in an otherwise zero-tolerance policy: an uncaught error is
|
||||||
// how this harness caught issue #150 in the first place.
|
// how this harness caught issue #150 in the first place.
|
||||||
const ALLOWED_ERRORS = [
|
//
|
||||||
{
|
// Empty, and worth keeping that way. Its only entry was the WASM
|
||||||
// libsodium ships a WASM build and an asm.js fallback. The
|
// CompileError libsodium provoked on every popup load, deleted with #182
|
||||||
// extension CSP (script-src 'self', with no wasm-unsafe-eval)
|
// when both manifests started allowing WASM; the run that used to need it
|
||||||
// refuses the WASM module on every popup load; libsodium catches
|
// is now the run that proves the fix.
|
||||||
// it and falls back to asm.js, so the wallet works. Deciding
|
const ALLOWED_ERRORS = [];
|
||||||
// which backend actually ships is issue #182, and this entry gets
|
|
||||||
// deleted when that lands.
|
|
||||||
issue: "#182",
|
|
||||||
pattern: /Refused to compile or instantiate WebAssembly module/,
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
function isAllowed(text) {
|
function isAllowed(text) {
|
||||||
return ALLOWED_ERRORS.some((a) => a.pattern.test(text));
|
return ALLOWED_ERRORS.some((a) => a.pattern.test(text));
|
||||||
@@ -247,6 +241,26 @@ async function visible(page, selector, timeout = 15000) {
|
|||||||
await page.waitForSelector(selector, { state: "visible", timeout });
|
await page.waitForSelector(selector, { state: "visible", timeout });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// An empty WebAssembly module: magic number and version header, no
|
||||||
|
// sections. Compiling it in the popup asks the one question that decides
|
||||||
|
// libsodium's backend — may this realm compile WebAssembly — of the real
|
||||||
|
// page under the real shipped manifest, which is the only place the
|
||||||
|
// answer can be observed. Kept independent of src/shared/vault.js on
|
||||||
|
// purpose: a bundle asked to grade itself proves less than an outside
|
||||||
|
// observation of the same realm.
|
||||||
|
const EMPTY_WASM_MODULE = [0x00, 0x61, 0x73, 0x6d, 0x01, 0x00, 0x00, 0x00];
|
||||||
|
|
||||||
|
async function pageCompilesWasm(page) {
|
||||||
|
return page.evaluate(async (bytes) => {
|
||||||
|
try {
|
||||||
|
await WebAssembly.compile(new Uint8Array(bytes));
|
||||||
|
return true;
|
||||||
|
} catch (_) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}, EMPTY_WASM_MODULE);
|
||||||
|
}
|
||||||
|
|
||||||
async function openPopup(ctx, popupUrl) {
|
async function openPopup(ctx, popupUrl) {
|
||||||
const page = await ctx.newPage();
|
const page = await ctx.newPage();
|
||||||
await page.goto(popupUrl);
|
await page.goto(popupUrl);
|
||||||
@@ -255,6 +269,11 @@ async function openPopup(ctx, popupUrl) {
|
|||||||
|
|
||||||
// Full wallet creation through the real UI: BIP-39 generation, libsodium
|
// Full wallet creation through the real UI: BIP-39 generation, libsodium
|
||||||
// vault encryption and extension storage persistence, for real.
|
// vault encryption and extension storage persistence, for real.
|
||||||
|
//
|
||||||
|
// Returns the recovery phrase it generated. Tests that assert on a secret
|
||||||
|
// need the real value — checking for "some 12 words" would pass against the
|
||||||
|
// wrong wallet's phrase, and checking for nothing at all would pass against
|
||||||
|
// a screen that shows the phrase it was supposed to hide.
|
||||||
async function createWallet(page) {
|
async function createWallet(page) {
|
||||||
await page.click("#btn-welcome-add");
|
await page.click("#btn-welcome-add");
|
||||||
await visible(page, "#view-add-wallet");
|
await visible(page, "#view-add-wallet");
|
||||||
@@ -263,10 +282,12 @@ async function createWallet(page) {
|
|||||||
const el = document.getElementById("wallet-mnemonic");
|
const el = document.getElementById("wallet-mnemonic");
|
||||||
return el && el.value.trim().split(/\s+/).length >= 12;
|
return el && el.value.trim().split(/\s+/).length >= 12;
|
||||||
});
|
});
|
||||||
|
const phrase = (await page.inputValue("#wallet-mnemonic")).trim();
|
||||||
await page.fill("#add-wallet-password", PASSWORD);
|
await page.fill("#add-wallet-password", PASSWORD);
|
||||||
await page.fill("#add-wallet-password-confirm", PASSWORD);
|
await page.fill("#add-wallet-password-confirm", PASSWORD);
|
||||||
await page.click("#btn-add-wallet-confirm");
|
await page.click("#btn-add-wallet-confirm");
|
||||||
await visible(page, "#view-main", 60000);
|
await visible(page, "#view-main", 60000);
|
||||||
|
return phrase;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Reach the address detail screen from wherever the popup restored to.
|
// Reach the address detail screen from wherever the popup restored to.
|
||||||
@@ -281,9 +302,11 @@ async function openAddressDetail(page) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
|
PASSWORD,
|
||||||
createWallet,
|
createWallet,
|
||||||
launch,
|
launch,
|
||||||
openAddressDetail,
|
openAddressDetail,
|
||||||
openPopup,
|
openPopup,
|
||||||
|
pageCompilesWasm,
|
||||||
visible,
|
visible,
|
||||||
};
|
};
|
||||||
|
|||||||
286
tests/e2e/run.js
286
tests/e2e/run.js
@@ -10,10 +10,12 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
|
|
||||||
const {
|
const {
|
||||||
|
PASSWORD,
|
||||||
createWallet,
|
createWallet,
|
||||||
launch,
|
launch,
|
||||||
openAddressDetail,
|
openAddressDetail,
|
||||||
openPopup,
|
openPopup,
|
||||||
|
pageCompilesWasm,
|
||||||
visible,
|
visible,
|
||||||
} = require("./harness");
|
} = require("./harness");
|
||||||
const { STUB_TOKEN, STUB_TX_HASH } = require("./network");
|
const { STUB_TOKEN, STUB_TX_HASH } = require("./network");
|
||||||
@@ -34,6 +36,10 @@ function assert(cond, message) {
|
|||||||
if (!cond) throw new Error(message);
|
if (!cond) throw new Error(message);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function sleep(ms) {
|
||||||
|
return new Promise((resolve) => setTimeout(resolve, ms));
|
||||||
|
}
|
||||||
|
|
||||||
function withTimeout(promise, name) {
|
function withTimeout(promise, name) {
|
||||||
let timer;
|
let timer;
|
||||||
const timeout = new Promise((_, reject) => {
|
const timeout = new Promise((_, reject) => {
|
||||||
@@ -55,8 +61,33 @@ test("popup loads and reaches the welcome view", async (env) => {
|
|||||||
assert(title === "AutistMask", "unexpected popup title: " + title);
|
assert(title === "AutistMask", "unexpected popup title: " + title);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// The empirical half of #182. The manifest change is only a claim about
|
||||||
|
// what the CSP permits; this is the observation. Two things have to hold
|
||||||
|
// together, and the run covers both: the popup realm compiles WASM (here),
|
||||||
|
// and no WASM refusal or abort is recorded anywhere in the run — the
|
||||||
|
// harness allowlist that used to excuse exactly that error is now empty,
|
||||||
|
// so a recurrence fails whichever test it lands in rather than being
|
||||||
|
// tolerated. Since libsodium's WASM module is embedded in the bundle and
|
||||||
|
// needs no fetch, a realm that compiles WASM is a realm where libsodium
|
||||||
|
// takes the WASM path, and the next test drives a real vault encryption
|
||||||
|
// through it.
|
||||||
|
test("the popup compiles WebAssembly under the shipped CSP (#182)", async (env) => {
|
||||||
|
const ok = await pageCompilesWasm(env.page);
|
||||||
|
assert(
|
||||||
|
ok,
|
||||||
|
"the popup refused to compile WebAssembly. The shipped manifest CSP " +
|
||||||
|
"has lost 'wasm-unsafe-eval', so libsodium is back on its wasm2js " +
|
||||||
|
"fallback and every password derivation costs roughly 20x what it " +
|
||||||
|
"should — see the backend note in src/shared/vault.js",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
test("wallet creation through the UI reaches the main view", async (env) => {
|
test("wallet creation through the UI reaches the main view", async (env) => {
|
||||||
await createWallet(env.page);
|
env.phrase = await createWallet(env.page);
|
||||||
|
assert(
|
||||||
|
env.phrase.split(/\s+/).length >= 12,
|
||||||
|
"wallet creation did not yield a recovery phrase",
|
||||||
|
);
|
||||||
const addrCount = await env.page
|
const addrCount = await env.page
|
||||||
.locator("#wallet-list .btn-addr-info")
|
.locator("#wallet-list .btn-addr-info")
|
||||||
.count();
|
.count();
|
||||||
@@ -117,6 +148,256 @@ test("transaction detail renders an ERC-20 transfer (#151)", async (env) => {
|
|||||||
assert(dots > 0, "token contract row rendered without its colour dot");
|
assert(dots > 0, "token contract row rendered without its colour dot");
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// -------------------------------------------- recovery phrase (#161)
|
||||||
|
|
||||||
|
// The gear toggles, so pressing it while Settings is already up leaves it.
|
||||||
|
async function openSettings(page) {
|
||||||
|
if (!(await page.isVisible("#view-settings"))) {
|
||||||
|
await page.click("#btn-settings");
|
||||||
|
}
|
||||||
|
await visible(page, "#view-settings");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Everything the recovery phrase screen is holding, read straight out of
|
||||||
|
// the DOM whether or not that screen is the one on top. Reading it while it
|
||||||
|
// is hidden is the point: "cleared on leave" means the node is empty, not
|
||||||
|
// merely off-screen.
|
||||||
|
async function phraseScreenState(page) {
|
||||||
|
return page.evaluate(() => ({
|
||||||
|
value: document.getElementById("show-phrase-value").textContent,
|
||||||
|
error: document.getElementById("show-phrase-flash").textContent,
|
||||||
|
html: document.getElementById("view-show-phrase").innerHTML,
|
||||||
|
resultHidden: document
|
||||||
|
.getElementById("show-phrase-result")
|
||||||
|
.classList.contains("hidden"),
|
||||||
|
viewHidden: document
|
||||||
|
.getElementById("view-show-phrase")
|
||||||
|
.classList.contains("hidden"),
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
async function openPhraseScreen(page) {
|
||||||
|
await openSettings(page);
|
||||||
|
await page.click("#settings-wallet-list .btn-show-phrase");
|
||||||
|
await visible(page, "#view-show-phrase");
|
||||||
|
}
|
||||||
|
|
||||||
|
async function revealPhrase(page) {
|
||||||
|
await page.fill("#show-phrase-password", PASSWORD);
|
||||||
|
await page.click("#btn-show-phrase-reveal");
|
||||||
|
await visible(page, "#show-phrase-result", 60000);
|
||||||
|
}
|
||||||
|
|
||||||
|
function assertWiped(st, phrase, where) {
|
||||||
|
assert(st.value === "", "phrase still in the DOM " + where);
|
||||||
|
assert(st.resultHidden, "result section still shown " + where);
|
||||||
|
assert(
|
||||||
|
!st.html.includes(phrase),
|
||||||
|
"the recovery phrase is still somewhere in the screen markup " + where,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
test("only an HD wallet is offered the recovery phrase action (#161)", async (env) => {
|
||||||
|
await openSettings(env.page);
|
||||||
|
const offered = await env.page
|
||||||
|
.locator("#settings-wallet-list .btn-show-phrase")
|
||||||
|
.count();
|
||||||
|
const wallets = await env.page
|
||||||
|
.locator("#settings-wallet-list .btn-delete-wallet")
|
||||||
|
.count();
|
||||||
|
assert(wallets === 1, "expected exactly one wallet row, got " + wallets);
|
||||||
|
assert(
|
||||||
|
offered === 1,
|
||||||
|
"the HD wallet was not offered the recovery phrase action",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The other half of the gate, against the real UI: a wallet holding a bare
|
||||||
|
// private key has no phrase to show, so no row of it may offer the action.
|
||||||
|
// The key is generated here rather than committed — the repo holds no
|
||||||
|
// private keys, test ones included.
|
||||||
|
test("a key wallet is not offered the recovery phrase action (#161)", async (env) => {
|
||||||
|
const { Wallet } = require("ethers");
|
||||||
|
|
||||||
|
await openSettings(env.page);
|
||||||
|
await env.page.click("#btn-main-add-wallet");
|
||||||
|
await visible(env.page, "#view-add-wallet");
|
||||||
|
await env.page.click("#tab-privkey");
|
||||||
|
await env.page.fill(
|
||||||
|
"#import-private-key",
|
||||||
|
Wallet.createRandom().privateKey,
|
||||||
|
);
|
||||||
|
await env.page.fill("#add-wallet-password", PASSWORD);
|
||||||
|
await env.page.fill("#add-wallet-password-confirm", PASSWORD);
|
||||||
|
await env.page.click("#btn-add-wallet-confirm");
|
||||||
|
await visible(env.page, "#view-main", 60000);
|
||||||
|
|
||||||
|
await openSettings(env.page);
|
||||||
|
const wallets = await env.page
|
||||||
|
.locator("#settings-wallet-list .btn-delete-wallet")
|
||||||
|
.count();
|
||||||
|
const offered = await env.page
|
||||||
|
.locator("#settings-wallet-list .btn-show-phrase")
|
||||||
|
.count();
|
||||||
|
assert(wallets === 2, "expected two wallet rows, got " + wallets);
|
||||||
|
assert(
|
||||||
|
offered === 1,
|
||||||
|
"the key wallet was offered the recovery phrase action",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the recovery phrase screen holds nothing before the password (#161)", async (env) => {
|
||||||
|
await openPhraseScreen(env.page);
|
||||||
|
const st = await phraseScreenState(env.page);
|
||||||
|
assertWiped(st, env.phrase, "before any password was entered");
|
||||||
|
const passwordShown = await env.page.isVisible(
|
||||||
|
"#show-phrase-password-section",
|
||||||
|
);
|
||||||
|
assert(passwordShown, "the password prompt is not shown");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a wrong password reveals nothing (#161)", async (env) => {
|
||||||
|
await env.page.fill("#show-phrase-password", "not-the-password");
|
||||||
|
await env.page.click("#btn-show-phrase-reveal");
|
||||||
|
await env.page.waitForFunction(
|
||||||
|
() =>
|
||||||
|
document.getElementById("show-phrase-flash").textContent.length > 0,
|
||||||
|
null,
|
||||||
|
{ timeout: 60000 },
|
||||||
|
);
|
||||||
|
|
||||||
|
const st = await phraseScreenState(env.page);
|
||||||
|
assertWiped(st, env.phrase, "after a wrong password");
|
||||||
|
assert(
|
||||||
|
/^[A-Z].*\.$/.test(st.error.trim()),
|
||||||
|
"the wrong-password error is not a full sentence: " +
|
||||||
|
JSON.stringify(st.error),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the correct password reveals the full phrase, and nothing logs it (#161)", async (env) => {
|
||||||
|
const console_ = [];
|
||||||
|
const listener = (msg) => console_.push(msg.text());
|
||||||
|
env.page.on("console", listener);
|
||||||
|
try {
|
||||||
|
await revealPhrase(env.page);
|
||||||
|
|
||||||
|
const st = await phraseScreenState(env.page);
|
||||||
|
assert(
|
||||||
|
st.value === env.phrase,
|
||||||
|
"the displayed phrase is not the wallet's phrase, verbatim",
|
||||||
|
);
|
||||||
|
const promptShown = await env.page.isVisible(
|
||||||
|
"#show-phrase-password-section",
|
||||||
|
);
|
||||||
|
assert(!promptShown, "the password prompt is still shown after unlock");
|
||||||
|
|
||||||
|
// Full Identifiers Policy: shown whole, and copyable.
|
||||||
|
const title = await env.page.getAttribute(
|
||||||
|
"#show-phrase-value",
|
||||||
|
"title",
|
||||||
|
);
|
||||||
|
assert(title === "Click to copy", "the phrase is not click-to-copy");
|
||||||
|
|
||||||
|
const leaked = console_.filter((line) => line.includes(env.phrase));
|
||||||
|
assert(
|
||||||
|
leaked.length === 0,
|
||||||
|
"the recovery phrase reached the console: " +
|
||||||
|
JSON.stringify(leaked),
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
env.page.off("console", listener);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test('"Back" wipes the revealed phrase (#161)', async (env) => {
|
||||||
|
await env.page.click("#btn-show-phrase-back");
|
||||||
|
await visible(env.page, "#view-settings");
|
||||||
|
const st = await phraseScreenState(env.page);
|
||||||
|
assert(st.viewHidden, "the recovery phrase screen is still on top");
|
||||||
|
assertWiped(st, env.phrase, "after Back");
|
||||||
|
});
|
||||||
|
|
||||||
|
// The settings gear leaves the screen without touching its Back button. A
|
||||||
|
// clear wired only to Back would pass the test above and leak here.
|
||||||
|
test("leaving by the settings gear wipes it too (#161)", async (env) => {
|
||||||
|
await openPhraseScreen(env.page);
|
||||||
|
await revealPhrase(env.page);
|
||||||
|
await env.page.click("#btn-settings");
|
||||||
|
await visible(env.page, "#view-settings");
|
||||||
|
const st = await phraseScreenState(env.page);
|
||||||
|
assertWiped(st, env.phrase, "after leaving via the settings gear");
|
||||||
|
});
|
||||||
|
|
||||||
|
// The same leave, but taken while the decrypt is still running. Both
|
||||||
|
// clicks are dispatched inside one page task on purpose: "Reveal" runs its
|
||||||
|
// handler up to the await, the gear then runs the leave — and the wipe with
|
||||||
|
// it — to completion, and the decrypt's continuation resumes afterwards.
|
||||||
|
// Without a liveness check that continuation writes the phrase into the
|
||||||
|
// hidden screen after the wipe, and nothing is left to wipe it again.
|
||||||
|
//
|
||||||
|
// A human cannot produce this interleaving by hand once libsodium's wasm is
|
||||||
|
// warm, because crypto_pwhash is synchronous and the only suspension point
|
||||||
|
// is a microtask; the window a user can actually hit is a still-pending
|
||||||
|
// sodium.ready on the first vault use of a page load. Forcing it here is
|
||||||
|
// the only way to test the guard deterministically.
|
||||||
|
test("leaving while the decrypt is in flight reveals nothing (#161)", async (env) => {
|
||||||
|
await openPhraseScreen(env.page);
|
||||||
|
await env.page.fill("#show-phrase-password", PASSWORD);
|
||||||
|
await env.page.evaluate(() => {
|
||||||
|
document.getElementById("btn-show-phrase-reveal").click();
|
||||||
|
document.getElementById("btn-settings").click();
|
||||||
|
});
|
||||||
|
await visible(env.page, "#view-settings");
|
||||||
|
|
||||||
|
// The Reveal button is disabled for exactly the duration of the
|
||||||
|
// decrypt and re-enabled in the same continuation that would have
|
||||||
|
// written the phrase, so waiting for it to come back is a precise
|
||||||
|
// "the decrypt has settled and its handler has finished" signal
|
||||||
|
// rather than a guess at a duration.
|
||||||
|
await env.page.waitForFunction(
|
||||||
|
() => !document.getElementById("btn-show-phrase-reveal").disabled,
|
||||||
|
null,
|
||||||
|
{ timeout: 60000 },
|
||||||
|
);
|
||||||
|
await sleep(2000);
|
||||||
|
|
||||||
|
const st = await phraseScreenState(env.page);
|
||||||
|
// Printed on every run, pass or fail: "the phrase is not there" is
|
||||||
|
// worth more as a measurement than as a silent assertion, and the
|
||||||
|
// same line read from a build without the guard is what this test
|
||||||
|
// exists to prevent.
|
||||||
|
console.log(
|
||||||
|
"# probe: len=" +
|
||||||
|
st.value.length +
|
||||||
|
" equalsPhrase=" +
|
||||||
|
(st.value === env.phrase) +
|
||||||
|
" resultHidden=" +
|
||||||
|
st.resultHidden +
|
||||||
|
" viewHidden=" +
|
||||||
|
st.viewHidden,
|
||||||
|
);
|
||||||
|
assert(st.viewHidden, "the recovery phrase screen is still on top");
|
||||||
|
assertWiped(st, env.phrase, "after leaving mid-decrypt");
|
||||||
|
});
|
||||||
|
|
||||||
|
// Closing and reopening the page rather than reloading it: that is what
|
||||||
|
// the toolbar popup actually does, and the persisted currentView is
|
||||||
|
// "show-phrase" at the moment it happens, which is precisely the state
|
||||||
|
// RESTORABLE_VIEWS has to refuse.
|
||||||
|
test("reopening the popup never lands on the phrase screen (#161)", async (env) => {
|
||||||
|
await openPhraseScreen(env.page);
|
||||||
|
await revealPhrase(env.page);
|
||||||
|
|
||||||
|
await env.page.close();
|
||||||
|
env.page = await openPopup(env.ctx, env.popupUrl);
|
||||||
|
await visible(env.page, "#view-main");
|
||||||
|
|
||||||
|
const st = await phraseScreenState(env.page);
|
||||||
|
assert(st.viewHidden, "the popup reopened onto the recovery phrase screen");
|
||||||
|
assertWiped(st, env.phrase, "after reopening the popup");
|
||||||
|
});
|
||||||
|
|
||||||
// ---------------------------------------------------------------- runner
|
// ---------------------------------------------------------------- runner
|
||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
@@ -154,6 +435,9 @@ async function main() {
|
|||||||
popupUrl: session.popupUrl,
|
popupUrl: session.popupUrl,
|
||||||
routeOpts,
|
routeOpts,
|
||||||
page: null,
|
page: null,
|
||||||
|
// The recovery phrase of the wallet created in test 2, so later
|
||||||
|
// tests can assert on the real secret rather than its shape.
|
||||||
|
phrase: null,
|
||||||
};
|
};
|
||||||
|
|
||||||
// Attribution of collected errors is total. session.errors has no
|
// Attribution of collected errors is total. session.errors has no
|
||||||
|
|||||||
108
tests/manifest.test.js
Normal file
108
tests/manifest.test.js
Normal file
@@ -0,0 +1,108 @@
|
|||||||
|
// The shipped Content Security Policy, pinned in both directions.
|
||||||
|
//
|
||||||
|
// This is the anti-regression check for #182. libsodium decides its
|
||||||
|
// backend by trying to compile WebAssembly and catching the failure, so a
|
||||||
|
// CSP that refuses WASM demotes the vault to the wasm2js translation —
|
||||||
|
// roughly 20x slower per Argon2id derivation — and says so only in a
|
||||||
|
// console message nobody reads. Dropping 'wasm-unsafe-eval' from either
|
||||||
|
// manifest therefore has to fail a check, not a log line.
|
||||||
|
//
|
||||||
|
// It is equally a check against loosening. 'wasm-unsafe-eval' is granted
|
||||||
|
// deliberately and narrowly (see the backend note in src/shared/vault.js);
|
||||||
|
// 'unsafe-eval', 'unsafe-inline' and any remote script source are not, and
|
||||||
|
// an exact match on the token set is what keeps the next edit from
|
||||||
|
// smuggling one in alongside.
|
||||||
|
//
|
||||||
|
// build.js copies these files to dist/<target>/manifest.json verbatim, so
|
||||||
|
// what is asserted here is what ships.
|
||||||
|
|
||||||
|
const fs = require("fs");
|
||||||
|
const path = require("path");
|
||||||
|
|
||||||
|
const MANIFEST_DIR = path.join(__dirname, "..", "manifest");
|
||||||
|
|
||||||
|
const EXPECTED_SCRIPT_SRC = ["'self'", "'wasm-unsafe-eval'"];
|
||||||
|
const EXPECTED_OBJECT_SRC = ["'self'"];
|
||||||
|
|
||||||
|
const FORBIDDEN_SOURCES = [
|
||||||
|
"'unsafe-eval'",
|
||||||
|
"'unsafe-inline'",
|
||||||
|
"http:",
|
||||||
|
"https:",
|
||||||
|
"data:",
|
||||||
|
"blob:",
|
||||||
|
"*",
|
||||||
|
];
|
||||||
|
|
||||||
|
function readManifest(name) {
|
||||||
|
return JSON.parse(
|
||||||
|
fs.readFileSync(path.join(MANIFEST_DIR, name + ".json"), "utf8"),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// "script-src 'self'; object-src 'self'" -> { "script-src": ["'self'"], ... }
|
||||||
|
function parseCsp(policy) {
|
||||||
|
const directives = {};
|
||||||
|
for (const part of policy.split(";")) {
|
||||||
|
const tokens = part.trim().split(/\s+/).filter(Boolean);
|
||||||
|
if (tokens.length === 0) continue;
|
||||||
|
directives[tokens[0]] = tokens.slice(1);
|
||||||
|
}
|
||||||
|
return directives;
|
||||||
|
}
|
||||||
|
|
||||||
|
function assertPolicy(policy) {
|
||||||
|
const directives = parseCsp(policy);
|
||||||
|
expect(Object.keys(directives).sort()).toEqual([
|
||||||
|
"object-src",
|
||||||
|
"script-src",
|
||||||
|
]);
|
||||||
|
expect(directives["script-src"].slice().sort()).toEqual(
|
||||||
|
EXPECTED_SCRIPT_SRC,
|
||||||
|
);
|
||||||
|
expect(directives["object-src"].slice().sort()).toEqual(
|
||||||
|
EXPECTED_OBJECT_SRC,
|
||||||
|
);
|
||||||
|
for (const source of FORBIDDEN_SOURCES) {
|
||||||
|
expect(directives["script-src"]).not.toContain(source);
|
||||||
|
expect(directives["object-src"]).not.toContain(source);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("shipped Content Security Policy", () => {
|
||||||
|
// MV3 takes an object and applies extension_pages to the popup and the
|
||||||
|
// background service worker, which is where libsodium runs.
|
||||||
|
test("chrome MV3 allows WASM and nothing else beyond 'self'", () => {
|
||||||
|
const csp = readManifest("chrome").content_security_policy;
|
||||||
|
expect(typeof csp).toBe("object");
|
||||||
|
expect(Object.keys(csp)).toEqual(["extension_pages"]);
|
||||||
|
assertPolicy(csp.extension_pages);
|
||||||
|
});
|
||||||
|
|
||||||
|
// MV2 takes the policy as a bare string. Firefox does not require
|
||||||
|
// 'wasm-unsafe-eval' for MV2 today — enforcement is report-only and
|
||||||
|
// Bugzilla 1770909 is still open — so this is future-proofing, not a
|
||||||
|
// mandate. It does not weaken anything under either baseline: Gecko's
|
||||||
|
// real MV2 default (extensions.webextensions.default-content-security-
|
||||||
|
// policy) is `script-src 'self' 'wasm-unsafe-eval';` with no object-src
|
||||||
|
// at all, so this string leaves script-src unchanged and ADDS
|
||||||
|
// object-src 'self', constraining <object>/<embed> sources that were
|
||||||
|
// previously unrestricted. Against MDN's documented MV2 default
|
||||||
|
// (`script-src 'self'; object-src 'self';`) it is a one-token loosening,
|
||||||
|
// identical to Chrome. Same policy, different manifest shape.
|
||||||
|
test("firefox MV2 allows WASM and nothing else beyond 'self'", () => {
|
||||||
|
const csp = readManifest("firefox").content_security_policy;
|
||||||
|
expect(typeof csp).toBe("string");
|
||||||
|
assertPolicy(csp);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The two targets share one codebase and one crypto path; a policy
|
||||||
|
// that drifts apart between them means one of the two builds is
|
||||||
|
// running a backend nothing tests.
|
||||||
|
test("both targets ship the same policy", () => {
|
||||||
|
const chrome =
|
||||||
|
readManifest("chrome").content_security_policy.extension_pages;
|
||||||
|
const firefox = readManifest("firefox").content_security_policy;
|
||||||
|
expect(firefox).toBe(chrome);
|
||||||
|
});
|
||||||
|
});
|
||||||
94
tests/showPhrase.test.js
Normal file
94
tests/showPhrase.test.js
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
// Tests for the recovery phrase display (issue #161).
|
||||||
|
//
|
||||||
|
// These cover the parts that do not need a DOM: which wallet types may be
|
||||||
|
// offered the action at all, the exclusion of the screen from the set of
|
||||||
|
// views the popup may reopen onto, and the absence of any path from this
|
||||||
|
// module to the logger. The DOM behaviour it guards — nothing rendered
|
||||||
|
// before the password is accepted, a wrong password revealing nothing, and
|
||||||
|
// the wipe on leaving — is driven against the real popup in a real browser
|
||||||
|
// by tests/e2e/run.js, which is where every other view behaviour is tested.
|
||||||
|
|
||||||
|
const fs = require("fs");
|
||||||
|
const path = require("path");
|
||||||
|
|
||||||
|
const { walletHasRecoveryPhrase } = require("../src/shared/wallet");
|
||||||
|
const { RESTORABLE_VIEWS } = require("../src/popup/restorableViews");
|
||||||
|
|
||||||
|
const SHOW_PHRASE_VIEW = "show-phrase";
|
||||||
|
|
||||||
|
// helpers.js pulls in state.js, which reads chrome.storage.local at load.
|
||||||
|
function loadHelpers() {
|
||||||
|
globalThis.chrome = {
|
||||||
|
storage: { local: { get: async () => ({}), set: async () => {} } },
|
||||||
|
};
|
||||||
|
return require("../src/popup/views/helpers");
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("which wallets have a recovery phrase", () => {
|
||||||
|
test("an HD wallet does", () => {
|
||||||
|
expect(walletHasRecoveryPhrase({ type: "hd" })).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
// A key wallet holds a bare private key and an xprv wallet an extended
|
||||||
|
// private key. Neither can be turned back into words, so neither may be
|
||||||
|
// offered the action.
|
||||||
|
test("a key wallet does not", () => {
|
||||||
|
expect(walletHasRecoveryPhrase({ type: "key" })).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an xprv wallet does not", () => {
|
||||||
|
expect(walletHasRecoveryPhrase({ type: "xprv" })).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an unknown or missing wallet type does not", () => {
|
||||||
|
expect(walletHasRecoveryPhrase({ type: "something-new" })).toBe(false);
|
||||||
|
expect(walletHasRecoveryPhrase({})).toBe(false);
|
||||||
|
expect(walletHasRecoveryPhrase(undefined)).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("views the popup may reopen onto", () => {
|
||||||
|
// Restoring onto a secret screen would put the phrase on screen with no
|
||||||
|
// password prompt in front of it, on a popup the user may have reopened
|
||||||
|
// by accident.
|
||||||
|
test("the recovery phrase screen is not restorable", () => {
|
||||||
|
expect(RESTORABLE_VIEWS.has(SHOW_PHRASE_VIEW)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the private key export screen is not restorable either", () => {
|
||||||
|
expect(RESTORABLE_VIEWS.has("export-privkey")).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the recovery phrase screen is still a registered view", () => {
|
||||||
|
const { VIEWS } = loadHelpers();
|
||||||
|
expect(VIEWS).toContain(SHOW_PHRASE_VIEW);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Guards the other direction: a restorable name that is not a real view
|
||||||
|
// would leave restoreView() showing nothing at all.
|
||||||
|
test("every restorable view is a registered view", () => {
|
||||||
|
const { VIEWS } = loadHelpers();
|
||||||
|
for (const view of RESTORABLE_VIEWS) {
|
||||||
|
expect(VIEWS).toContain(view);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the phrase cannot reach the logger", () => {
|
||||||
|
const source = fs.readFileSync(
|
||||||
|
path.join(__dirname, "..", "src", "popup", "views", "showPhrase.js"),
|
||||||
|
"utf8",
|
||||||
|
);
|
||||||
|
|
||||||
|
// The decrypted phrase only ever lives in a local and in the DOM node
|
||||||
|
// that displays it. The module has no logger to hand it to, and this
|
||||||
|
// pins that: src/shared/log.js writes to the console, and a console
|
||||||
|
// record of a recovery phrase outlives the popup.
|
||||||
|
test("the view does not import src/shared/log.js", () => {
|
||||||
|
expect(source).not.toMatch(/require\(["'][^"']*shared\/log["']\)/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the view calls no logger method", () => {
|
||||||
|
expect(source).not.toMatch(/\blog\.(debugf|infof|warnf|errorf)\b/);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -329,18 +329,42 @@ describe("known-symbol spoof verification", () => {
|
|||||||
expect(result.newFraudContracts).toEqual([]);
|
expect(result.newFraudContracts).toEqual([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Documents current behaviour, not desired behaviour: the spoof check
|
// Regression guard (#179): EIP-55 mixed case is a checksum over the
|
||||||
// compares tx.contractAddress against a lowercased known address with
|
// address, not part of its identity, so the contract comparison must be
|
||||||
// ===, so a caller passing a checksummed address for a genuine token has
|
// case-insensitive in both directions — a genuine token in any casing is
|
||||||
// it treated as a spoof. In the app this cannot happen because
|
// genuine, and a spoof cannot escape detection by changing its casing.
|
||||||
// parseTokenTransfer lowercases, but the exported function is not
|
test("a genuine contract in all-lowercase form is not a spoof", () => {
|
||||||
// defensive about it the way the blocklist check is.
|
const tx = tokenTx({ contractAddress: USDC_CONTRACT });
|
||||||
test("current behaviour: a checksummed genuine contract is treated as a spoof", () => {
|
expect(filterTransactions([tx], filters()).transactions).toEqual([tx]);
|
||||||
const genuineButChecksummed = tokenTx({
|
});
|
||||||
|
|
||||||
|
test("a genuine contract in EIP-55 checksummed form is not a spoof", () => {
|
||||||
|
const tx = tokenTx({
|
||||||
contractAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
|
contractAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
|
||||||
});
|
});
|
||||||
const result = filterTransactions([genuineButChecksummed], filters());
|
const result = filterTransactions([tx], filters());
|
||||||
|
expect(result.transactions).toEqual([tx]);
|
||||||
|
expect(result.newFraudContracts).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a genuine contract in all-uppercase form is not a spoof", () => {
|
||||||
|
const tx = tokenTx({
|
||||||
|
contractAddress: "0X" + USDC_CONTRACT.slice(2).toUpperCase(),
|
||||||
|
});
|
||||||
|
const result = filterTransactions([tx], filters());
|
||||||
|
expect(result.transactions).toEqual([tx]);
|
||||||
|
expect(result.newFraudContracts).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a genuinely different contract claiming USDC is still a spoof in any casing", () => {
|
||||||
|
const tx = tokenTx({
|
||||||
|
contractAddress: "0xD05339F9EA5AB9D9F03B9D57F671D2ABD1F55C82",
|
||||||
|
});
|
||||||
|
const result = filterTransactions([tx], filters());
|
||||||
expect(result.transactions).toEqual([]);
|
expect(result.transactions).toEqual([]);
|
||||||
|
// The recorded fraud contract is normalised, so the persisted
|
||||||
|
// blocklist matches later transfers whatever casing they arrive in.
|
||||||
|
expect(result.newFraudContracts).toEqual([FAKE_ETH_CONTRACT]);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Documents current behaviour: README.md:810-814 says all four filters
|
// Documents current behaviour: README.md:810-814 says all four filters
|
||||||
@@ -412,6 +436,21 @@ describe("low-holder token filtering (the 1,000-holder rule)", () => {
|
|||||||
expect(tx.holders).toBeNull();
|
expect(tx.holders).toBeNull();
|
||||||
expect(filterTransactions([tx], filters()).transactions).toEqual([tx]);
|
expect(filterTransactions([tx], filters()).transactions).toEqual([tx]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Regression guard (#179): an unknown holder count on a real token — the
|
||||||
|
// explorer rate-limited the call, or a self-hosted instance omits the
|
||||||
|
// field — must not be read as zero holders. Reading it that way hides a
|
||||||
|
// legitimate transfer from the user's history, the same over-filtering
|
||||||
|
// harm as the zero-threshold bug. This pins the `tx.holders !== null`
|
||||||
|
// guard, which no fixture previously reached.
|
||||||
|
test("a token whose holder count is unknown is not filtered", () => {
|
||||||
|
const tx = tokenTx({
|
||||||
|
symbol: NOVEL_SPAM_SYMBOL,
|
||||||
|
contractAddress: NOVEL_SPAM_CONTRACT,
|
||||||
|
holders: null,
|
||||||
|
});
|
||||||
|
expect(filterTransactions([tx], filters()).transactions).toEqual([tx]);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("fraud contract blocklist", () => {
|
describe("fraud contract blocklist", () => {
|
||||||
@@ -575,16 +614,50 @@ describe("dust threshold filtering", () => {
|
|||||||
expect(filterTransactions([tx], filters()).transactions).toEqual([tx]);
|
expect(filterTransactions([tx], filters()).transactions).toEqual([tx]);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Documents current behaviour: the threshold is read as
|
// Regression guard (#179): 0 is a real threshold meaning "hide nothing",
|
||||||
// `filters.dustThresholdGwei || 100000`, so a user who sets the threshold
|
// not an absent one. It used to be swallowed by `|| 100000`, so the one
|
||||||
// to 0 (the natural way to ask for no dust filtering while leaving the
|
// value a user would pick to see everything was the one that did not
|
||||||
// toggle on) silently gets the 100,000 gwei default instead.
|
// work.
|
||||||
test("current behaviour: a threshold of 0 falls back to the 100,000 gwei default", () => {
|
test("a threshold of 0 hides nothing, leaving the toggle on", () => {
|
||||||
const result = filterTransactions(
|
const dust = dustOf(50);
|
||||||
[dustOf(50)],
|
const zero = dustOf(0);
|
||||||
|
const opts = filters({ dustThresholdGwei: 0 });
|
||||||
|
expect(filterTransactions([dust], opts).transactions).toEqual([dust]);
|
||||||
|
expect(filterTransactions([zero], opts).transactions).toEqual([zero]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a threshold of 0 agrees with clearing the hide-dust checkbox", () => {
|
||||||
|
const tx = nativeDustTransfer();
|
||||||
|
const thresholdZero = filterTransactions(
|
||||||
|
[tx],
|
||||||
filters({ dustThresholdGwei: 0 }),
|
filters({ dustThresholdGwei: 0 }),
|
||||||
);
|
);
|
||||||
expect(result.transactions).toEqual([]);
|
const toggleOff = filterTransactions(
|
||||||
|
[tx],
|
||||||
|
filters({ hideDustTransactions: false }),
|
||||||
|
);
|
||||||
|
expect(thresholdZero.transactions).toEqual([tx]);
|
||||||
|
expect(toggleOff.transactions).toEqual([tx]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("0, unset and a set threshold are three distinct behaviours", () => {
|
||||||
|
const tx = dustOf(50);
|
||||||
|
expect(
|
||||||
|
filterTransactions([tx], filters({ dustThresholdGwei: 0 }))
|
||||||
|
.transactions,
|
||||||
|
).toEqual([tx]);
|
||||||
|
expect(
|
||||||
|
filterTransactions([tx], filters({ dustThresholdGwei: undefined }))
|
||||||
|
.transactions,
|
||||||
|
).toEqual([]);
|
||||||
|
expect(
|
||||||
|
filterTransactions([tx], filters({ dustThresholdGwei: 40 }))
|
||||||
|
.transactions,
|
||||||
|
).toEqual([tx]);
|
||||||
|
expect(
|
||||||
|
filterTransactions([tx], filters({ dustThresholdGwei: 60 }))
|
||||||
|
.transactions,
|
||||||
|
).toEqual([]);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
346
tests/vault.test.js
Normal file
346
tests/vault.test.js
Normal file
@@ -0,0 +1,346 @@
|
|||||||
|
// Tests for src/shared/vault.js: the Argon2id + XSalsa20-Poly1305 encryption
|
||||||
|
// that protects recovery phrases and private keys at rest.
|
||||||
|
//
|
||||||
|
// The properties that matter here are the ones whose failure is silent. A
|
||||||
|
// vault that decrypts under the wrong password, that hands back plaintext from
|
||||||
|
// a ciphertext an attacker edited, that reuses a nonce, or that leaves the
|
||||||
|
// recovery phrase readable somewhere in the stored blob all look exactly like
|
||||||
|
// a working vault from the UI. So each test below asserts a negative: the
|
||||||
|
// thing that must not happen.
|
||||||
|
//
|
||||||
|
// Cost: every encrypt and decrypt runs one Argon2id pwhash at the production
|
||||||
|
// interactive parameters, which the module hardcodes. The parameters are not
|
||||||
|
// weakened or overridden anywhere in this file — they are pinned by the "key
|
||||||
|
// derivation cost" tests, since they are the vault's only defence against an
|
||||||
|
// offline attack on a stolen blob. The suite is kept inside script/test's
|
||||||
|
// 30-second budget by sharing one encrypted fixture across the tamper cases
|
||||||
|
// instead of re-encrypting per test.
|
||||||
|
|
||||||
|
const sodium = require("libsodium-wrappers-sumo");
|
||||||
|
const {
|
||||||
|
encryptWithPassword,
|
||||||
|
decryptWithPassword,
|
||||||
|
} = require("../src/shared/vault");
|
||||||
|
|
||||||
|
// A publicly known development phrase. Never fund it.
|
||||||
|
const SECRET = "test test test test test test test test test test test junk";
|
||||||
|
const PASSWORD = "correct horse battery staple";
|
||||||
|
const WRONG_PASSWORD = "correct horse battery stapl";
|
||||||
|
|
||||||
|
const SALT_BYTES = 16;
|
||||||
|
const NONCE_BYTES = 24;
|
||||||
|
const POLY1305_TAG_BYTES = 16;
|
||||||
|
|
||||||
|
const BASE64 = /^[A-Za-z0-9+/_-]+={0,2}$/;
|
||||||
|
|
||||||
|
function b64decode(s) {
|
||||||
|
return sodium.from_base64(s);
|
||||||
|
}
|
||||||
|
|
||||||
|
// A shallow copy with one field replaced, so the shared fixture is never
|
||||||
|
// mutated by a tamper test.
|
||||||
|
function withField(blob, field, value) {
|
||||||
|
return { ...blob, [field]: value };
|
||||||
|
}
|
||||||
|
|
||||||
|
// Flip the low bit of one byte of a base64-encoded field.
|
||||||
|
function flipByte(b64, index) {
|
||||||
|
const bytes = b64decode(b64);
|
||||||
|
bytes[index] ^= 0x01;
|
||||||
|
return sodium.to_base64(bytes);
|
||||||
|
}
|
||||||
|
|
||||||
|
let vault;
|
||||||
|
|
||||||
|
beforeAll(async () => {
|
||||||
|
await sodium.ready;
|
||||||
|
vault = await encryptWithPassword(SECRET, PASSWORD);
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("stored blob shape", () => {
|
||||||
|
test("is exactly the documented { salt, nonce, ciphertext }", () => {
|
||||||
|
expect(Object.keys(vault).sort()).toEqual([
|
||||||
|
"ciphertext",
|
||||||
|
"nonce",
|
||||||
|
"salt",
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("every field is a base64 string", () => {
|
||||||
|
for (const field of ["salt", "nonce", "ciphertext"]) {
|
||||||
|
expect(typeof vault[field]).toBe("string");
|
||||||
|
expect(vault[field]).toMatch(BASE64);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("salt and nonce are full length", () => {
|
||||||
|
expect(b64decode(vault.salt)).toHaveLength(SALT_BYTES);
|
||||||
|
expect(b64decode(vault.nonce)).toHaveLength(NONCE_BYTES);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("ciphertext carries a Poly1305 authentication tag", () => {
|
||||||
|
expect(b64decode(vault.ciphertext)).toHaveLength(
|
||||||
|
SECRET.length + POLY1305_TAG_BYTES,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the blob survives JSON storage unchanged", async () => {
|
||||||
|
const stored = JSON.parse(JSON.stringify(vault));
|
||||||
|
|
||||||
|
await expect(decryptWithPassword(stored, PASSWORD)).resolves.toBe(
|
||||||
|
SECRET,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("no plaintext leakage", () => {
|
||||||
|
test("the secret does not appear in the serialized vault", () => {
|
||||||
|
const serialized = JSON.stringify(vault);
|
||||||
|
|
||||||
|
expect(serialized).not.toContain(SECRET);
|
||||||
|
for (const word of new Set(SECRET.split(" "))) {
|
||||||
|
expect(serialized).not.toContain(word);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the ciphertext bytes do not contain the secret bytes", () => {
|
||||||
|
const bytes = Buffer.from(b64decode(vault.ciphertext));
|
||||||
|
|
||||||
|
expect(bytes.includes(Buffer.from(SECRET, "utf8"))).toBe(false);
|
||||||
|
// Not even the first word, which would betray an unencrypted prefix.
|
||||||
|
expect(bytes.includes(Buffer.from("test test", "utf8"))).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the password does not appear in the serialized vault", () => {
|
||||||
|
expect(JSON.stringify(vault)).not.toContain(PASSWORD);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("round trip", () => {
|
||||||
|
test("decrypts back to the original secret", async () => {
|
||||||
|
await expect(decryptWithPassword(vault, PASSWORD)).resolves.toBe(
|
||||||
|
SECRET,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("survives a non-ASCII plaintext byte for byte", async () => {
|
||||||
|
const unicode = "recovery phrase é中文\u{1f600}";
|
||||||
|
|
||||||
|
const blob = await encryptWithPassword(unicode, PASSWORD);
|
||||||
|
|
||||||
|
await expect(decryptWithPassword(blob, PASSWORD)).resolves.toBe(
|
||||||
|
unicode,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an empty password still round-trips and is not a bypass", async () => {
|
||||||
|
const blob = await encryptWithPassword(SECRET, "");
|
||||||
|
|
||||||
|
await expect(decryptWithPassword(blob, "")).resolves.toBe(SECRET);
|
||||||
|
// An empty password must not act as a skeleton key on other vaults,
|
||||||
|
// nor may a real password open an empty-password vault.
|
||||||
|
await expect(decryptWithPassword(vault, "")).rejects.toThrow();
|
||||||
|
await expect(decryptWithPassword(blob, PASSWORD)).rejects.toThrow();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("fresh salt and nonce", () => {
|
||||||
|
test("two encryptions of the same plaintext differ in all three fields", async () => {
|
||||||
|
const second = await encryptWithPassword(SECRET, PASSWORD);
|
||||||
|
|
||||||
|
expect(second.salt).not.toBe(vault.salt);
|
||||||
|
expect(second.nonce).not.toBe(vault.nonce);
|
||||||
|
expect(second.ciphertext).not.toBe(vault.ciphertext);
|
||||||
|
await expect(decryptWithPassword(second, PASSWORD)).resolves.toBe(
|
||||||
|
SECRET,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("key derivation cost", () => {
|
||||||
|
// Argon2id's opslimit and memlimit are the whole of the vault's resistance
|
||||||
|
// to an offline attack on a stolen blob, and lowering them breaks nothing
|
||||||
|
// any other test here can see — the suite merely runs faster. So pin them
|
||||||
|
// directly, both to libsodium's INTERACTIVE constants and to the absolute
|
||||||
|
// values those constants must keep meaning.
|
||||||
|
const INTERACTIVE_OPSLIMIT = 2;
|
||||||
|
const INTERACTIVE_MEMLIMIT = 64 * 1024 * 1024;
|
||||||
|
|
||||||
|
test("the interactive constants still mean 2 passes over 64 MiB", () => {
|
||||||
|
expect(sodium.crypto_pwhash_OPSLIMIT_INTERACTIVE).toBe(
|
||||||
|
INTERACTIVE_OPSLIMIT,
|
||||||
|
);
|
||||||
|
expect(sodium.crypto_pwhash_MEMLIMIT_INTERACTIVE).toBe(
|
||||||
|
INTERACTIVE_MEMLIMIT,
|
||||||
|
);
|
||||||
|
// The floor these must never quietly be swapped for: _MIN is one pass
|
||||||
|
// over 8 KiB, an 8192x reduction in memory cost.
|
||||||
|
expect(sodium.crypto_pwhash_OPSLIMIT_MIN).toBeLessThan(
|
||||||
|
INTERACTIVE_OPSLIMIT,
|
||||||
|
);
|
||||||
|
expect(sodium.crypto_pwhash_MEMLIMIT_MIN).toBeLessThan(
|
||||||
|
INTERACTIVE_MEMLIMIT,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a key derived at the interactive parameters opens the vault", () => {
|
||||||
|
// Independent of any spy, and of the module's own code path: derive
|
||||||
|
// the key here from the vault's published salt at the interactive cost
|
||||||
|
// and open its ciphertext directly. A vault whose key came from any
|
||||||
|
// other opslimit, memlimit or Argon2id variant yields a different key
|
||||||
|
// and cannot be opened this way.
|
||||||
|
const key = sodium.crypto_pwhash(
|
||||||
|
sodium.crypto_secretbox_KEYBYTES,
|
||||||
|
PASSWORD,
|
||||||
|
b64decode(vault.salt),
|
||||||
|
INTERACTIVE_OPSLIMIT,
|
||||||
|
INTERACTIVE_MEMLIMIT,
|
||||||
|
sodium.crypto_pwhash_ALG_ARGON2ID13,
|
||||||
|
);
|
||||||
|
const opened = sodium.crypto_secretbox_open_easy(
|
||||||
|
b64decode(vault.ciphertext),
|
||||||
|
b64decode(vault.nonce),
|
||||||
|
key,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(sodium.to_string(opened)).toBe(SECRET);
|
||||||
|
});
|
||||||
|
|
||||||
|
test.each([
|
||||||
|
[
|
||||||
|
"encrypt",
|
||||||
|
async () => {
|
||||||
|
await encryptWithPassword(SECRET, PASSWORD);
|
||||||
|
},
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"decrypt",
|
||||||
|
async () => {
|
||||||
|
await decryptWithPassword(vault, PASSWORD);
|
||||||
|
},
|
||||||
|
],
|
||||||
|
])("%s derives exactly one key at the interactive cost", async (_, run) => {
|
||||||
|
const spy = jest.spyOn(sodium, "crypto_pwhash");
|
||||||
|
try {
|
||||||
|
await run();
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(1);
|
||||||
|
const [keyBytes, , salt, opslimit, memlimit, alg] =
|
||||||
|
spy.mock.calls[0];
|
||||||
|
expect(keyBytes).toBe(sodium.crypto_secretbox_KEYBYTES);
|
||||||
|
expect(salt).toHaveLength(SALT_BYTES);
|
||||||
|
expect(opslimit).toBe(sodium.crypto_pwhash_OPSLIMIT_INTERACTIVE);
|
||||||
|
expect(memlimit).toBe(sodium.crypto_pwhash_MEMLIMIT_INTERACTIVE);
|
||||||
|
expect(alg).toBe(sodium.crypto_pwhash_ALG_ARGON2ID13);
|
||||||
|
} finally {
|
||||||
|
spy.mockRestore();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("wrong password", () => {
|
||||||
|
test("is rejected, and rejects cleanly", async () => {
|
||||||
|
// rejects.toThrow asserts a rejected promise, not a synchronous throw
|
||||||
|
// and not an unhandled rejection: the caller can catch this.
|
||||||
|
await expect(
|
||||||
|
decryptWithPassword(vault, WRONG_PASSWORD),
|
||||||
|
).rejects.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("returns no plaintext, not even partially", async () => {
|
||||||
|
const result = await decryptWithPassword(vault, WRONG_PASSWORD).catch(
|
||||||
|
(err) => err,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(result).toBeInstanceOf(Error);
|
||||||
|
expect(String(result)).not.toContain("test");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the empty password is rejected on a password-protected vault", async () => {
|
||||||
|
await expect(decryptWithPassword(vault, "")).rejects.toThrow();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("tampering", () => {
|
||||||
|
test("a flipped ciphertext bit is rejected by the auth tag", async () => {
|
||||||
|
const tampered = withField(
|
||||||
|
vault,
|
||||||
|
"ciphertext",
|
||||||
|
flipByte(vault.ciphertext, 0),
|
||||||
|
);
|
||||||
|
|
||||||
|
await expect(decryptWithPassword(tampered, PASSWORD)).rejects.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a flipped bit in the authentication tag itself is rejected", async () => {
|
||||||
|
const tagStart = b64decode(vault.ciphertext).length - 1;
|
||||||
|
const tampered = withField(
|
||||||
|
vault,
|
||||||
|
"ciphertext",
|
||||||
|
flipByte(vault.ciphertext, tagStart),
|
||||||
|
);
|
||||||
|
|
||||||
|
await expect(decryptWithPassword(tampered, PASSWORD)).rejects.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a flipped nonce bit is rejected", async () => {
|
||||||
|
const tampered = withField(vault, "nonce", flipByte(vault.nonce, 0));
|
||||||
|
|
||||||
|
await expect(decryptWithPassword(tampered, PASSWORD)).rejects.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a flipped salt bit is rejected", async () => {
|
||||||
|
const tampered = withField(vault, "salt", flipByte(vault.salt, 0));
|
||||||
|
|
||||||
|
await expect(decryptWithPassword(tampered, PASSWORD)).rejects.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a truncated ciphertext is rejected", async () => {
|
||||||
|
const bytes = b64decode(vault.ciphertext);
|
||||||
|
const tampered = withField(
|
||||||
|
vault,
|
||||||
|
"ciphertext",
|
||||||
|
sodium.to_base64(bytes.slice(0, bytes.length - 4)),
|
||||||
|
);
|
||||||
|
|
||||||
|
await expect(decryptWithPassword(tampered, PASSWORD)).rejects.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a ciphertext shorter than the auth tag is rejected", async () => {
|
||||||
|
const tampered = withField(
|
||||||
|
vault,
|
||||||
|
"ciphertext",
|
||||||
|
sodium.to_base64(b64decode(vault.ciphertext).slice(0, 4)),
|
||||||
|
);
|
||||||
|
|
||||||
|
await expect(decryptWithPassword(tampered, PASSWORD)).rejects.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a truncated nonce is rejected", async () => {
|
||||||
|
const tampered = withField(
|
||||||
|
vault,
|
||||||
|
"nonce",
|
||||||
|
sodium.to_base64(b64decode(vault.nonce).slice(0, NONCE_BYTES - 1)),
|
||||||
|
);
|
||||||
|
|
||||||
|
await expect(decryptWithPassword(tampered, PASSWORD)).rejects.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a ciphertext from another vault is rejected", async () => {
|
||||||
|
const other = await encryptWithPassword("a different secret", PASSWORD);
|
||||||
|
const spliced = withField(vault, "ciphertext", other.ciphertext);
|
||||||
|
|
||||||
|
await expect(decryptWithPassword(spliced, PASSWORD)).rejects.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a missing field is rejected rather than decrypted", async () => {
|
||||||
|
for (const field of ["salt", "nonce", "ciphertext"]) {
|
||||||
|
const broken = { ...vault };
|
||||||
|
delete broken[field];
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
decryptWithPassword(broken, PASSWORD),
|
||||||
|
).rejects.toThrow();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
52
tests/vaultBackend.test.js
Normal file
52
tests/vaultBackend.test.js
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
// The unit tests must exercise the libsodium backend that actually ships
|
||||||
|
// (#182). Before this, they could not: node compiles WebAssembly happily,
|
||||||
|
// the extension CSP refused it, and so the browser silently ran the
|
||||||
|
// wasm2js translation while every test ran the WASM build.
|
||||||
|
//
|
||||||
|
// With 'wasm-unsafe-eval' in both manifests the two agree, and these tests
|
||||||
|
// hold that agreement in place from the node side. tests/manifest.test.js
|
||||||
|
// holds up the CSP end of it, and the end-to-end suite observes the real
|
||||||
|
// popup.
|
||||||
|
|
||||||
|
const { cryptoBackend } = require("../src/shared/vault");
|
||||||
|
|
||||||
|
// The module libsodium-wrappers-sumo itself requires and drives. Not a new
|
||||||
|
// dependency: it is inspected here, never used to perform crypto, because
|
||||||
|
// it is the only thing that can say which backend is loaded.
|
||||||
|
const SODIUM_CORE = "libsodium-sumo";
|
||||||
|
|
||||||
|
describe("libsodium backend", () => {
|
||||||
|
test("this realm compiles WebAssembly, so the tests run the WASM build", async () => {
|
||||||
|
await expect(cryptoBackend()).resolves.toBe("wasm");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("libsodium did not swap in the wasm2js fallback", async () => {
|
||||||
|
const core = require(SODIUM_CORE);
|
||||||
|
await require("libsodium-wrappers-sumo").ready;
|
||||||
|
// useBackupModule is the entry point to the fallback; taking it
|
||||||
|
// replaces the module's exports with the translation's, and the
|
||||||
|
// entry point goes with them. Still present after ready means the
|
||||||
|
// WASM module is the one in place. The test below is what keeps
|
||||||
|
// that inference honest.
|
||||||
|
expect(typeof core.useBackupModule).toBe("function");
|
||||||
|
});
|
||||||
|
|
||||||
|
// Deliberately last, and deliberately destructive: it takes the
|
||||||
|
// fallback, which replaces the loaded module for the rest of this
|
||||||
|
// file. Jest gives each test file its own module registry, so nothing
|
||||||
|
// outside sees it.
|
||||||
|
//
|
||||||
|
// Without this, the check above would be a claim about libsodium's
|
||||||
|
// internals with nothing holding it to account: if a future version
|
||||||
|
// kept useBackupModule on the fallback module too, the marker would
|
||||||
|
// quietly become true in both backends and the test would pass while
|
||||||
|
// measuring nothing. Forcing the fallback and watching the marker
|
||||||
|
// disappear is what makes its presence mean something.
|
||||||
|
test("the fallback marker distinguishes the two backends", async () => {
|
||||||
|
const core = require(SODIUM_CORE);
|
||||||
|
await require("libsodium-wrappers-sumo").ready;
|
||||||
|
expect(typeof core.useBackupModule).toBe("function");
|
||||||
|
await core.useBackupModule();
|
||||||
|
expect(typeof core.useBackupModule).toBe("undefined");
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,4 +1,6 @@
|
|||||||
// Tests for the DEBUG build flag as it gates mnemonic generation.
|
// Tests for src/shared/wallet.js: the DEBUG build flag as it gates mnemonic
|
||||||
|
// generation (first two describes), and HD key derivation against published
|
||||||
|
// known-answer vectors (rest of the file).
|
||||||
//
|
//
|
||||||
// The modules read the __BUILD_DEBUG__ global that esbuild replaces at bundle
|
// The modules read the __BUILD_DEBUG__ global that esbuild replaces at bundle
|
||||||
// time. Under jest the global is absent, which is exactly the release-build
|
// time. Under jest the global is absent, which is exactly the release-build
|
||||||
@@ -92,3 +94,317 @@ describe("generateMnemonic in a debug build", () => {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Key derivation.
|
||||||
|
//
|
||||||
|
// Every address below is a published constant, not something this codebase
|
||||||
|
// produced. Asserting against what the implementation happens to return today
|
||||||
|
// would pass just as happily with the wrong coin type, the wrong path depth or
|
||||||
|
// a non-empty seed passphrase, all of which silently send funds to addresses
|
||||||
|
// no other wallet can recover.
|
||||||
|
//
|
||||||
|
// Vector sources:
|
||||||
|
//
|
||||||
|
// VECTOR_PHRASE / VECTOR_ADDRESSES / VECTOR_PRIVATE_KEYS — the standard
|
||||||
|
// development recovery phrase and the first three accounts it yields at
|
||||||
|
// m/44'/60'/0'/0/n with an empty seed passphrase, as published in the
|
||||||
|
// Hardhat and Ganache documentation. Publicly known; never fund it.
|
||||||
|
//
|
||||||
|
// ZERO_ENTROPY_PHRASE / ZERO_ENTROPY_ADDRESS — the BIP-39 all-zero-entropy
|
||||||
|
// phrase (Trezor's official BIP-39 vector set, first entry) and its
|
||||||
|
// m/44'/60'/0'/0/0 Ethereum address with an empty seed passphrase. A second,
|
||||||
|
// independently published phrase so the pin is not one vector deep.
|
||||||
|
//
|
||||||
|
// BIP32_VECTOR_1_XPRV — the master key of BIP-32 test vector 1
|
||||||
|
// (seed 000102030405060708090a0b0c0d0e0f).
|
||||||
|
//
|
||||||
|
// The two Hardhat facts cross-check each other: VECTOR_PRIVATE_KEYS[n] is the
|
||||||
|
// published key for VECTOR_ADDRESSES[n], so addressFromPrivateKey and the HD
|
||||||
|
// path must meet at the same address from two different directions.
|
||||||
|
|
||||||
|
const { HDNodeWallet, Mnemonic, verifyMessage } = require("ethers");
|
||||||
|
const wallet = require("../src/shared/wallet");
|
||||||
|
const { BIP44_ETH_PATH } = require("../src/shared/constants");
|
||||||
|
|
||||||
|
const VECTOR_PHRASE =
|
||||||
|
"test test test test test test test test test test test junk";
|
||||||
|
|
||||||
|
const VECTOR_ADDRESSES = [
|
||||||
|
"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
|
||||||
|
"0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
|
||||||
|
"0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC",
|
||||||
|
];
|
||||||
|
|
||||||
|
const VECTOR_PRIVATE_KEYS = [
|
||||||
|
"0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80",
|
||||||
|
"0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d",
|
||||||
|
"0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a",
|
||||||
|
];
|
||||||
|
|
||||||
|
const ZERO_ENTROPY_PHRASE =
|
||||||
|
"abandon abandon abandon abandon abandon abandon " +
|
||||||
|
"abandon abandon abandon abandon abandon about";
|
||||||
|
const ZERO_ENTROPY_ADDRESS = "0x9858EfFD232B4033E47d90003D41EC34EcaEda94";
|
||||||
|
|
||||||
|
const BIP32_VECTOR_1_XPRV =
|
||||||
|
"xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqji" +
|
||||||
|
"ChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi";
|
||||||
|
|
||||||
|
// The master (depth-0) extended private key for a phrase, which is what the
|
||||||
|
// import-an-xprv flow is handed. Built with ethers rather than with the module
|
||||||
|
// under test, so hdWalletFromXprv is not being checked against itself.
|
||||||
|
function masterXprv(phrase, passphrase = "") {
|
||||||
|
return HDNodeWallet.fromSeed(
|
||||||
|
Mnemonic.fromPhrase(phrase, passphrase).computeSeed(),
|
||||||
|
).extendedKey;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("hdWalletFromMnemonic", () => {
|
||||||
|
test("first address matches the published vector for m/44'/60'/0'/0/0", () => {
|
||||||
|
expect(wallet.hdWalletFromMnemonic(VECTOR_PHRASE).firstAddress).toBe(
|
||||||
|
VECTOR_ADDRESSES[0],
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("second published phrase derives its published address", () => {
|
||||||
|
expect(
|
||||||
|
wallet.hdWalletFromMnemonic(ZERO_ENTROPY_PHRASE).firstAddress,
|
||||||
|
).toBe(ZERO_ENTROPY_ADDRESS);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("returns the account-level xpub, which is watch-only", () => {
|
||||||
|
const { xpub } = wallet.hdWalletFromMnemonic(VECTOR_PHRASE);
|
||||||
|
|
||||||
|
expect(xpub.startsWith("xpub")).toBe(true);
|
||||||
|
// A neutered ethers node exposes no private key at all, so accept
|
||||||
|
// either absent or null rather than pinning which.
|
||||||
|
expect(
|
||||||
|
HDNodeWallet.fromExtendedKey(xpub).privateKey ?? null,
|
||||||
|
).toBeNull();
|
||||||
|
expect(wallet.isValidXprv(xpub)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the account path is the documented BIP-44 Ethereum path", () => {
|
||||||
|
expect(BIP44_ETH_PATH).toBe("m/44'/60'/0'/0");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("rejects an invalid recovery phrase rather than deriving from it", () => {
|
||||||
|
expect(() => wallet.hdWalletFromMnemonic("not a phrase")).toThrow();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("deriveAddressFromXpub", () => {
|
||||||
|
const { xpub } = wallet.hdWalletFromMnemonic(VECTOR_PHRASE);
|
||||||
|
|
||||||
|
test.each([0, 1, 2])(
|
||||||
|
"child %i matches the published vector address",
|
||||||
|
(index) => {
|
||||||
|
expect(wallet.deriveAddressFromXpub(xpub, index)).toBe(
|
||||||
|
VECTOR_ADDRESSES[index],
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
test("agrees with hdWalletFromMnemonic at index 0", () => {
|
||||||
|
expect(wallet.deriveAddressFromXpub(xpub, 0)).toBe(
|
||||||
|
wallet.hdWalletFromMnemonic(VECTOR_PHRASE).firstAddress,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("rejects garbage instead of returning an address", () => {
|
||||||
|
expect(() =>
|
||||||
|
wallet.deriveAddressFromXpub("xpub-nonsense", 0),
|
||||||
|
).toThrow();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("hdWalletFromMnemonic seed passphrase handling", () => {
|
||||||
|
// The vectors above are only reproducible with an empty BIP-39 seed
|
||||||
|
// passphrase. This pins that the empty string reaching
|
||||||
|
// HDNodeWallet.fromPhrase is load-bearing: with any passphrase applied the
|
||||||
|
// published address is unreachable, and a wallet derived that way could
|
||||||
|
// not be restored anywhere else from the phrase alone.
|
||||||
|
test("a non-empty seed passphrase would yield a different address", () => {
|
||||||
|
const withPassphrase = HDNodeWallet.fromPhrase(
|
||||||
|
VECTOR_PHRASE,
|
||||||
|
"TREZOR",
|
||||||
|
BIP44_ETH_PATH,
|
||||||
|
).deriveChild(0).address;
|
||||||
|
|
||||||
|
expect(withPassphrase).not.toBe(VECTOR_ADDRESSES[0]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("hdWalletFromXprv", () => {
|
||||||
|
// hdWalletFromMnemonic derives the absolute path "m/44'/60'/0'/0" while
|
||||||
|
// hdWalletFromXprv derives the relative path "44'/60'/0'/0". For a
|
||||||
|
// depth-0 master key the two are the same derivation; these tests pin that
|
||||||
|
// equivalence to a published address rather than assuming it.
|
||||||
|
test("master xprv for the vector phrase yields the vector address", () => {
|
||||||
|
expect(
|
||||||
|
wallet.hdWalletFromXprv(masterXprv(VECTOR_PHRASE)).firstAddress,
|
||||||
|
).toBe(VECTOR_ADDRESSES[0]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("agrees with hdWalletFromMnemonic on xpub and address", () => {
|
||||||
|
const fromPhrase = wallet.hdWalletFromMnemonic(VECTOR_PHRASE);
|
||||||
|
const fromXprv = wallet.hdWalletFromXprv(masterXprv(VECTOR_PHRASE));
|
||||||
|
|
||||||
|
expect(fromXprv).toEqual(fromPhrase);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("derived xpub generates the same child addresses", () => {
|
||||||
|
const { xpub } = wallet.hdWalletFromXprv(masterXprv(VECTOR_PHRASE));
|
||||||
|
|
||||||
|
expect(
|
||||||
|
[0, 1, 2].map((i) => wallet.deriveAddressFromXpub(xpub, i)),
|
||||||
|
).toEqual(VECTOR_ADDRESSES);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("accepts the BIP-32 test vector 1 master key", () => {
|
||||||
|
const { xpub, firstAddress } =
|
||||||
|
wallet.hdWalletFromXprv(BIP32_VECTOR_1_XPRV);
|
||||||
|
|
||||||
|
expect(xpub.startsWith("xpub")).toBe(true);
|
||||||
|
expect(firstAddress).toMatch(/^0x[0-9a-fA-F]{40}$/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("rejects a watch-only xpub", () => {
|
||||||
|
const { xpub } = wallet.hdWalletFromMnemonic(VECTOR_PHRASE);
|
||||||
|
|
||||||
|
expect(() => wallet.hdWalletFromXprv(xpub)).toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("rejects garbage", () => {
|
||||||
|
expect(() => wallet.hdWalletFromXprv("nonsense")).toThrow();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("isValidXprv", () => {
|
||||||
|
test.each([
|
||||||
|
["BIP-32 test vector 1 master key", BIP32_VECTOR_1_XPRV, true],
|
||||||
|
["the empty string", "", false],
|
||||||
|
["garbage", "not-a-key", false],
|
||||||
|
["a bare private key", VECTOR_PRIVATE_KEYS[0], false],
|
||||||
|
["a truncated xprv", BIP32_VECTOR_1_XPRV.slice(0, -6), false],
|
||||||
|
["an xprv with an extra character", BIP32_VECTOR_1_XPRV + "a", false],
|
||||||
|
])("%s -> %s", (_name, key, expected) => {
|
||||||
|
expect(wallet.isValidXprv(key)).toBe(expected);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a watch-only xpub is not an xprv", () => {
|
||||||
|
const { xpub } = wallet.hdWalletFromMnemonic(VECTOR_PHRASE);
|
||||||
|
|
||||||
|
expect(wallet.isValidXprv(xpub)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Skipped: this asserts the correct behaviour, which the code does not
|
||||||
|
// currently have. isValidXprv gates the paste-your-extended-private-key
|
||||||
|
// import in src/popup/views/addWallet.js:215, and it accepts a key with a
|
||||||
|
// one-character typo: ethers' HDNodeWallet.fromExtendedKey skips base58
|
||||||
|
// checksum verification whenever the decoded payload is the usual 82
|
||||||
|
// bytes, which is the whole point of that checksum. Measured on this
|
||||||
|
// vector: changing any one of the last 14 characters passes validation,
|
||||||
|
// and for 9 of those 14 positions the import silently yields a *different*
|
||||||
|
// wallet (e.g. 0x3F334f0a356d6B46B1d70B590E7437D77100d28D instead of
|
||||||
|
// 0x022b971dFF0C43305e691DEd7a14367AF19D6407) with no error shown.
|
||||||
|
// Tracked as https://git.eeqj.de/sneak/AutistMask/issues/210; out of scope
|
||||||
|
// here, which is tests only. Unskip when it is fixed.
|
||||||
|
test.skip("rejects an extended key with a one-character typo", () => {
|
||||||
|
const index = BIP32_VECTOR_1_XPRV.length - 8;
|
||||||
|
const typo =
|
||||||
|
BIP32_VECTOR_1_XPRV.slice(0, index) +
|
||||||
|
(BIP32_VECTOR_1_XPRV[index] === "a" ? "b" : "a") +
|
||||||
|
BIP32_VECTOR_1_XPRV.slice(index + 1);
|
||||||
|
|
||||||
|
expect(wallet.isValidXprv(typo)).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("isValidMnemonic", () => {
|
||||||
|
test.each([
|
||||||
|
["the vector phrase", VECTOR_PHRASE, true],
|
||||||
|
["the BIP-39 zero-entropy phrase", ZERO_ENTROPY_PHRASE, true],
|
||||||
|
[
|
||||||
|
"a 12-word phrase with a bad checksum",
|
||||||
|
"abandon abandon abandon abandon abandon abandon " +
|
||||||
|
"abandon abandon abandon abandon abandon abandon",
|
||||||
|
false,
|
||||||
|
],
|
||||||
|
["an 11-word phrase", "abandon ".repeat(10) + "about", false],
|
||||||
|
["a word outside the wordlist", VECTOR_PHRASE + " zzzzzz", false],
|
||||||
|
["the empty string", "", false],
|
||||||
|
["garbage", "correct horse battery staple", false],
|
||||||
|
])("%s -> %s", (_name, phrase, expected) => {
|
||||||
|
expect(wallet.isValidMnemonic(phrase)).toBe(expected);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("addressFromPrivateKey", () => {
|
||||||
|
test.each([0, 1, 2])(
|
||||||
|
"published key %i yields its published address",
|
||||||
|
(index) => {
|
||||||
|
expect(
|
||||||
|
wallet.addressFromPrivateKey(VECTOR_PRIVATE_KEYS[index]),
|
||||||
|
).toBe(VECTOR_ADDRESSES[index]);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
test("rejects a key of the wrong length", () => {
|
||||||
|
expect(() => wallet.addressFromPrivateKey("0xdeadbeef")).toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("rejects the empty string", () => {
|
||||||
|
expect(() => wallet.addressFromPrivateKey("")).toThrow();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("getSignerForAddress", () => {
|
||||||
|
test.each([0, 1, 2])("hd wallet, address index %i", (index) => {
|
||||||
|
const signer = wallet.getSignerForAddress(
|
||||||
|
{ type: "hd" },
|
||||||
|
index,
|
||||||
|
VECTOR_PHRASE,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(signer.address).toBe(VECTOR_ADDRESSES[index]);
|
||||||
|
expect(signer.privateKey).toBe(VECTOR_PRIVATE_KEYS[index]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test.each([0, 1, 2])("xprv wallet, address index %i", (index) => {
|
||||||
|
const signer = wallet.getSignerForAddress(
|
||||||
|
{ type: "xprv" },
|
||||||
|
index,
|
||||||
|
masterXprv(VECTOR_PHRASE),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(signer.address).toBe(VECTOR_ADDRESSES[index]);
|
||||||
|
expect(signer.privateKey).toBe(VECTOR_PRIVATE_KEYS[index]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("single private key ignores the address index", () => {
|
||||||
|
for (const index of [0, 1, 2]) {
|
||||||
|
const signer = wallet.getSignerForAddress(
|
||||||
|
{ type: "privkey" },
|
||||||
|
index,
|
||||||
|
VECTOR_PRIVATE_KEYS[1],
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(signer.address).toBe(VECTOR_ADDRESSES[1]);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the returned signer signs recoverably as the expected address", async () => {
|
||||||
|
const signer = wallet.getSignerForAddress(
|
||||||
|
{ type: "hd" },
|
||||||
|
1,
|
||||||
|
VECTOR_PHRASE,
|
||||||
|
);
|
||||||
|
const message = "AutistMask derivation test";
|
||||||
|
|
||||||
|
const signature = await signer.signMessage(message);
|
||||||
|
|
||||||
|
expect(verifyMessage(message, signature)).toBe(VECTOR_ADDRESSES[1]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user