src/allmydata/client.py

   1 import os, stat, time, weakref
   2 from allmydata import node
   3
   4 from zope.interface import implements
   5 from twisted.internet import reactor, defer
   6 from twisted.application import service
   7 from twisted.application.internet import TimerService
   8 from pycryptopp.publickey import rsa
   9
  10 import allmydata
  11 from allmydata.storage.server import StorageServer
  12 from allmydata import storage_client
  13 from allmydata.immutable.upload import Uploader
  14 from allmydata.immutable.offloaded import Helper
  15 from allmydata.control import ControlServer
  16 from allmydata.introducer.client import IntroducerClient
  17 from allmydata.util import hashutil, base32, pollmixin, log, keyutil
  18 from allmydata.util.encodingutil import get_filesystem_encoding
  19 from allmydata.util.abbreviate import parse_abbreviated_size
  20 from allmydata.util.time_format import parse_duration, parse_date
  21 from allmydata.stats import StatsProvider
  22 from allmydata.history import History
  23 from allmydata.interfaces import IStatsProducer, SDMF_VERSION, MDMF_VERSION
  24 from allmydata.nodemaker import NodeMaker
  25 from allmydata.blacklist import Blacklist
  26 from allmydata.node import OldConfigOptionError
  27
  28
  29 KiB=1024
  30 MiB=1024*KiB
  31 GiB=1024*MiB
  32 TiB=1024*GiB
  33 PiB=1024*TiB
  34
  35 def _make_secret():
  36     return base32.b2a(os.urandom(hashutil.CRYPTO_VAL_SIZE)) + "\n"
  37
  38 class SecretHolder:
  39     def __init__(self, lease_secret, convergence_secret):
  40         self._lease_secret = lease_secret
  41         self._convergence_secret = convergence_secret
  42
  43     def get_renewal_secret(self):
  44         return hashutil.my_renewal_secret_hash(self._lease_secret)
  45
  46     def get_cancel_secret(self):
  47         return hashutil.my_cancel_secret_hash(self._lease_secret)
  48
  49     def get_convergence_secret(self):
  50         return self._convergence_secret
  51
  52 class KeyGenerator:
  53     """I create RSA keys for mutable files. Each call to generate() returns a
  54     single keypair. The keysize is specified first by the keysize= argument
  55     to generate(), then with a default set by set_default_keysize(), then
  56     with a built-in default of 2048 bits."""
  57     def __init__(self):
  58         self._remote = None
  59         self.default_keysize = 2048
  60
  61     def set_remote_generator(self, keygen):
  62         self._remote = keygen
  63     def set_default_keysize(self, keysize):
  64         """Call this to override the size of the RSA keys created for new
  65         mutable files which don't otherwise specify a size. This will affect
  66         all subsequent calls to generate() without a keysize= argument. The
  67         default size is 2048 bits. Test cases should call this method once
  68         during setup, to cause me to create smaller keys, so the unit tests
  69         run faster."""
  70         self.default_keysize = keysize
  71
  72     def generate(self, keysize=None):
  73         """I return a Deferred that fires with a (verifyingkey, signingkey)
  74         pair. I accept a keysize in bits (2048 bit keys are standard, smaller
  75         keys are used for testing). If you do not provide a keysize, I will
  76         use my default, which is set by a call to set_default_keysize(). If
  77         set_default_keysize() has never been called, I will create 2048 bit
  78         keys."""
  79         keysize = keysize or self.default_keysize
  80         if self._remote:
  81             d = self._remote.callRemote('get_rsa_key_pair', keysize)
  82             def make_key_objs((verifying_key, signing_key)):
  83                 v = rsa.create_verifying_key_from_string(verifying_key)
  84                 s = rsa.create_signing_key_from_string(signing_key)
  85                 return v, s
  86             d.addCallback(make_key_objs)
  87             return d
  88         else:
  89             # RSA key generation for a 2048 bit key takes between 0.8 and 3.2
  90             # secs
  91             signer = rsa.generate(keysize)
  92             verifier = signer.get_verifying_key()
  93             return defer.succeed( (verifier, signer) )
  94
  95 class Terminator(service.Service):
  96     def __init__(self):
  97         self._clients = weakref.WeakKeyDictionary()
  98     def register(self, c):
  99         self._clients[c] = None
 100     def stopService(self):
 101         for c in self._clients:
 102             c.stop()
 103         return service.Service.stopService(self)
 104
 105
 106 class Client(node.Node, pollmixin.PollMixin):
 107     implements(IStatsProducer)
 108
 109     PORTNUMFILE = "client.port"
 110     STOREDIR = 'storage'
 111     NODETYPE = "client"
 112     SUICIDE_PREVENTION_HOTLINE_FILE = "suicide_prevention_hotline"
 113
 114     # This means that if a storage server treats me as though I were a
 115     # 1.0.0 storage client, it will work as they expect.
 116     OLDEST_SUPPORTED_VERSION = "1.0.0"
 117
 118     # this is a tuple of (needed, desired, total, max_segment_size). 'needed'
 119     # is the number of shares required to reconstruct a file. 'desired' means
 120     # that we will abort an upload unless we can allocate space for at least
 121     # this many. 'total' is the total number of shares created by encoding.
 122     # If everybody has room then this is is how many we will upload.
 123     DEFAULT_ENCODING_PARAMETERS = {"k": 3,
 124                                    "happy": 7,
 125                                    "n": 10,
 126                                    "max_segment_size": 128*KiB,
 127                                    }
 128
 129     def __init__(self, basedir="."):
 130         node.Node.__init__(self, basedir)
 131         self.started_timestamp = time.time()
 132         self.logSource="Client"
 133         self.DEFAULT_ENCODING_PARAMETERS = self.DEFAULT_ENCODING_PARAMETERS.copy()
 134         self.init_introducer_client()
 135         self.init_stats_provider()
 136         self.init_secrets()
 137         self.init_storage()
 138         self.init_control()
 139         self.helper = None
 140         if self.get_config("helper", "enabled", False, boolean=True):
 141             self.init_helper()
 142         self._key_generator = KeyGenerator()
 143         key_gen_furl = self.get_config("client", "key_generator.furl", None)
 144         if key_gen_furl:
 145             self.init_key_gen(key_gen_furl)
 146         self.init_client()
 147         # ControlServer and Helper are attached after Tub startup
 148         self.init_ftp_server()
 149         self.init_sftp_server()
 150         self.init_drop_uploader()
 151
 152         hotline_file = os.path.join(self.basedir,
 153                                     self.SUICIDE_PREVENTION_HOTLINE_FILE)
 154         if os.path.exists(hotline_file):
 155             age = time.time() - os.stat(hotline_file)[stat.ST_MTIME]
 156             self.log("hotline file noticed (%ds old), starting timer" % age)
 157             hotline = TimerService(1.0, self._check_hotline, hotline_file)
 158             hotline.setServiceParent(self)
 159
 160         # this needs to happen last, so it can use getServiceNamed() to
 161         # acquire references to StorageServer and other web-statusable things
 162         webport = self.get_config("node", "web.port", None)
 163         if webport:
 164             self.init_web(webport) # strports string
 165
 166     def init_introducer_client(self):
 167         self.introducer_furl = self.get_config("client", "introducer.furl")
 168         ic = IntroducerClient(self.tub, self.introducer_furl,
 169                               self.nickname,
 170                               str(allmydata.__full_version__),
 171                               str(self.OLDEST_SUPPORTED_VERSION),
 172                               self.get_app_versions())
 173         self.introducer_client = ic
 174         # hold off on starting the IntroducerClient until our tub has been
 175         # started, so we'll have a useful address on our RemoteReference, so
 176         # that the introducer's status page will show us.
 177         d = self.when_tub_ready()
 178         def _start_introducer_client(res):
 179             ic.setServiceParent(self)
 180         d.addCallback(_start_introducer_client)
 181         d.addErrback(log.err, facility="tahoe.init",
 182                      level=log.BAD, umid="URyI5w")
 183
 184     def init_stats_provider(self):
 185         gatherer_furl = self.get_config("client", "stats_gatherer.furl", None)
 186         self.stats_provider = StatsProvider(self, gatherer_furl)
 187         self.add_service(self.stats_provider)
 188         self.stats_provider.register_producer(self)
 189
 190     def get_stats(self):
 191         return { 'node.uptime': time.time() - self.started_timestamp }
 192
 193     def init_secrets(self):
 194         lease_s = self.get_or_create_private_config("secret", _make_secret)
 195         lease_secret = base32.a2b(lease_s)
 196         convergence_s = self.get_or_create_private_config('convergence',
 197                                                           _make_secret)
 198         self.convergence = base32.a2b(convergence_s)
 199         self._secret_holder = SecretHolder(lease_secret, self.convergence)
 200
 201     def _maybe_create_server_key(self):
 202         # we only create the key once. On all subsequent runs, we re-use the
 203         # existing key
 204         def _make_key():
 205             sk_vs,vk_vs = keyutil.make_keypair()
 206             return sk_vs+"\n"
 207         sk_vs = self.get_or_create_private_config("server.privkey", _make_key)
 208         sk,vk_vs = keyutil.parse_privkey(sk_vs.strip())
 209         self.write_config("server.pubkey", vk_vs+"\n")
 210         self._server_key = sk
 211
 212     def _init_permutation_seed(self, ss):
 213         seed = self.get_config_from_file("permutation-seed")
 214         if not seed:
 215             have_shares = ss.have_shares()
 216             if have_shares:
 217                 # if the server has shares but not a recorded
 218                 # permutation-seed, then it has been around since pre-#466
 219                 # days, and the clients who uploaded those shares used our
 220                 # TubID as a permutation-seed. We should keep using that same
 221                 # seed to keep the shares in the same place in the permuted
 222                 # ring, so those clients don't have to perform excessive
 223                 # searches.
 224                 seed = base32.b2a(self.nodeid)
 225             else:
 226                 # otherwise, we're free to use the more natural seed of our
 227                 # pubkey-based serverid
 228                 vk_bytes = self._server_key.get_verifying_key_bytes()
 229                 seed = base32.b2a(vk_bytes)
 230             self.write_config("permutation-seed", seed+"\n")
 231         return seed.strip()
 232
 233     def init_storage(self):
 234         # should we run a storage server (and publish it for others to use)?
 235         if not self.get_config("storage", "enabled", True, boolean=True):
 236             return
 237         readonly = self.get_config("storage", "readonly", False, boolean=True)
 238
 239         self._maybe_create_server_key()
 240
 241         storedir = os.path.join(self.basedir, self.STOREDIR)
 242
 243         data = self.get_config("storage", "reserved_space", None)
 244         reserved = None
 245         try:
 246             reserved = parse_abbreviated_size(data)
 247         except ValueError:
 248             log.msg("[storage]reserved_space= contains unparseable value %s"
 249                     % data)
 250         if reserved is None:
 251             reserved = 0
 252         discard = self.get_config("storage", "debug_discard", False,
 253                                   boolean=True)
 254
 255         expire = self.get_config("storage", "expire.enabled", False, boolean=True)
 256         if expire:
 257             mode = self.get_config("storage", "expire.mode") # require a mode
 258         else:
 259             mode = self.get_config("storage", "expire.mode", "age")
 260
 261         o_l_d = self.get_config("storage", "expire.override_lease_duration", None)
 262         if o_l_d is not None:
 263             o_l_d = parse_duration(o_l_d)
 264
 265         cutoff_date = None
 266         if mode == "cutoff-date":
 267             cutoff_date = self.get_config("storage", "expire.cutoff_date")
 268             cutoff_date = parse_date(cutoff_date)
 269
 270         sharetypes = []
 271         if self.get_config("storage", "expire.immutable", True, boolean=True):
 272             sharetypes.append("immutable")
 273         if self.get_config("storage", "expire.mutable", True, boolean=True):
 274             sharetypes.append("mutable")
 275         expiration_sharetypes = tuple(sharetypes)
 276
 277         ss = StorageServer(storedir, self.nodeid,
 278                            reserved_space=reserved,
 279                            discard_storage=discard,
 280                            readonly_storage=readonly,
 281                            stats_provider=self.stats_provider,
 282                            expiration_enabled=expire,
 283                            expiration_mode=mode,
 284                            expiration_override_lease_duration=o_l_d,
 285                            expiration_cutoff_date=cutoff_date,
 286                            expiration_sharetypes=expiration_sharetypes)
 287         self.add_service(ss)
 288
 289         d = self.when_tub_ready()
 290         # we can't do registerReference until the Tub is ready
 291         def _publish(res):
 292             furl_file = os.path.join(self.basedir, "private", "storage.furl").encode(get_filesystem_encoding())
 293             furl = self.tub.registerReference(ss, furlFile=furl_file)
 294             ann = {"anonymous-storage-FURL": furl,
 295                    "permutation-seed-base32": self._init_permutation_seed(ss),
 296                    }
 297             self.introducer_client.publish("storage", ann, self._server_key)
 298         d.addCallback(_publish)
 299         d.addErrback(log.err, facility="tahoe.init",
 300                      level=log.BAD, umid="aLGBKw")
 301
 302     def init_client(self):
 303         helper_furl = self.get_config("client", "helper.furl", None)
 304         DEP = self.DEFAULT_ENCODING_PARAMETERS
 305         DEP["k"] = int(self.get_config("client", "shares.needed", DEP["k"]))
 306         DEP["n"] = int(self.get_config("client", "shares.total", DEP["n"]))
 307         DEP["happy"] = int(self.get_config("client", "shares.happy", DEP["happy"]))
 308
 309         self.init_client_storage_broker()
 310         self.history = History(self.stats_provider)
 311         self.terminator = Terminator()
 312         self.terminator.setServiceParent(self)
 313         self.add_service(Uploader(helper_furl, self.stats_provider,
 314                                   self.history))
 315         self.init_blacklist()
 316         self.init_nodemaker()
 317
 318     def init_client_storage_broker(self):
 319         # create a StorageFarmBroker object, for use by Uploader/Downloader
 320         # (and everybody else who wants to use storage servers)
 321         sb = storage_client.StorageFarmBroker(self.tub, permute_peers=True)
 322         self.storage_broker = sb
 323
 324         # load static server specifications from tahoe.cfg, if any.
 325         # Not quite ready yet.
 326         #if self.config.has_section("client-server-selection"):
 327         #    server_params = {} # maps serverid to dict of parameters
 328         #    for (name, value) in self.config.items("client-server-selection"):
 329         #        pieces = name.split(".")
 330         #        if pieces[0] == "server":
 331         #            serverid = pieces[1]
 332         #            if serverid not in server_params:
 333         #                server_params[serverid] = {}
 334         #            server_params[serverid][pieces[2]] = value
 335         #    for serverid, params in server_params.items():
 336         #        server_type = params.pop("type")
 337         #        if server_type == "tahoe-foolscap":
 338         #            s = storage_client.NativeStorageClient(*params)
 339         #        else:
 340         #            msg = ("unrecognized server type '%s' in "
 341         #                   "tahoe.cfg [client-server-selection]server.%s.type"
 342         #                   % (server_type, serverid))
 343         #            raise storage_client.UnknownServerTypeError(msg)
 344         #        sb.add_server(s.serverid, s)
 345
 346         # check to see if we're supposed to use the introducer too
 347         if self.get_config("client-server-selection", "use_introducer",
 348                            default=True, boolean=True):
 349             sb.use_introducer(self.introducer_client)
 350
 351     def get_storage_broker(self):
 352         return self.storage_broker
 353
 354     def init_blacklist(self):
 355         fn = os.path.join(self.basedir, "access.blacklist")
 356         self.blacklist = Blacklist(fn)
 357
 358     def init_nodemaker(self):
 359         default = self.get_config("client", "mutable.format", default="SDMF")
 360         if default.upper() == "MDMF":
 361             self.mutable_file_default = MDMF_VERSION
 362         else:
 363             self.mutable_file_default = SDMF_VERSION
 364         self.nodemaker = NodeMaker(self.storage_broker,
 365                                    self._secret_holder,
 366                                    self.get_history(),
 367                                    self.getServiceNamed("uploader"),
 368                                    self.terminator,
 369                                    self.get_encoding_parameters(),
 370                                    self.mutable_file_default,
 371                                    self._key_generator,
 372                                    self.blacklist)
 373
 374     def get_history(self):
 375         return self.history
 376
 377     def init_control(self):
 378         d = self.when_tub_ready()
 379         def _publish(res):
 380             c = ControlServer()
 381             c.setServiceParent(self)
 382             control_url = self.tub.registerReference(c)
 383             self.write_private_config("control.furl", control_url + "\n")
 384         d.addCallback(_publish)
 385         d.addErrback(log.err, facility="tahoe.init",
 386                      level=log.BAD, umid="d3tNXA")
 387
 388     def init_helper(self):
 389         d = self.when_tub_ready()
 390         def _publish(self):
 391             self.helper = Helper(os.path.join(self.basedir, "helper"),
 392                                  self.storage_broker, self._secret_holder,
 393                                  self.stats_provider, self.history)
 394             # TODO: this is confusing. BASEDIR/private/helper.furl is created
 395             # by the helper. BASEDIR/helper.furl is consumed by the client
 396             # who wants to use the helper. I like having the filename be the
 397             # same, since that makes 'cp' work smoothly, but the difference
 398             # between config inputs and generated outputs is hard to see.
 399             helper_furlfile = os.path.join(self.basedir,
 400                                            "private", "helper.furl").encode(get_filesystem_encoding())
 401             self.tub.registerReference(self.helper, furlFile=helper_furlfile)
 402         d.addCallback(_publish)
 403         d.addErrback(log.err, facility="tahoe.init",
 404                      level=log.BAD, umid="K0mW5w")
 405
 406     def init_key_gen(self, key_gen_furl):
 407         d = self.when_tub_ready()
 408         def _subscribe(self):
 409             self.tub.connectTo(key_gen_furl, self._got_key_generator)
 410         d.addCallback(_subscribe)
 411         d.addErrback(log.err, facility="tahoe.init",
 412                      level=log.BAD, umid="z9DMzw")
 413
 414     def _got_key_generator(self, key_generator):
 415         self._key_generator.set_remote_generator(key_generator)
 416         key_generator.notifyOnDisconnect(self._lost_key_generator)
 417
 418     def _lost_key_generator(self):
 419         self._key_generator.set_remote_generator(None)
 420
 421     def set_default_mutable_keysize(self, keysize):
 422         self._key_generator.set_default_keysize(keysize)
 423
 424     def init_web(self, webport):
 425         self.log("init_web(webport=%s)", args=(webport,))
 426
 427         from allmydata.webish import WebishServer
 428         nodeurl_path = os.path.join(self.basedir, "node.url")
 429         staticdir = self.get_config("node", "web.static", "public_html")
 430         staticdir = os.path.expanduser(staticdir)
 431         ws = WebishServer(self, webport, nodeurl_path, staticdir)
 432         self.add_service(ws)
 433
 434     def init_ftp_server(self):
 435         if self.get_config("ftpd", "enabled", False, boolean=True):
 436             accountfile = self.get_config("ftpd", "accounts.file", None)
 437             accounturl = self.get_config("ftpd", "accounts.url", None)
 438             ftp_portstr = self.get_config("ftpd", "port", "8021")
 439
 440             from allmydata.frontends import ftpd
 441             s = ftpd.FTPServer(self, accountfile, accounturl, ftp_portstr)
 442             s.setServiceParent(self)
 443
 444     def init_sftp_server(self):
 445         if self.get_config("sftpd", "enabled", False, boolean=True):
 446             accountfile = self.get_config("sftpd", "accounts.file", None)
 447             accounturl = self.get_config("sftpd", "accounts.url", None)
 448             sftp_portstr = self.get_config("sftpd", "port", "8022")
 449             pubkey_file = self.get_config("sftpd", "host_pubkey_file")
 450             privkey_file = self.get_config("sftpd", "host_privkey_file")
 451
 452             from allmydata.frontends import sftpd
 453             s = sftpd.SFTPServer(self, accountfile, accounturl,
 454                                  sftp_portstr, pubkey_file, privkey_file)
 455             s.setServiceParent(self)
 456
 457     def init_drop_uploader(self):
 458         if self.get_config("drop_upload", "enabled", False, boolean=True):
 459             if self.get_config("drop_upload", "upload.dircap", None):
 460                 raise OldConfigOptionError("The [drop_upload]upload.dircap option is no longer supported; please "
 461                                            "put the cap in a 'private/drop_upload_dircap' file, and delete this option.")
 462
 463             upload_dircap = self.get_or_create_private_config("drop_upload_dircap")
 464             local_dir_utf8 = self.get_config("drop_upload", "local.directory")
 465
 466             try:
 467                 from allmydata.frontends import drop_upload
 468                 s = drop_upload.DropUploader(self, upload_dircap, local_dir_utf8)
 469                 s.setServiceParent(self)
 470                 s.startService()
 471             except Exception, e:
 472                 self.log("couldn't start drop-uploader: %r", args=(e,))
 473
 474     def _check_hotline(self, hotline_file):
 475         if os.path.exists(hotline_file):
 476             mtime = os.stat(hotline_file)[stat.ST_MTIME]
 477             if mtime > time.time() - 120.0:
 478                 return
 479             else:
 480                 self.log("hotline file too old, shutting down")
 481         else:
 482             self.log("hotline file missing, shutting down")
 483         reactor.stop()
 484
 485     def get_encoding_parameters(self):
 486         return self.DEFAULT_ENCODING_PARAMETERS
 487
 488     def connected_to_introducer(self):
 489         if self.introducer_client:
 490             return self.introducer_client.connected_to_introducer()
 491         return False
 492
 493     def get_renewal_secret(self): # this will go away
 494         return self._secret_holder.get_renewal_secret()
 495
 496     def get_cancel_secret(self):
 497         return self._secret_holder.get_cancel_secret()
 498
 499     def debug_wait_for_client_connections(self, num_clients):
 500         """Return a Deferred that fires (with None) when we have connections
 501         to the given number of peers. Useful for tests that set up a
 502         temporary test network and need to know when it is safe to proceed
 503         with an upload or download."""
 504         def _check():
 505             return len(self.storage_broker.get_connected_servers()) >= num_clients
 506         d = self.poll(_check, 0.5)
 507         d.addCallback(lambda res: None)
 508         return d
 509
 510
 511     # these four methods are the primitives for creating filenodes and
 512     # dirnodes. The first takes a URI and produces a filenode or (new-style)
 513     # dirnode. The other three create brand-new filenodes/dirnodes.
 514
 515     def create_node_from_uri(self, write_uri, read_uri=None, deep_immutable=False, name="<unknown name>"):
 516         # This returns synchronously.
 517         # Note that it does *not* validate the write_uri and read_uri; instead we
 518         # may get an opaque node if there were any problems.
 519         return self.nodemaker.create_from_cap(write_uri, read_uri, deep_immutable=deep_immutable, name=name)
 520
 521     def create_dirnode(self, initial_children={}, version=None):
 522         d = self.nodemaker.create_new_mutable_directory(initial_children, version=version)
 523         return d
 524
 525     def create_immutable_dirnode(self, children, convergence=None):
 526         return self.nodemaker.create_immutable_directory(children, convergence)
 527
 528     def create_mutable_file(self, contents=None, keysize=None, version=None):
 529         return self.nodemaker.create_mutable_file(contents, keysize,
 530                                                   version=version)
 531
 532     def upload(self, uploadable):
 533         uploader = self.getServiceNamed("uploader")
 534         return uploader.upload(uploadable)