src/key.cpp

   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
   5 #include <map>
   6
   7 #include <openssl/ecdsa.h>
   8 #include <openssl/obj_mac.h>
   9
  10 #include "key.h"
  11
  12 // Generate a private key from just the secret parameter
  13 int EC_KEY_regenerate_key(EC_KEY *eckey, BIGNUM *priv_key)
  14 {
  15     int ok = 0;
  16     BN_CTX *ctx = NULL;
  17     EC_POINT *pub_key = NULL;
  18
  19     if (!eckey) return 0;
  20
  21     const EC_GROUP *group = EC_KEY_get0_group(eckey);
  22
  23     if ((ctx = BN_CTX_new()) == NULL)
  24         goto err;
  25
  26     pub_key = EC_POINT_new(group);
  27
  28     if (pub_key == NULL)
  29         goto err;
  30
  31     if (!EC_POINT_mul(group, pub_key, priv_key, NULL, NULL, ctx))
  32         goto err;
  33
  34     EC_KEY_set_private_key(eckey,priv_key);
  35     EC_KEY_set_public_key(eckey,pub_key);
  36
  37     ok = 1;
  38
  39 err:
  40
  41     if (pub_key)
  42         EC_POINT_free(pub_key);
  43     if (ctx != NULL)
  44         BN_CTX_free(ctx);
  45
  46     return(ok);
  47 }
  48
  49 // Perform ECDSA key recovery (see SEC1 4.1.6) for curves over (mod p)-fields
  50 // recid selects which key is recovered
  51 // if check is non-zero, additional checks are performed
  52 int ECDSA_SIG_recover_key_GFp(EC_KEY *eckey, ECDSA_SIG *ecsig, const unsigned char *msg, int msglen, int recid, int check)
  53 {
  54     if (!eckey) return 0;
  55
  56     int ret = 0;
  57     BN_CTX *ctx = NULL;
  58
  59     BIGNUM *x = NULL;
  60     BIGNUM *e = NULL;
  61     BIGNUM *order = NULL;
  62     BIGNUM *sor = NULL;
  63     BIGNUM *eor = NULL;
  64     BIGNUM *field = NULL;
  65     EC_POINT *R = NULL;
  66     EC_POINT *O = NULL;
  67     EC_POINT *Q = NULL;
  68     BIGNUM *rr = NULL;
  69     BIGNUM *zero = NULL;
  70     int n = 0;
  71     int i = recid / 2;
  72
  73     const EC_GROUP *group = EC_KEY_get0_group(eckey);
  74     if ((ctx = BN_CTX_new()) == NULL) { ret = -1; goto err; }
  75     BN_CTX_start(ctx);
  76     order = BN_CTX_get(ctx);
  77     if (!EC_GROUP_get_order(group, order, ctx)) { ret = -2; goto err; }
  78     x = BN_CTX_get(ctx);
  79     if (!BN_copy(x, order)) { ret=-1; goto err; }
  80     if (!BN_mul_word(x, i)) { ret=-1; goto err; }
  81     if (!BN_add(x, x, ecsig->r)) { ret=-1; goto err; }
  82     field = BN_CTX_get(ctx);
  83     if (!EC_GROUP_get_curve_GFp(group, field, NULL, NULL, ctx)) { ret=-2; goto err; }
  84     if (BN_cmp(x, field) >= 0) { ret=0; goto err; }
  85     if ((R = EC_POINT_new(group)) == NULL) { ret = -2; goto err; }
  86     if (!EC_POINT_set_compressed_coordinates_GFp(group, R, x, recid % 2, ctx)) { ret=0; goto err; }
  87     if (check)
  88     {
  89         if ((O = EC_POINT_new(group)) == NULL) { ret = -2; goto err; }
  90         if (!EC_POINT_mul(group, O, NULL, R, order, ctx)) { ret=-2; goto err; }
  91         if (!EC_POINT_is_at_infinity(group, O)) { ret = 0; goto err; }
  92     }
  93     if ((Q = EC_POINT_new(group)) == NULL) { ret = -2; goto err; }
  94     n = EC_GROUP_get_degree(group);
  95     e = BN_CTX_get(ctx);
  96     if (!BN_bin2bn(msg, msglen, e)) { ret=-1; goto err; }
  97     if (8*msglen > n) BN_rshift(e, e, 8-(n & 7));
  98     zero = BN_CTX_get(ctx);
  99     if (!BN_zero(zero)) { ret=-1; goto err; }
 100     if (!BN_mod_sub(e, zero, e, order, ctx)) { ret=-1; goto err; }
 101     rr = BN_CTX_get(ctx);
 102     if (!BN_mod_inverse(rr, ecsig->r, order, ctx)) { ret=-1; goto err; }
 103     sor = BN_CTX_get(ctx);
 104     if (!BN_mod_mul(sor, ecsig->s, rr, order, ctx)) { ret=-1; goto err; }
 105     eor = BN_CTX_get(ctx);
 106     if (!BN_mod_mul(eor, e, rr, order, ctx)) { ret=-1; goto err; }
 107     if (!EC_POINT_mul(group, Q, eor, R, sor, ctx)) { ret=-2; goto err; }
 108     if (!EC_KEY_set_public_key(eckey, Q)) { ret=-2; goto err; }
 109
 110     ret = 1;
 111
 112 err:
 113     if (ctx) {
 114         BN_CTX_end(ctx);
 115         BN_CTX_free(ctx);
 116     }
 117     if (R != NULL) EC_POINT_free(R);
 118     if (O != NULL) EC_POINT_free(O);
 119     if (Q != NULL) EC_POINT_free(Q);
 120     return ret;
 121 }
 122
 123 int CompareBigEndian(const unsigned char *c1, size_t c1len, const unsigned char *c2, size_t c2len) {
 124     while (c1len > c2len) {
 125         if (*c1)
 126             return 1;
 127         c1++;
 128         c1len--;
 129     }
 130     while (c2len > c1len) {
 131         if (*c2)
 132             return -1;
 133         c2++;
 134         c2len--;
 135     }
 136     while (c1len > 0) {
 137         if (*c1 > *c2)
 138             return 1;
 139         if (*c2 > *c1)
 140             return -1;
 141         c1++;
 142         c2++;
 143         c1len--;
 144     }
 145     return 0;
 146 }
 147
 148 // Order of secp256k1's generator minus 1.
 149 const unsigned char vchMaxModOrder[32] = {
 150     0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
 151     0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFE,
 152     0xBA,0xAE,0xDC,0xE6,0xAF,0x48,0xA0,0x3B,
 153     0xBF,0xD2,0x5E,0x8C,0xD0,0x36,0x41,0x40
 154 };
 155
 156 // Half of the order of secp256k1's generator minus 1.
 157 const unsigned char vchMaxModHalfOrder[32] = {
 158     0x7F,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
 159     0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
 160     0x5D,0x57,0x6E,0x73,0x57,0xA4,0x50,0x1D,
 161     0xDF,0xE9,0x2F,0x46,0x68,0x1B,0x20,0xA0
 162 };
 163
 164 const unsigned char *vchZero = NULL;
 165
 166
 167
 168 void CKey::SetCompressedPubKey()
 169 {
 170     EC_KEY_set_conv_form(pkey, POINT_CONVERSION_COMPRESSED);
 171     fCompressedPubKey = true;
 172 }
 173
 174 void CKey::Reset()
 175 {
 176     fCompressedPubKey = false;
 177     if (pkey != NULL)
 178         EC_KEY_free(pkey);
 179     pkey = EC_KEY_new_by_curve_name(NID_secp256k1);
 180     if (pkey == NULL)
 181         throw key_error("CKey::CKey() : EC_KEY_new_by_curve_name failed");
 182     fSet = false;
 183 }
 184
 185 CKey::CKey()
 186 {
 187     pkey = NULL;
 188     Reset();
 189 }
 190
 191 CKey::CKey(const CKey& b)
 192 {
 193     pkey = EC_KEY_dup(b.pkey);
 194     if (pkey == NULL)
 195         throw key_error("CKey::CKey(const CKey&) : EC_KEY_dup failed");
 196     fSet = b.fSet;
 197     fCompressedPubKey = b.fCompressedPubKey;
 198 }
 199
 200 CKey& CKey::operator=(const CKey& b)
 201 {
 202     if (!EC_KEY_copy(pkey, b.pkey))
 203         throw key_error("CKey::operator=(const CKey&) : EC_KEY_copy failed");
 204     fSet = b.fSet;
 205     fCompressedPubKey = b.fCompressedPubKey;
 206     return (*this);
 207 }
 208
 209 CKey::~CKey()
 210 {
 211     EC_KEY_free(pkey);
 212 }
 213
 214 bool CKey::IsNull() const
 215 {
 216     return !fSet;
 217 }
 218
 219 bool CKey::IsCompressed() const
 220 {
 221     return fCompressedPubKey;
 222 }
 223
 224 bool CKey::CheckSignatureElement(const unsigned char *vch, int len, bool half) {
 225     return CompareBigEndian(vch, len, vchZero, 0) > 0 &&
 226         CompareBigEndian(vch, len, half ? vchMaxModHalfOrder : vchMaxModOrder, 32) <= 0;
 227 }
 228
 229 bool CKey::ReserealizeSignature(std::vector<unsigned char>& vchSig)
 230 {
 231     if (vchSig.empty())
 232         return false;
 233
 234     unsigned char *pos = &vchSig[0];
 235     ECDSA_SIG *sig = d2i_ECDSA_SIG(NULL, (const unsigned char **)&pos, vchSig.size());
 236     if (sig == NULL)
 237         return false;
 238
 239     bool ret = false;
 240     int nSize = i2d_ECDSA_SIG(sig, NULL);
 241     if (nSize > 0) {
 242         vchSig.resize(nSize); // grow or shrink as needed
 243
 244         pos = &vchSig[0];
 245         i2d_ECDSA_SIG(sig, &pos);
 246
 247         ret = true;
 248     }
 249
 250     ECDSA_SIG_free(sig);
 251
 252     return ret;
 253 }
 254
 255 void CKey::MakeNewKey(bool fCompressed)
 256 {
 257     if (!EC_KEY_generate_key(pkey))
 258         throw key_error("CKey::MakeNewKey() : EC_KEY_generate_key failed");
 259     if (fCompressed)
 260         SetCompressedPubKey();
 261     fSet = true;
 262 }
 263
 264 bool CKey::SetPrivKey(const CPrivKey& vchPrivKey)
 265 {
 266     const unsigned char* pbegin = &vchPrivKey[0];
 267     if (d2i_ECPrivateKey(&pkey, &pbegin, vchPrivKey.size()))
 268     {
 269         // In testing, d2i_ECPrivateKey can return true
 270         // but fill in pkey with a key that fails
 271         // EC_KEY_check_key, so:
 272         if (EC_KEY_check_key(pkey))
 273         {
 274             fSet = true;
 275             return true;
 276         }
 277     }
 278     // If vchPrivKey data is bad d2i_ECPrivateKey() can
 279     // leave pkey in a state where calling EC_KEY_free()
 280     // crashes. To avoid that, set pkey to NULL and
 281     // leak the memory (a leak is better than a crash)
 282     pkey = NULL;
 283     Reset();
 284     return false;
 285 }
 286
 287 bool CKey::SetSecret(const CSecret& vchSecret, bool fCompressed)
 288 {
 289     EC_KEY_free(pkey);
 290     pkey = EC_KEY_new_by_curve_name(NID_secp256k1);
 291     if (pkey == NULL)
 292         throw key_error("CKey::SetSecret() : EC_KEY_new_by_curve_name failed");
 293     if (vchSecret.size() != 32)
 294         throw key_error("CKey::SetSecret() : secret must be 32 bytes");
 295     BIGNUM *bn = BN_bin2bn(&vchSecret[0],32,BN_new());
 296     if (bn == NULL)
 297         throw key_error("CKey::SetSecret() : BN_bin2bn failed");
 298     if (!EC_KEY_regenerate_key(pkey,bn))
 299     {
 300         BN_clear_free(bn);
 301         throw key_error("CKey::SetSecret() : EC_KEY_regenerate_key failed");
 302     }
 303     BN_clear_free(bn);
 304     fSet = true;
 305     if (fCompressed || fCompressedPubKey)
 306         SetCompressedPubKey();
 307     return true;
 308 }
 309
 310 CSecret CKey::GetSecret(bool &fCompressed) const
 311 {
 312     CSecret vchRet;
 313     vchRet.resize(32);
 314     const BIGNUM *bn = EC_KEY_get0_private_key(pkey);
 315     int nBytes = BN_num_bytes(bn);
 316     if (bn == NULL)
 317         throw key_error("CKey::GetSecret() : EC_KEY_get0_private_key failed");
 318     int n=BN_bn2bin(bn,&vchRet[32 - nBytes]);
 319     if (n != nBytes)
 320         throw key_error("CKey::GetSecret(): BN_bn2bin failed");
 321     fCompressed = fCompressedPubKey;
 322     return vchRet;
 323 }
 324
 325 CPrivKey CKey::GetPrivKey() const
 326 {
 327     int nSize = i2d_ECPrivateKey(pkey, NULL);
 328     if (!nSize)
 329         throw key_error("CKey::GetPrivKey() : i2d_ECPrivateKey failed");
 330     CPrivKey vchPrivKey(nSize, 0);
 331     unsigned char* pbegin = &vchPrivKey[0];
 332     if (i2d_ECPrivateKey(pkey, &pbegin) != nSize)
 333         throw key_error("CKey::GetPrivKey() : i2d_ECPrivateKey returned unexpected size");
 334     return vchPrivKey;
 335 }
 336
 337 bool CKey::SetPubKey(const CPubKey& vchPubKey)
 338 {
 339     const unsigned char* pbegin = &vchPubKey.vchPubKey[0];
 340     if (o2i_ECPublicKey(&pkey, &pbegin, vchPubKey.vchPubKey.size()))
 341     {
 342         fSet = true;
 343         if (vchPubKey.vchPubKey.size() == 33)
 344             SetCompressedPubKey();
 345         return true;
 346     }
 347     pkey = NULL;
 348     Reset();
 349     return false;
 350 }
 351
 352 CPubKey CKey::GetPubKey() const
 353 {
 354     int nSize = i2o_ECPublicKey(pkey, NULL);
 355     if (!nSize)
 356         throw key_error("CKey::GetPubKey() : i2o_ECPublicKey failed");
 357     std::vector<unsigned char> vchPubKey(nSize, 0);
 358     unsigned char* pbegin = &vchPubKey[0];
 359     if (i2o_ECPublicKey(pkey, &pbegin) != nSize)
 360         throw key_error("CKey::GetPubKey() : i2o_ECPublicKey returned unexpected size");
 361     return CPubKey(vchPubKey);
 362 }
 363
 364 bool CKey::Sign(uint256 hash, std::vector<unsigned char>& vchSig)
 365 {
 366     vchSig.clear();
 367     ECDSA_SIG *sig = ECDSA_do_sign((unsigned char*)&hash, sizeof(hash), pkey);
 368     if (sig==NULL)
 369         return false;
 370     const EC_GROUP *group = EC_KEY_get0_group(pkey);
 371     CBigNum order, halforder;
 372     EC_GROUP_get_order(group, &order, NULL);
 373     BN_rshift1(&halforder, &order);
 374     // enforce low S values, by negating the value (modulo the order) if above order/2.
 375     if (BN_cmp(sig->s, &halforder) > 0) {
 376         BN_sub(sig->s, &order, sig->s);
 377     }
 378     unsigned int nSize = ECDSA_size(pkey);
 379     vchSig.resize(nSize); // Make sure it is big enough
 380     unsigned char *pos = &vchSig[0];
 381     nSize = i2d_ECDSA_SIG(sig, &pos);
 382     ECDSA_SIG_free(sig);
 383     vchSig.resize(nSize); // Shrink to fit actual size
 384     // Testing our new signature
 385     if (ECDSA_verify(0, (unsigned char*)&hash, sizeof(hash), &vchSig[0], vchSig.size(), pkey) != 1) {
 386         vchSig.clear();
 387         return false;
 388     }
 389     return true;
 390 }
 391
 392 // create a compact signature (65 bytes), which allows reconstructing the used public key
 393 // The format is one header byte, followed by two times 32 bytes for the serialized r and s values.
 394 // The header byte: 0x1B = first key with even y, 0x1C = first key with odd y,
 395 //                  0x1D = second key with even y, 0x1E = second key with odd y
 396 bool CKey::SignCompact(uint256 hash, std::vector<unsigned char>& vchSig)
 397 {
 398     bool fOk = false;
 399     ECDSA_SIG *sig = ECDSA_do_sign((unsigned char*)&hash, sizeof(hash), pkey);
 400     if (sig==NULL)
 401         return false;
 402     const EC_GROUP *group = EC_KEY_get0_group(pkey);
 403     CBigNum order, halforder;
 404     EC_GROUP_get_order(group, &order, NULL);
 405     BN_rshift1(&halforder, &order);
 406     // enforce low S values, by negating the value (modulo the order) if above order/2.
 407     if (BN_cmp(sig->s, &halforder) > 0) {
 408         BN_sub(sig->s, &order, sig->s);
 409     }
 410     vchSig.clear();
 411     vchSig.resize(65,0);
 412     int nBitsR = BN_num_bits(sig->r);
 413     int nBitsS = BN_num_bits(sig->s);
 414     if (nBitsR <= 256 && nBitsS <= 256)
 415     {
 416         int8_t nRecId = -1;
 417         for (int8_t i=0; i<4; i++)
 418         {
 419             CKey keyRec;
 420             keyRec.fSet = true;
 421             if (fCompressedPubKey)
 422                 keyRec.SetCompressedPubKey();
 423             if (ECDSA_SIG_recover_key_GFp(keyRec.pkey, sig, (unsigned char*)&hash, sizeof(hash), i, 1) == 1)
 424                 if (keyRec.GetPubKey() == this->GetPubKey())
 425                 {
 426                     nRecId = i;
 427                     break;
 428                 }
 429         }
 430
 431         if (nRecId == -1)
 432         {
 433             ECDSA_SIG_free(sig);
 434             throw key_error("CKey::SignCompact() : unable to construct recoverable key");
 435         }
 436
 437         vchSig[0] = nRecId+27+(fCompressedPubKey ? 4 : 0);
 438         BN_bn2bin(sig->r,&vchSig[33-(nBitsR+7)/8]);
 439         BN_bn2bin(sig->s,&vchSig[65-(nBitsS+7)/8]);
 440         fOk = true;
 441     }
 442     ECDSA_SIG_free(sig);
 443     return fOk;
 444 }
 445
 446 // reconstruct public key from a compact signature
 447 // This is only slightly more CPU intensive than just verifying it.
 448 // If this function succeeds, the recovered public key is guaranteed to be valid
 449 // (the signature is a valid signature of the given data for that key)
 450 bool CKey::SetCompactSignature(uint256 hash, const std::vector<unsigned char>& vchSig)
 451 {
 452     if (vchSig.size() != 65)
 453         return false;
 454     int nV = vchSig[0];
 455     if (nV<27 || nV>=35)
 456         return false;
 457     ECDSA_SIG *sig = ECDSA_SIG_new();
 458     BN_bin2bn(&vchSig[1],32,sig->r);
 459     BN_bin2bn(&vchSig[33],32,sig->s);
 460
 461     EC_KEY_free(pkey);
 462     pkey = EC_KEY_new_by_curve_name(NID_secp256k1);
 463     if (nV >= 31)
 464     {
 465         SetCompressedPubKey();
 466         nV -= 4;
 467     }
 468     if (ECDSA_SIG_recover_key_GFp(pkey, sig, (unsigned char*)&hash, sizeof(hash), nV - 27, 0) == 1)
 469     {
 470         fSet = true;
 471         ECDSA_SIG_free(sig);
 472         return true;
 473     }
 474     ECDSA_SIG_free(sig);
 475     return false;
 476 }
 477
 478 bool CKey::Verify(uint256 hash, const std::vector<unsigned char>& vchSig)
 479 {
 480     if (vchSig.empty())
 481         return false;
 482
 483     // New versions of OpenSSL will reject non-canonical DER signatures. de/re-serialize first.
 484     unsigned char *norm_der = NULL;
 485     ECDSA_SIG *norm_sig = ECDSA_SIG_new();
 486     const unsigned char* sigptr = &vchSig[0];
 487     assert(norm_sig);
 488     if (d2i_ECDSA_SIG(&norm_sig, &sigptr, vchSig.size()) == NULL)
 489     {
 490         /* As of OpenSSL 1.0.0p d2i_ECDSA_SIG frees and nulls the pointer on
 491         * error. But OpenSSL's own use of this function redundantly frees the
 492         * result. As ECDSA_SIG_free(NULL) is a no-op, and in the absence of a
 493         * clear contract for the function behaving the same way is more
 494         * conservative.
 495         */
 496         ECDSA_SIG_free(norm_sig);
 497         return false;
 498     }
 499     int derlen = i2d_ECDSA_SIG(norm_sig, &norm_der);
 500     ECDSA_SIG_free(norm_sig);
 501     if (derlen <= 0)
 502         return false;
 503
 504     // -1 = error, 0 = bad sig, 1 = good
 505     bool ret = ECDSA_verify(0, (unsigned char*)&hash, sizeof(hash), norm_der, derlen, pkey) == 1;
 506     OPENSSL_free(norm_der);
 507     return ret;
 508 }
 509
 510 bool CKey::VerifyCompact(uint256 hash, const std::vector<unsigned char>& vchSig)
 511 {
 512     CKey key;
 513     if (!key.SetCompactSignature(hash, vchSig))
 514         return false;
 515     if (GetPubKey() != key.GetPubKey())
 516         return false;
 517
 518     return true;
 519 }
 520
 521 bool CKey::IsValid()
 522 {
 523     if (!fSet)
 524         return false;
 525
 526     if (!EC_KEY_check_key(pkey))
 527         return false;
 528
 529     bool fCompr;
 530     CSecret secret = GetSecret(fCompr);
 531     CKey key2;
 532     key2.SetSecret(secret, fCompr);
 533     return GetPubKey() == key2.GetPubKey();
 534 }