salvage.cpp

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2020 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#include <config.h>
#include <fs.h>
#include <streams.h>
#include <util/translation.h>
#include <wallet/salvage.h>
#include <wallet/wallet.h>
#include <wallet/walletdb.h>
 
/* End of headers, beginning of key/value data */
static const char *HEADER_END = "HEADER=END";
/* End of key/value data */
static const char *DATA_END = "DATA=END";
typedef std::pair<std::vector<uint8_t>, std::vector<uint8_t>> KeyValPair;
 
static bool KeyFilter(const std::string &type) {
    return WalletBatch::IsKeyType(type) || type == DBKeys::HDCHAIN;
}
 
bool RecoverDatabaseFile(const fs::path &file_path, bilingual_str &error,
                         std::vector<bilingual_str> &warnings) {
    DatabaseOptions options;
    DatabaseStatus status;
    options.require_existing = true;
    options.verify = false;
    std::unique_ptr<WalletDatabase> database =
        MakeDatabase(file_path, options, status, error);
    if (!database) {
        return false;
    }
 
    std::string filename;
    std::shared_ptr<BerkeleyEnvironment> env =
        GetWalletEnv(file_path, filename);
 
    if (!env->Open(error)) {
        return false;
    }
 
    // Recovery procedure:
    // move wallet file to walletfilename.timestamp.bak
    // Call Salvage with fAggressive=true to
    // get as much data as possible.
    // Rewrite salvaged data to fresh wallet file
    // Set -rescan so any missing transactions will be
    // found.
    int64_t now = GetTime();
    std::string newFilename = strprintf("%s.%d.bak", filename, now);
 
    int result = env->dbenv->dbrename(nullptr, filename.c_str(), nullptr,
                                      newFilename.c_str(), DB_AUTO_COMMIT);
    if (result != 0) {
        error = strprintf(Untranslated("Failed to rename %s to %s"), filename,
                          newFilename);
        return false;
    }
 
    std::vector<KeyValPair> salvagedData;
 
    std::stringstream strDump;
 
    Db db(env->dbenv.get(), 0);
    result = db.verify(newFilename.c_str(), nullptr, &strDump,
                       DB_SALVAGE | DB_AGGRESSIVE);
    if (result == DB_VERIFY_BAD) {
        warnings.push_back(
            Untranslated("Salvage: Database salvage found errors, all data may "
                         "not be recoverable."));
    }
    if (result != 0 && result != DB_VERIFY_BAD) {
        error = strprintf(
            Untranslated("Salvage: Database salvage failed with result %d."),
            result);
        return false;
    }
 
    // Format of bdb dump is ascii lines:
    // header lines...
    // HEADER=END
    //  hexadecimal key
    //  hexadecimal value
    //  ... repeated
    // DATA=END
 
    std::string strLine;
    while (!strDump.eof() && strLine != HEADER_END) {
        getline(strDump, strLine); // Skip past header
    }
 
    std::string keyHex, valueHex;
    while (!strDump.eof() && keyHex != DATA_END) {
        getline(strDump, keyHex);
        if (keyHex != DATA_END) {
            if (strDump.eof()) {
                break;
            }
            getline(strDump, valueHex);
            if (valueHex == DATA_END) {
                warnings.push_back(
                    Untranslated("Salvage: WARNING: Number of keys in data "
                                 "does not match number of values."));
                break;
            }
            salvagedData.push_back(
                make_pair(ParseHex(keyHex), ParseHex(valueHex)));
        }
    }
 
    bool fSuccess;
    if (keyHex != DATA_END) {
        warnings.push_back(Untranslated("Salvage: WARNING: Unexpected end of "
                                        "file while reading salvage output."));
        fSuccess = false;
    } else {
        fSuccess = (result == 0);
    }
 
    if (salvagedData.empty()) {
        error = strprintf(
            Untranslated("Salvage(aggressive) found no records in %s."),
            newFilename);
        return false;
    }
 
    std::unique_ptr<Db> pdbCopy = std::make_unique<Db>(env->dbenv.get(), 0);
    int ret = pdbCopy->open(nullptr,          // Txn pointer
                            filename.c_str(), // Filename
                            "main",           // Logical db name
                            DB_BTREE,         // Database type
                            DB_CREATE,        // Flags
                            0);
    if (ret > 0) {
        error =
            strprintf(Untranslated("Cannot create database file %s"), filename);
        pdbCopy->close(0);
        return false;
    }
 
    DbTxn *ptxn = env->TxnBegin();
    CWallet dummyWallet(nullptr, "", CreateDummyWalletDatabase());
    for (KeyValPair &row : salvagedData) {
        /* Filter for only private key type KV pairs to be added to the salvaged
         * wallet */
        CDataStream ssKey(row.first, SER_DISK, CLIENT_VERSION);
        CDataStream ssValue(row.second, SER_DISK, CLIENT_VERSION);
        std::string strType, strErr;
        bool fReadOK;
        {
            // Required in LoadKeyMetadata():
            LOCK(dummyWallet.cs_wallet);
            fReadOK = ReadKeyValue(&dummyWallet, ssKey, ssValue, strType,
                                   strErr, KeyFilter);
        }
        if (!KeyFilter(strType)) {
            continue;
        }
        if (!fReadOK) {
            warnings.push_back(strprintf(
                Untranslated("WARNING: WalletBatch::Recover skipping %s: %s"),
                strType, strErr));
            continue;
        }
        Dbt datKey(row.first.data(), row.first.size());
        Dbt datValue(row.second.data(), row.second.size());
        int ret2 = pdbCopy->put(ptxn, &datKey, &datValue, DB_NOOVERWRITE);
        if (ret2 > 0) {
            fSuccess = false;
        }
    }
    ptxn->commit(0);
    pdbCopy->close(0);
 
    return fSuccess;
}