src/key.cpp

   1 // Copyright (c) 2009-2014 The Bitcoin Core developers
   2 // Copyright (c) 2017 The Zcash developers
   3 // Distributed under the MIT software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5
   6 #include "key.h"
   7
   8 #include "arith_uint256.h"
   9 #include "crypto/common.h"
  10 #include "crypto/hmac_sha512.h"
  11 #include "pubkey.h"
  12 #include "random.h"
  13
  14 #include <secp256k1.h>
  15 #include <secp256k1_recovery.h>
  16
  17 static secp256k1_context* secp256k1_context_sign = NULL;
  18
  19 /** These functions are taken from the libsecp256k1 distribution and are very ugly. */
  20 static int ec_privkey_import_der(const secp256k1_context* ctx, unsigned char *out32, const unsigned char *privkey, size_t privkeylen) {
  21     const unsigned char *end = privkey + privkeylen;
  22     size_t lenb = 0;
  23     size_t len = 0;
  24     memset(out32, 0, 32);
  25     /* sequence header */
  26     if (end - privkey < 1 || *privkey != 0x30u) {
  27         return 0;
  28     }
  29     privkey++;
  30     /* sequence length constructor */
  31     if (end - privkey < 1 || !(*privkey & 0x80u)) {
  32         return 0;
  33     }
  34     lenb = *privkey & ~0x80u; privkey++;
  35     if (lenb < 1 || lenb > 2) {
  36         return 0;
  37     }
  38     if (end - privkey < lenb) {
  39         return 0;
  40     }
  41     /* sequence length */
  42     len = privkey[lenb-1] | (lenb > 1 ? privkey[lenb-2] << 8 : 0u);
  43     privkey += lenb;
  44     if (end - privkey < len) {
  45         return 0;
  46     }
  47     /* sequence element 0: version number (=1) */
  48     if (end - privkey < 3 || privkey[0] != 0x02u || privkey[1] != 0x01u || privkey[2] != 0x01u) {
  49         return 0;
  50     }
  51     privkey += 3;
  52     /* sequence element 1: octet string, up to 32 bytes */
  53     if (end - privkey < 2 || privkey[0] != 0x04u) {
  54         return 0;
  55     }
  56     size_t oslen = privkey[1];
  57     privkey += 2;
  58     if (oslen > 32 || end - privkey < oslen) {
  59         return 0;
  60     }
  61     memcpy(out32 + (32 - oslen), privkey, oslen);
  62     if (!secp256k1_ec_seckey_verify(ctx, out32)) {
  63         memset(out32, 0, 32);
  64         return 0;
  65     }
  66     return 1;
  67 }
  68
  69 static int ec_privkey_export_der(const secp256k1_context *ctx, unsigned char *privkey, size_t *privkeylen, const unsigned char *key32, int compressed) {
  70     secp256k1_pubkey pubkey;
  71     size_t pubkeylen = 0;
  72     if (!secp256k1_ec_pubkey_create(ctx, &pubkey, key32)) {
  73         *privkeylen = 0;
  74         return 0;
  75     }
  76     if (compressed) {
  77         static const unsigned char begin[] = {
  78             0x30,0x81,0xD3,0x02,0x01,0x01,0x04,0x20
  79         };
  80         static const unsigned char middle[] = {
  81             0xA0,0x81,0x85,0x30,0x81,0x82,0x02,0x01,0x01,0x30,0x2C,0x06,0x07,0x2A,0x86,0x48,
  82             0xCE,0x3D,0x01,0x01,0x02,0x21,0x00,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
  83             0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
  84             0xFF,0xFF,0xFE,0xFF,0xFF,0xFC,0x2F,0x30,0x06,0x04,0x01,0x00,0x04,0x01,0x07,0x04,
  85             0x21,0x02,0x79,0xBE,0x66,0x7E,0xF9,0xDC,0xBB,0xAC,0x55,0xA0,0x62,0x95,0xCE,0x87,
  86             0x0B,0x07,0x02,0x9B,0xFC,0xDB,0x2D,0xCE,0x28,0xD9,0x59,0xF2,0x81,0x5B,0x16,0xF8,
  87             0x17,0x98,0x02,0x21,0x00,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
  88             0xFF,0xFF,0xFF,0xFF,0xFE,0xBA,0xAE,0xDC,0xE6,0xAF,0x48,0xA0,0x3B,0xBF,0xD2,0x5E,
  89             0x8C,0xD0,0x36,0x41,0x41,0x02,0x01,0x01,0xA1,0x24,0x03,0x22,0x00
  90         };
  91         unsigned char *ptr = privkey;
  92         memcpy(ptr, begin, sizeof(begin)); ptr += sizeof(begin);
  93         memcpy(ptr, key32, 32); ptr += 32;
  94         memcpy(ptr, middle, sizeof(middle)); ptr += sizeof(middle);
  95         pubkeylen = 33;
  96         secp256k1_ec_pubkey_serialize(ctx, ptr, &pubkeylen, &pubkey, SECP256K1_EC_COMPRESSED);
  97         ptr += pubkeylen;
  98         *privkeylen = ptr - privkey;
  99     } else {
 100         static const unsigned char begin[] = {
 101             0x30,0x82,0x01,0x13,0x02,0x01,0x01,0x04,0x20
 102         };
 103         static const unsigned char middle[] = {
 104             0xA0,0x81,0xA5,0x30,0x81,0xA2,0x02,0x01,0x01,0x30,0x2C,0x06,0x07,0x2A,0x86,0x48,
 105             0xCE,0x3D,0x01,0x01,0x02,0x21,0x00,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
 106             0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
 107             0xFF,0xFF,0xFE,0xFF,0xFF,0xFC,0x2F,0x30,0x06,0x04,0x01,0x00,0x04,0x01,0x07,0x04,
 108             0x41,0x04,0x79,0xBE,0x66,0x7E,0xF9,0xDC,0xBB,0xAC,0x55,0xA0,0x62,0x95,0xCE,0x87,
 109             0x0B,0x07,0x02,0x9B,0xFC,0xDB,0x2D,0xCE,0x28,0xD9,0x59,0xF2,0x81,0x5B,0x16,0xF8,
 110             0x17,0x98,0x48,0x3A,0xDA,0x77,0x26,0xA3,0xC4,0x65,0x5D,0xA4,0xFB,0xFC,0x0E,0x11,
 111             0x08,0xA8,0xFD,0x17,0xB4,0x48,0xA6,0x85,0x54,0x19,0x9C,0x47,0xD0,0x8F,0xFB,0x10,
 112             0xD4,0xB8,0x02,0x21,0x00,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
 113             0xFF,0xFF,0xFF,0xFF,0xFE,0xBA,0xAE,0xDC,0xE6,0xAF,0x48,0xA0,0x3B,0xBF,0xD2,0x5E,
 114             0x8C,0xD0,0x36,0x41,0x41,0x02,0x01,0x01,0xA1,0x44,0x03,0x42,0x00
 115         };
 116         unsigned char *ptr = privkey;
 117         memcpy(ptr, begin, sizeof(begin)); ptr += sizeof(begin);
 118         memcpy(ptr, key32, 32); ptr += 32;
 119         memcpy(ptr, middle, sizeof(middle)); ptr += sizeof(middle);
 120         pubkeylen = 65;
 121         secp256k1_ec_pubkey_serialize(ctx, ptr, &pubkeylen, &pubkey, SECP256K1_EC_UNCOMPRESSED);
 122         ptr += pubkeylen;
 123         *privkeylen = ptr - privkey;
 124     }
 125     return 1;
 126 }
 127
 128 bool CKey::Check(const unsigned char *vch) {
 129     return secp256k1_ec_seckey_verify(secp256k1_context_sign, vch);
 130 }
 131
 132 void CKey::MakeNewKey(bool fCompressedIn) {
 133     do {
 134         GetRandBytes(vch, sizeof(vch));
 135     } while (!Check(vch));
 136     fValid = true;
 137     fCompressed = fCompressedIn;
 138 }
 139
 140 bool CKey::SetPrivKey(const CPrivKey &privkey, bool fCompressedIn) {
 141     if (!ec_privkey_import_der(secp256k1_context_sign, (unsigned char*)begin(), &privkey[0], privkey.size()))
 142         return false;
 143     fCompressed = fCompressedIn;
 144     fValid = true;
 145     return true;
 146 }
 147
 148 CPrivKey CKey::GetPrivKey() const {
 149     assert(fValid);
 150     CPrivKey privkey;
 151     int ret;
 152     size_t privkeylen;
 153     privkey.resize(279);
 154     privkeylen = 279;
 155     ret = ec_privkey_export_der(secp256k1_context_sign, (unsigned char*)&privkey[0], &privkeylen, begin(), fCompressed ? SECP256K1_EC_COMPRESSED : SECP256K1_EC_UNCOMPRESSED);
 156     assert(ret);
 157     privkey.resize(privkeylen);
 158     return privkey;
 159 }
 160
 161 CPubKey CKey::GetPubKey() const {
 162     assert(fValid);
 163     secp256k1_pubkey pubkey;
 164     size_t clen = 65;
 165     CPubKey result;
 166     int ret = secp256k1_ec_pubkey_create(secp256k1_context_sign, &pubkey, begin());
 167     assert(ret);
 168     secp256k1_ec_pubkey_serialize(secp256k1_context_sign, (unsigned char*)result.begin(), &clen, &pubkey, fCompressed ? SECP256K1_EC_COMPRESSED : SECP256K1_EC_UNCOMPRESSED);
 169     assert(result.size() == clen);
 170     assert(result.IsValid());
 171     return result;
 172 }
 173
 174 bool CKey::Sign(const uint256 &hash, std::vector<unsigned char>& vchSig, uint32_t test_case) const {
 175     if (!fValid)
 176         return false;
 177     vchSig.resize(72);
 178     size_t nSigLen = 72;
 179     unsigned char extra_entropy[32] = {0};
 180     WriteLE32(extra_entropy, test_case);
 181     secp256k1_ecdsa_signature sig;
 182     int ret = secp256k1_ecdsa_sign(secp256k1_context_sign, &sig, hash.begin(), begin(), secp256k1_nonce_function_rfc6979, test_case ? extra_entropy : NULL);
 183     assert(ret);
 184     secp256k1_ecdsa_signature_serialize_der(secp256k1_context_sign, (unsigned char*)&vchSig[0], &nSigLen, &sig);
 185     vchSig.resize(nSigLen);
 186     return true;
 187 }
 188
 189 bool CKey::VerifyPubKey(const CPubKey& pubkey) const {
 190     if (pubkey.IsCompressed() != fCompressed) {
 191         return false;
 192     }
 193     unsigned char rnd[8];
 194     std::string str = "Bitcoin key verification\n";
 195     GetRandBytes(rnd, sizeof(rnd));
 196     uint256 hash;
 197     CHash256().Write((unsigned char*)str.data(), str.size()).Write(rnd, sizeof(rnd)).Finalize(hash.begin());
 198     std::vector<unsigned char> vchSig;
 199     Sign(hash, vchSig);
 200     return pubkey.Verify(hash, vchSig);
 201 }
 202
 203 bool CKey::SignCompact(const uint256 &hash, std::vector<unsigned char>& vchSig) const {
 204     if (!fValid)
 205         return false;
 206     vchSig.resize(65);
 207     int rec = -1;
 208     secp256k1_ecdsa_recoverable_signature sig;
 209     int ret = secp256k1_ecdsa_sign_recoverable(secp256k1_context_sign, &sig, hash.begin(), begin(), secp256k1_nonce_function_rfc6979, NULL);
 210     assert(ret);
 211     secp256k1_ecdsa_recoverable_signature_serialize_compact(secp256k1_context_sign, (unsigned char*)&vchSig[1], &rec, &sig);
 212     assert(ret);
 213     assert(rec != -1);
 214     vchSig[0] = 27 + rec + (fCompressed ? 4 : 0);
 215     return true;
 216 }
 217
 218 bool CKey::Load(CPrivKey &privkey, CPubKey &vchPubKey, bool fSkipCheck=false) {
 219     if (!ec_privkey_import_der(secp256k1_context_sign, (unsigned char*)begin(), &privkey[0], privkey.size()))
 220         return false;
 221     fCompressed = vchPubKey.IsCompressed();
 222     fValid = true;
 223
 224     if (fSkipCheck)
 225         return true;
 226
 227     return VerifyPubKey(vchPubKey);
 228 }
 229
 230 bool CKey::Derive(CKey& keyChild, ChainCode &ccChild, unsigned int nChild, const ChainCode& cc) const {
 231     assert(IsValid());
 232     assert(IsCompressed());
 233     unsigned char out[64];
 234     LockObject(out);
 235     if ((nChild >> 31) == 0) {
 236         CPubKey pubkey = GetPubKey();
 237         assert(pubkey.size() == 33);
 238         BIP32Hash(cc, nChild, *pubkey.begin(), pubkey.begin()+1, out);
 239     } else {
 240         assert(size() == 32);
 241         BIP32Hash(cc, nChild, 0, begin(), out);
 242     }
 243     memcpy(ccChild.begin(), out+32, 32);
 244     memcpy((unsigned char*)keyChild.begin(), begin(), 32);
 245     bool ret = secp256k1_ec_privkey_tweak_add(secp256k1_context_sign, (unsigned char*)keyChild.begin(), out);
 246     UnlockObject(out);
 247     keyChild.fCompressed = true;
 248     keyChild.fValid = ret;
 249     return ret;
 250 }
 251
 252 bool CExtKey::Derive(CExtKey &out, unsigned int nChild) const {
 253     out.nDepth = nDepth + 1;
 254     CKeyID id = key.GetPubKey().GetID();
 255     memcpy(&out.vchFingerprint[0], &id, 4);
 256     out.nChild = nChild;
 257     return key.Derive(out.key, out.chaincode, nChild, chaincode);
 258 }
 259
 260 void CExtKey::SetMaster(const unsigned char *seed, unsigned int nSeedLen) {
 261     static const unsigned char hashkey[] = {'B','i','t','c','o','i','n',' ','s','e','e','d'};
 262     unsigned char out[64];
 263     LockObject(out);
 264     CHMAC_SHA512(hashkey, sizeof(hashkey)).Write(seed, nSeedLen).Finalize(out);
 265     key.Set(&out[0], &out[32], true);
 266     memcpy(chaincode.begin(), &out[32], 32);
 267     UnlockObject(out);
 268     nDepth = 0;
 269     nChild = 0;
 270     memset(vchFingerprint, 0, sizeof(vchFingerprint));
 271 }
 272
 273 CExtPubKey CExtKey::Neuter() const {
 274     CExtPubKey ret;
 275     ret.nDepth = nDepth;
 276     memcpy(&ret.vchFingerprint[0], &vchFingerprint[0], 4);
 277     ret.nChild = nChild;
 278     ret.pubkey = key.GetPubKey();
 279     ret.chaincode = chaincode;
 280     return ret;
 281 }
 282
 283 void CExtKey::Encode(unsigned char code[74]) const {
 284     code[0] = nDepth;
 285     memcpy(code+1, vchFingerprint, 4);
 286     code[5] = (nChild >> 24) & 0xFF; code[6] = (nChild >> 16) & 0xFF;
 287     code[7] = (nChild >>  8) & 0xFF; code[8] = (nChild >>  0) & 0xFF;
 288     memcpy(code+9, chaincode.begin(), 32);
 289     code[41] = 0;
 290     assert(key.size() == 32);
 291     memcpy(code+42, key.begin(), 32);
 292 }
 293
 294 void CExtKey::Decode(const unsigned char code[74]) {
 295     nDepth = code[0];
 296     memcpy(vchFingerprint, code+1, 4);
 297     nChild = (code[5] << 24) | (code[6] << 16) | (code[7] << 8) | code[8];
 298     memcpy(chaincode.begin(), code+9, 32);
 299     key.Set(code+42, code+74, true);
 300 }
 301
 302 bool ECC_InitSanityCheck() {
 303     CKey key;
 304     key.MakeNewKey(true);
 305     CPubKey pubkey = key.GetPubKey();
 306     return key.VerifyPubKey(pubkey);
 307 }
 308
 309 void ECC_Start() {
 310     assert(secp256k1_context_sign == NULL);
 311
 312     secp256k1_context *ctx = secp256k1_context_create(SECP256K1_CONTEXT_SIGN);
 313     assert(ctx != NULL);
 314
 315     {
 316         // Pass in a random blinding seed to the secp256k1 context.
 317         unsigned char seed[32];
 318         LockObject(seed);
 319         GetRandBytes(seed, 32);
 320         bool ret = secp256k1_context_randomize(ctx, seed);
 321         assert(ret);
 322         UnlockObject(seed);
 323     }
 324
 325     secp256k1_context_sign = ctx;
 326 }
 327
 328 void ECC_Stop() {
 329     secp256k1_context *ctx = secp256k1_context_sign;
 330     secp256k1_context_sign = NULL;
 331
 332     if (ctx) {
 333         secp256k1_context_destroy(ctx);
 334     }
 335 }