src/allmydata/_auto_deps.py

   1 # Note: please minimize imports in this file. In particular, do not import
   2 # any module from Tahoe-LAFS or its dependencies, and do not import any
   3 # modules at all at global level. That includes setuptools and pkg_resources.
   4 # It is ok to import modules from the Python Standard Library if they are
   5 # always available, or the import is protected by try...except ImportError.
   6
   7 # The semantics for requirement specs changed incompatibly in setuptools 8,
   8 # which now follows PEP 440. The requirements used in this file must be valid
   9 # under both the old and new semantics. That can be achieved by limiting
  10 # requirement specs to one of the following forms:
  11 #
  12 #   * >= X, <= Y where X < Y
  13 #   * >= X, != Y, != Z, ... where X < Y < Z...
  14 #
  15 # (In addition, check_requirement in allmydata/__init__.py only supports
  16 # >=, <= and != operators.)
  17
  18 install_requires = [
  19     # We require newer versions of setuptools (actually
  20     # zetuptoolz) to build, but can handle older versions to run.
  21     "setuptools >= 0.6c6",
  22
  23     "zfec >= 1.1.0",
  24
  25     # Feisty has simplejson 1.4
  26     "simplejson >= 1.4",
  27
  28     # zope.interface >= 3.6.0 is required for Twisted >= 12.1.0.
  29     # zope.interface 3.6.3 and 3.6.4 are incompatible with Nevow (#1435).
  30     "zope.interface >= 3.6.0, != 3.6.3, != 3.6.4",
  31
  32     # * foolscap < 0.5.1 had a performance bug which spent O(N**2) CPU for
  33     #   transferring large mutable files of size N.
  34     # * foolscap < 0.6 is incompatible with Twisted 10.2.0.
  35     # * foolscap 0.6.1 quiets a DeprecationWarning.
  36     # * foolscap < 0.6.3 is incompatible with Twisted 11.1.0 and newer.
  37     "foolscap >= 0.6.3",
  38
  39     # Needed for SFTP.
  40     # pycrypto 2.2 doesn't work due to <https://bugs.launchpad.net/pycrypto/+bug/620253>
  41     # pycrypto 2.4 doesn't work due to <https://bugs.launchpad.net/pycrypto/+bug/881130>
  42     "pycrypto >= 2.1.0, != 2.2, != 2.4",
  43
  44     # <http://www.voidspace.org.uk/python/mock/>, 0.8.0 provides "call"
  45     "mock >= 0.8.0",
  46
  47     # pycryptopp-0.6.0 includes ed25519
  48     "pycryptopp >= 0.6.0",
  49
  50     "service-identity",         # this is needed to suppress complaints about being unable to verify certs
  51     "characteristic >= 14.0.0", # latest service-identity depends on this version
  52     "pyasn1 >= 0.1.4",          # latest pyasn1-modules depends on this version
  53     "pyasn1-modules >= 0.0.5",  # service-identity depends on this
  54 ]
  55
  56 # Includes some indirect dependencies, but does not include allmydata.
  57 # These are in the order they should be listed by --version, etc.
  58 package_imports = [
  59     # package name       module name
  60     ('foolscap',         'foolscap'),
  61     ('pycryptopp',       'pycryptopp'),
  62     ('zfec',             'zfec'),
  63     ('Twisted',          'twisted'),
  64     ('Nevow',            'nevow'),
  65     ('zope.interface',   'zope.interface'),
  66     ('python',           None),
  67     ('platform',         None),
  68     ('pyOpenSSL',        'OpenSSL'),
  69     ('simplejson',       'simplejson'),
  70     ('pycrypto',         'Crypto'),
  71     ('pyasn1',           'pyasn1'),
  72     ('mock',             'mock'),
  73     ('service-identity', 'service_identity'),
  74     ('characteristic',   'characteristic'),
  75     ('pyasn1-modules',   'pyasn1_modules'),
  76 ]
  77
  78 # Dependencies for which we don't know how to get a version number at run-time.
  79 not_import_versionable = [
  80     'zope.interface',
  81     'mock',
  82     'pyasn1',
  83 ]
  84
  85 # Dependencies reported by pkg_resources that we can safely ignore.
  86 ignorable = [
  87     'argparse',
  88     'pyutil',
  89     'zbase32',
  90     'distribute',
  91     'twisted-web',
  92     'twisted-core',
  93     'twisted-conch',
  94 ]
  95
  96 import sys
  97
  98 # Don't try to get the version number of setuptools in frozen builds, because
  99 # that triggers 'site' processing that causes failures. Note that frozen
 100 # builds still (unfortunately) import pkg_resources in .tac files, so the
 101 # entry for setuptools in install_requires above isn't conditional.
 102 if not hasattr(sys, 'frozen'):
 103     package_imports.append(('setuptools', 'setuptools'))
 104
 105
 106 # Splitting the dependencies for Windows and non-Windows helps to fix
 107 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2249> and
 108 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2028>.
 109
 110 if sys.platform == "win32":
 111     install_requires += [
 112         # * On Windows we need at least Twisted 9.0 to avoid an indirect
 113         #   dependency on pywin32.
 114         # * We also need Twisted 10.1 for the FTP frontend in order for
 115         #   Twisted's FTP server to support asynchronous close.
 116         # * When the cloud backend lands, it will depend on Twisted 10.2.0
 117         #   which includes the fix to <https://twistedmatrix.com/trac/ticket/411>.
 118         # * The SFTP frontend depends on Twisted 11.0.0 to fix the SSH server
 119         #   rekeying bug <https://twistedmatrix.com/trac/ticket/4395>
 120         # * The FTP frontend depends on Twisted >=11.1.0 for
 121         #   filepath.Permissions
 122         # * We don't want Twisted >= 12.2.0 to avoid a dependency of its endpoints
 123         #   code on pywin32. <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2028>
 124         #
 125         "Twisted >= 11.1.0, <= 12.1.0",
 126
 127         # * We need Nevow >= 0.9.33 to avoid a bug in Nevow's setup.py
 128         #   which imported twisted at setup time.
 129         # * We don't want Nevow 0.11 because that requires Twisted >= 13.0
 130         #   which conflicts with the Twisted requirement above.
 131         #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2291>
 132         #
 133         "Nevow >= 0.9.33, <= 0.10",
 134     ]
 135 else:
 136     install_requires += [
 137         # * On Linux we need at least Twisted 10.1.0 for inotify support
 138         #   used by the drop-upload frontend.
 139         # * Nevow 0.11.1 requires Twisted >= 13.0.0 so we might as well
 140         #   require it directly; this helps to work around
 141         #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2286>.
 142         #   This also satisfies the requirements for the FTP and SFTP
 143         #   frontends and cloud backend mentioned in the Windows section
 144         #   above.
 145         #
 146         "Twisted >= 13.0.0",
 147
 148         # Nevow >= 0.11.1 can be installed using pip.
 149         "Nevow >= 0.11.1",
 150     ]
 151
 152
 153 # * pyOpenSSL is required in order for foolscap to provide secure connections.
 154 #   Since foolscap doesn't reliably declare this dependency in a machine-readable
 155 #   way, we need to declare a dependency on pyOpenSSL ourselves. Tahoe-LAFS does
 156 #   not *directly* depend on pyOpenSSL.
 157 #
 158 # * pyOpenSSL >= 0.13 is needed in order to avoid
 159 #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2005>.
 160 #
 161 # * pyOpenSSL >= 0.14 is built on the 'cryptography' package which depends
 162 #   on 'cffi' (and indirectly several other packages). Unfortunately cffi
 163 #   attempts to compile code dynamically, which causes problems on many systems.
 164 #   It also depends on the libffi OS package which may not be installed.
 165 #   <https://bitbucket.org/cffi/cffi/issue/109/enable-sane-packaging-for-cffi>
 166 #   <https://bitbucket.org/cffi/cffi/issue/70/cant-install-cffi-using-pip-on-windows>
 167 #
 168 #   So, if pyOpenSSL 0.14 has *already* been installed and is importable, we
 169 #   want to accept it; otherwise we ask for pyOpenSSL 0.13 or 0.13.1.
 170 #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2193>
 171 #
 172 #   We don't rely on pkg_resources to tell us the installed pyOpenSSL version
 173 #   number, because pkg_resources telling us that we have 0.14 is not sufficient
 174 #   evidence that 0.14 will be the imported version (or will work correctly).
 175 #   One possible reason why it might not be is explained in
 176 #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1246#comment:6> and
 177 #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1258>.
 178
 179 _can_use_pyOpenSSL_0_14 = False
 180 try:
 181     import OpenSSL
 182     pyOpenSSL_ver = OpenSSL.__version__.split('.')
 183     if int(pyOpenSSL_ver[0]) > 0 or int(pyOpenSSL_ver[1]) >= 14:
 184         _can_use_pyOpenSSL_0_14 = True
 185 except Exception:
 186     pass
 187
 188 if _can_use_pyOpenSSL_0_14:
 189     install_requires += [
 190         # Although we checked for pyOpenSSL >= 0.14 above, we only actually
 191         # need pyOpenSSL >= 0.13; requiring 0.14 here cannot help.
 192         "pyOpenSSL >= 0.13",
 193
 194         # ... and now all the new stuff that pyOpenSSL 0.14 transitively
 195         # depends on. We specify these explicitly because setuptools is
 196         # bad at correctly resolving indirect dependencies (e.g. see
 197         # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2286>).
 198         #
 199         "cryptography",
 200         "cffi >= 0.8",          # latest cryptography depends on this version
 201         "six >= 1.4.1",         # latest cryptography depends on this version
 202         "enum34",               # latest cryptography depends on this
 203         "pycparser",            # cffi depends on this
 204     ]
 205
 206     package_imports += [
 207         ('cryptography',     'cryptography'),
 208         ('cffi',             'cffi'),
 209         ('six',              'six'),
 210         ('enum34',           'enum'),
 211         ('pycparser',        'pycparser'),
 212     ]
 213 else:
 214     install_requires += [
 215         "pyOpenSSL >= 0.13, <= 0.13.1",
 216     ]
 217
 218
 219 # These are suppressed globally:
 220
 221 global_deprecation_messages = [
 222     "BaseException.message has been deprecated as of Python 2.6",
 223     "twisted.internet.interfaces.IFinishableConsumer was deprecated in Twisted 11.1.0: Please use IConsumer (and IConsumer.unregisterProducer) instead.",
 224     "twisted.internet.interfaces.IStreamClientEndpointStringParser was deprecated in Twisted 14.0.0: This interface has been superseded by IStreamClientEndpointStringParserWithReactor.",
 225 ]
 226
 227 # These are suppressed while importing dependencies:
 228
 229 deprecation_messages = [
 230     "the sha module is deprecated; use the hashlib module instead",
 231     "object.__new__\(\) takes no parameters",
 232     "The popen2 module is deprecated.  Use the subprocess module.",
 233     "the md5 module is deprecated; use hashlib instead",
 234     "twisted.web.error.NoResource is deprecated since Twisted 9.0.  See twisted.web.resource.NoResource.",
 235     "the sets module is deprecated",
 236 ]
 237
 238 runtime_warning_messages = [
 239     "Not using mpz_powm_sec.  You should rebuild using libgmp >= 5 to avoid timing attack vulnerability.",
 240 ]
 241
 242 warning_imports = [
 243     'nevow',
 244     'twisted.persisted.sob',
 245     'twisted.python.filepath',
 246     'Crypto.Hash.SHA',
 247 ]