]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blobdiff - src/allmydata/_auto_deps.py
bump foolscap dependency to 0.10.1
[tahoe-lafs/tahoe-lafs.git] / src / allmydata / _auto_deps.py
index 68ef9f683a59f0d0643082639b506e690b5ecf83..4dcd50f75ed432f259dd6e0b66ce8d36269a8bfb 100644 (file)
@@ -4,9 +4,20 @@
 # It is ok to import modules from the Python Standard Library if they are
 # always available, or the import is protected by try...except ImportError.
 
+# The semantics for requirement specs changed incompatibly in setuptools 8,
+# which now follows PEP 440. The requirements used in this file must be valid
+# under both the old and new semantics. That can be achieved by limiting
+# requirement specs to one of the following forms:
+#
+#   * >= X, <= Y where X < Y
+#   * >= X, != Y, != Z, ... where X < Y < Z...
+#
+# (In addition, check_requirement in allmydata/__init__.py only supports
+# >=, <= and != operators.)
+
 install_requires = [
-    # we require newer versions of setuptools (actually
-    # zetuptoolz) to build, but can handle older versions to run
+    # We require newer versions of setuptools (actually
+    # zetuptoolz) to build, but can handle older versions to run.
     "setuptools >= 0.6c6",
 
     "zfec >= 1.1.0",
@@ -14,100 +25,215 @@ install_requires = [
     # Feisty has simplejson 1.4
     "simplejson >= 1.4",
 
+    # zope.interface >= 3.6.0 is required for Twisted >= 12.1.0.
     # zope.interface 3.6.3 and 3.6.4 are incompatible with Nevow (#1435).
-    # 3.6.5 is compatible but fails tests due to an unsuppressed warning.
-    "zope.interface <= 3.6.2, >= 3.6.6",
-
-    # On Windows we need at least Twisted 9.0 to avoid an indirect dependency on pywin32.
-    # On Linux we need at least Twisted 10.1.0 for inotify support used by the drop-upload
-    # frontend.
-    # We also need Twisted 10.1 for the FTP frontend in order for Twisted's FTP server to
-    # support asynchronous close.
-    "Twisted >= 10.1.0",
-
-    # foolscap < 0.5.1 had a performance bug which spent
-    # O(N**2) CPU for transferring large mutable files
-    # of size N.
-    # foolscap < 0.6 is incompatible with Twisted 10.2.0.
-    # foolscap 0.6.1 quiets a DeprecationWarning.
-    # pyOpenSSL is required by foolscap for it (foolscap) to provide secure
-    # connections. Foolscap doesn't reliably declare this dependency in a
-    # machine-readable way, so we need to declare a dependency on pyOpenSSL
-    # ourselves. Tahoe-LAFS doesn't *really* depend directly on pyOpenSSL,
-    # so if something changes in the relationship between foolscap and
-    # pyOpenSSL, such as foolscap requiring a specific version of pyOpenSSL,
-    # or foolscap switching from pyOpenSSL to a different crypto library, we
-    # need to update this declaration here.
-    "foolscap >= 0.6.1",
-    "pyOpenSSL",
-
-    "Nevow >= 0.6.0",
-
-    # Needed for SFTP. pyasn1 is needed by twisted.conch in Twisted >= 9.0.
-    # pycrypto 2.2 doesn't work due to https://bugs.launchpad.net/pycrypto/+bug/620253
-    "pycrypto == 2.0.1, == 2.1.0, >= 2.3",
-    "pyasn1 >= 0.0.8a",
-
-    # http://www.voidspace.org.uk/python/mock/
-    "mock",
-
-    # Will be needed to test web apps, but not yet. See #1001.
-    #"windmill >= 1.3",
+    "zope.interface >= 3.6.0, != 3.6.3, != 3.6.4",
+
+    # * foolscap < 0.5.1 had a performance bug which spent O(N**2) CPU for
+    #   transferring large mutable files of size N.
+    # * foolscap < 0.6 is incompatible with Twisted 10.2.0.
+    # * foolscap 0.6.1 quiets a DeprecationWarning.
+    # * foolscap < 0.6.3 is incompatible with Twisted 11.1.0 and newer.
+    # * foolscap 0.8.0 generates 2048-bit RSA-with-SHA-256 signatures,
+    #   rather than 1024-bit RSA-with-MD5. This also allows us to work
+    #   with a FIPS build of OpenSSL.
+    "foolscap >= 0.10.1",
+
+    # Needed for SFTP.
+    # pycrypto 2.2 doesn't work due to <https://bugs.launchpad.net/pycrypto/+bug/620253>
+    # pycrypto 2.4 doesn't work due to <https://bugs.launchpad.net/pycrypto/+bug/881130>
+    "pycrypto >= 2.1.0, != 2.2, != 2.4",
+
+    # pycryptopp-0.6.0 includes ed25519
+    "pycryptopp >= 0.6.0",
+
+    "service-identity",         # this is needed to suppress complaints about being unable to verify certs
+    "characteristic >= 14.0.0", # latest service-identity depends on this version
+    "pyasn1 >= 0.1.8",          # latest pyasn1-modules depends on this version
+    "pyasn1-modules >= 0.0.5",  # service-identity depends on this
 ]
 
 # Includes some indirect dependencies, but does not include allmydata.
 # These are in the order they should be listed by --version, etc.
 package_imports = [
-    # package name      module name
-    ('foolscap',        'foolscap'),
-    ('pycryptopp',      'pycryptopp'),
-    ('zfec',            'zfec'),
-    ('Twisted',         'twisted'),
-    ('Nevow',           'nevow'),
-    ('zope.interface',  'zope.interface'),
-    ('python',          None),
-    ('platform',        None),
-    ('pyOpenSSL',       'OpenSSL'),
-    ('simplejson',      'simplejson'),
-    ('pycrypto',        'Crypto'),
-    ('pyasn1',          'pyasn1'),
-    ('mock',            'mock'),
+    # package name       module name
+    ('foolscap',         'foolscap'),
+    ('pycryptopp',       'pycryptopp'),
+    ('zfec',             'zfec'),
+    ('Twisted',          'twisted'),
+    ('Nevow',            'nevow'),
+    ('zope.interface',   'zope.interface'),
+    ('python',           None),
+    ('platform',         None),
+    ('pyOpenSSL',        'OpenSSL'),
+    ('OpenSSL',          None),
+    ('simplejson',       'simplejson'),
+    ('pycrypto',         'Crypto'),
+    ('pyasn1',           'pyasn1'),
+    ('service-identity', 'service_identity'),
+    ('characteristic',   'characteristic'),
+    ('pyasn1-modules',   'pyasn1_modules'),
+]
+
+# Dependencies for which we don't know how to get a version number at run-time.
+not_import_versionable = [
+    'zope.interface',
 ]
 
-def require_more():
-    import platform, sys
-
-    if platform.machine().lower() in ['i386', 'x86', 'i686', 'x86_64', 'amd64', '']:
-        # pycryptopp v0.5.20 fixes bugs in SHA-256 and AES on x86 or amd64
-        # (from Crypto++ revisions 470, 471, 480, 492).  The '' is there
-        # in case platform.machine is broken and this is actually an x86
-        # or amd64 machine.
-        install_requires.append("pycryptopp >= 0.5.20")
-    else:
-        # pycryptopp v0.5.13 had a new bundled version of Crypto++
-        # (v5.6.0) and a new bundled version of setuptools (although that
-        # shouldn't make any difference to users of pycryptopp).
-        install_requires.append("pycryptopp >= 0.5.14")
-
-    # Sqlite comes built into Python >= 2.5, and is provided by the "pysqlite"
-    # distribution for Python 2.4.
+# Dependencies reported by pkg_resources that we can safely ignore.
+ignorable = [
+    'argparse',
+    'pyutil',
+    'zbase32',
+    'distribute',
+    'twisted-web',
+    'twisted-core',
+    'twisted-conch',
+]
+
+import sys
+
+# Don't try to get the version number of setuptools in frozen builds, because
+# that triggers 'site' processing that causes failures. Note that frozen
+# builds still (unfortunately) import pkg_resources in .tac files, so the
+# entry for setuptools in install_requires above isn't conditional.
+if not hasattr(sys, 'frozen'):
+    package_imports.append(('setuptools', 'setuptools'))
+
+
+# * On Linux we need at least Twisted 10.1.0 for inotify support
+#   used by the drop-upload frontend.
+# * We also need Twisted 10.1.0 for the FTP frontend in order for
+#   Twisted's FTP server to support asynchronous close.
+# * The SFTP frontend depends on Twisted 11.0.0 to fix the SSH server
+#   rekeying bug <https://twistedmatrix.com/trac/ticket/4395>
+# * The FTP frontend depends on Twisted >= 11.1.0 for
+#   filepath.Permissions
+#
+# On Windows, Twisted >= 12.2.0 has a dependency on pywin32.
+# Since pywin32 can only be installed manually, we fall back to
+# requiring earlier versions of Twisted and Nevow if it is not
+# already installed.
+# <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2028>
+#
+# When the fallback is used we also need to work around the fact
+# that Nevow imports itself when building, which causes Twisted
+# and zope.interface to be imported; therefore, we need to set
+# setup_requires to make sure that the versions of Twisted and
+# zope.interface used at build time satisfy Nevow's requirements.
+#
+# In cases where this fallback isn't needed, we prefer Nevow >= 0.11.1
+# which can be installed using pip, and Twisted >= 13.0.0 which
+# Nevow 0.11.1 depends on. In this case we should *not* use the
+# setup_requires hack, because if we do then the build will break
+# when Twisted < 13.0.0 is already installed (even though it could
+# have succeeded by building a later version under support/ ).
+#
+# <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2032>
+# <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2249>
+# <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2291>
+# <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2286>
+
+setup_requires = []
+
+_use_old_Twisted_and_Nevow = False
+if sys.platform == "win32":
     try:
-        import sqlite3
-        sqlite3 # hush pyflakes
-        package_imports.append(('sqlite3', 'sqlite3'))
+        import win32api
+        [win32api]
     except ImportError:
-        # pysqlite v2.0.5 was shipped in Ubuntu 6.06 LTS "dapper" and Nexenta NCP 1.
-        install_requires.append("pysqlite >= 2.0.5")
-        package_imports.append(('pysqlite', 'pysqlite2.dbapi2'))
+        _use_old_Twisted_and_Nevow = True
+
+if _use_old_Twisted_and_Nevow:
+    install_requires += [
+        "Twisted >= 11.1.0, <= 12.1.0",
+        "Nevow >= 0.9.33, <= 0.10",
+    ]
+    setup_requires += [req for req in install_requires if req.startswith('Twisted')
+                                                       or req.startswith('zope.interface')]
+else:
+    install_requires += [
+        "Twisted >= 13.0.0",
+        "Nevow >= 0.11.1",
+    ]
+
+
+# * pyOpenSSL is required in order for foolscap to provide secure connections.
+#   Since foolscap doesn't reliably declare this dependency in a machine-readable
+#   way, we need to declare a dependency on pyOpenSSL ourselves. Tahoe-LAFS does
+#   not *directly* depend on pyOpenSSL.
+#
+# * pyOpenSSL >= 0.13 is needed in order to avoid
+#   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2005>, and also to check the
+#   version of OpenSSL that pyOpenSSL is using.
+#
+# * pyOpenSSL >= 0.14 is built on the 'cryptography' package which depends
+#   on 'cffi' (and indirectly several other packages). Unfortunately cffi
+#   attempts to compile code dynamically, which causes problems on many systems.
+#   It also depends on the libffi OS package which may not be installed.
+#   <https://bitbucket.org/cffi/cffi/issue/109/enable-sane-packaging-for-cffi>
+#   <https://bitbucket.org/cffi/cffi/issue/70/cant-install-cffi-using-pip-on-windows>
+#
+#   So, if pyOpenSSL 0.14 has *already* been installed and is importable, we
+#   want to accept it; otherwise we ask for pyOpenSSL 0.13 or 0.13.1.
+#   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2193>
+#
+#   We don't rely on pkg_resources to tell us the installed pyOpenSSL version
+#   number, because pkg_resources telling us that we have 0.14 is not sufficient
+#   evidence that 0.14 will be the imported version (or will work correctly).
+#   One possible reason why it might not be is explained in
+#   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1246#comment:6> and
+#   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1258>.
+
+_can_use_pyOpenSSL_0_14 = False
+try:
+    import OpenSSL
+    pyOpenSSL_ver = OpenSSL.__version__.split('.')
+    if int(pyOpenSSL_ver[0]) > 0 or int(pyOpenSSL_ver[1]) >= 14:
+        _can_use_pyOpenSSL_0_14 = True
+except Exception:
+    pass
+
+if _can_use_pyOpenSSL_0_14:
+    install_requires += [
+        # Although we checked for pyOpenSSL >= 0.14 above, we only actually
+        # need pyOpenSSL >= 0.13; requiring 0.14 here cannot help.
+        "pyOpenSSL >= 0.13",
+
+        # ... and now all the new stuff that pyOpenSSL 0.14 transitively
+        # depends on. We specify these explicitly because setuptools is
+        # bad at correctly resolving indirect dependencies (e.g. see
+        # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2286>).
+        #
+        "cryptography",
+        "cffi >= 0.8",          # latest cryptography depends on this version
+        "six >= 1.4.1",         # latest cryptography depends on this version
+        "enum34",               # latest cryptography depends on this
+        "pycparser",            # cffi depends on this
+    ]
 
-    # Don't try to get the version number of setuptools in frozen builds, because
-    # that triggers 'site' processing that causes failures. Note that frozen
-    # builds still (unfortunately) import pkg_resources in .tac files, so the
-    # entry for setuptools in install_requires above isn't conditional.
-    if not hasattr(sys, 'frozen'):
-        package_imports.append(('setuptools', 'setuptools'))
+    package_imports += [
+        ('cryptography',     'cryptography'),
+        ('cffi',             'cffi'),
+        ('six',              'six'),
+        ('enum34',           'enum'),
+        ('pycparser',        'pycparser'),
+    ]
+else:
+    install_requires += [
+        "pyOpenSSL >= 0.13, <= 0.13.1",
+    ]
 
-require_more()
+
+# These are suppressed globally:
+
+global_deprecation_messages = [
+    "BaseException.message has been deprecated as of Python 2.6",
+    "twisted.internet.interfaces.IFinishableConsumer was deprecated in Twisted 11.1.0: Please use IConsumer (and IConsumer.unregisterProducer) instead.",
+    "twisted.internet.interfaces.IStreamClientEndpointStringParser was deprecated in Twisted 14.0.0: This interface has been superseded by IStreamClientEndpointStringParserWithReactor.",
+]
+
+# These are suppressed while importing dependencies:
 
 deprecation_messages = [
     "the sha module is deprecated; use the hashlib module instead",
@@ -118,7 +244,11 @@ deprecation_messages = [
     "the sets module is deprecated",
 ]
 
-deprecation_imports = [
+runtime_warning_messages = [
+    "Not using mpz_powm_sec.  You should rebuild using libgmp >= 5 to avoid timing attack vulnerability.",
+]
+
+warning_imports = [
     'nevow',
     'twisted.persisted.sob',
     'twisted.python.filepath',