lib/interface.py

   1 #!/usr/bin/env python
   2 #
   3 # Electrum - lightweight Bitcoin client
   4 # Copyright (C) 2011 thomasv@gitorious
   5 #
   6 # This program is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation, either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
  18
  19
  20 import random, ast, re, errno, os
  21 import threading, traceback, sys, time, json, Queue
  22 import socks
  23 import socket
  24 import ssl
  25
  26 from version import ELECTRUM_VERSION, PROTOCOL_VERSION
  27 from util import print_error, print_msg
  28 from simple_config import SimpleConfig
  29
  30
  31 DEFAULT_TIMEOUT = 5
  32 proxy_modes = ['socks4', 'socks5', 'http']
  33
  34
  35 def check_cert(host, cert):
  36     from OpenSSL import crypto as c
  37     _cert = c.load_certificate(c.FILETYPE_PEM, cert)
  38
  39     m = "host: %s\n"%host
  40     m += "has_expired: %s\n"% _cert.has_expired()
  41     m += "pubkey: %s bits\n" % _cert.get_pubkey().bits()
  42     m += "serial number: %s\n"% _cert.get_serial_number()
  43     #m += "issuer: %s\n"% _cert.get_issuer()
  44     #m += "algo: %s\n"% _cert.get_signature_algorithm()
  45     m += "version: %s\n"% _cert.get_version()
  46     print_msg(m)
  47
  48
  49 def cert_has_expired(cert_path):
  50     try:
  51         import OpenSSL
  52     except Exception:
  53         print_error("Warning: cannot import OpenSSL")
  54         return False
  55     from OpenSSL import crypto as c
  56     with open(cert_path) as f:
  57         cert = f.read()
  58     _cert = c.load_certificate(c.FILETYPE_PEM, cert)
  59     return _cert.has_expired()
  60
  61
  62 def check_certificates():
  63     config = SimpleConfig()
  64     mydir = os.path.join(config.path, "certs")
  65     certs = os.listdir(mydir)
  66     for c in certs:
  67         print c
  68         p = os.path.join(mydir,c)
  69         with open(p) as f:
  70             cert = f.read()
  71         check_cert(c, cert)
  72
  73
  74 def cert_verify_hostname(s):
  75     # hostname verification (disabled)
  76     from backports.ssl_match_hostname import match_hostname, CertificateError
  77     try:
  78         match_hostname(s.getpeercert(True), host)
  79         print_error("hostname matches", host)
  80     except CertificateError, ce:
  81         print_error("hostname did not match", host)
  82
  83
  84
  85 class Interface(threading.Thread):
  86
  87
  88     def __init__(self, server, config = None):
  89
  90         threading.Thread.__init__(self)
  91         self.daemon = True
  92         self.config = config if config is not None else SimpleConfig()
  93         self.connect_event = threading.Event()
  94
  95         self.subscriptions = {}
  96         self.lock = threading.Lock()
  97
  98         self.rtime = 0
  99         self.bytes_received = 0
 100         self.is_connected = False
 101         self.poll_interval = 1
 102
 103         self.debug = False # dump network messages. can be changed at runtime using the console
 104
 105         #json
 106         self.message_id = 0
 107         self.unanswered_requests = {}
 108         self.pending_transactions_for_notifications= []
 109
 110         # parse server
 111         self.server = server
 112         try:
 113             host, port, protocol = self.server.split(':')
 114             port = int(port)
 115         except Exception:
 116             self.server = None
 117             return
 118
 119         if protocol not in 'ghst':
 120             raise Exception('Unknown protocol: %s'%protocol)
 121
 122         self.host = host
 123         self.port = port
 124         self.protocol = protocol
 125         self.use_ssl = ( protocol in 'sg' )
 126         self.proxy = self.parse_proxy_options(self.config.get('proxy'))
 127         if self.proxy:
 128             self.proxy_mode = proxy_modes.index(self.proxy["mode"]) + 1
 129
 130
 131
 132
 133
 134     def queue_json_response(self, c):
 135
 136         # uncomment to debug
 137         if self.debug:
 138             print_error( "<--",c )
 139
 140         msg_id = c.get('id')
 141         error = c.get('error')
 142
 143         if error:
 144             print_error("received error:", c)
 145             if msg_id is not None:
 146                 with self.lock:
 147                     method, params, callback = self.unanswered_requests.pop(msg_id)
 148                 callback(self,{'method':method, 'params':params, 'error':error, 'id':msg_id})
 149
 150             return
 151
 152         if msg_id is not None:
 153             with self.lock:
 154                 method, params, callback = self.unanswered_requests.pop(msg_id)
 155             result = c.get('result')
 156
 157         else:
 158             # notification
 159             method = c.get('method')
 160             params = c.get('params')
 161
 162             if method == 'blockchain.numblocks.subscribe':
 163                 result = params[0]
 164                 params = []
 165
 166             elif method == 'blockchain.headers.subscribe':
 167                 result = params[0]
 168                 params = []
 169
 170             elif method == 'blockchain.address.subscribe':
 171                 addr = params[0]
 172                 result = params[1]
 173                 params = [addr]
 174
 175             with self.lock:
 176                 for k,v in self.subscriptions.items():
 177                     if (method, params) in v:
 178                         callback = k
 179                         break
 180                 else:
 181                     print_error( "received unexpected notification", method, params)
 182                     print_error( self.subscriptions )
 183                     return
 184
 185
 186         callback(self, {'method':method, 'params':params, 'result':result, 'id':msg_id})
 187
 188
 189     def on_version(self, i, result):
 190         self.server_version = result
 191
 192
 193     def start_http(self):
 194         self.session_id = None
 195         self.is_connected = True
 196         self.connection_msg = ('https' if self.use_ssl else 'http') + '://%s:%d'%( self.host, self.port )
 197         try:
 198             self.poll()
 199         except Exception:
 200             print_error("http init session failed")
 201             self.is_connected = False
 202             return
 203
 204         if self.session_id:
 205             print_error('http session:',self.session_id)
 206             self.is_connected = True
 207         else:
 208             self.is_connected = False
 209
 210     def run_http(self):
 211         self.is_connected = True
 212         while self.is_connected:
 213             try:
 214                 if self.session_id:
 215                     self.poll()
 216                 time.sleep(self.poll_interval)
 217             except socket.gaierror:
 218                 break
 219             except socket.error:
 220                 break
 221             except Exception:
 222                 traceback.print_exc(file=sys.stdout)
 223                 break
 224
 225         self.is_connected = False
 226
 227
 228     def poll(self):
 229         self.send([], None)
 230
 231
 232     def send_http(self, messages, callback):
 233         import urllib2, json, time, cookielib
 234         print_error( "send_http", messages )
 235
 236         if self.proxy:
 237             socks.setdefaultproxy(self.proxy_mode, self.proxy["host"], int(self.proxy["port"]) )
 238             socks.wrapmodule(urllib2)
 239
 240         cj = cookielib.CookieJar()
 241         opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
 242         urllib2.install_opener(opener)
 243
 244         t1 = time.time()
 245
 246         data = []
 247         for m in messages:
 248             method, params = m
 249             if type(params) != type([]): params = [params]
 250             data.append( { 'method':method, 'id':self.message_id, 'params':params } )
 251             self.unanswered_requests[self.message_id] = method, params, callback
 252             self.message_id += 1
 253
 254         if data:
 255             data_json = json.dumps(data)
 256         else:
 257             # poll with GET
 258             data_json = None
 259
 260
 261         headers = {'content-type': 'application/json'}
 262         if self.session_id:
 263             headers['cookie'] = 'SESSION=%s'%self.session_id
 264
 265         try:
 266             req = urllib2.Request(self.connection_msg, data_json, headers)
 267             response_stream = urllib2.urlopen(req, timeout=DEFAULT_TIMEOUT)
 268         except Exception:
 269             return
 270
 271         for index, cookie in enumerate(cj):
 272             if cookie.name=='SESSION':
 273                 self.session_id = cookie.value
 274
 275         response = response_stream.read()
 276         self.bytes_received += len(response)
 277         if response:
 278             response = json.loads( response )
 279             if type(response) is not type([]):
 280                 self.queue_json_response(response)
 281             else:
 282                 for item in response:
 283                     self.queue_json_response(item)
 284
 285         if response:
 286             self.poll_interval = 1
 287         else:
 288             if self.poll_interval < 15:
 289                 self.poll_interval += 1
 290         #print self.poll_interval, response
 291
 292         self.rtime = time.time() - t1
 293         self.is_connected = True
 294
 295
 296
 297
 298     def start_tcp(self):
 299
 300         self.connection_msg = self.host + ':%d' % self.port
 301
 302         if self.proxy is not None:
 303
 304             socks.setdefaultproxy(self.proxy_mode, self.proxy["host"], int(self.proxy["port"]))
 305             socket.socket = socks.socksocket
 306             # prevent dns leaks, see http://stackoverflow.com/questions/13184205/dns-over-proxy
 307             def getaddrinfo(*args):
 308                 return [(socket.AF_INET, socket.SOCK_STREAM, 6, '', (args[0], args[1]))]
 309             socket.getaddrinfo = getaddrinfo
 310
 311         if self.use_ssl:
 312             cert_path = os.path.join( self.config.path, 'certs', self.host)
 313
 314             if not os.path.exists(cert_path):
 315                 is_new = True
 316                 # get server certificate.
 317                 # Do not use ssl.get_server_certificate because it does not work with proxy
 318                 try:
 319                     l = socket.getaddrinfo(self.host, self.port, socket.AF_UNSPEC, socket.SOCK_STREAM)
 320                 except socket.gaierror:
 321                     print_error("error: cannot resolve", self.host)
 322                     return
 323
 324                 for res in l:
 325                     try:
 326                         s = socket.socket( res[0], socket.SOCK_STREAM )
 327                         s.connect(res[4])
 328                     except:
 329                         s = None
 330                         continue
 331
 332                     try:
 333                         s = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_SSLv3, cert_reqs=ssl.CERT_NONE, ca_certs=None)
 334                     except ssl.SSLError, e:
 335                         print_error("SSL error retrieving SSL certificate:", self.host, e)
 336                         s = None
 337
 338                     break
 339
 340                 if s is None:
 341                     return
 342
 343                 dercert = s.getpeercert(True)
 344                 s.close()
 345                 cert = ssl.DER_cert_to_PEM_cert(dercert)
 346                 # workaround android bug
 347                 cert = re.sub("([^\n])-----END CERTIFICATE-----","\\1\n-----END CERTIFICATE-----",cert)
 348                 temporary_path = cert_path + '.temp'
 349                 with open(temporary_path,"w") as f:
 350                     f.write(cert)
 351
 352             else:
 353                 is_new = False
 354
 355         try:
 356             addrinfo = socket.getaddrinfo(self.host, self.port, socket.AF_UNSPEC, socket.SOCK_STREAM)
 357         except socket.gaierror:
 358             print_error("error: cannot resolve", self.host)
 359             return
 360
 361         for res in addrinfo:
 362             try:
 363                 s = socket.socket( res[0], socket.SOCK_STREAM )
 364                 s.settimeout(2)
 365                 s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
 366                 s.connect(res[4])
 367             except:
 368                 s = None
 369                 continue
 370             break
 371
 372         if s is None:
 373             print_error("failed to connect", self.host, self.port)
 374             return
 375
 376         if self.use_ssl:
 377             try:
 378                 s = ssl.wrap_socket(s,
 379                                     ssl_version=ssl.PROTOCOL_SSLv3,
 380                                     cert_reqs=ssl.CERT_REQUIRED,
 381                                     ca_certs= (temporary_path if is_new else cert_path),
 382                                     do_handshake_on_connect=True)
 383             except ssl.SSLError, e:
 384                 print_error("SSL error:", self.host, e)
 385                 if e.errno != 1:
 386                     return
 387                 if is_new:
 388                     rej = cert_path + '.rej'
 389                     if os.path.exists(rej):
 390                         os.unlink(rej)
 391                     os.rename(temporary_path, rej)
 392                 else:
 393                     if cert_has_expired(cert_path):
 394                         print_error("certificate has expired:", cert_path)
 395                         os.unlink(cert_path)
 396                     else:
 397                         print_msg("wrong certificate", self.host)
 398                 return
 399             except Exception:
 400                 print_error("wrap_socket failed", self.host)
 401                 traceback.print_exc(file=sys.stdout)
 402                 return
 403
 404             if is_new:
 405                 print_error("saving certificate for", self.host)
 406                 os.rename(temporary_path, cert_path)
 407
 408         s.settimeout(60)
 409         self.s = s
 410         self.is_connected = True
 411         print_error("connected to", self.host, self.port)
 412
 413
 414     def run_tcp(self):
 415         try:
 416             #if self.use_ssl: self.s.do_handshake()
 417             out = ''
 418             while self.is_connected:
 419                 try:
 420                     timeout = False
 421                     msg = self.s.recv(1024)
 422                 except socket.timeout:
 423                     timeout = True
 424                 except ssl.SSLError:
 425                     timeout = True
 426                 except socket.error, err:
 427                     if err.errno in [11, 10035]:
 428                         print_error("socket errno", err.errno)
 429                         time.sleep(0.1)
 430                         continue
 431                     else:
 432                         traceback.print_exc(file=sys.stdout)
 433                         raise
 434
 435                 if timeout:
 436                     # ping the server with server.version, as a real ping does not exist yet
 437                     self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])], self.on_version)
 438                     continue
 439
 440                 out += msg
 441                 self.bytes_received += len(msg)
 442                 if msg == '':
 443                     self.is_connected = False
 444
 445                 while True:
 446                     s = out.find('\n')
 447                     if s==-1: break
 448                     c = out[0:s]
 449                     out = out[s+1:]
 450                     c = json.loads(c)
 451                     self.queue_json_response(c)
 452
 453         except Exception:
 454             traceback.print_exc(file=sys.stdout)
 455
 456         self.is_connected = False
 457
 458
 459     def send_tcp(self, messages, callback):
 460         """return the ids of the requests that we sent"""
 461         out = ''
 462         ids = []
 463         for m in messages:
 464             method, params = m
 465             request = json.dumps( { 'id':self.message_id, 'method':method, 'params':params } )
 466             self.unanswered_requests[self.message_id] = method, params, callback
 467             ids.append(self.message_id)
 468             if self.debug:
 469                 print "-->", request
 470             self.message_id += 1
 471             out += request + '\n'
 472         while out:
 473             try:
 474                 sent = self.s.send( out )
 475                 out = out[sent:]
 476             except socket.error,e:
 477                 if e[0] in (errno.EWOULDBLOCK,errno.EAGAIN):
 478                     print_error( "EAGAIN: retrying")
 479                     time.sleep(0.1)
 480                     continue
 481                 else:
 482                     traceback.print_exc(file=sys.stdout)
 483                     # this happens when we get disconnected
 484                     print_error( "Not connected, cannot send" )
 485                     return None
 486         return ids
 487
 488
 489
 490
 491
 492     def start_interface(self):
 493
 494         if self.protocol in 'st':
 495             self.start_tcp()
 496         elif self.protocol in 'gh':
 497             self.start_http()
 498
 499         self.connect_event.set()
 500
 501
 502
 503     def stop_subscriptions(self):
 504         for callback in self.subscriptions.keys():
 505             callback(self, None)
 506         self.subscriptions = {}
 507
 508
 509     def send(self, messages, callback):
 510
 511         sub = []
 512         for message in messages:
 513             m, v = message
 514             if m[-10:] == '.subscribe':
 515                 sub.append(message)
 516
 517         if sub:
 518             with self.lock:
 519                 if self.subscriptions.get(callback) is None:
 520                     self.subscriptions[callback] = []
 521                 for message in sub:
 522                     if message not in self.subscriptions[callback]:
 523                         self.subscriptions[callback].append(message)
 524
 525         if not self.is_connected:
 526             print_error("interface: trying to send while not connected")
 527             return
 528
 529         if self.protocol in 'st':
 530             with self.lock:
 531                 out = self.send_tcp(messages, callback)
 532         else:
 533             # do not use lock, http is synchronous
 534             out = self.send_http(messages, callback)
 535
 536         return out
 537
 538
 539     def parse_proxy_options(self, s):
 540         if type(s) == type({}): return s  # fixme: type should be fixed
 541         if type(s) != type(""): return None
 542         if s.lower() == 'none': return None
 543         proxy = { "mode":"socks5", "host":"localhost" }
 544         args = s.split(':')
 545         n = 0
 546         if proxy_modes.count(args[n]) == 1:
 547             proxy["mode"] = args[n]
 548             n += 1
 549         if len(args) > n:
 550             proxy["host"] = args[n]
 551             n += 1
 552         if len(args) > n:
 553             proxy["port"] = args[n]
 554         else:
 555             proxy["port"] = "8080" if proxy["mode"] == "http" else "1080"
 556         return proxy
 557
 558
 559
 560     def stop(self):
 561         if self.is_connected and self.protocol in 'st' and self.s:
 562             self.s.shutdown(socket.SHUT_RDWR)
 563             self.s.close()
 564
 565
 566     def is_up_to_date(self):
 567         return self.unanswered_requests == {}
 568
 569
 570
 571     def start(self, queue = None, wait = False):
 572         if not self.server:
 573             return
 574         self.queue = queue if queue else Queue.Queue()
 575         threading.Thread.start(self)
 576         if wait:
 577             self.connect_event.wait()
 578
 579
 580     def run(self):
 581         self.start_interface()
 582         if self.is_connected:
 583             self.send([('server.version', [ELECTRUM_VERSION, PROTOCOL_VERSION])], self.on_version)
 584             self.change_status()
 585             self.run_tcp() if self.protocol in 'st' else self.run_http()
 586         self.change_status()
 587
 588
 589     def change_status(self):
 590         #print "change status", self.server, self.is_connected
 591         self.queue.put(self)
 592
 593
 594
 595 if __name__ == "__main__":
 596
 597     check_certificates()