lib/bitcoin.py

   1 # -*- coding: utf-8 -*-
   2 #!/usr/bin/env python
   3 #
   4 # Electrum - lightweight Bitcoin client
   5 # Copyright (C) 2011 thomasv@gitorious
   6 #
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21 import hashlib, base64, ecdsa, re
  22 from util import print_error
  23
  24 def rev_hex(s):
  25     return s.decode('hex')[::-1].encode('hex')
  26
  27 def int_to_hex(i, length=1):
  28     s = hex(i)[2:].rstrip('L')
  29     s = "0"*(2*length - len(s)) + s
  30     return rev_hex(s)
  31
  32 def var_int(i):
  33     # https://en.bitcoin.it/wiki/Protocol_specification#Variable_length_integer
  34     if i<0xfd:
  35         return int_to_hex(i)
  36     elif i<=0xffff:
  37         return "fd"+int_to_hex(i,2)
  38     elif i<=0xffffffff:
  39         return "fe"+int_to_hex(i,4)
  40     else:
  41         return "ff"+int_to_hex(i,8)
  42
  43 def op_push(i):
  44     if i<0x4c:
  45         return int_to_hex(i)
  46     elif i<0xff:
  47         return '4c' + int_to_hex(i)
  48     elif i<0xffff:
  49         return '4d' + int_to_hex(i,2)
  50     else:
  51         return '4e' + int_to_hex(i,4)
  52
  53
  54
  55 Hash = lambda x: hashlib.sha256(hashlib.sha256(x).digest()).digest()
  56 hash_encode = lambda x: x[::-1].encode('hex')
  57 hash_decode = lambda x: x.decode('hex')[::-1]
  58
  59
  60 # pywallet openssl private key implementation
  61
  62 def i2d_ECPrivateKey(pkey, compressed=False):
  63     if compressed:
  64         key = '3081d30201010420' + \
  65               '%064x' % pkey.secret + \
  66               'a081a53081a2020101302c06072a8648ce3d0101022100' + \
  67               '%064x' % _p + \
  68               '3006040100040107042102' + \
  69               '%064x' % _Gx + \
  70               '022100' + \
  71               '%064x' % _r + \
  72               '020101a124032200'
  73     else:
  74         key = '308201130201010420' + \
  75               '%064x' % pkey.secret + \
  76               'a081a53081a2020101302c06072a8648ce3d0101022100' + \
  77               '%064x' % _p + \
  78               '3006040100040107044104' + \
  79               '%064x' % _Gx + \
  80               '%064x' % _Gy + \
  81               '022100' + \
  82               '%064x' % _r + \
  83               '020101a144034200'
  84
  85     return key.decode('hex') + i2o_ECPublicKey(pkey.pubkey, compressed)
  86
  87 def i2o_ECPublicKey(pubkey, compressed=False):
  88     # public keys are 65 bytes long (520 bits)
  89     # 0x04 + 32-byte X-coordinate + 32-byte Y-coordinate
  90     # 0x00 = point at infinity, 0x02 and 0x03 = compressed, 0x04 = uncompressed
  91     # compressed keys: <sign> <x> where <sign> is 0x02 if y is even and 0x03 if y is odd
  92     if compressed:
  93         if pubkey.point.y() & 1:
  94             key = '03' + '%064x' % pubkey.point.x()
  95         else:
  96             key = '02' + '%064x' % pubkey.point.x()
  97     else:
  98         key = '04' + \
  99               '%064x' % pubkey.point.x() + \
 100               '%064x' % pubkey.point.y()
 101
 102     return key.decode('hex')
 103
 104 # end pywallet openssl private key implementation
 105
 106
 107
 108 ############ functions from pywallet #####################
 109
 110 def hash_160(public_key):
 111     try:
 112         md = hashlib.new('ripemd160')
 113         md.update(hashlib.sha256(public_key).digest())
 114         return md.digest()
 115     except:
 116         import ripemd
 117         md = ripemd.new(hashlib.sha256(public_key).digest())
 118         return md.digest()
 119
 120
 121 def public_key_to_bc_address(public_key):
 122     h160 = hash_160(public_key)
 123     return hash_160_to_bc_address(h160)
 124
 125 def hash_160_to_bc_address(h160, addrtype = 0):
 126     vh160 = chr(addrtype) + h160
 127     h = Hash(vh160)
 128     addr = vh160 + h[0:4]
 129     return b58encode(addr)
 130
 131 def bc_address_to_hash_160(addr):
 132     bytes = b58decode(addr, 25)
 133     return ord(bytes[0]), bytes[1:21]
 134
 135 def encode_point(pubkey, compressed=False):
 136     order = generator_secp256k1.order()
 137     p = pubkey.pubkey.point
 138     x_str = ecdsa.util.number_to_string(p.x(), order)
 139     y_str = ecdsa.util.number_to_string(p.y(), order)
 140     if compressed:
 141         return chr(2 + (p.y() & 1)) + x_str
 142     else:
 143         return chr(4) + pubkey.to_string() #x_str + y_str
 144
 145 __b58chars = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
 146 __b58base = len(__b58chars)
 147
 148 def b58encode(v):
 149     """ encode v, which is a string of bytes, to base58."""
 150
 151     long_value = 0L
 152     for (i, c) in enumerate(v[::-1]):
 153         long_value += (256**i) * ord(c)
 154
 155     result = ''
 156     while long_value >= __b58base:
 157         div, mod = divmod(long_value, __b58base)
 158         result = __b58chars[mod] + result
 159         long_value = div
 160     result = __b58chars[long_value] + result
 161
 162     # Bitcoin does a little leading-zero-compression:
 163     # leading 0-bytes in the input become leading-1s
 164     nPad = 0
 165     for c in v:
 166         if c == '\0': nPad += 1
 167         else: break
 168
 169     return (__b58chars[0]*nPad) + result
 170
 171 def b58decode(v, length):
 172     """ decode v into a string of len bytes."""
 173     long_value = 0L
 174     for (i, c) in enumerate(v[::-1]):
 175         long_value += __b58chars.find(c) * (__b58base**i)
 176
 177     result = ''
 178     while long_value >= 256:
 179         div, mod = divmod(long_value, 256)
 180         result = chr(mod) + result
 181         long_value = div
 182     result = chr(long_value) + result
 183
 184     nPad = 0
 185     for c in v:
 186         if c == __b58chars[0]: nPad += 1
 187         else: break
 188
 189     result = chr(0)*nPad + result
 190     if length is not None and len(result) != length:
 191         return None
 192
 193     return result
 194
 195
 196 def EncodeBase58Check(vchIn):
 197     hash = Hash(vchIn)
 198     return b58encode(vchIn + hash[0:4])
 199
 200 def DecodeBase58Check(psz):
 201     vchRet = b58decode(psz, None)
 202     key = vchRet[0:-4]
 203     csum = vchRet[-4:]
 204     hash = Hash(key)
 205     cs32 = hash[0:4]
 206     if cs32 != csum:
 207         return None
 208     else:
 209         return key
 210
 211 def PrivKeyToSecret(privkey):
 212     return privkey[9:9+32]
 213
 214 def SecretToASecret(secret, compressed=False, addrtype=0):
 215     vchIn = chr((addrtype+128)&255) + secret
 216     if compressed: vchIn += '\01'
 217     return EncodeBase58Check(vchIn)
 218
 219 def ASecretToSecret(key, addrtype=0):
 220     vch = DecodeBase58Check(key)
 221     if vch and vch[0] == chr((addrtype+128)&255):
 222         return vch[1:]
 223     else:
 224         return False
 225
 226 def regenerate_key(sec):
 227     b = ASecretToSecret(sec)
 228     if not b:
 229         return False
 230     b = b[0:32]
 231     secret = int('0x' + b.encode('hex'), 16)
 232     return EC_KEY(secret)
 233
 234 def GetPubKey(pubkey, compressed=False):
 235     return i2o_ECPublicKey(pubkey, compressed)
 236
 237 def GetPrivKey(pkey, compressed=False):
 238     return i2d_ECPrivateKey(pkey, compressed)
 239
 240 def GetSecret(pkey):
 241     return ('%064x' % pkey.secret).decode('hex')
 242
 243 def is_compressed(sec):
 244     b = ASecretToSecret(sec)
 245     return len(b) == 33
 246
 247
 248 def public_key_from_private_key(sec):
 249     # rebuild public key from private key, compressed or uncompressed
 250     pkey = regenerate_key(sec)
 251     assert pkey
 252     compressed = is_compressed(sec)
 253     public_key = GetPubKey(pkey.pubkey, compressed)
 254     return public_key.encode('hex')
 255
 256
 257 def address_from_private_key(sec):
 258     public_key = public_key_from_private_key(sec)
 259     address = public_key_to_bc_address(public_key.decode('hex'))
 260     return address
 261
 262
 263 def is_valid(addr):
 264     ADDRESS_RE = re.compile('[1-9A-HJ-NP-Za-km-z]{26,}\\Z')
 265     if not ADDRESS_RE.match(addr): return False
 266     try:
 267         addrtype, h = bc_address_to_hash_160(addr)
 268     except:
 269         return False
 270     return addr == hash_160_to_bc_address(h, addrtype)
 271
 272
 273 ########### end pywallet functions #######################
 274
 275 try:
 276     from ecdsa.ecdsa import curve_secp256k1, generator_secp256k1
 277 except:
 278     print "cannot import ecdsa.curve_secp256k1. You probably need to upgrade ecdsa.\nTry: sudo pip install --upgrade ecdsa"
 279     exit()
 280 from ecdsa.curves import SECP256k1
 281 from ecdsa.util import string_to_number, number_to_string
 282
 283 def msg_magic(message):
 284     varint = var_int(len(message))
 285     encoded_varint = "".join([chr(int(varint[i:i+2], 16)) for i in xrange(0, len(varint), 2)])
 286
 287     return "\x18Bitcoin Signed Message:\n" + encoded_varint + message
 288
 289
 290 def verify_message(address, signature, message):
 291     try:
 292         EC_KEY.verify_message(address, signature, message)
 293         return True
 294     except BaseException as e:
 295         print_error("Verification error: {0}".format(e))
 296         return False
 297
 298
 299
 300 class EC_KEY(object):
 301     def __init__( self, secret ):
 302         self.pubkey = ecdsa.ecdsa.Public_key( generator_secp256k1, generator_secp256k1 * secret )
 303         self.privkey = ecdsa.ecdsa.Private_key( self.pubkey, secret )
 304         self.secret = secret
 305
 306     def sign_message(self, message, compressed, address):
 307         private_key = ecdsa.SigningKey.from_secret_exponent( self.secret, curve = SECP256k1 )
 308         public_key = private_key.get_verifying_key()
 309         signature = private_key.sign_digest_deterministic( Hash( msg_magic(message) ), hashfunc=hashlib.sha256, sigencode = ecdsa.util.sigencode_string )
 310         assert public_key.verify_digest( signature, Hash( msg_magic(message) ), sigdecode = ecdsa.util.sigdecode_string)
 311         for i in range(4):
 312             sig = base64.b64encode( chr(27 + i + (4 if compressed else 0)) + signature )
 313             try:
 314                 self.verify_message( address, sig, message)
 315                 return sig
 316             except:
 317                 continue
 318         else:
 319             raise BaseException("error: cannot sign message")
 320
 321     @classmethod
 322     def verify_message(self, address, signature, message):
 323         """ See http://www.secg.org/download/aid-780/sec1-v2.pdf for the math """
 324         from ecdsa import numbertheory, ellipticcurve, util
 325         import msqr
 326         curve = curve_secp256k1
 327         G = generator_secp256k1
 328         order = G.order()
 329         # extract r,s from signature
 330         sig = base64.b64decode(signature)
 331         if len(sig) != 65: raise BaseException("Wrong encoding")
 332         r,s = util.sigdecode_string(sig[1:], order)
 333         nV = ord(sig[0])
 334         if nV < 27 or nV >= 35:
 335             raise BaseException("Bad encoding")
 336         if nV >= 31:
 337             compressed = True
 338             nV -= 4
 339         else:
 340             compressed = False
 341
 342         recid = nV - 27
 343         # 1.1
 344         x = r + (recid/2) * order
 345         # 1.3
 346         alpha = ( x * x * x  + curve.a() * x + curve.b() ) % curve.p()
 347         beta = msqr.modular_sqrt(alpha, curve.p())
 348         y = beta if (beta - recid) % 2 == 0 else curve.p() - beta
 349         # 1.4 the constructor checks that nR is at infinity
 350         R = ellipticcurve.Point(curve, x, y, order)
 351         # 1.5 compute e from message:
 352         h = Hash( msg_magic(message) )
 353         e = string_to_number(h)
 354         minus_e = -e % order
 355         # 1.6 compute Q = r^-1 (sR - eG)
 356         inv_r = numbertheory.inverse_mod(r,order)
 357         Q = inv_r * ( s * R + minus_e * G )
 358         public_key = ecdsa.VerifyingKey.from_public_point( Q, curve = SECP256k1 )
 359         # check that Q is the public key
 360         public_key.verify_digest( sig[1:], h, sigdecode = ecdsa.util.sigdecode_string)
 361         # check that we get the original signing address
 362         addr = public_key_to_bc_address( encode_point(public_key, compressed) )
 363         if address != addr:
 364             raise BaseException("Bad signature")
 365
 366
 367 ###################################### BIP32 ##############################
 368
 369 random_seed = lambda n: "%032x"%ecdsa.util.randrange( pow(2,n) )
 370 BIP32_PRIME = 0x80000000
 371
 372 def bip32_init(seed):
 373     import hmac
 374     seed = seed.decode('hex')
 375     I = hmac.new("Bitcoin seed", seed, hashlib.sha512).digest()
 376
 377     master_secret = I[0:32]
 378     master_chain = I[32:]
 379
 380     K, K_compressed = get_pubkeys_from_secret(master_secret)
 381     return master_secret, master_chain, K, K_compressed
 382
 383
 384 def get_pubkeys_from_secret(secret):
 385     # public key
 386     curve = SECP256k1
 387     private_key = ecdsa.SigningKey.from_string( secret, curve = SECP256k1 )
 388     public_key = private_key.get_verifying_key()
 389     K = public_key.to_string()
 390     K_compressed = GetPubKey(public_key.pubkey,True)
 391     return K, K_compressed
 392
 393
 394
 395
 396 def CKD(k, c, n):
 397     import hmac
 398     from ecdsa.util import string_to_number, number_to_string
 399     order = generator_secp256k1.order()
 400     keypair = EC_KEY(string_to_number(k))
 401     K = GetPubKey(keypair.pubkey,True)
 402
 403     if n & BIP32_PRIME:
 404         data = chr(0) + k + rev_hex(int_to_hex(n,4)).decode('hex')
 405         I = hmac.new(c, data, hashlib.sha512).digest()
 406     else:
 407         I = hmac.new(c, K + rev_hex(int_to_hex(n,4)).decode('hex'), hashlib.sha512).digest()
 408
 409     k_n = number_to_string( (string_to_number(I[0:32]) + string_to_number(k)) % order , order )
 410     c_n = I[32:]
 411     return k_n, c_n
 412
 413
 414 def CKD_prime(K, c, n):
 415     import hmac
 416     from ecdsa.util import string_to_number, number_to_string
 417     order = generator_secp256k1.order()
 418
 419     if n & BIP32_PRIME: raise
 420
 421     K_public_key = ecdsa.VerifyingKey.from_string( K, curve = SECP256k1 )
 422     K_compressed = GetPubKey(K_public_key.pubkey,True)
 423
 424     I = hmac.new(c, K_compressed + rev_hex(int_to_hex(n,4)).decode('hex'), hashlib.sha512).digest()
 425
 426     curve = SECP256k1
 427     pubkey_point = string_to_number(I[0:32])*curve.generator + K_public_key.pubkey.point
 428     public_key = ecdsa.VerifyingKey.from_public_point( pubkey_point, curve = SECP256k1 )
 429
 430     K_n = public_key.to_string()
 431     K_n_compressed = GetPubKey(public_key.pubkey,True)
 432     c_n = I[32:]
 433
 434     return K_n, K_n_compressed, c_n
 435
 436
 437
 438 def bip32_private_derivation(k, c, branch, sequence):
 439     assert sequence.startswith(branch)
 440     sequence = sequence[len(branch):]
 441     for n in sequence.split('/'):
 442         if n == '': continue
 443         n = int(n[:-1]) + BIP32_PRIME if n[-1] == "'" else int(n)
 444         k, c = CKD(k, c, n)
 445     K, K_compressed = get_pubkeys_from_secret(k)
 446     return k.encode('hex'), c.encode('hex'), K.encode('hex'), K_compressed.encode('hex')
 447
 448
 449 def bip32_public_derivation(c, K, branch, sequence):
 450     assert sequence.startswith(branch)
 451     sequence = sequence[len(branch):]
 452     for n in sequence.split('/'):
 453         n = int(n)
 454         K, cK, c = CKD_prime(K, c, n)
 455
 456     return c.encode('hex'), K.encode('hex'), cK.encode('hex')
 457
 458
 459 def bip32_private_key(sequence, k, chain):
 460     for i in sequence:
 461         k, chain = CKD(k, chain, i)
 462     return SecretToASecret(k, True)
 463
 464
 465
 466
 467 ################################## transactions
 468
 469 MIN_RELAY_TX_FEE = 10000
 470
 471
 472
 473 def test_bip32(seed, sequence):
 474     """
 475     run a test vector,
 476     see https://en.bitcoin.it/wiki/BIP_0032_TestVectors
 477     """
 478
 479     master_secret, master_chain, master_public_key, master_public_key_compressed = bip32_init(seed)
 480
 481     print "secret key", master_secret.encode('hex')
 482     print "chain code", master_chain.encode('hex')
 483
 484     key_id = hash_160(master_public_key_compressed)
 485     print "keyid", key_id.encode('hex')
 486     print "base58"
 487     print "address", hash_160_to_bc_address(key_id)
 488     print "secret key", SecretToASecret(master_secret, True)
 489
 490     k = master_secret
 491     c = master_chain
 492
 493     s = ['m']
 494     for n in sequence.split('/'):
 495         s.append(n)
 496         print "Chain [%s]" % '/'.join(s)
 497
 498         n = int(n[:-1]) + BIP32_PRIME if n[-1] == "'" else int(n)
 499         k0, c0 = CKD(k, c, n)
 500         K0, K0_compressed = get_pubkeys_from_secret(k0)
 501
 502         print "* Identifier"
 503         print "  * (main addr)", hash_160_to_bc_address(hash_160(K0_compressed))
 504
 505         print "* Secret Key"
 506         print "  * (hex)", k0.encode('hex')
 507         print "  * (wif)", SecretToASecret(k0, True)
 508
 509         print "* Chain Code"
 510         print "   * (hex)", c0.encode('hex')
 511
 512         k = k0
 513         c = c0
 514     print "----"
 515
 516
 517
 518
 519 if __name__ == '__main__':
 520     test_bip32("000102030405060708090a0b0c0d0e0f", "0'/1/2'/2/1000000000")
 521     test_bip32("fffcf9f6f3f0edeae7e4e1dedbd8d5d2cfccc9c6c3c0bdbab7b4b1aeaba8a5a29f9c999693908d8a8784817e7b7875726f6c696663605d5a5754514e4b484542","0/2147483647'/1/2147483646'/2")
 522