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
  54 typedef std::vector<unsigned char, secure_allocator<unsigned char> > CKeyingMaterial;
  55
  56 /** Encryption/decryption context with key information */
  57 class CCrypter
  58 {
  59 private:
  60     unsigned char chKey[WALLET_CRYPTO_KEY_SIZE];
  61     unsigned char chIV[WALLET_CRYPTO_KEY_SIZE];
  62     bool fKeySet;
  63
  64 public:
  65     bool SetKeyFromPassphrase(const SecureString &strKeyData, const std::vector<unsigned char>& chSalt, const unsigned int nRounds, const unsigned int nDerivationMethod);
  66     bool Encrypt(const CKeyingMaterial& vchPlaintext, std::vector<unsigned char> &vchCiphertext);
  67     bool Decrypt(const std::vector<unsigned char>& vchCiphertext, CKeyingMaterial& vchPlaintext);
  68     bool SetKey(const CKeyingMaterial& chNewKey, const std::vector<unsigned char>& chNewIV);
  69     void CleanKey();
  70     CCrypter();
  71     ~CCrypter();
  72 };
  73
  74 bool EncryptSecret(CKeyingMaterial& vMasterKey, const CSecret &vchPlaintext, const uint256& nIV, std::vector<unsigned char> &vchCiphertext);
  75 bool DecryptSecret(const CKeyingMaterial& vMasterKey, const std::vector<unsigned char> &vchCiphertext, const uint256& nIV, CSecret &vchPlaintext);
  76
  77 #endif