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 }
 198
 199 CKey& CKey::operator=(const CKey& b)
 200 {
 201     if (!EC_KEY_copy(pkey, b.pkey))
 202         throw key_error("CKey::operator=(const CKey&) : EC_KEY_copy failed");
 203     fSet = b.fSet;
 204     fCompressedPubKey = b.fCompressedPubKey;
 205     return (*this);
 206 }
 207
 208 CKey::~CKey()
 209 {
 210     EC_KEY_free(pkey);
 211 }
 212
 213 bool CKey::IsNull() const
 214 {
 215     return !fSet;
 216 }
 217
 218 bool CKey::IsCompressed() const
 219 {
 220     return fCompressedPubKey;
 221 }
 222
 223 bool CKey::CheckSignatureElement(const unsigned char *vch, int len, bool half) {
 224     return CompareBigEndian(vch, len, vchZero, 0) > 0 &&
 225         CompareBigEndian(vch, len, half ? vchMaxModHalfOrder : vchMaxModOrder, 32) <= 0;
 226 }
 227
 228 bool CKey::ReserealizeSignature(std::vector<unsigned char>& vchSig)
 229 {
 230     if (vchSig.empty())
 231         return false;
 232
 233     unsigned char *pos = &vchSig[0];
 234     ECDSA_SIG *sig = d2i_ECDSA_SIG(NULL, (const unsigned char **)&pos, vchSig.size());
 235     if (sig == NULL)
 236         return false;
 237
 238     bool ret = false;
 239     int nSize = i2d_ECDSA_SIG(sig, NULL);
 240     if (nSize > 0) {
 241         vchSig.resize(nSize); // grow or shrink as needed
 242
 243         pos = &vchSig[0];
 244         i2d_ECDSA_SIG(sig, &pos);
 245
 246         ret = true;
 247     }
 248
 249     ECDSA_SIG_free(sig);
 250
 251     return ret;
 252 }
 253
 254 void CKey::MakeNewKey(bool fCompressed)
 255 {
 256     if (!EC_KEY_generate_key(pkey))
 257         throw key_error("CKey::MakeNewKey() : EC_KEY_generate_key failed");
 258     if (fCompressed)
 259         SetCompressedPubKey();
 260     fSet = true;
 261 }
 262
 263 bool CKey::SetPrivKey(const CPrivKey& vchPrivKey)
 264 {
 265     const unsigned char* pbegin = &vchPrivKey[0];
 266     if (d2i_ECPrivateKey(&pkey, &pbegin, vchPrivKey.size()))
 267     {
 268         // In testing, d2i_ECPrivateKey can return true
 269         // but fill in pkey with a key that fails
 270         // EC_KEY_check_key, so:
 271         if (EC_KEY_check_key(pkey))
 272         {
 273             fSet = true;
 274             return true;
 275         }
 276     }
 277     // If vchPrivKey data is bad d2i_ECPrivateKey() can
 278     // leave pkey in a state where calling EC_KEY_free()
 279     // crashes. To avoid that, set pkey to NULL and
 280     // leak the memory (a leak is better than a crash)
 281     pkey = NULL;
 282     Reset();
 283     return false;
 284 }
 285
 286 bool CKey::SetSecret(const CSecret& vchSecret, bool fCompressed)
 287 {
 288     EC_KEY_free(pkey);
 289     pkey = EC_KEY_new_by_curve_name(NID_secp256k1);
 290     if (pkey == NULL)
 291         throw key_error("CKey::SetSecret() : EC_KEY_new_by_curve_name failed");
 292     if (vchSecret.size() != 32)
 293         throw key_error("CKey::SetSecret() : secret must be 32 bytes");
 294     BIGNUM *bn = BN_bin2bn(&vchSecret[0],32,BN_new());
 295     if (bn == NULL)
 296         throw key_error("CKey::SetSecret() : BN_bin2bn failed");
 297     if (!EC_KEY_regenerate_key(pkey,bn))
 298     {
 299         BN_clear_free(bn);
 300         throw key_error("CKey::SetSecret() : EC_KEY_regenerate_key failed");
 301     }
 302     BN_clear_free(bn);
 303     fSet = true;
 304     if (fCompressed || fCompressedPubKey)
 305         SetCompressedPubKey();
 306     return true;
 307 }
 308
 309 CSecret CKey::GetSecret(bool &fCompressed) const
 310 {
 311     CSecret vchRet;
 312     vchRet.resize(32);
 313     const BIGNUM *bn = EC_KEY_get0_private_key(pkey);
 314     int nBytes = BN_num_bytes(bn);
 315     if (bn == NULL)
 316         throw key_error("CKey::GetSecret() : EC_KEY_get0_private_key failed");
 317     int n=BN_bn2bin(bn,&vchRet[32 - nBytes]);
 318     if (n != nBytes)
 319         throw key_error("CKey::GetSecret(): BN_bn2bin failed");
 320     fCompressed = fCompressedPubKey;
 321     return vchRet;
 322 }
 323
 324 CPrivKey CKey::GetPrivKey() const
 325 {
 326     int nSize = i2d_ECPrivateKey(pkey, NULL);
 327     if (!nSize)
 328         throw key_error("CKey::GetPrivKey() : i2d_ECPrivateKey failed");
 329     CPrivKey vchPrivKey(nSize, 0);
 330     unsigned char* pbegin = &vchPrivKey[0];
 331     if (i2d_ECPrivateKey(pkey, &pbegin) != nSize)
 332         throw key_error("CKey::GetPrivKey() : i2d_ECPrivateKey returned unexpected size");
 333     return vchPrivKey;
 334 }
 335
 336 bool CKey::SetPubKey(const CPubKey& vchPubKey)
 337 {
 338     const unsigned char* pbegin = &vchPubKey.vchPubKey[0];
 339     if (o2i_ECPublicKey(&pkey, &pbegin, vchPubKey.vchPubKey.size()))
 340     {
 341         fSet = true;
 342         if (vchPubKey.vchPubKey.size() == 33)
 343             SetCompressedPubKey();
 344         return true;
 345     }
 346     pkey = NULL;
 347     Reset();
 348     return false;
 349 }
 350
 351 CPubKey CKey::GetPubKey() const
 352 {
 353     int nSize = i2o_ECPublicKey(pkey, NULL);
 354     if (!nSize)
 355         throw key_error("CKey::GetPubKey() : i2o_ECPublicKey failed");
 356     std::vector<unsigned char> vchPubKey(nSize, 0);
 357     unsigned char* pbegin = &vchPubKey[0];
 358     if (i2o_ECPublicKey(pkey, &pbegin) != nSize)
 359         throw key_error("CKey::GetPubKey() : i2o_ECPublicKey returned unexpected size");
 360     return CPubKey(vchPubKey);
 361 }
 362
 363 bool CKey::Sign(uint256 hash, std::vector<unsigned char>& vchSig)
 364 {
 365     vchSig.clear();
 366     ECDSA_SIG *sig = ECDSA_do_sign((unsigned char*)&hash, sizeof(hash), pkey);
 367     if (sig==NULL)
 368         return false;
 369     const EC_GROUP *group = EC_KEY_get0_group(pkey);
 370     CBigNum order, halforder;
 371     EC_GROUP_get_order(group, &order, NULL);
 372     BN_rshift1(&halforder, &order);
 373     // enforce low S values, by negating the value (modulo the order) if above order/2.
 374     if (BN_cmp(sig->s, &halforder) > 0) {
 375         BN_sub(sig->s, &order, sig->s);
 376     }
 377     unsigned int nSize = ECDSA_size(pkey);
 378     vchSig.resize(nSize); // Make sure it is big enough
 379     unsigned char *pos = &vchSig[0];
 380     nSize = i2d_ECDSA_SIG(sig, &pos);
 381     ECDSA_SIG_free(sig);
 382     vchSig.resize(nSize); // Shrink to fit actual size
 383     // Testing our new signature
 384     if (ECDSA_verify(0, (unsigned char*)&hash, sizeof(hash), &vchSig[0], vchSig.size(), pkey) != 1) {
 385         vchSig.clear();
 386         return false;
 387     }
 388     return true;
 389 }
 390
 391 // create a compact signature (65 bytes), which allows reconstructing the used public key
 392 // The format is one header byte, followed by two times 32 bytes for the serialized r and s values.
 393 // The header byte: 0x1B = first key with even y, 0x1C = first key with odd y,
 394 //                  0x1D = second key with even y, 0x1E = second key with odd y
 395 bool CKey::SignCompact(uint256 hash, std::vector<unsigned char>& vchSig)
 396 {
 397     bool fOk = false;
 398     ECDSA_SIG *sig = ECDSA_do_sign((unsigned char*)&hash, sizeof(hash), pkey);
 399     if (sig==NULL)
 400         return false;
 401     const EC_GROUP *group = EC_KEY_get0_group(pkey);
 402     CBigNum order, halforder;
 403     EC_GROUP_get_order(group, &order, NULL);
 404     BN_rshift1(&halforder, &order);
 405     // enforce low S values, by negating the value (modulo the order) if above order/2.
 406     if (BN_cmp(sig->s, &halforder) > 0) {
 407         BN_sub(sig->s, &order, sig->s);
 408     }
 409     vchSig.clear();
 410     vchSig.resize(65,0);
 411     int nBitsR = BN_num_bits(sig->r);
 412     int nBitsS = BN_num_bits(sig->s);
 413     if (nBitsR <= 256 && nBitsS <= 256)
 414     {
 415         int8_t nRecId = -1;
 416         for (int8_t i=0; i<4; i++)
 417         {
 418             CKey keyRec;
 419             keyRec.fSet = true;
 420             if (fCompressedPubKey)
 421                 keyRec.SetCompressedPubKey();
 422             if (ECDSA_SIG_recover_key_GFp(keyRec.pkey, sig, (unsigned char*)&hash, sizeof(hash), i, 1) == 1)
 423                 if (keyRec.GetPubKey() == this->GetPubKey())
 424                 {
 425                     nRecId = i;
 426                     break;
 427                 }
 428         }
 429
 430         if (nRecId == -1)
 431         {
 432             ECDSA_SIG_free(sig);
 433             throw key_error("CKey::SignCompact() : unable to construct recoverable key");
 434         }
 435
 436         vchSig[0] = nRecId+27+(fCompressedPubKey ? 4 : 0);
 437         BN_bn2bin(sig->r,&vchSig[33-(nBitsR+7)/8]);
 438         BN_bn2bin(sig->s,&vchSig[65-(nBitsS+7)/8]);
 439         fOk = true;
 440     }
 441     ECDSA_SIG_free(sig);
 442     return fOk;
 443 }
 444
 445 // reconstruct public key from a compact signature
 446 // This is only slightly more CPU intensive than just verifying it.
 447 // If this function succeeds, the recovered public key is guaranteed to be valid
 448 // (the signature is a valid signature of the given data for that key)
 449 bool CKey::SetCompactSignature(uint256 hash, const std::vector<unsigned char>& vchSig)
 450 {
 451     if (vchSig.size() != 65)
 452         return false;
 453     int nV = vchSig[0];
 454     if (nV<27 || nV>=35)
 455         return false;
 456     ECDSA_SIG *sig = ECDSA_SIG_new();
 457     BN_bin2bn(&vchSig[1],32,sig->r);
 458     BN_bin2bn(&vchSig[33],32,sig->s);
 459
 460     EC_KEY_free(pkey);
 461     pkey = EC_KEY_new_by_curve_name(NID_secp256k1);
 462     if (nV >= 31)
 463     {
 464         SetCompressedPubKey();
 465         nV -= 4;
 466     }
 467     if (ECDSA_SIG_recover_key_GFp(pkey, sig, (unsigned char*)&hash, sizeof(hash), nV - 27, 0) == 1)
 468     {
 469         fSet = true;
 470         ECDSA_SIG_free(sig);
 471         return true;
 472     }
 473     ECDSA_SIG_free(sig);
 474     return false;
 475 }
 476
 477 bool CKey::Verify(uint256 hash, const std::vector<unsigned char>& vchSig)
 478 {
 479     if (vchSig.empty())
 480         return false;
 481
 482     // New versions of OpenSSL will reject non-canonical DER signatures. de/re-serialize first.
 483     unsigned char *norm_der = NULL;
 484     ECDSA_SIG *norm_sig = ECDSA_SIG_new();
 485     const unsigned char* sigptr = &vchSig[0];
 486     assert(norm_sig);
 487     if (d2i_ECDSA_SIG(&norm_sig, &sigptr, vchSig.size()) == NULL)
 488     {
 489         /* As of OpenSSL 1.0.0p d2i_ECDSA_SIG frees and nulls the pointer on
 490         * error. But OpenSSL's own use of this function redundantly frees the
 491         * result. As ECDSA_SIG_free(NULL) is a no-op, and in the absence of a
 492         * clear contract for the function behaving the same way is more
 493         * conservative.
 494         */
 495         ECDSA_SIG_free(norm_sig);
 496         return false;
 497     }
 498     int derlen = i2d_ECDSA_SIG(norm_sig, &norm_der);
 499     ECDSA_SIG_free(norm_sig);
 500     if (derlen <= 0)
 501         return false;
 502
 503     // -1 = error, 0 = bad sig, 1 = good
 504     bool ret = ECDSA_verify(0, (unsigned char*)&hash, sizeof(hash), norm_der, derlen, pkey) == 1;
 505     OPENSSL_free(norm_der);
 506     return ret;
 507 }
 508
 509 bool CKey::VerifyCompact(uint256 hash, const std::vector<unsigned char>& vchSig)
 510 {
 511     CKey key;
 512     if (!key.SetCompactSignature(hash, vchSig))
 513         return false;
 514     if (GetPubKey() != key.GetPubKey())
 515         return false;
 516
 517     return true;
 518 }
 519
 520 bool CKey::IsValid()
 521 {
 522     if (!fSet)
 523         return false;
 524
 525     if (!EC_KEY_check_key(pkey))
 526         return false;
 527
 528     bool fCompr;
 529     CSecret secret = GetSecret(fCompr);
 530     CKey key2;
 531     key2.SetSecret(secret, fCompr);
 532     return GetPubKey() == key2.GetPubKey();
 533 }