wallet encryption: the stack from #130–#133, with the two blockers fixed (#134)

* wallet: refuse future encrypted wallet formats

* wallet: add encrypted key unlock core

* wallet: add encryptwallet rewrite command

* wallet: read passphrases from stdin or files

* wallet: keep the derivation across encryption, and take the logs with it

Two things stopped the encryption stack from being safe to merge. Both
were found against a wallet holding real coin, not in the self-tests.

1. Encrypting turned a BIP44 wallet into a legacy one.

LoadWallet() ends by resetting the schema and the derivation counters
when no seed is in memory. That was written when "no seed after loading"
could only mean the wallet had none. An encrypted wallet has a seed --
it just has not been decrypted yet -- so the reset threw away metadata
that had been read correctly a moment earlier. Unlocking later restores
the seed and nothing restores the rest.

Measured on the wallet from the #124 proof: after encrypting, index 1
moved off BAtgSgra2X8Dqo5PJzPCLJhPwrrC2thYVJ, the address actually
holding 1.00 BTF, and the audit went from "1.00 covered by the phrase"
to "0.00 covered, 1.00 wallet.dat-only". Encrypt your wallet and the
program told you your recovery phrase no longer covered your money.

Now the condition also accepts a wallet whose seed is present but
encrypted. Same wallet, before and after: schema bip44, same four
derived addresses, 1.00 BTF still reported as covered.

2. The plaintext keys stayed behind in the Berkeley DB logs.

wallet.dat comes out clean -- verified by scanning the raw file for the
118 bytes of a known private key. database/log.0000000002 did not: it
held the whole key, and still did after a full node restart, because
every record this wallet ever wrote passed through the log.

That defeats the feature for the case it exists for, since our own
backup advice is to copy the whole directory rather than wallet.dat
alone. log_archive() cannot fix it: it only drops logs Berkeley DB
considers obsolete and never the one it is writing to, and with one 10
MB log per directory that is precisely where the keys are. They also did
not get there at encryption time -- they accumulated over the wallet's
whole life -- so nothing done during the rewrite can archive them out.

So the encrypt command now closes the environment and deletes the logs
on its way out, after the flush that makes every .dat self-contained.
This is not secure erasure; the blocks are unlinked, not overwritten.
It closes the case of someone reading a copied data directory.

Getting there uncovered a third bug, older than both.

DBFlush(true) is not safe to call twice. The first call closes the
environment, and txn_checkpoint() on a closed environment segfaults
instead of returning an error, so the try/catch around it never sees
anything. EncryptWallet() already flushes before renaming the wallet,
and the command flushes again on the way out -- that pair crashed every
single time. Guarded now.

The same function has been calling log_archive() with the address of an
uninitialised pointer since 0.1.0, on every clean shutdown, in a path
whose catch(...) cannot catch a structured fault on Windows.
DB_ARCH_REMOVE requires that argument to be NULL. Fixed while here,
because the encryption cleanup depends on that call not being a coin
flip.

---------

Co-authored-by: Gilcimar Duarte <ti@gpm.infra>

1 files changed, 100 insertions, 1 deletions

diff --git a/src/main_gui.cpp b/src/main_gui.cpp
index 6164ad7..a2577ca 100644
--- a/src/main_gui.cpp
+++ b/src/main_gui.cpp
@@ -40,6 +40,60 @@ static string argval2(int argc, char* argv[], const char* keySlash, const char*
     return argval(argc, argv, keyDash);
 }
 
+static bool ReadPassphraseArgument(const string& strArg, string& strPassphraseRet, string& strErrorRet)
+{
+    strPassphraseRet.clear();
+    strErrorRet.clear();
+    if (strArg.empty())
+    {
+        AttachTerminal();
+        fprintf(stderr, "Enter wallet passphrase: ");
+        fflush(stderr);
+        char buf[4096];
+        if (!fgets(buf, sizeof(buf), stdin))
+        {
+            strErrorRet = "could not read passphrase from stdin";
+            return false;
+        }
+        strPassphraseRet = buf;
+    }
+    else if (strArg[0] == '@')
+    {
+        string strPath = strArg.substr(1);
+        FILE* pf = fopen(strPath.c_str(), "rb");
+        if (!pf)
+        {
+            strErrorRet = strprintf("could not read passphrase file %s", strPath.c_str());
+            return false;
+        }
+        char buf[4096];
+        if (!fgets(buf, sizeof(buf), pf))
+        {
+            fclose(pf);
+            strErrorRet = strprintf("passphrase file %s is empty", strPath.c_str());
+            return false;
+        }
+        fclose(pf);
+        strPassphraseRet = buf;
+    }
+    else
+    {
+        strErrorRet = "passphrase literals on the command line are unsafe; use the option without a value to read stdin, or use @FILE";
+        return false;
+    }
+
+    while (!strPassphraseRet.empty() &&
+           (strPassphraseRet[strPassphraseRet.size() - 1] == '\n' ||
+            strPassphraseRet[strPassphraseRet.size() - 1] == '\r'))
+        strPassphraseRet.resize(strPassphraseRet.size() - 1);
+    if (strPassphraseRet.empty())
+    {
+        strErrorRet = "empty passphrase";
+        return false;
+    }
+    return true;
+}
+
 // The real printf, not the one util.h remaps to OutputDebugStringF. Help that
 // goes to debug.log is help nobody asked for: `-help` printed a full page into
 // the data directory and returned 0 with an empty terminal, which reads as a
