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