torbrowser-launcher

   1 #!/usr/bin/env python
   2 from twisted.internet import gtk2reactor
   3 gtk2reactor.install()
   4 from twisted.internet import reactor
   5
   6 import pygtk
   7 pygtk.require('2.0')
   8 import gtk
   9
  10 import os, sys, subprocess, locale, urllib2, gobject, time, pickle, json
  11
  12 from twisted.web.client import Agent, ResponseDone
  13 from twisted.web.http_headers import Headers
  14 from twisted.internet.protocol import Protocol
  15 from twisted.internet.ssl import ClientContextFactory
  16
  17 from OpenSSL.SSL import Context, VERIFY_PEER, VERIFY_FAIL_IF_NO_PEER_CERT
  18 from OpenSSL.crypto import load_certificate, FILETYPE_PEM
  19
  20 class VerifyTorProjectCert(ClientContextFactory):
  21
  22     def __init__(self, torproject_pem):
  23         self.torproject_ca = load_certificate(FILETYPE_PEM, open(torproject_pem, 'r').read())
  24
  25     def getContext(self, host, port):
  26         ctx = ClientContextFactory.getContext(self)
  27         ctx.set_verify_depth(0)
  28         ctx.set_verify(VERIFY_PEER | VERIFY_FAIL_IF_NO_PEER_CERT, self.verifyHostname)
  29         return ctx
  30
  31     def verifyHostname(self, connection, cert, errno, depth, preverifyOK):
  32         return cert.digest('sha256') == self.torproject_ca.digest('sha256')
  33
  34
  35 class TorBrowserLauncher:
  36     def __init__(self):
  37         # initialize the app
  38         self.discover_arch_lang()
  39         self.build_paths()
  40         self.mkdirs()
  41
  42         # allow buttons to have icons
  43         try:
  44             settings = gtk.settings_get_default()
  45             settings.props.gtk_button_images = True
  46         except:
  47             pass
  48
  49         self.launch_gui = True
  50
  51         # load settings
  52         if self.load_settings():
  53             self.build_paths(self.settings['latest_version'])
  54
  55             # how long was it since the last update check?
  56             # 86400 seconds = 24 hours
  57             current_timestamp = int(time.time())
  58             if current_timestamp - self.settings['last_update_check_timestamp'] >= 86400:
  59                 # check for update
  60                 print 'Checking for update'
  61                 self.set_gui('task', "Checking for Tor Browser update.",
  62                     ['download_update_check',
  63                      'attempt_update'])
  64
  65             else:
  66                 # no need to check for update
  67                 print 'Checked for update within 24 hours, skipping'
  68                 self.start_launcher()
  69
  70         else:
  71             self.set_gui('error', "Error loading settings. Delete ~/.torbrowser and try again.", [])
  72
  73         if self.launch_gui:
  74             # set up the window
  75             self.window = gtk.Window(gtk.WINDOW_TOPLEVEL)
  76             self.window.set_title("Tor Browser")
  77             self.window.set_position(gtk.WIN_POS_CENTER)
  78             self.window.set_border_width(10)
  79             self.window.connect("delete_event", self.delete_event)
  80             self.window.connect("destroy", self.destroy)
  81
  82             # build the rest of the UI
  83             self.build_ui()
  84             reactor.run()
  85
  86     # download or run TBB
  87     def start_launcher(self):
  88       # is TBB already installed?
  89       if os.path.isfile(self.paths['file']['start']) and os.access(self.paths['file']['start'], os.X_OK):
  90         if self.settings['installed_version'] == self.settings['latest_version']:
  91           # current version of tbb is installed, launch it
  92           self.run(False)
  93           self.launch_gui = False
  94         elif self.settings['installed_version'] < self.settings['latest_version']:
  95           # there is a tbb upgrade available
  96           self.set_gui('task', "Your Tor Browser is out of date.",
  97             ['download_tarball',
  98              'download_tarball_sig',
  99              'verify',
 100              'extract',
 101              'run'])
 102         else:
 103           # for some reason the installed tbb is newer than the current version?
 104           self.set_gui('error', "Something is wrong. The version of Tor Browser Bundle you have installed is newer than the current version?", [])
 105
 106       # not installed
 107       else:
 108           # are the tarball and sig already downloaded?
 109           if os.path.isfile(self.paths['file']['tarball']) and os.path.isfile(self.paths['file']['tarball_sig']):
 110               # start the gui with verify
 111               self.set_gui('task', "Installing Tor Browser.",
 112                   ['verify',
 113                    'extract',
 114                    'run'])
 115
 116           # first run
 117           else:
 118               self.set_gui('task', "Downloading and installing Tor Browser.",
 119                   ['download_tarball',
 120                    'download_tarball_sig',
 121                    'verify',
 122                    'extract',
 123                    'run'])
 124
 125     # discover the architecture and language
 126     def discover_arch_lang(self):
 127         # figure out the architecture
 128         (sysname, nodename, release, version, machine) = os.uname()
 129         self.architecture = machine
 130
 131         # figure out the language
 132         available_languages = ['en-US', 'ar', 'de', 'es-ES', 'fa', 'fr', 'it', 'ko', 'nl', 'pl', 'pt-PT', 'ru', 'vi', 'zh-CN']
 133         default_locale = locale.getdefaultlocale()[0]
 134         if default_locale == None:
 135             self.language = 'en-US'
 136         else:
 137             self.language = default_locale.replace('_', '-')
 138             if self.language not in available_languages:
 139                 self.language = self.language.split('-')[0]
 140                 if self.language not in available_languages:
 141                     for l in available_languages:
 142                         if l[0:2] == self.language:
 143                             self.language = l
 144             # if language isn't available, default to english
 145             if self.language not in available_languages:
 146                 self.language = 'en-US'
 147
 148     # build all relevant paths
 149     def build_paths(self, tbb_version = None):
 150         tbb_data = os.getenv('HOME')+'/.torbrowser'
 151
 152         if tbb_version:
 153             tarball_filename = 'tor-browser-gnu-linux-'+self.architecture+'-'+tbb_version+'-dev-'+self.language+'.tar.gz'
 154             self.paths['file']['tarball'] = tbb_data+'/download/'+tarball_filename
 155             self.paths['file']['tarball_sig'] = tbb_data+'/download/'+tarball_filename+'.asc'
 156             self.paths['url']['tarball'] = 'https://www.torproject.org/dist/torbrowser/linux/'+tarball_filename
 157             self.paths['url']['tarball_sig'] = 'https://www.torproject.org/dist/torbrowser/linux/'+tarball_filename+'.asc'
 158             self.paths['filename']['tarball'] = tarball_filename
 159             self.paths['filename']['tarball_sig'] = tarball_filename+'.asc'
 160
 161         else:
 162             self.paths = {
 163                 'dir': {
 164                     'data': tbb_data,
 165                     'download': tbb_data+'/download',
 166                     'tbb': tbb_data+'/tbb/'+self.architecture,
 167                     'gpg': tbb_data+'/gpgtmp'
 168                 },
 169                 'file': {
 170                     'settings': tbb_data+'/settings',
 171                     'version': tbb_data+'/version',
 172                     'start': tbb_data+'/tbb/'+self.architecture+'/tor-browser_'+self.language+'/start-tor-browser',
 173                     'update_check': tbb_data+'/download/RecommendedTBBVersions',
 174                     'verify': '/usr/share/torbrowser-launcher/verify.sh',
 175                     'torproject_pem': '/usr/share/torbrowser-launcher/torproject.pem'
 176                 },
 177                 'url': {
 178                     'update_check': 'https://check.torproject.org/RecommendedTBBVersions'
 179                 },
 180                 'filename': {}
 181             }
 182
 183     # create directories that don't exist
 184     def mkdirs(self):
 185         if os.path.exists(self.paths['dir']['download']) == False:
 186             os.makedirs(self.paths['dir']['download'])
 187         if os.path.exists(self.paths['dir']['tbb']) == False:
 188             os.makedirs(self.paths['dir']['tbb'])
 189
 190     # there are different GUIs that might appear, this sets which one we want
 191     def set_gui(self, gui, message, tasks, autostart=True):
 192         self.gui = gui
 193         self.gui_message = message
 194         self.gui_tasks = tasks
 195         self.gui_task_i = 0
 196         self.gui_autostart = autostart
 197
 198     # set all gtk variables to False
 199     def clear_ui(self):
 200         if self.box:
 201             self.box.destroy()
 202         self.box = False
 203
 204         self.label1 = False
 205         self.label2 = False
 206         self.label = False
 207         self.progressbar = False
 208         self.button_box = False
 209         self.start_button = False
 210         self.exit_button = False
 211
 212     # build the application's UI
 213     def build_ui(self):
 214         self.box = gtk.VBox(False, 20)
 215         self.window.add(self.box)
 216
 217         if self.gui == 'error':
 218             # labels
 219             self.label1 = gtk.Label( self.gui_message )
 220             self.label1.set_line_wrap(True)
 221             self.box.pack_start(self.label1, True, True, 0)
 222             self.label1.show()
 223
 224             self.label2 = gtk.Label("You can fix the problem by deleting:\n"+self.paths['dir']['data']+"\n\nHowever, you will lose all your bookmarks and other Tor Browser preferences.")
 225             self.label2.set_line_wrap(True)
 226             self.box.pack_start(self.label2, True, True, 0)
 227             self.label2.show()
 228
 229             # exit button
 230             exit_image = gtk.Image()
 231             exit_image.set_from_stock(gtk.STOCK_CANCEL, gtk.ICON_SIZE_BUTTON)
 232             self.exit_button = gtk.Button("Exit")
 233             self.exit_button.set_image(exit_image)
 234             self.exit_button.connect("clicked", self.destroy, None)
 235             self.box.add(self.exit_button)
 236             self.exit_button.show()
 237
 238         elif self.gui == 'task':
 239             # label
 240             self.label = gtk.Label( self.gui_message )
 241             self.label.set_line_wrap(True)
 242             self.box.pack_start(self.label, True, True, 0)
 243             self.label.show()
 244
 245             # progress bar
 246             self.progressbar = gtk.ProgressBar(adjustment=None)
 247             self.progressbar.set_orientation(gtk.PROGRESS_LEFT_TO_RIGHT)
 248             self.progressbar.set_pulse_step(0.01)
 249             self.box.pack_start(self.progressbar, True, True, 0)
 250
 251             # button box
 252             self.button_box = gtk.HButtonBox()
 253             self.button_box.set_layout(gtk.BUTTONBOX_SPREAD)
 254             self.box.pack_start(self.button_box, True, True, 0)
 255             self.button_box.show()
 256
 257             # start button
 258             start_image = gtk.Image()
 259             start_image.set_from_stock(gtk.STOCK_APPLY, gtk.ICON_SIZE_BUTTON)
 260             self.start_button = gtk.Button("Start")
 261             self.start_button.set_image(start_image)
 262             self.start_button.connect("clicked", self.start, None)
 263             self.button_box.add(self.start_button)
 264             if not self.gui_autostart:
 265               self.start_button.show()
 266
 267             # exit button
 268             exit_image = gtk.Image()
 269             exit_image.set_from_stock(gtk.STOCK_CANCEL, gtk.ICON_SIZE_BUTTON)
 270             self.exit_button = gtk.Button("Exit")
 271             self.exit_button.set_image(exit_image)
 272             self.exit_button.connect("clicked", self.destroy, None)
 273             self.button_box.add(self.exit_button)
 274             self.exit_button.show()
 275
 276         self.box.show()
 277         self.window.show()
 278
 279         if self.gui_autostart:
 280           self.start(None)
 281
 282     # start button clicked, begin tasks
 283     def start(self, widget, data=None):
 284         # disable the start button
 285         if self.start_button:
 286             self.start_button.set_sensitive(False)
 287
 288         # start running tasks
 289         self.run_task()
 290
 291     # run the next task in the task list
 292     def run_task(self):
 293         self.refresh_gtk()
 294
 295         if self.gui_task_i >= len(self.gui_tasks):
 296             self.destroy(False)
 297             return
 298
 299         task = self.gui_tasks[self.gui_task_i]
 300
 301         # get ready for the next task
 302         self.gui_task_i += 1
 303
 304         if task == 'download_update_check':
 305             print 'Downloading '+self.paths['url']['update_check']
 306             self.download('update check', self.paths['url']['update_check'], self.paths['file']['update_check'])
 307
 308         if task == 'attempt_update':
 309             print 'Checking to see if update it needed'
 310             self.attempt_update()
 311
 312         elif task == 'download_tarball':
 313             print 'Downloading '+self.paths['url']['tarball']
 314             self.download('tarball', self.paths['url']['tarball'], self.paths['file']['tarball'])
 315
 316         elif task == 'download_tarball_sig':
 317             print 'Downloading '+self.paths['url']['tarball_sig']
 318             self.download('signature', self.paths['url']['tarball_sig'], self.paths['file']['tarball_sig'])
 319
 320         elif task == 'verify':
 321             print 'Verifying signature'
 322             self.verify()
 323
 324         elif task == 'extract':
 325             print 'Extracting '+self.paths['filename']['tarball']
 326             self.extract()
 327
 328         elif task == 'run':
 329             print 'Running '+self.paths['file']['start']
 330             self.run()
 331
 332         elif task == 'start_over':
 333             print 'Starting download over again'
 334             self.start_over()
 335
 336     def response_received(self, response):
 337         class FileDownloader(Protocol):
 338             def __init__(self, file, total, progress, done_cb):
 339                 self.file = file
 340                 self.total = total
 341                 self.so_far = 0
 342                 self.progress = progress
 343                 self.all_done = done_cb
 344
 345             def dataReceived(self, bytes):
 346                 self.file.write(bytes)
 347                 self.so_far += len(bytes)
 348                 percent = float(self.so_far) / float(self.total)
 349                 self.progress.set_fraction(percent)
 350                 amount = float(self.so_far)
 351                 units = "bytes"
 352                 for (size, unit) in [(1024 * 1024, "MiB"), (1024, "KiB")]:
 353                     if amount > size:
 354                         units = unit
 355                         amount = amount / float(size)
 356                         break
 357
 358                 self.progress.set_text('Downloaded %2.1f%% (%2.1f %s)' % ((percent * 100.0), amount, units))
 359
 360             def connectionLost(self, reason):
 361                 print 'Finished receiving body:', reason.getErrorMessage()
 362                 self.all_done(reason)
 363
 364         dl = FileDownloader(self.file_download, response.length, self.progressbar, self.response_finished)
 365         response.deliverBody(dl)
 366
 367
 368     def response_finished(self, msg):
 369         if msg.check(ResponseDone):
 370             self.file_download.close()
 371             # next task!
 372             self.run_task()
 373
 374         else:
 375             print "FINISHED", msg
 376             ## FIXME handle errors
 377
 378
 379     def error(self, f):
 380         print "FAIL", f
 381
 382
 383     def download(self, name, url, path):
 384         # initialize the progress bar
 385         self.progressbar.set_fraction(0)
 386         self.progressbar.set_text('Downloading '+name)
 387         self.progressbar.show()
 388         self.refresh_gtk()
 389
 390         agent = Agent(reactor, VerifyTorProjectCert(self.paths['file']['torproject_pem']))
 391         d = agent.request('GET', url,
 392                           Headers({'User-Agent': ['torbrowser-launcher']}),
 393                           None)
 394
 395         self.file_download = open(path, 'w')
 396         d.addCallback(self.response_received).addErrback(self.error)
 397
 398     def download_chunk(self, name):
 399         # download 10kb a time
 400         chunk = self.dl_response.read(10240)
 401         self.dl_bytes_so_far += len(chunk)
 402         self.file_download.write(chunk)
 403
 404         if not chunk:
 405             self.file_download.close()
 406             # next task!
 407             self.run_task()
 408             return False
 409
 410         percent = float(self.dl_bytes_so_far) / self.dl_total_size
 411         self.progressbar.set_fraction(percent)
 412         percent = round(percent*100, 2)
 413         self.progressbar.set_text("Downloaded %d%% of %s" % (percent, name))
 414         self.refresh_gtk()
 415
 416         sys.stdout.write("Downloaded %d of %d bytes (%0.2f%%)\r" % (self.dl_bytes_so_far, self.dl_total_size, percent))
 417
 418         if self.dl_bytes_so_far >= self.dl_total_size:
 419             sys.stdout.write('\n')
 420
 421         return True
 422
 423     def attempt_update(self):
 424         # load the update check file
 425         try:
 426             versions = json.load(open(self.paths['file']['update_check']))
 427             latest_version = None
 428
 429             end = '-Linux'
 430             for version in versions:
 431                 if str(version).find(end) != -1:
 432                     latest_version = str(version)
 433
 434             if latest_version:
 435                 self.settings['latest_version'] = latest_version[:-len(end)]
 436                 self.settings['last_update_check_timestamp'] = int(time.time())
 437                 self.save_settings()
 438                 self.build_paths(self.settings['latest_version'])
 439                 self.start_launcher()
 440
 441             else:
 442                 # failed to find the latest version
 443                 self.set_gui('error', "Error checking for updates.", [], False)
 444
 445         except:
 446             # not a valid JSON object
 447             self.set_gui('error', "Error checking for updates.", [], False)
 448
 449         # now start over
 450         self.clear_ui()
 451         self.build_ui()
 452
 453     def verify(self):
 454         # initialize the progress bar
 455         self.progressbar.set_fraction(0)
 456         self.progressbar.set_text('Verifying Signature')
 457         self.progressbar.show()
 458
 459         p = subprocess.Popen([self.paths['file']['verify'], self.paths['dir']['gpg'], self.paths['file']['tarball_sig']], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
 460         self.pulse_until_process_exits(p)
 461
 462         output = p.stdout.read()
 463
 464         if 'Good signature' in output:
 465             self.run_task()
 466         else:
 467             self.progressbar.hide()
 468             self.label.set_text("SIGNATURE VERIFICATION FAILED!\n\nYou might be under attack, or there might just be a networking problem. Click Start try the download again.")
 469             self.gui_tasks = ['start_over']
 470             self.gui_task_i = 0
 471             self.start_button.show()
 472             self.start_button.set_sensitive(True)
 473
 474     def extract(self):
 475         # initialize the progress bar
 476         self.progressbar.set_fraction(0)
 477         self.progressbar.set_text('Installing')
 478         self.progressbar.show()
 479
 480         p = subprocess.Popen(['tar', '-xf', self.paths['file']['tarball'], '-C', self.paths['dir']['tbb']], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
 481         self.pulse_until_process_exits(p)
 482
 483         # installation is finished, so save installed_version
 484         self.settings['installed_version'] = self.settings['latest_version']
 485         self.save_settings()
 486
 487         self.run_task()
 488
 489     def run(self, run_next_task = True):
 490         subprocess.Popen([self.paths['file']['start']])
 491         if run_next_task:
 492             self.run_task()
 493
 494     # make the progress bar pulse until process p (a Popen object) finishes
 495     def pulse_until_process_exits(self, p):
 496         while p.poll() == None:
 497             time.sleep(0.01)
 498             self.progressbar.pulse()
 499             self.refresh_gtk()
 500
 501     # start over and download TBB again
 502     def start_over(self):
 503         self.label.set_text("Downloading Tor Browser Bundle over again.")
 504         self.gui_tasks = ['download_tarball', 'download_tarball_sig', 'verify', 'extract', 'run']
 505         self.gui_task_i = 0
 506         self.start(None)
 507
 508     # load settings
 509     def load_settings(self):
 510         if os.path.isfile(self.paths['file']['settings']):
 511             self.settings = pickle.load(open(self.paths['file']['settings']))
 512             # sanity checks
 513             if not 'installed_version' in self.settings:
 514                 return False
 515             if not 'latest_version' in self.settings:
 516                 return False
 517             if not 'last_update_check_timestamp' in self.settings:
 518                 return False
 519         else:
 520             self.settings = {
 521                 'installed_version': False,
 522                 'latest_version': '0',
 523                 'last_update_check_timestamp': 0
 524             }
 525             self.save_settings()
 526         return True
 527
 528     # save settings
 529     def save_settings(self):
 530         pickle.dump(self.settings, open(self.paths['file']['settings'], 'w'))
 531         return True
 532
 533     # refresh gtk
 534     def refresh_gtk(self):
 535         while gtk.events_pending():
 536             gtk.main_iteration(False)
 537
 538     # exit
 539     def delete_event(self, widget, event, data=None):
 540         return False
 541     def destroy(self, widget, data=None):
 542         self.file_download.close()
 543         reactor.stop()
 544
 545 if __name__ == "__main__":
 546     tor_browser_launcher_version = '0.1'
 547
 548     print 'Tor Browser Launcher'
 549     print 'version %s' % (tor_browser_launcher_version)
 550     print 'https://github.com/micahflee/torbrowser-launcher'
 551
 552     app = TorBrowserLauncher()
 553