diff options
Diffstat (limited to 'setup.py')
| -rw-r--r-- | setup.py | 423 |
1 files changed, 423 insertions, 0 deletions
diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..e4fb8b4 --- /dev/null +++ b/setup.py @@ -0,0 +1,423 @@ +# -*- coding: utf-8 -*- + +# Copyright © 2009-2013 Zooko Wilcox-O'Hearn +# Author: Zooko Wilcox-O'Hearn +# +# See README.rst for licensing information. + +import os, platform, re, sys + +from setuptools import Extension, setup +from setuptools import Command +from distutils.util import get_platform +from setuptools.command.test import ScanningLoader +import unittest + +PKG='pycryptopp' +VERSION_PY_FNAME = os.path.join('src', PKG, '_version.py') + +import versioneer + +# ECDSA=False +ECDSA=True + +DEBUG=False +if "--debug" in sys.argv: + DEBUG=True + sys.argv.remove("--debug") + +DISABLE_EMBEDDED_CRYPTOPP=False +if "--disable-embedded-cryptopp" in sys.argv: + DISABLE_EMBEDDED_CRYPTOPP=True + sys.argv.remove("--disable-embedded-cryptopp") + +# Unfortunately stdeb v0.3 doesn't seem to offer a way to pass command-line +# arguments to setup.py when building for Debian, but it does offer a way to +# pass environment variables, so we here check for that in addition to the +# command-line argument check above. +if os.environ.get('PYCRYPTOPP_DISABLE_EMBEDDED_CRYPTOPP') == "1": + DISABLE_EMBEDDED_CRYPTOPP=True + +EMBEDDED_CRYPTOPP_DIR='src-cryptopp' + +BUILD_DOUBLE_LOAD_TESTER=False +BDLTARG="--build-double-load-tester" +if BDLTARG in sys.argv: + BUILD_DOUBLE_LOAD_TESTER=True + sys.argv.remove(BDLTARG) + +# There are two ways that this setup.py script can build pycryptopp, either by using the +# Crypto++ source code bundled in the pycryptopp source tree, or by linking to a copy of the +# Crypto++ library that is already installed on the system. + +extra_compile_args=[] +extra_link_args=[] +define_macros=[] +undef_macros=[] +libraries=[] +ext_modules=[] +include_dirs=[] +library_dirs=[] +extra_srcs=[] # This is for Crypto++ .cpp files if they are needed. + +# +# Fix the build on OpenBSD +# https://tahoe-lafs/trac/pycryptopp/ticket/32 +# +if 'openbsd' in platform.system().lower(): + extra_link_args.append("-fpic") + +if DEBUG: + extra_compile_args.append("-O0") + extra_compile_args.append("-g") + extra_compile_args.append("-Wall") + extra_link_args.append("-g") + undef_macros.append('NDEBUG') +else: + extra_compile_args.append("-w") + +if DISABLE_EMBEDDED_CRYPTOPP: + define_macros.append(('DISABLE_EMBEDDED_CRYPTOPP', 1)) + + # Link with a Crypto++ library that is already installed on the system. + + for inclpath in ["/usr/local/include/cryptopp", "/usr/include/cryptopp"]: + if os.path.exists(inclpath): + libraries.append("cryptopp") + incldir = os.path.dirname(inclpath) + include_dirs.append(incldir) + libdir = os.path.join(os.path.dirname(incldir), "lib") + library_dirs.append(libdir) + break + + if not libraries: + print "Did not locate libcryptopp in the usual places." + print "Adding /usr/local/{include,lib} and -lcryptopp in the hopes" + print "that they will work." + + # Note that when using cygwin build tools (including gcc) to build + # Windows-native binaries, the os.path.exists() will not see the + # /usr/local/include/cryptopp directory but the subsequent call to g++ + # will. + libraries.append("cryptopp") + include_dirs.append("/usr/local/include") + library_dirs.append("/usr/local/lib") + +else: + # Build the bundled Crypto++ library which is included by source + # code in the pycryptopp tree and link against it. + define_macros.append(('CRYPTOPP_DISABLE_ASM', 1)) + + include_dirs.append(".") + + if 'sunos' in platform.system().lower(): + extra_compile_args.append('-Wa,--divide') # allow use of "/" operator + + cryptopp_src = [ os.path.join(EMBEDDED_CRYPTOPP_DIR, x) for x in os.listdir(EMBEDDED_CRYPTOPP_DIR) if x.endswith('.cpp') ] + + # Mac OS X extended attribute files when written to a non-Mac-OS-X + # filesystem come out as "._$FNAME", for example "._rdtables.cpp", + # and those files contain uncompilable data that is not C++, thus + # on occasion causing the build to fail. This works-around that: + cryptopp_src = [ c for c in cryptopp_src if not os.path.basename(c).startswith('._') ] + + extra_srcs.extend(cryptopp_src) + +trove_classifiers=[ + "Environment :: Console", + "License :: OSI Approved :: GNU General Public License (GPL)", # See README.rst for alternative licensing. + "License :: DFSG approved", + "Intended Audience :: Developers", + "Operating System :: Microsoft :: Windows", + "Operating System :: Unix", + "Operating System :: MacOS :: MacOS X", + "Natural Language :: English", + "Programming Language :: C", + "Programming Language :: C++", + "Programming Language :: Python", + "Programming Language :: Python :: 2", + "Programming Language :: Python :: 2.6", + "Programming Language :: Python :: 2.7", + "Topic :: Software Development :: Libraries", + ] + +srcs = ['src/pycryptopp/_pycryptoppmodule.cpp', + 'src/pycryptopp/publickey/rsamodule.cpp', + 'src/pycryptopp/hash/sha256module.cpp', + 'src/pycryptopp/cipher/aesmodule.cpp', + 'src/pycryptopp/cipher/xsalsa20module.cpp', + ] +if ECDSA: + srcs.append('src/pycryptopp/publickey/ecdsamodule.cpp') +if BUILD_DOUBLE_LOAD_TESTER: + srcs.append('_doubleloadtester.cpp', ) + +ext_modules.append( + Extension('pycryptopp._pycryptopp', extra_srcs + srcs, include_dirs=include_dirs, library_dirs=library_dirs, libraries=libraries, extra_link_args=extra_link_args, extra_compile_args=extra_compile_args, define_macros=define_macros, undef_macros=undef_macros) + ) + +# python-ed25519 +sources = [os.path.join("src-ed25519","glue","ed25519module.c")] +sources.extend([os.path.join("src-ed25519","supercop-ref",s) + for s in os.listdir(os.path.join("src-ed25519","supercop-ref")) + if s.endswith(".c") and s!="test.c"]) +m = Extension("pycryptopp.publickey.ed25519._ed25519", + include_dirs=[os.path.join("src-ed25519","supercop-ref")], + sources=sources) +ext_modules.append(m) + + +if BUILD_DOUBLE_LOAD_TESTER: + ext_modules.append( + Extension('_doubleloadtester', extra_srcs + srcs, include_dirs=include_dirs, library_dirs=library_dirs, libraries=libraries, extra_link_args=extra_link_args, extra_compile_args=extra_compile_args, define_macros=define_macros, undef_macros=undef_macros) + ) + +miscdeps=os.path.join(os.getcwd(), 'misc', 'dependencies') +dependency_links=[os.path.join(miscdeps, t) for t in os.listdir(miscdeps) if t.endswith(".tar")] +setup_requires = [] +install_requires = ['setuptools >= 0.6a9'] # for pkg_resources for loading test vectors for unit tests + +# setuptools_pyflakes is needed only if you want "./setup.py flakes" to run +# pyflakes on all the pycryptopp modules. +if 'flakes' in sys.argv[1:]: + setup_requires.append('setuptools_pyflakes >= 1.0.0') + +# stdeb is required to produce Debian files with "sdist_dsc". +# http://github.com/astraw/stdeb/tree/master +if "sdist_dsc" in sys.argv: + setup_requires.append('stdeb') + +data_fnames=['COPYING.GPL', 'COPYING.TGPPL.rst', 'COPYING.MIT.txt', 'COPYING.SPL.txt', 'README.rst'] + +readmetext = open('README.rst').read() +if readmetext[:3] == '\xef\xbb\xbf': + # utf-8 "BOM" + readmetext = readmetext[3:] + +try: + readmetext = readmetext.decode('utf-8') +except UnicodeDecodeError: + pass + +# In case we are building for a .deb with stdeb's sdist_dsc command, we put the +# docs in "share/doc/pycryptopp". +doc_loc = "share/doc/" + PKG +data_files = [(doc_loc, data_fnames)] + +commands = {} + +###### Version updating code + +CPP_GIT_VERSION_BODY = ''' +/* This _version.py is generated from git metadata by the pycryptopp + * setup.py. The main version number is taken from the most recent release + * tag. If some patches have been added since the last release, this will + * have a -NN "build number" suffix, or else a -rNN "revision number" suffix. + */ + +#define CRYPTOPP_EXTRA_VERSION "%(pkgname)s-%(pkgversion)s" +''' + +def get_normalized_version(versions): + pieces = versions['version'].split("-") + +# examples: versions: {'version': '2.3.4-dirty', 'full': '5ebdca46cf83a185710ecb9b29d46ec8ac70de61-dirty'} +# examples versions: {'version': '0.5.29-108-g5ebdca4-dirty', 'full': '5ebdca46cf83a185710ecb9b29d46ec8ac70de61-dirty'} +# examples: pieces: ['0.5.29', '108', 'g5ebdca4', 'dirty'] +# examples: pieces: ['2.3.4', 'dirty'] +# examples: pieces: ['2.3.4'] + + normalized_version = [] + normalized_version.append(pieces.pop(0)) + + postrelease = None + dirty = False + + while len(pieces) > 0: + nextpiece = pieces.pop(0) + if re.match('\d+$', nextpiece): + postrelease = nextpiece + normalized_version.append('.'+postrelease) + elif nextpiece.startswith('g'): + continue + # Use the full version instead ,below + elif nextpiece == 'dirty': + dirty = True + + fullvhex = versions['full'].split('-')[0] + full = int(fullvhex, 16) + normalized_version.append('.'+str(full)) + + if postrelease is not None: + normalized_version.append('.post'+postrelease) + if dirty is True: + normalized_version.append('.dev0') + + return ''.join(normalized_version) + +def read_version_py(infname): + try: + verstrline = open(infname, "rt").read() + except EnvironmentError: + return None + else: + VSRE = r"^__version__ = ['\"]([^'\"]*)['\"]" + mo = re.search(VSRE, verstrline, re.M) + if mo: + return mo.group(1) + +EXTRAVERSION_H_FNAME = os.path.join(EMBEDDED_CRYPTOPP_DIR, 'extraversion.h') + +VERSION_BODY = ''' +# This is the version of this tree, as created by %(versiontool)s from the +# git information: the main version number is taken from the most recent +# release tag. If some patches have been added since the last release, this +# will have a -NN "build number" suffix, followed by -gXXX "revid" suffix. + +__pkgname__ = "%(pkgname)s" +__version__ = "%(pkgversion)s" +''' + +class UpdateVersion(object): + def run(self): + + versions = versioneer.versions_from_vcs(PKG+'-', '.') + assert isinstance(versions, dict) + + vers_f_file = read_version_py(VERSION_PY_FNAME) + + if not versions and vers_f_file is None: + raise Exception("problem: couldn't get version information from revision control history, and there is no version information in '%s'. Stopping." % (VERSION_PY_FNAME,)) + + if versions: + version = get_normalized_version(versions) + else: + version = vers_f_file + + # Let's avoid touching the change time (ctime) on the files unless + # they actually need to be updated. + + if self.read_extraversion_h(EXTRAVERSION_H_FNAME) != version: + self.write_extraversion_h( + PKG, + version, + EXTRAVERSION_H_FNAME, + CPP_GIT_VERSION_BODY + ) + + if read_version_py(VERSION_PY_FNAME) != version: + self.write_version_py( + PKG, + version, + VERSION_PY_FNAME, + VERSION_BODY, + "pycryptopp's setup.py" + ) + + return version + + def write_version_py(self, pkgname, version, outfname, body, EXE_NAME): + f = open(outfname, "wb+") + f.write(body % { + 'versiontool': EXE_NAME, + 'pkgversion': version, + 'pkgname': pkgname, + }) + f.close() + + def write_extraversion_h(self, pkgname, version, outfname, body): + f = open(outfname, "wb") + f.write(body % {"pkgname": pkgname, "pkgversion": version}) + f.close() + + def read_extraversion_h(self, infname): + try: + verstrline = open(infname, "rt").read() + except EnvironmentError: + return None + else: + VSRE = r"^#define CRYPTOPP_EXTRA_VERSION +\"([^\"]*)\"" + mo = re.search(VSRE, verstrline, re.M) + if mo: + return mo.group(1) + +version = UpdateVersion().run() + +class Test(Command): + description = "run tests" + user_options = [] + def initialize_options(self): + self.test_suite = None + def finalize_options(self): + if self.test_suite is None: + self.test_suite = self.distribution.test_suite + def setup_path(self): + # copied from distutils/command/build.py + self.plat_name = get_platform() + plat_specifier = ".%s-%s" % (self.plat_name, sys.version[0:3]) + self.build_lib = os.path.join("build", "lib"+plat_specifier) + sys.path.insert(0, self.build_lib) + def run(self): + self.setup_path() + loader = ScanningLoader() + test = loader.loadTestsFromName(self.test_suite) + runner = unittest.TextTestRunner(verbosity=2) + result = runner.run(test) + sys.exit(not result.wasSuccessful()) +commands["test"] = Test + +class Bench(Command): + description = "run benchmarks" + user_options = [] + def initialize_options(self): + pass + def finalize_options(self): + pass + def setup_path(self): + # copied from distutils/command/build.py + self.plat_name = get_platform() + plat_specifier = ".%s-%s" % (self.plat_name, sys.version[0:3]) + self.build_lib = os.path.join("build", "lib"+plat_specifier) + sys.path.insert(0, self.build_lib) + def run(self): + self.setup_path() + from pycryptopp.bench import bench_algs + bench_algs.bench(MAXTIME=1.0) # Requires pyutil ≤ 1.9.7 +commands["bench"] = Bench + +def _setup(longdescription): + setup(name=PKG, + version=version, + description='Python wrappers for a few algorithms from the Crypto++ library', + long_description=longdescription, + author='Zooko Wilcox', + author_email='zookog@gmail.com', + url='https://tahoe-lafs.org/trac/' + PKG, + license='GNU GPL', # see README.rst for details -- there is also an alternative licence + packages=["pycryptopp", + "pycryptopp.cipher", + "pycryptopp.hash", + "pycryptopp.publickey", + "pycryptopp.publickey.ed25519", + "pycryptopp.test", + ], + include_package_data=True, + exclude_package_data={ + '': [ '*.cpp', '*.hpp', ] + }, + data_files=data_files, + package_dir={"pycryptopp": "src/pycryptopp"}, + setup_requires=setup_requires, + install_requires=install_requires, + dependency_links=dependency_links, + classifiers=trove_classifiers, + ext_modules=ext_modules, + test_suite=PKG+".test", + zip_safe=False, # I prefer unzipped for easier access. + cmdclass=commands, + ) + +try: + _setup(readmetext) +except UnicodeEncodeError: + _setup(repr(readmetext)) |