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     # * We need Twisted 10.1.0 for the FTP frontend in order for
  33     #   Twisted's FTP server to support asynchronous close.
  34     # * The SFTP frontend depends on Twisted 11.0.0 to fix the SSH server
  35     #   rekeying bug <https://twistedmatrix.com/trac/ticket/4395>
  36     # * The FTP frontend depends on Twisted >= 11.1.0 for
  37     #   filepath.Permissions
  38     # * Nevow 0.11.1 depends on Twisted >= 13.0.0.
  39     # * The Magic Folder frontend depends on Twisted >= 15.2.0.
  40     # * For now we pin Twisted 15.2.0 to avoid <http://foolscap.lothar.com/trac/ticket/244>.
  41     "Twisted == 15.2.0",
  42
  43     # Nevow 0.11.1 can be installed using pip (#2032).
  44     "Nevow >= 0.11.1",
  45
  46     # * foolscap < 0.5.1 had a performance bug which spent O(N**2) CPU for
  47     #   transferring large mutable files of size N.
  48     # * foolscap < 0.6 is incompatible with Twisted 10.2.0.
  49     # * foolscap 0.6.1 quiets a DeprecationWarning.
  50     # * foolscap < 0.6.3 is incompatible with Twisted 11.1.0 and newer.
  51     # * foolscap 0.8.0 generates 2048-bit RSA-with-SHA-256 signatures,
  52     #   rather than 1024-bit RSA-with-MD5. This also allows us to work
  53     #   with a FIPS build of OpenSSL.
  54     "foolscap >= 0.10.1",
  55
  56     # Needed for SFTP.
  57     # pycrypto 2.2 doesn't work due to <https://bugs.launchpad.net/pycrypto/+bug/620253>
  58     # pycrypto 2.4 doesn't work due to <https://bugs.launchpad.net/pycrypto/+bug/881130>
  59     "pycrypto >= 2.1.0, != 2.2, != 2.4",
  60
  61     # pycryptopp-0.6.0 includes ed25519
  62     "pycryptopp >= 0.6.0",
  63
  64     "service-identity",         # this is needed to suppress complaints about being unable to verify certs
  65     "characteristic >= 14.0.0", # latest service-identity depends on this version
  66     "pyasn1 >= 0.1.8",          # latest pyasn1-modules depends on this version
  67     "pyasn1-modules >= 0.0.5",  # service-identity depends on this
  68 ]
  69
  70 # We no longer have any setup dependencies.
  71 setup_requires = []
  72
  73 # Includes some indirect dependencies, but does not include allmydata.
  74 # These are in the order they should be listed by --version, etc.
  75 package_imports = [
  76     # package name       module name
  77     ('foolscap',         'foolscap'),
  78     ('pycryptopp',       'pycryptopp'),
  79     ('zfec',             'zfec'),
  80     ('Twisted',          'twisted'),
  81     ('Nevow',            'nevow'),
  82     ('zope.interface',   'zope.interface'),
  83     ('python',           None),
  84     ('platform',         None),
  85     ('pyOpenSSL',        'OpenSSL'),
  86     ('OpenSSL',          None),
  87     ('simplejson',       'simplejson'),
  88     ('pycrypto',         'Crypto'),
  89     ('pyasn1',           'pyasn1'),
  90     ('service-identity', 'service_identity'),
  91     ('characteristic',   'characteristic'),
  92     ('pyasn1-modules',   'pyasn1_modules'),
  93 ]
  94
  95 # Dependencies for which we don't know how to get a version number at run-time.
  96 not_import_versionable = [
  97     'zope.interface',
  98 ]
  99
 100 # Dependencies reported by pkg_resources that we can safely ignore.
 101 ignorable = [
 102     'argparse',
 103     'pyutil',
 104     'zbase32',
 105     'distribute',
 106     'twisted-web',
 107     'twisted-core',
 108     'twisted-conch',
 109 ]
 110
 111 import sys
 112
 113 # Don't try to get the version number of setuptools in frozen builds, because
 114 # that triggers 'site' processing that causes failures. Note that frozen
 115 # builds still (unfortunately) import pkg_resources in .tac files, so the
 116 # entry for setuptools in install_requires above isn't conditional.
 117 if not hasattr(sys, 'frozen'):
 118     package_imports.append(('setuptools', 'setuptools'))
 119
 120
 121 # * pyOpenSSL is required in order for foolscap to provide secure connections.
 122 #   Since foolscap doesn't reliably declare this dependency in a machine-readable
 123 #   way, we need to declare a dependency on pyOpenSSL ourselves. Tahoe-LAFS does
 124 #   not *directly* depend on pyOpenSSL.
 125 #
 126 # * pyOpenSSL >= 0.13 is needed in order to avoid
 127 #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2005>, and also to check the
 128 #   version of OpenSSL that pyOpenSSL is using.
 129 #
 130 # * pyOpenSSL >= 0.14 is built on the 'cryptography' package which depends
 131 #   on 'cffi' (and indirectly several other packages). Unfortunately cffi
 132 #   attempts to compile code dynamically, which causes problems on many systems.
 133 #   It also depends on the libffi OS package which may not be installed.
 134 #   <https://bitbucket.org/cffi/cffi/issue/109/enable-sane-packaging-for-cffi>
 135 #   <https://bitbucket.org/cffi/cffi/issue/70/cant-install-cffi-using-pip-on-windows>
 136 #
 137 #   So, if pyOpenSSL 0.14 has *already* been installed and is importable, we
 138 #   want to accept it; otherwise we ask for pyOpenSSL 0.13 or 0.13.1.
 139 #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2193>
 140 #
 141 #   We don't rely on pkg_resources to tell us the installed pyOpenSSL version
 142 #   number, because pkg_resources telling us that we have 0.14 is not sufficient
 143 #   evidence that 0.14 will be the imported version (or will work correctly).
 144 #   One possible reason why it might not be is explained in
 145 #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1246#comment:6> and
 146 #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1258>.
 147
 148 _can_use_pyOpenSSL_0_14 = False
 149 try:
 150     import OpenSSL
 151     pyOpenSSL_ver = OpenSSL.__version__.split('.')
 152     if int(pyOpenSSL_ver[0]) > 0 or int(pyOpenSSL_ver[1]) >= 14:
 153         _can_use_pyOpenSSL_0_14 = True
 154 except Exception:
 155     pass
 156
 157 if _can_use_pyOpenSSL_0_14:
 158     install_requires += [
 159         # Although we checked for pyOpenSSL >= 0.14 above, we only actually
 160         # need pyOpenSSL >= 0.13; requiring 0.14 here cannot help.
 161         "pyOpenSSL >= 0.13",
 162
 163         # ... and now all the new stuff that pyOpenSSL 0.14 transitively
 164         # depends on. We specify these explicitly because setuptools is
 165         # bad at correctly resolving indirect dependencies (e.g. see
 166         # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2286>).
 167         #
 168         "cryptography",
 169         "cffi >= 0.8",          # latest cryptography depends on this version
 170         "six >= 1.4.1",         # latest cryptography depends on this version
 171         "enum34",               # latest cryptography depends on this
 172         "pycparser",            # cffi depends on this
 173     ]
 174
 175     package_imports += [
 176         ('cryptography',     'cryptography'),
 177         ('cffi',             'cffi'),
 178         ('six',              'six'),
 179         ('enum34',           'enum'),
 180         ('pycparser',        'pycparser'),
 181     ]
 182 else:
 183     install_requires += [
 184         "pyOpenSSL >= 0.13, <= 0.13.1",
 185     ]
 186
 187
 188 # These are suppressed globally:
 189
 190 global_deprecation_messages = [
 191     "BaseException.message has been deprecated as of Python 2.6",
 192     "twisted.internet.interfaces.IFinishableConsumer was deprecated in Twisted 11.1.0: Please use IConsumer (and IConsumer.unregisterProducer) instead.",
 193     "twisted.internet.interfaces.IStreamClientEndpointStringParser was deprecated in Twisted 14.0.0: This interface has been superseded by IStreamClientEndpointStringParserWithReactor.",
 194 ]
 195
 196 # These are suppressed while importing dependencies:
 197
 198 deprecation_messages = [
 199     "the sha module is deprecated; use the hashlib module instead",
 200     "object.__new__\(\) takes no parameters",
 201     "The popen2 module is deprecated.  Use the subprocess module.",
 202     "the md5 module is deprecated; use hashlib instead",
 203     "twisted.web.error.NoResource is deprecated since Twisted 9.0.  See twisted.web.resource.NoResource.",
 204     "the sets module is deprecated",
 205 ]
 206
 207 runtime_warning_messages = [
 208     "Not using mpz_powm_sec.  You should rebuild using libgmp >= 5 to avoid timing attack vulnerability.",
 209 ]
 210
 211 warning_imports = [
 212     'nevow',
 213     'twisted.persisted.sob',
 214     'twisted.python.filepath',
 215     'Crypto.Hash.SHA',
 216 ]