@@ -56,7 +110,7 @@ static void PrintUsage()
     printf("  /debug\n");
     printf("  /gen\n");
     printf("  /nogui or /daemon\n");
-    printf("  /selftest=wallet-keypool or /selftest=wallet-hd\n");
+    printf("  /selftest=wallet-keypool, wallet-hd, wallet-format, wallet-crypto, or wallet-encrypt\n");
     printf("\n");
     printf("Mining mode:\n");
     printf("  /operator\n");
@@ -85,6 +139,10 @@ static void PrintUsage()
     printf("  /dumpwallet=FILE           (export private keys as text -- readable by\n");
     printf("                              anyone, so guard it like cash)\n");
     printf("  /importwallet=FILE         (load keys from such a file back in)\n");
+    printf("  /encryptwallet[=@FILE]     (rewrite wallet.dat with encrypted private keys\n");
+    printf("                              and encrypted HD seed, then exit)\n");
+    printf("  /walletpassphrase[=@FILE]  (unlock an encrypted wallet for one-shot\n");
+    printf("                              commands; without @FILE reads stdin)\n");
     printf("  /newaddress                (print the next receiving address, then exit)\n");
     printf("  /sendto=ADDRESS,AMOUNT     (spend from this wallet, then exit -- the\n");
     printf("                              only way to send without the window)\n");
@@ -299,6 +357,39 @@ int main(int argc, char* argv[])
     }
     printf("Height=%d\n", nBestHeight);
 
+    bool fEncryptWallet = arg(argc, argv, "/encryptwallet") || arg(argc, argv, "-encryptwallet");
+    string strEncryptWallet = argval2(argc, argv, "/encryptwallet", "-encryptwallet");
+    if (fEncryptWallet)
+    {
+        string strPassphrase;
+        string strPassphraseError;
+        if (!ReadPassphraseArgument(strEncryptWallet, strPassphrase, strPassphraseError))
+        {
+            fprintf(stderr, "Cannot read encryption passphrase: %s\n", strPassphraseError.c_str());
+            DBFlush(true);
+            return 1;
+        }
+        int nRet = CmdEncryptWallet(strPassphrase);
+        if (nRet != 0)
+            DBFlush(true);
+        return nRet;
+    }
+
+    bool fWalletPassphrase = arg(argc, argv, "/walletpassphrase") || arg(argc, argv, "-walletpassphrase");
+    string strWalletPassphrase = argval2(argc, argv, "/walletpassphrase", "-walletpassphrase");
+    if (fWalletPassphrase)
+    {
+        string strPassphrase;
+        string strUnlockError;
+        if (!ReadPassphraseArgument(strWalletPassphrase, strPassphrase, strUnlockError) ||
+            !UnlockWallet(strPassphrase, strUnlockError))
+        {
+            fprintf(stderr, "Cannot unlock wallet: %s\n", strUnlockError.c_str());
+            DBFlush(true);
+            return 1;
+        }
+    }
+
     // Before the node opens sockets or touches anything: the wallet is loaded,
     // which is all a backup needs, and finishing here means the copy is taken
     // from a quiet directory rather than from under a running node.
@@ -442,6 +533,14 @@ int main(int argc, char* argv[])
         return 0;
     }
 
+    if (fGenerateBitcoins && IsWalletLocked())
+    {
+        fprintf(stderr, "Cannot mine while the encrypted wallet is locked. "
+                        "Start with /walletpassphrase or /walletpassphrase=@FILE, or disable mining.\n");
+        DBFlush(true);
+        return 1;
+    }
+
     ReacceptWalletTransactions();
 
     if (!StartNode(strErrors)) { fprintf(stderr,"StartNode: %s\n",strErrors.c_str()); return 1; }