src/crypter.h

   1 // Copyright (c) 2009-2012 The Bitcoin Developers
   2 // Distributed under the MIT/X11 software license, see the accompanying
   3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   4 #ifndef __CRYPTER_H__
   5 #define __CRYPTER_H__
   6
   7 #include "allocators.h" /* for SecureString */
   8 #include "key.h"
   9 #include "serialize.h"
  10
  11 const unsigned int WALLET_CRYPTO_KEY_SIZE = 32;
  12 const unsigned int WALLET_CRYPTO_SALT_SIZE = 8;
  13
  14 /*
  15 Private key encryption is done based on a CMasterKey,
  16 which holds a salt and random encryption key.
  17
  18 CMasterKeys are encrypted using AES-256-CBC using a key
  19 derived using derivation method nDerivationMethod
  20 (0 == EVP_sha512()) and derivation iterations nDeriveIterations.
  21 vchOtherDerivationParameters is provided for alternative algorithms
  22 which may require more parameters (such as scrypt).
  23
  24 Wallet Private Keys are then encrypted using AES-256-CBC
  25 with the double-sha256 of the public key as the IV, and the
  26 master key's key as the encryption key (see keystore.[ch]).
  27 */
  28
  29 /** Master key for wallet encryption */
  30 class CMasterKey
  31 {
  32 public:
  33     std::vector<unsigned char> vchCryptedKey;
  34     std::vector<unsigned char> vchSalt;
  35     // 0 = EVP_sha512()
  36     // 1 = scrypt()
  37     unsigned int nDerivationMethod;
  38     unsigned int nDeriveIterations;
  39     // Use this for more parameters to key derivation,
  40     // such as the various parameters to scrypt
  41     std::vector<unsigned char> vchOtherDerivationParameters;
  42
  43     IMPLEMENT_SERIALIZE
  44     (
  45         READWRITE(vchCryptedKey);
  46         READWRITE(vchSalt);
  47         READWRITE(nDerivationMethod);
  48         READWRITE(nDeriveIterations);
  49         READWRITE(vchOtherDerivationParameters);
  50     )
  51     CMasterKey()
  52     {
  53         // 25000 rounds is just under 0.1 seconds on a 1.86 GHz Pentium M
  54         // ie slightly lower than the lowest hardware we need bother supporting
  55         nDeriveIterations = 25000;
  56         nDerivationMethod = 1;
  57         vchOtherDerivationParameters = std::vector<unsigned char>(0);
  58     }
  59
  60     CMasterKey(unsigned int nDerivationMethodIndex)
  61     {
  62         switch (nDerivationMethodIndex)
  63         {
  64             case 0: // sha512
  65             default:
  66                 nDeriveIterations = 25000;
  67                 nDerivationMethod = 0;
  68                 vchOtherDerivationParameters = std::vector<unsigned char>(0);
  69             break;
  70
  71             case 1: // scrypt+sha512
  72                 nDeriveIterations = 10000;
  73                 nDerivationMethod = 1;
  74                 vchOtherDerivationParameters = std::vector<unsigned char>(0);
  75             break;
  76         }
  77     }
  78
  79 };
  80
  81 typedef std::vector<unsigned char, secure_allocator<unsigned char> > CKeyingMaterial;
  82
  83 /** Encryption/decryption context with key information */
  84 class CCrypter
  85 {
  86 private:
  87     unsigned char chKey[WALLET_CRYPTO_KEY_SIZE];
  88     unsigned char chIV[WALLET_CRYPTO_KEY_SIZE];
  89     bool fKeySet;
  90
  91 public:
  92     bool SetKeyFromPassphrase(const SecureString &strKeyData, const std::vector<unsigned char>& chSalt, const unsigned int nRounds, const unsigned int nDerivationMethod);
  93     bool Encrypt(const CKeyingMaterial& vchPlaintext, std::vector<unsigned char> &vchCiphertext);
  94     bool Decrypt(const std::vector<unsigned char>& vchCiphertext, CKeyingMaterial& vchPlaintext);
  95     bool SetKey(const CKeyingMaterial& chNewKey, const std::vector<unsigned char>& chNewIV);
  96
  97     void CleanKey()
  98     {
  99         memset(&chKey, 0, sizeof chKey);
 100         memset(&chIV, 0, sizeof chIV);
 101         fKeySet = false;
 102     }
 103
 104     CCrypter()
 105     {
 106         fKeySet = false;
 107
 108         // Try to keep the key data out of swap (and be a bit over-careful to keep the IV that we don't even use out of swap)
 109         // Note that this does nothing about suspend-to-disk (which will put all our key data on disk)
 110         // Note as well that at no point in this program is any attempt made to prevent stealing of keys by reading the memory of the running process.
 111         LockedPageManager::instance.LockRange(&chKey[0], sizeof chKey);
 112         LockedPageManager::instance.LockRange(&chIV[0], sizeof chIV);
 113     }
 114
 115     ~CCrypter()
 116     {
 117         CleanKey();
 118
 119         LockedPageManager::instance.UnlockRange(&chKey[0], sizeof chKey);
 120         LockedPageManager::instance.UnlockRange(&chIV[0], sizeof chIV);
 121     }
 122 };
 123
 124 bool EncryptSecret(CKeyingMaterial& vMasterKey, const CSecret &vchPlaintext, const uint256& nIV, std::vector<unsigned char> &vchCiphertext);
 125 bool DecryptSecret(const CKeyingMaterial& vMasterKey, const std::vector<unsigned char> &vchCiphertext, const uint256& nIV, CSecret &vchPlaintext);
 126
 127 #endif