from allmydata import node
from zope.interface import implements
-from twisted.internet import reactor
+from twisted.internet import reactor, defer
+from twisted.application import service
from twisted.application.internet import TimerService
-from foolscap import Referenceable
-from foolscap.logging import log
+from foolscap.api import Referenceable
from pycryptopp.publickey import rsa
import allmydata
-from allmydata.storage import StorageServer
+from allmydata.storage.server import StorageServer
+from allmydata import storage_client
from allmydata.immutable.upload import Uploader
-from allmydata.immutable.download import Downloader
-from allmydata.immutable.filenode import FileNode, LiteralFileNode
from allmydata.immutable.offloaded import Helper
from allmydata.control import ControlServer
from allmydata.introducer.client import IntroducerClient
-from allmydata.util import hashutil, base32, pollmixin, cachedir
+from allmydata.util import hashutil, base32, pollmixin, log
+from allmydata.util.encodingutil import get_filesystem_encoding
from allmydata.util.abbreviate import parse_abbreviated_size
-from allmydata.uri import LiteralFileURI
-from allmydata.dirnode import NewDirectoryNode
-from allmydata.mutable.filenode import MutableFileNode
+from allmydata.util.time_format import parse_duration, parse_date
from allmydata.stats import StatsProvider
from allmydata.history import History
-from allmydata.interfaces import IURI, INewDirectoryURI, IStatsProducer, \
- IReadonlyNewDirectoryURI, IFileURI, IMutableFileURI, RIStubClient
+from allmydata.interfaces import IStatsProducer, RIStubClient, \
+ SDMF_VERSION, MDMF_VERSION
+from allmydata.nodemaker import NodeMaker
+from allmydata.blacklist import Blacklist
+
KiB=1024
MiB=1024*KiB
def _make_secret():
return base32.b2a(os.urandom(hashutil.CRYPTO_VAL_SIZE)) + "\n"
+class SecretHolder:
+ def __init__(self, lease_secret, convergence_secret):
+ self._lease_secret = lease_secret
+ self._convergence_secret = convergence_secret
+
+ def get_renewal_secret(self):
+ return hashutil.my_renewal_secret_hash(self._lease_secret)
+
+ def get_cancel_secret(self):
+ return hashutil.my_cancel_secret_hash(self._lease_secret)
+
+ def get_convergence_secret(self):
+ return self._convergence_secret
+
+class KeyGenerator:
+ """I create RSA keys for mutable files. Each call to generate() returns a
+ single keypair. The keysize is specified first by the keysize= argument
+ to generate(), then with a default set by set_default_keysize(), then
+ with a built-in default of 2048 bits."""
+ def __init__(self):
+ self._remote = None
+ self.default_keysize = 2048
+
+ def set_remote_generator(self, keygen):
+ self._remote = keygen
+ def set_default_keysize(self, keysize):
+ """Call this to override the size of the RSA keys created for new
+ mutable files which don't otherwise specify a size. This will affect
+ all subsequent calls to generate() without a keysize= argument. The
+ default size is 2048 bits. Test cases should call this method once
+ during setup, to cause me to create smaller keys, so the unit tests
+ run faster."""
+ self.default_keysize = keysize
+
+ def generate(self, keysize=None):
+ """I return a Deferred that fires with a (verifyingkey, signingkey)
+ pair. I accept a keysize in bits (2048 bit keys are standard, smaller
+ keys are used for testing). If you do not provide a keysize, I will
+ use my default, which is set by a call to set_default_keysize(). If
+ set_default_keysize() has never been called, I will create 2048 bit
+ keys."""
+ keysize = keysize or self.default_keysize
+ if self._remote:
+ d = self._remote.callRemote('get_rsa_key_pair', keysize)
+ def make_key_objs((verifying_key, signing_key)):
+ v = rsa.create_verifying_key_from_string(verifying_key)
+ s = rsa.create_signing_key_from_string(signing_key)
+ return v, s
+ d.addCallback(make_key_objs)
+ return d
+ else:
+ # RSA key generation for a 2048 bit key takes between 0.8 and 3.2
+ # secs
+ signer = rsa.generate(keysize)
+ verifier = signer.get_verifying_key()
+ return defer.succeed( (verifier, signer) )
+
+class Terminator(service.Service):
+ def __init__(self):
+ self._clients = weakref.WeakKeyDictionary()
+ def register(self, c):
+ self._clients[c] = None
+ def stopService(self):
+ for c in self._clients:
+ c.stop()
+ return service.Service.stopService(self)
+
+
class Client(node.Node, pollmixin.PollMixin):
implements(IStatsProducer)
self.DEFAULT_ENCODING_PARAMETERS = self.DEFAULT_ENCODING_PARAMETERS.copy()
self.init_introducer_client()
self.init_stats_provider()
- self.init_lease_secret()
+ self.init_secrets()
self.init_storage()
self.init_control()
+ self.helper = None
if self.get_config("helper", "enabled", False, boolean=True):
self.init_helper()
- self.init_client()
- self._key_generator = None
+ self._key_generator = KeyGenerator()
key_gen_furl = self.get_config("client", "key_generator.furl", None)
if key_gen_furl:
self.init_key_gen(key_gen_furl)
+ self.init_client()
# ControlServer and Helper are attached after Tub startup
self.init_ftp_server()
self.init_sftp_server()
+ self.init_drop_uploader()
hotline_file = os.path.join(self.basedir,
self.SUICIDE_PREVENTION_HOTLINE_FILE)
hotline = TimerService(1.0, self._check_hotline, hotline_file)
hotline.setServiceParent(self)
+ # this needs to happen last, so it can use getServiceNamed() to
+ # acquire references to StorageServer and other web-statusable things
webport = self.get_config("node", "web.port", None)
if webport:
self.init_web(webport) # strports string
- def read_old_config_files(self):
- node.Node.read_old_config_files(self)
- copy = self._copy_config_from_file
- copy("introducer.furl", "client", "introducer.furl")
- copy("helper.furl", "client", "helper.furl")
- copy("key_generator.furl", "client", "key_generator.furl")
- copy("stats_gatherer.furl", "client", "stats_gatherer.furl")
- if os.path.exists(os.path.join(self.basedir, "no_storage")):
- self.set_config("storage", "enabled", "false")
- if os.path.exists(os.path.join(self.basedir, "readonly_storage")):
- self.set_config("storage", "readonly", "true")
- if os.path.exists(os.path.join(self.basedir, "debug_discard_storage")):
- self.set_config("storage", "debug_discard", "true")
- if os.path.exists(os.path.join(self.basedir, "run_helper")):
- self.set_config("helper", "enabled", "true")
-
def init_introducer_client(self):
self.introducer_furl = self.get_config("client", "introducer.furl")
ic = IntroducerClient(self.tub, self.introducer_furl,
d = self.when_tub_ready()
def _start_introducer_client(res):
ic.setServiceParent(self)
- # nodes that want to upload and download will need storage servers
- ic.subscribe_to("storage")
d.addCallback(_start_introducer_client)
d.addErrback(log.err, facility="tahoe.init",
level=log.BAD, umid="URyI5w")
def get_stats(self):
return { 'node.uptime': time.time() - self.started_timestamp }
- def init_lease_secret(self):
- secret_s = self.get_or_create_private_config("secret", _make_secret)
- self._lease_secret = base32.a2b(secret_s)
+ def init_secrets(self):
+ lease_s = self.get_or_create_private_config("secret", _make_secret)
+ lease_secret = base32.a2b(lease_s)
+ convergence_s = self.get_or_create_private_config('convergence',
+ _make_secret)
+ self.convergence = base32.a2b(convergence_s)
+ self._secret_holder = SecretHolder(lease_secret, self.convergence)
def init_storage(self):
# should we run a storage server (and publish it for others to use)?
reserved = 0
discard = self.get_config("storage", "debug_discard", False,
boolean=True)
- ss = StorageServer(storedir,
+
+ expire = self.get_config("storage", "expire.enabled", False, boolean=True)
+ if expire:
+ mode = self.get_config("storage", "expire.mode") # require a mode
+ else:
+ mode = self.get_config("storage", "expire.mode", "age")
+
+ o_l_d = self.get_config("storage", "expire.override_lease_duration", None)
+ if o_l_d is not None:
+ o_l_d = parse_duration(o_l_d)
+
+ cutoff_date = None
+ if mode == "cutoff-date":
+ cutoff_date = self.get_config("storage", "expire.cutoff_date")
+ cutoff_date = parse_date(cutoff_date)
+
+ sharetypes = []
+ if self.get_config("storage", "expire.immutable", True, boolean=True):
+ sharetypes.append("immutable")
+ if self.get_config("storage", "expire.mutable", True, boolean=True):
+ sharetypes.append("mutable")
+ expiration_sharetypes = tuple(sharetypes)
+
+ ss = StorageServer(storedir, self.nodeid,
reserved_space=reserved,
discard_storage=discard,
readonly_storage=readonly,
- stats_provider=self.stats_provider)
+ stats_provider=self.stats_provider,
+ expiration_enabled=expire,
+ expiration_mode=mode,
+ expiration_override_lease_duration=o_l_d,
+ expiration_cutoff_date=cutoff_date,
+ expiration_sharetypes=expiration_sharetypes)
self.add_service(ss)
+
d = self.when_tub_ready()
# we can't do registerReference until the Tub is ready
def _publish(res):
- furl_file = os.path.join(self.basedir, "private", "storage.furl")
+ furl_file = os.path.join(self.basedir, "private", "storage.furl").encode(get_filesystem_encoding())
furl = self.tub.registerReference(ss, furlFile=furl_file)
ri_name = RIStorageServer.__remote_name__
self.introducer_client.publish(furl, "storage", ri_name)
DEP["k"] = int(self.get_config("client", "shares.needed", DEP["k"]))
DEP["n"] = int(self.get_config("client", "shares.total", DEP["n"]))
DEP["happy"] = int(self.get_config("client", "shares.happy", DEP["happy"]))
- convergence_s = self.get_or_create_private_config('convergence', _make_secret)
- self.convergence = base32.a2b(convergence_s)
- self._node_cache = weakref.WeakValueDictionary() # uri -> node
- self.add_service(History(self.stats_provider))
- self.add_service(Uploader(helper_furl, self.stats_provider))
- download_cachedir = os.path.join(self.basedir,
- "private", "cache", "download")
- self.download_cache = cachedir.CacheDirectoryManager(download_cachedir)
- self.download_cache.setServiceParent(self)
- self.add_service(Downloader(self.stats_provider))
+
+ self.init_client_storage_broker()
+ self.history = History(self.stats_provider)
+ self.terminator = Terminator()
+ self.terminator.setServiceParent(self)
+ self.add_service(Uploader(helper_furl, self.stats_provider,
+ self.history))
+ self.init_stub_client()
+ self.init_blacklist()
+ self.init_nodemaker()
+
+ def init_client_storage_broker(self):
+ # create a StorageFarmBroker object, for use by Uploader/Downloader
+ # (and everybody else who wants to use storage servers)
+ sb = storage_client.StorageFarmBroker(self.tub, permute_peers=True)
+ self.storage_broker = sb
+
+ # load static server specifications from tahoe.cfg, if any.
+ # Not quite ready yet.
+ #if self.config.has_section("client-server-selection"):
+ # server_params = {} # maps serverid to dict of parameters
+ # for (name, value) in self.config.items("client-server-selection"):
+ # pieces = name.split(".")
+ # if pieces[0] == "server":
+ # serverid = pieces[1]
+ # if serverid not in server_params:
+ # server_params[serverid] = {}
+ # server_params[serverid][pieces[2]] = value
+ # for serverid, params in server_params.items():
+ # server_type = params.pop("type")
+ # if server_type == "tahoe-foolscap":
+ # s = storage_client.NativeStorageClient(*params)
+ # else:
+ # msg = ("unrecognized server type '%s' in "
+ # "tahoe.cfg [client-server-selection]server.%s.type"
+ # % (server_type, serverid))
+ # raise storage_client.UnknownServerTypeError(msg)
+ # sb.add_server(s.serverid, s)
+
+ # check to see if we're supposed to use the introducer too
+ if self.get_config("client-server-selection", "use_introducer",
+ default=True, boolean=True):
+ sb.use_introducer(self.introducer_client)
+
+ def get_storage_broker(self):
+ return self.storage_broker
+
+ def init_stub_client(self):
def _publish(res):
# we publish an empty object so that the introducer can count how
# many clients are connected and see what versions they're
d.addErrback(log.err, facility="tahoe.init",
level=log.BAD, umid="OEHq3g")
+ def init_blacklist(self):
+ fn = os.path.join(self.basedir, "access.blacklist")
+ self.blacklist = Blacklist(fn)
+
+ def init_nodemaker(self):
+ self.nodemaker = NodeMaker(self.storage_broker,
+ self._secret_holder,
+ self.get_history(),
+ self.getServiceNamed("uploader"),
+ self.terminator,
+ self.get_encoding_parameters(),
+ self._key_generator,
+ self.blacklist)
+ default = self.get_config("client", "mutable.format", default="sdmf")
+ if default == "mdmf":
+ self.mutable_file_default = MDMF_VERSION
+ else:
+ self.mutable_file_default = SDMF_VERSION
+
def get_history(self):
- return self.getServiceNamed("history")
+ return self.history
def init_control(self):
d = self.when_tub_ready()
def init_helper(self):
d = self.when_tub_ready()
def _publish(self):
- h = Helper(os.path.join(self.basedir, "helper"), self.stats_provider)
- h.setServiceParent(self)
+ self.helper = Helper(os.path.join(self.basedir, "helper"),
+ self.storage_broker, self._secret_holder,
+ self.stats_provider, self.history)
# TODO: this is confusing. BASEDIR/private/helper.furl is created
# by the helper. BASEDIR/helper.furl is consumed by the client
# who wants to use the helper. I like having the filename be the
# same, since that makes 'cp' work smoothly, but the difference
# between config inputs and generated outputs is hard to see.
helper_furlfile = os.path.join(self.basedir,
- "private", "helper.furl")
- self.tub.registerReference(h, furlFile=helper_furlfile)
+ "private", "helper.furl").encode(get_filesystem_encoding())
+ self.tub.registerReference(self.helper, furlFile=helper_furlfile)
d.addCallback(_publish)
d.addErrback(log.err, facility="tahoe.init",
level=log.BAD, umid="K0mW5w")
level=log.BAD, umid="z9DMzw")
def _got_key_generator(self, key_generator):
- self._key_generator = key_generator
+ self._key_generator.set_remote_generator(key_generator)
key_generator.notifyOnDisconnect(self._lost_key_generator)
def _lost_key_generator(self):
- self._key_generator = None
+ self._key_generator.set_remote_generator(None)
- def get_servers(self, service_name):
- """ Return set of (peerid, versioned-rref) """
- assert isinstance(service_name, str)
- return self.introducer_client.get_peers(service_name)
+ def set_default_mutable_keysize(self, keysize):
+ self._key_generator.set_default_keysize(keysize)
def init_web(self, webport):
self.log("init_web(webport=%s)", args=(webport,))
nodeurl_path = os.path.join(self.basedir, "node.url")
staticdir = self.get_config("node", "web.static", "public_html")
staticdir = os.path.expanduser(staticdir)
- ws = WebishServer(webport, nodeurl_path, staticdir)
+ ws = WebishServer(self, webport, nodeurl_path, staticdir)
self.add_service(ws)
def init_ftp_server(self):
sftp_portstr, pubkey_file, privkey_file)
s.setServiceParent(self)
+ def init_drop_uploader(self):
+ if self.get_config("drop_upload", "enabled", False, boolean=True):
+ upload_dircap = self.get_config("drop_upload", "upload.dircap", None)
+ local_dir_utf8 = self.get_config("drop_upload", "local.directory", None)
+
+ if upload_dircap and local_dir_utf8:
+ try:
+ from allmydata.frontends import drop_upload
+ s = drop_upload.DropUploader(self, upload_dircap, local_dir_utf8)
+ s.setServiceParent(self)
+ s.startService()
+ except Exception, e:
+ self.log("couldn't start drop-uploader: %r", args=(e,))
+ else:
+ self.log("couldn't start drop-uploader: upload.dircap or local.directory not specified")
+
def _check_hotline(self, hotline_file):
if os.path.exists(hotline_file):
mtime = os.stat(hotline_file)[stat.ST_MTIME]
- if mtime > time.time() - 40.0:
+ if mtime > time.time() - 120.0:
return
else:
self.log("hotline file too old, shutting down")
self.log("hotline file missing, shutting down")
reactor.stop()
- def get_all_peerids(self):
- return self.introducer_client.get_all_peerids()
- def get_nickname_for_peerid(self, peerid):
- return self.introducer_client.get_nickname_for_peerid(peerid)
-
- def get_permuted_peers(self, service_name, key):
- """
- @return: list of (peerid, connection,)
- """
- assert isinstance(service_name, str)
- assert isinstance(key, str)
- return self.introducer_client.get_permuted_peers(service_name, key)
-
def get_encoding_parameters(self):
return self.DEFAULT_ENCODING_PARAMETERS
return self.introducer_client.connected_to_introducer()
return False
- def get_renewal_secret(self):
- return hashutil.my_renewal_secret_hash(self._lease_secret)
+ def get_renewal_secret(self): # this will go away
+ return self._secret_holder.get_renewal_secret()
def get_cancel_secret(self):
- return hashutil.my_cancel_secret_hash(self._lease_secret)
+ return self._secret_holder.get_cancel_secret()
def debug_wait_for_client_connections(self, num_clients):
"""Return a Deferred that fires (with None) when we have connections
temporary test network and need to know when it is safe to proceed
with an upload or download."""
def _check():
- current_clients = list(self.get_all_peerids())
- return len(current_clients) >= num_clients
+ return len(self.storage_broker.get_connected_servers()) >= num_clients
d = self.poll(_check, 0.5)
d.addCallback(lambda res: None)
return d
# dirnodes. The first takes a URI and produces a filenode or (new-style)
# dirnode. The other three create brand-new filenodes/dirnodes.
- def create_node_from_uri(self, u):
- # this returns synchronously.
- u = IURI(u)
- u_s = u.to_string()
- if u_s not in self._node_cache:
- if IReadonlyNewDirectoryURI.providedBy(u):
- # new-style read-only dirnodes
- node = NewDirectoryNode(self).init_from_uri(u)
- elif INewDirectoryURI.providedBy(u):
- # new-style dirnodes
- node = NewDirectoryNode(self).init_from_uri(u)
- elif IFileURI.providedBy(u):
- if isinstance(u, LiteralFileURI):
- node = LiteralFileNode(u, self) # LIT
- else:
- key = base32.b2a(u.storage_index)
- cachefile = self.download_cache.get_file(key)
- node = FileNode(u, self, cachefile) # CHK
- else:
- assert IMutableFileURI.providedBy(u), u
- node = MutableFileNode(self).init_from_uri(u)
- self._node_cache[u_s] = node
- return self._node_cache[u_s]
-
- def create_empty_dirnode(self):
- n = NewDirectoryNode(self)
- d = n.create(self._generate_pubprivkeys)
- d.addCallback(lambda res: n)
- return d
+ def create_node_from_uri(self, write_uri, read_uri=None, deep_immutable=False, name="<unknown name>"):
+ # This returns synchronously.
+ # Note that it does *not* validate the write_uri and read_uri; instead we
+ # may get an opaque node if there were any problems.
+ return self.nodemaker.create_from_cap(write_uri, read_uri, deep_immutable=deep_immutable, name=name)
- def create_mutable_file(self, contents=""):
- n = MutableFileNode(self)
- d = n.create(contents, self._generate_pubprivkeys)
- d.addCallback(lambda res: n)
+ def create_dirnode(self, initial_children={}, version=SDMF_VERSION):
+ d = self.nodemaker.create_new_mutable_directory(initial_children, version=version)
return d
- def _generate_pubprivkeys(self, key_size):
- if self._key_generator:
- d = self._key_generator.callRemote('get_rsa_key_pair', key_size)
- def make_key_objs((verifying_key, signing_key)):
- v = rsa.create_verifying_key_from_string(verifying_key)
- s = rsa.create_signing_key_from_string(signing_key)
- return v, s
- d.addCallback(make_key_objs)
- return d
- else:
- # RSA key generation for a 2048 bit key takes between 0.8 and 3.2
- # secs
- signer = rsa.generate(key_size)
- verifier = signer.get_verifying_key()
- return verifier, signer
+ def create_immutable_dirnode(self, children, convergence=None):
+ return self.nodemaker.create_immutable_directory(children, convergence)
+
+ def create_mutable_file(self, contents=None, keysize=None, version=None):
+ if not version:
+ version = self.mutable_file_default
+ return self.nodemaker.create_mutable_file(contents, keysize,
+ version=version)
def upload(self, uploadable):
uploader = self.getServiceNamed("uploader")
- return uploader.upload(uploadable, history=self.get_history())
-
-
- def list_all_upload_statuses(self):
- return self.get_history().list_all_upload_statuses()
-
- def list_all_download_statuses(self):
- return self.get_history().list_all_download_statuses()
-
- def list_all_mapupdate_statuses(self):
- return self.get_history().list_all_mapupdate_statuses()
- def list_all_publish_statuses(self):
- return self.get_history().list_all_publish_statuses()
- def list_all_retrieve_statuses(self):
- return self.get_history().list_all_retrieve_statuses()
-
- def list_all_helper_statuses(self):
- try:
- helper = self.getServiceNamed("helper")
- except KeyError:
- return []
- return helper.get_all_upload_statuses()
+ return uploader.upload(uploadable)