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.8.0 generates 2048-bit RSA-with-SHA-256 signatures,
  38     #   rather than 1024-bit RSA-with-MD5. This also allows us to work
  39     #   with a FIPS build of OpenSSL.
  40     "foolscap >= 0.8.0",
  41
  42     # Needed for SFTP.
  43     # pycrypto 2.2 doesn't work due to <https://bugs.launchpad.net/pycrypto/+bug/620253>
  44     # pycrypto 2.4 doesn't work due to <https://bugs.launchpad.net/pycrypto/+bug/881130>
  45     "pycrypto >= 2.1.0, != 2.2, != 2.4",
  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.8",          # 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     ('OpenSSL',          None),
  70     ('simplejson',       'simplejson'),
  71     ('pycrypto',         'Crypto'),
  72     ('pyasn1',           'pyasn1'),
  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 ]
  82
  83 # Dependencies reported by pkg_resources that we can safely ignore.
  84 ignorable = [
  85     'argparse',
  86     'pyutil',
  87     'zbase32',
  88     'distribute',
  89     'twisted-web',
  90     'twisted-core',
  91     'twisted-conch',
  92 ]
  93
  94 import sys
  95
  96 # Don't try to get the version number of setuptools in frozen builds, because
  97 # that triggers 'site' processing that causes failures. Note that frozen
  98 # builds still (unfortunately) import pkg_resources in .tac files, so the
  99 # entry for setuptools in install_requires above isn't conditional.
 100 if not hasattr(sys, 'frozen'):
 101     package_imports.append(('setuptools', 'setuptools'))
 102
 103
 104 # * On Linux we need at least Twisted 10.1.0 for inotify support
 105 #   used by the drop-upload frontend.
 106 # * We also need Twisted 10.1.0 for the FTP frontend in order for
 107 #   Twisted's FTP server to support asynchronous close.
 108 # * The SFTP frontend depends on Twisted 11.0.0 to fix the SSH server
 109 #   rekeying bug <https://twistedmatrix.com/trac/ticket/4395>
 110 # * The FTP frontend depends on Twisted >= 11.1.0 for
 111 #   filepath.Permissions
 112 #
 113 # On Windows, Twisted >= 12.2.0 has a dependency on pywin32.
 114 # Since pywin32 can only be installed manually, we fall back to
 115 # requiring earlier versions of Twisted and Nevow if it is not
 116 # already installed.
 117 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2028>
 118 #
 119 # When the fallback is used we also need to work around the fact
 120 # that Nevow imports itself when building, which causes Twisted
 121 # and zope.interface to be imported; therefore, we need to set
 122 # setup_requires to make sure that the versions of Twisted and
 123 # zope.interface used at build time satisfy Nevow's requirements.
 124 #
 125 # In cases where this fallback isn't needed, we prefer Nevow >= 0.11.1
 126 # which can be installed using pip, and Twisted >= 13.0.0 which
 127 # Nevow 0.11.1 depends on. In this case we should *not* use the
 128 # setup_requires hack, because if we do then the build will break
 129 # when Twisted < 13.0.0 is already installed (even though it could
 130 # have succeeded by building a later version under support/ ).
 131 #
 132 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2032>
 133 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2249>
 134 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2291>
 135 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2286>
 136
 137 setup_requires = []
 138
 139 _use_old_Twisted_and_Nevow = False
 140 if sys.platform == "win32":
 141     try:
 142         import win32api
 143         [win32api]
 144     except ImportError:
 145         _use_old_Twisted_and_Nevow = True
 146
 147 if _use_old_Twisted_and_Nevow:
 148     install_requires += [
 149         "Twisted >= 11.1.0, <= 12.1.0",
 150         "Nevow >= 0.9.33, <= 0.10",
 151     ]
 152     setup_requires += [req for req in install_requires if req.startswith('Twisted')
 153                                                        or req.startswith('zope.interface')]
 154 else:
 155     install_requires += [
 156         "Twisted >= 13.0.0",
 157         "Nevow >= 0.11.1",
 158     ]
 159
 160
 161 # * pyOpenSSL is required in order for foolscap to provide secure connections.
 162 #   Since foolscap doesn't reliably declare this dependency in a machine-readable
 163 #   way, we need to declare a dependency on pyOpenSSL ourselves. Tahoe-LAFS does
 164 #   not *directly* depend on pyOpenSSL.
 165 #
 166 # * pyOpenSSL >= 0.13 is needed in order to avoid
 167 #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2005>, and also to check the
 168 #   version of OpenSSL that pyOpenSSL is using.
 169 #
 170 # * pyOpenSSL >= 0.14 is built on the 'cryptography' package which depends
 171 #   on 'cffi' (and indirectly several other packages). Unfortunately cffi
 172 #   attempts to compile code dynamically, which causes problems on many systems.
 173 #   It also depends on the libffi OS package which may not be installed.
 174 #   <https://bitbucket.org/cffi/cffi/issue/109/enable-sane-packaging-for-cffi>
 175 #   <https://bitbucket.org/cffi/cffi/issue/70/cant-install-cffi-using-pip-on-windows>
 176 #
 177 #   So, if pyOpenSSL 0.14 has *already* been installed and is importable, we
 178 #   want to accept it; otherwise we ask for pyOpenSSL 0.13 or 0.13.1.
 179 #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2193>
 180 #
 181 #   We don't rely on pkg_resources to tell us the installed pyOpenSSL version
 182 #   number, because pkg_resources telling us that we have 0.14 is not sufficient
 183 #   evidence that 0.14 will be the imported version (or will work correctly).
 184 #   One possible reason why it might not be is explained in
 185 #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1246#comment:6> and
 186 #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1258>.
 187
 188 _can_use_pyOpenSSL_0_14 = False
 189 try:
 190     import OpenSSL
 191     pyOpenSSL_ver = OpenSSL.__version__.split('.')
 192     if int(pyOpenSSL_ver[0]) > 0 or int(pyOpenSSL_ver[1]) >= 14:
 193         _can_use_pyOpenSSL_0_14 = True
 194 except Exception:
 195     pass
 196
 197 if _can_use_pyOpenSSL_0_14:
 198     install_requires += [
 199         # Although we checked for pyOpenSSL >= 0.14 above, we only actually
 200         # need pyOpenSSL >= 0.13; requiring 0.14 here cannot help.
 201         "pyOpenSSL >= 0.13",
 202
 203         # ... and now all the new stuff that pyOpenSSL 0.14 transitively
 204         # depends on. We specify these explicitly because setuptools is
 205         # bad at correctly resolving indirect dependencies (e.g. see
 206         # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2286>).
 207         #
 208         "cryptography",
 209         "cffi >= 0.8",          # latest cryptography depends on this version
 210         "six >= 1.4.1",         # latest cryptography depends on this version
 211         "enum34",               # latest cryptography depends on this
 212         "pycparser",            # cffi depends on this
 213     ]
 214
 215     package_imports += [
 216         ('cryptography',     'cryptography'),
 217         ('cffi',             'cffi'),
 218         ('six',              'six'),
 219         ('enum34',           'enum'),
 220         ('pycparser',        'pycparser'),
 221     ]
 222 else:
 223     install_requires += [
 224         "pyOpenSSL >= 0.13, <= 0.13.1",
 225     ]
 226
 227
 228 # These are suppressed globally:
 229
 230 global_deprecation_messages = [
 231     "BaseException.message has been deprecated as of Python 2.6",
 232     "twisted.internet.interfaces.IFinishableConsumer was deprecated in Twisted 11.1.0: Please use IConsumer (and IConsumer.unregisterProducer) instead.",
 233     "twisted.internet.interfaces.IStreamClientEndpointStringParser was deprecated in Twisted 14.0.0: This interface has been superseded by IStreamClientEndpointStringParserWithReactor.",
 234 ]
 235
 236 # These are suppressed while importing dependencies:
 237
 238 deprecation_messages = [
 239     "the sha module is deprecated; use the hashlib module instead",
 240     "object.__new__\(\) takes no parameters",
 241     "The popen2 module is deprecated.  Use the subprocess module.",
 242     "the md5 module is deprecated; use hashlib instead",
 243     "twisted.web.error.NoResource is deprecated since Twisted 9.0.  See twisted.web.resource.NoResource.",
 244     "the sets module is deprecated",
 245 ]
 246
 247 runtime_warning_messages = [
 248     "Not using mpz_powm_sec.  You should rebuild using libgmp >= 5 to avoid timing attack vulnerability.",
 249 ]
 250
 251 warning_imports = [
 252     'nevow',
 253     'twisted.persisted.sob',
 254     'twisted.python.filepath',
 255     'Crypto.Hash.SHA',
 256 ]