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.
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:
12 # * >= X, <= Y where X < Y
13 # * >= X, != Y, != Z, ... where X < Y < Z...
15 # (In addition, check_requirement in allmydata/__init__.py only supports
16 # >=, <= and != operators.)
19 # We require newer versions of setuptools (actually
20 # zetuptoolz) to build, but can handle older versions to run.
21 "setuptools >= 0.6c6",
25 # Feisty has simplejson 1.4
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",
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.
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",
47 # <http://www.voidspace.org.uk/python/mock/>, 0.8.0 provides "call"
50 # pycryptopp-0.6.0 includes ed25519
51 "pycryptopp >= 0.6.0",
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
59 # Includes some indirect dependencies, but does not include allmydata.
60 # These are in the order they should be listed by --version, etc.
62 # package name module name
63 ('foolscap', 'foolscap'),
64 ('pycryptopp', 'pycryptopp'),
66 ('Twisted', 'twisted'),
68 ('zope.interface', 'zope.interface'),
71 ('pyOpenSSL', 'OpenSSL'),
73 ('simplejson', 'simplejson'),
74 ('pycrypto', 'Crypto'),
77 ('service-identity', 'service_identity'),
78 ('characteristic', 'characteristic'),
79 ('pyasn1-modules', 'pyasn1_modules'),
82 # Dependencies for which we don't know how to get a version number at run-time.
83 not_import_versionable = [
87 # Dependencies reported by pkg_resources that we can safely ignore.
100 # Don't try to get the version number of setuptools in frozen builds, because
101 # that triggers 'site' processing that causes failures. Note that frozen
102 # builds still (unfortunately) import pkg_resources in .tac files, so the
103 # entry for setuptools in install_requires above isn't conditional.
104 if not hasattr(sys, 'frozen'):
105 package_imports.append(('setuptools', 'setuptools'))
108 # * On Linux we need at least Twisted 10.1.0 for inotify support
109 # used by the drop-upload frontend.
110 # * We also need Twisted 10.1.0 for the FTP frontend in order for
111 # Twisted's FTP server to support asynchronous close.
112 # * The SFTP frontend depends on Twisted 11.0.0 to fix the SSH server
113 # rekeying bug <https://twistedmatrix.com/trac/ticket/4395>
114 # * The FTP frontend depends on Twisted >= 11.1.0 for
115 # filepath.Permissions
117 # On Windows, Twisted >= 12.2.0 has a dependency on pywin32.
118 # Since pywin32 can only be installed manually, we fall back to
119 # requiring earlier versions of Twisted and Nevow if it is not
121 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2028>
123 # When the fallback is used we also need to work around the fact
124 # that Nevow imports itself when building, which causes Twisted
125 # and zope.interface to be imported; therefore, we need to set
126 # setup_requires to make sure that the versions of Twisted and
127 # zope.interface used at build time satisfy Nevow's requirements.
129 # In cases where this fallback isn't needed, we prefer Nevow >= 0.11.1
130 # which can be installed using pip, and Twisted >= 13.0.0 which
131 # Nevow 0.11.1 depends on. In this case we should *not* use the
132 # setup_requires hack, because if we do then the build will break
133 # when Twisted < 13.0.0 is already installed (even though it could
134 # have succeeded by building a later version under support/ ).
136 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2032>
137 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2249>
138 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2291>
139 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2286>
143 _use_old_Twisted_and_Nevow = False
144 if sys.platform == "win32":
149 _use_old_Twisted_and_Nevow = True
151 if _use_old_Twisted_and_Nevow:
152 install_requires += [
153 "Twisted >= 11.1.0, <= 12.1.0",
154 "Nevow >= 0.9.33, <= 0.10",
156 setup_requires += [req for req in install_requires if req.startswith('Twisted')
157 or req.startswith('zope.interface')]
159 install_requires += [
165 # * pyOpenSSL is required in order for foolscap to provide secure connections.
166 # Since foolscap doesn't reliably declare this dependency in a machine-readable
167 # way, we need to declare a dependency on pyOpenSSL ourselves. Tahoe-LAFS does
168 # not *directly* depend on pyOpenSSL.
170 # * pyOpenSSL >= 0.13 is needed in order to avoid
171 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2005>, and also to check the
172 # version of OpenSSL that pyOpenSSL is using.
174 # * pyOpenSSL >= 0.14 is built on the 'cryptography' package which depends
175 # on 'cffi' (and indirectly several other packages). Unfortunately cffi
176 # attempts to compile code dynamically, which causes problems on many systems.
177 # It also depends on the libffi OS package which may not be installed.
178 # <https://bitbucket.org/cffi/cffi/issue/109/enable-sane-packaging-for-cffi>
179 # <https://bitbucket.org/cffi/cffi/issue/70/cant-install-cffi-using-pip-on-windows>
181 # So, if pyOpenSSL 0.14 has *already* been installed and is importable, we
182 # want to accept it; otherwise we ask for pyOpenSSL 0.13 or 0.13.1.
183 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2193>
185 # We don't rely on pkg_resources to tell us the installed pyOpenSSL version
186 # number, because pkg_resources telling us that we have 0.14 is not sufficient
187 # evidence that 0.14 will be the imported version (or will work correctly).
188 # One possible reason why it might not be is explained in
189 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1246#comment:6> and
190 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1258>.
192 _can_use_pyOpenSSL_0_14 = False
195 pyOpenSSL_ver = OpenSSL.__version__.split('.')
196 if int(pyOpenSSL_ver[0]) > 0 or int(pyOpenSSL_ver[1]) >= 14:
197 _can_use_pyOpenSSL_0_14 = True
201 if _can_use_pyOpenSSL_0_14:
202 install_requires += [
203 # Although we checked for pyOpenSSL >= 0.14 above, we only actually
204 # need pyOpenSSL >= 0.13; requiring 0.14 here cannot help.
207 # ... and now all the new stuff that pyOpenSSL 0.14 transitively
208 # depends on. We specify these explicitly because setuptools is
209 # bad at correctly resolving indirect dependencies (e.g. see
210 # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2286>).
213 "cffi >= 0.8", # latest cryptography depends on this version
214 "six >= 1.4.1", # latest cryptography depends on this version
215 "enum34", # latest cryptography depends on this
216 "pycparser", # cffi depends on this
220 ('cryptography', 'cryptography'),
224 ('pycparser', 'pycparser'),
227 install_requires += [
228 "pyOpenSSL >= 0.13, <= 0.13.1",
232 # These are suppressed globally:
234 global_deprecation_messages = [
235 "BaseException.message has been deprecated as of Python 2.6",
236 "twisted.internet.interfaces.IFinishableConsumer was deprecated in Twisted 11.1.0: Please use IConsumer (and IConsumer.unregisterProducer) instead.",
237 "twisted.internet.interfaces.IStreamClientEndpointStringParser was deprecated in Twisted 14.0.0: This interface has been superseded by IStreamClientEndpointStringParserWithReactor.",
240 # These are suppressed while importing dependencies:
242 deprecation_messages = [
243 "the sha module is deprecated; use the hashlib module instead",
244 "object.__new__\(\) takes no parameters",
245 "The popen2 module is deprecated. Use the subprocess module.",
246 "the md5 module is deprecated; use hashlib instead",
247 "twisted.web.error.NoResource is deprecated since Twisted 9.0. See twisted.web.resource.NoResource.",
248 "the sets module is deprecated",
251 runtime_warning_messages = [
252 "Not using mpz_powm_sec. You should rebuild using libgmp >= 5 to avoid timing attack vulnerability.",
257 'twisted.persisted.sob',
258 'twisted.python.filepath',