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