| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610 |
- #! /usr/bin/env python
- #
- # setup.py : Distutils setup script
- #
- # ===================================================================
- # The contents of this file are dedicated to the public domain. To
- # the extent that dedication to the public domain is not available,
- # everyone is granted a worldwide, perpetual, royalty-free,
- # non-exclusive license to exercise all rights associated with the
- # contents of this file for any purpose whatsoever.
- # No rights are reserved.
- #
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
- # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
- # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- # SOFTWARE.
- # ===================================================================
- try:
- from setuptools import Extension, Command, setup
- except ImportError:
- from distutils.core import Extension, Command, setup
- from distutils.command.build_ext import build_ext
- from distutils.command.build import build
- from distutils.command.install_lib import install_lib
- from distutils.errors import CCompilerError
- import distutils
- import re, os, sys, shutil
- use_separate_namespace = os.path.isfile(".separate_namespace")
- project_name = "pycryptodome"
- package_root = "Crypto"
- other_project = "pycryptodomex"
- other_root = "Cryptodome"
- if use_separate_namespace:
- project_name, other_project = other_project, project_name
- package_root, other_root = other_root, package_root
- longdesc = """
- PyCryptodome
- ============
- PyCryptodome is a self-contained Python package of low-level
- cryptographic primitives.
- It supports Python 2.4 or newer, all Python 3 versions and PyPy.
- You can install it with::
- pip install THIS_PROJECT
- All modules are installed under the ``THIS_ROOT`` package.
- Check the OTHER_PROJECT_ project for the equivalent library that
- works under the ``OTHER_ROOT`` package.
- PyCryptodome is a fork of PyCrypto. It brings several enhancements
- with respect to the last official version of PyCrypto (2.6.1),
- for instance:
- * Authenticated encryption modes (GCM, CCM, EAX, SIV, OCB)
- * Accelerated AES on Intel platforms via AES-NI
- * First class support for PyPy
- * Elliptic curves cryptography (NIST P-256 curve only)
- * Better and more compact API (`nonce` and `iv` attributes for ciphers,
- automatic generation of random nonces and IVs, simplified CTR cipher mode,
- and more)
- * SHA-3 (including SHAKE XOFs) and BLAKE2 hash algorithms
- * Salsa20 and ChaCha20 stream ciphers
- * scrypt and HKDF
- * Deterministic (EC)DSA
- * Password-protected PKCS#8 key containers
- * Shamir's Secret Sharing scheme
- * Random numbers get sourced directly from the OS (and not from a CSPRNG in userspace)
- * Simplified install process, including better support for Windows
- * Cleaner RSA and DSA key generation (largely based on FIPS 186-4)
- * Major clean ups and simplification of the code base
- PyCryptodome is not a wrapper to a separate C library like *OpenSSL*.
- To the largest possible extent, algorithms are implemented in pure Python.
- Only the pieces that are extremely critical to performance (e.g. block ciphers)
- are implemented as C extensions.
- For more information, see the `homepage`_.
- All the code can be downloaded from `GitHub`_.
- .. _OTHER_PROJECT: https://pypi.python.org/pypi/OTHER_PROJECT
- .. _`homepage`: http://www.pycryptodome.org
- .. _GitHub: https://github.com/Legrandin/pycryptodome
- """.replace("THIS_PROJECT", project_name).\
- replace("THIS_ROOT", package_root).\
- replace("OTHER_PROJECT", other_project).\
- replace("OTHER_ROOT", other_root)
- # By doing this we neeed to change version information in a single file
- for line in open(os.path.join("lib", "Crypto", "__init__.py")):
- if line.startswith("version_info"):
- version_tuple = eval(line.split("=")[1])
- version_string = "%d.%d" % version_tuple[:-1]
- if version_tuple[2] is not None:
- if str(version_tuple[2]).isdigit():
- version_string += "."
- version_string += str(version_tuple[2])
- if sys.version[0:1] == '1':
- raise RuntimeError ("The Python Cryptography Toolkit requires "
- "Python 2.x or 3.x to build.")
- try:
- # Python 3
- from distutils.command.build_py import build_py_2to3 as build_py
- except ImportError:
- # Python 2
- from distutils.command.build_py import build_py
- # Work around the print / print() issue with Python 2.x and 3.x. We only need
- # to print at one point of the code, which makes this easy
- def PrintErr(*args, **kwd):
- fout = kwd.get("file", sys.stderr)
- w = fout.write
- if args:
- w(str(args[0]))
- sep = kwd.get("sep", " ")
- for a in args[1:]:
- w(sep)
- w(str(a))
- w(kwd.get("end", "\n"))
- def test_compilation(program, extra_cc_options=None, extra_libraries=None):
- """Test if a certain C program can be compiled."""
- # Create a temporary file with the C program
- if not os.path.exists("build"):
- os.makedirs("build")
- fname = os.path.join("build", "test1.c")
- f = open(fname, 'w')
- f.write(program)
- f.close()
- # Name for the temporary executable
- oname = os.path.join("build", "test1.out")
- debug = False
- # Mute the compiler and the linker
- if not debug:
- old_stdout = os.dup(sys.stdout.fileno())
- old_stderr = os.dup(sys.stderr.fileno())
- dev_null = open(os.devnull, "w")
- os.dup2(dev_null.fileno(), sys.stdout.fileno())
- os.dup2(dev_null.fileno(), sys.stderr.fileno())
- objects = []
- try:
- compiler = distutils.ccompiler.new_compiler()
- if compiler.compiler_type in [ 'msvc' ]:
- # Force creation of the manifest file (http://bugs.python.org/issue16296)
- # as needed by VS2010
- extra_linker_options = [ "/MANIFEST" ]
- else:
- extra_linker_options = []
- distutils.sysconfig.customize_compiler(compiler)
- objects = compiler.compile([fname], extra_postargs=extra_cc_options)
- compiler.link_executable(objects, oname, libraries=extra_libraries, extra_preargs=extra_linker_options)
- result = True
- except CCompilerError:
- result = False
- for f in objects + [fname, oname]:
- try:
- os.remove(f)
- except OSError:
- pass
- # Restore stdout and stderr
- if not debug:
- if old_stdout is not None:
- os.dup2(old_stdout, sys.stdout.fileno())
- if old_stderr is not None:
- os.dup2(old_stderr, sys.stderr.fileno())
- if dev_null is not None:
- dev_null.close()
- return result
- def change_module_name(file_name):
- """Change any occurrance of 'Crypto' to 'Cryptodome'."""
- fd = open(file_name, "rt")
- content = (fd.read().
- replace("Crypto.", "Cryptodome.").
- replace("Crypto ", "Cryptodome ").
- replace("'Crypto'", "'Cryptodome'").
- replace('"Crypto"', '"Cryptodome"'))
- fd.close()
- os.remove(file_name)
- fd = open(file_name, "wt")
- fd.write(content)
- fd.close()
- def rename_crypto_dir(build_lib):
- """Move all files from the 'Crypto' package to the
- 'Cryptodome' package in the given build directory"""
- source = os.path.join(build_lib, "Crypto")
- target = os.path.join(build_lib, "Cryptodome")
- if not os.path.exists(target):
- PrintErr("Creating directory %s" % target)
- os.makedirs(target)
- else:
- PrintErr("Directory %s already exists" % target)
- # Crypto package becomes Cryptodome
- for root_src, dirs, files in os.walk(source):
- root_dst, nr_repl = re.subn('Crypto', 'Cryptodome', root_src)
- assert nr_repl == 1
- for dir_name in dirs:
- full_dir_name_dst = os.path.join(root_dst, dir_name)
- if not os.path.exists(full_dir_name_dst):
- os.makedirs(full_dir_name_dst)
- for file_name in files:
- full_file_name_src = os.path.join(root_src, file_name)
- full_file_name_dst = os.path.join(root_dst, file_name)
- PrintErr("Copying file %s to %s" % (full_file_name_src, full_file_name_dst))
- shutil.copy2(full_file_name_src, full_file_name_dst)
- if file_name.endswith(".py"):
- change_module_name(full_file_name_dst)
- class PCTBuildExt (build_ext):
- aesni_mod_names = "Crypto.Cipher._raw_aesni",
- def run(self):
- build_ext.run(self)
- if use_separate_namespace:
- rename_crypto_dir(self.build_lib)
- # Clean-up (extensions are built last)
- crypto_dir = os.path.join(self.build_lib, "Crypto")
- PrintErr("Deleting directory %s" % crypto_dir)
- shutil.rmtree(crypto_dir)
- def build_extensions(self):
- # Disable any assembly in libtomcrypt files
- self.compiler.define_macro("LTC_NO_ASM")
- # Detect which modules should be compiled
- self.detect_modules()
- # Call the superclass's build_extensions method
- build_ext.build_extensions(self)
- def check_cpuid_h(self):
- # UNIX
- source = """
- #include <cpuid.h>
- int main(void)
- {
- unsigned int eax, ebx, ecx, edx;
- __get_cpuid(1, &eax, &ebx, &ecx, &edx);
- return 0;
- }
- """
- if test_compilation(source):
- self.compiler.define_macro("HAVE_CPUID_H")
- return True
- else:
- return False
- def check_intrin_h(self):
- # Windows
- source = """
- #include <intrin.h>
- int main(void)
- {
- int a, b[4];
- __cpuid(b, a);
- return 0;
- }
- """
- if test_compilation(source):
- self.compiler.define_macro("HAVE_INTRIN_H")
- return True
- else:
- return False
- def check_aesni(self):
- source = """
- #include <wmmintrin.h>
- __m128i f(__m128i x, __m128i y) {
- return _mm_aesenc_si128(x, y);
- }
- int main(void) {
- return 0;
- }
- """
- aes_mods = [ x for x in self.extensions if x.name in self.aesni_mod_names ]
- result = test_compilation(source)
- if not result:
- result = test_compilation(source, extra_cc_options=['-maes'])
- if result:
- for x in aes_mods:
- x.extra_compile_args += ['-maes']
- return result
- def detect_modules (self):
- # Detect compiler support for CPUID instruction and AESNI
- if (self.check_cpuid_h() or self.check_intrin_h()) and self.check_aesni():
- PrintErr("Compiling support for Intel AES instructions")
- else:
- PrintErr ("warning: no support for Intel AESNI instructions")
- self.remove_extensions(self.aesni_mod_names)
- def remove_extensions(self, names):
- """Remove the specified extension from the list of extensions
- to build"""
- self.extensions = [ x for x in self.extensions if x.name not in names ]
- class PCTBuildPy(build_py):
- def find_package_modules(self, package, package_dir, *args, **kwargs):
- modules = build_py.find_package_modules(self, package, package_dir,
- *args, **kwargs)
- # Exclude certain modules
- retval = []
- for item in modules:
- pkg, module = item[:2]
- retval.append(item)
- return retval
- def run(self):
- build_py.run(self)
- if use_separate_namespace:
- rename_crypto_dir(self.build_lib)
- """
- class TestCommand(Command):
- description = "Run self-test"
- # Long option name, short option name, description
- user_options = [
- ('skip-slow-tests', None,
- 'Skip slow tests'),
- ('module=', 'm', 'Test a single module (e.g. Cipher, PublicKey)')
- ]
- def initialize_options(self):
- self.build_dir = None
- self.skip_slow_tests = None
- self.module = None
- def finalize_options(self):
- self.set_undefined_options('install', ('build_lib', 'build_dir'))
- self.config = {'slow_tests': not self.skip_slow_tests}
- def run(self):
- # Run sub commands
- for cmd_name in self.get_sub_commands():
- self.run_command(cmd_name)
- # Run SelfTest
- old_path = sys.path[:]
- self.announce("running self-tests on " + package_root)
- try:
- sys.path.insert(0, self.build_dir)
- if use_separate_namespace:
- from Cryptodome import SelfTest
- from Cryptodome.Math import Numbers
- else:
- from Crypto import SelfTest
- from Crypto.Math import Numbers
- moduleObj = None
- if self.module:
- if self.module.count('.')==0:
- # Test a whole a sub-package
- full_module = package_root + ".SelfTest." + self.module
- module_name = self.module
- else:
- # Test only a module
- # Assume only one dot is present
- comps = self.module.split('.')
- module_name = "test_" + comps[1]
- full_module = package_root + ".SelfTest." + comps[0] + "." + module_name
- # Import sub-package or module
- moduleObj = __import__( full_module, globals(), locals(), module_name )
- PrintErr(package_root + ".Math implementation:",
- str(Numbers._implementation))
- SelfTest.run(module=moduleObj, verbosity=self.verbose, stream=sys.stdout, config=self.config)
- finally:
- # Restore sys.path
- sys.path[:] = old_path
- # Run slower self-tests
- self.announce("running extended self-tests")
- sub_commands = [ ('build', None) ]
- """
- setup(
- name = project_name,
- version = version_string,
- description = "Cryptographic library for Python",
- long_description = longdesc,
- author = "Helder Eijs",
- author_email = "helderijs@gmail.com",
- url = "http://www.pycryptodome.org",
- platforms = 'Posix; MacOS X; Windows',
- classifiers = [
- 'Development Status :: 4 - Beta',
- 'License :: OSI Approved :: BSD License',
- 'License :: Public Domain',
- 'Intended Audience :: Developers',
- 'Operating System :: Unix',
- 'Operating System :: Microsoft :: Windows',
- 'Operating System :: MacOS :: MacOS X',
- 'Topic :: Security :: Cryptography',
- 'Programming Language :: Python :: 2',
- 'Programming Language :: Python :: 2.4',
- 'Programming Language :: Python :: 2.5',
- 'Programming Language :: Python :: 2.6',
- 'Programming Language :: Python :: 2.7',
- 'Programming Language :: Python :: 3',
- ],
- packages = [
- "Crypto",
- "Crypto.Cipher",
- "Crypto.Hash",
- "Crypto.IO",
- "Crypto.PublicKey",
- "Crypto.Protocol",
- "Crypto.Random",
- "Crypto.Signature",
- "Crypto.Util",
- "Crypto.Math",
- #"Crypto.SelfTest",
- #"Crypto.SelfTest.Cipher",
- #"Crypto.SelfTest.Hash",
- #"Crypto.SelfTest.IO",
- #"Crypto.SelfTest.Protocol",
- #"Crypto.SelfTest.PublicKey",
- #"Crypto.SelfTest.Random",
- #"Crypto.SelfTest.Signature",
- #"Crypto.SelfTest.Util",
- #"Crypto.SelfTest.Math",
- ],
- package_dir = { "Crypto": "lib/Crypto" },
- package_data = {
- #"Crypto.SelfTest.Cipher" : [
- # "test_vectors/AES/*.rsp",
- # "test_vectors/TDES/*.rsp",
- # ],
- #"Crypto.SelfTest.Hash" : [
- # "test_vectors/SHA3/*.txt",
- # "test_vectors/keccak/*.txt",
- # "test_vectors/BLAKE2s/*.txt",
- # "test_vectors/BLAKE2b/*.txt"
- # ],
- #"Crypto.SelfTest.Signature" : [
- # "test_vectors/DSA/*.*",
- # "test_vectors/ECDSA/*.*",
- # "test_vectors/PKCS1-v1.5/*.*",
- # "test_vectors/PKCS1-PSS/*.*"
- # ],
- #"Crypto.SelfTest.PublicKey" : [
- # "test_vectors/ECC/*.*",
- # ],
- "Crypto.Math" : [ "mpir.dll" ],
- },
- cmdclass = {
- 'build_ext':PCTBuildExt,
- 'build_py': PCTBuildPy
- #'test': TestCommand
- },
- ext_modules = [
- # Hash functions
- Extension("Crypto.Hash._MD2",
- include_dirs=['src/'],
- sources=["src/MD2.c"]),
- Extension("Crypto.Hash._MD4",
- include_dirs=['src/'],
- sources=["src/MD4.c"]),
- Extension("Crypto.Hash._SHA256",
- include_dirs=['src/'],
- sources=["src/SHA256.c"]),
- Extension("Crypto.Hash._SHA224",
- include_dirs=['src/'],
- sources=["src/SHA224.c"]),
- Extension("Crypto.Hash._SHA384",
- include_dirs=['src/'],
- sources=["src/SHA384.c"]),
- Extension("Crypto.Hash._SHA512",
- include_dirs=['src/'],
- sources=["src/SHA512.c"]),
- Extension("Crypto.Hash._RIPEMD160",
- include_dirs=['src/'],
- sources=["src/RIPEMD160.c"]),
- Extension("Crypto.Hash._keccak",
- include_dirs=['src/'],
- sources=["src/keccak.c"]),
- Extension("Crypto.Hash._BLAKE2b",
- include_dirs=['src/'],
- sources=["src/blake2b.c"]),
- Extension("Crypto.Hash._BLAKE2s",
- include_dirs=['src/'],
- sources=["src/blake2s.c"]),
- # Block encryption algorithms
- Extension("Crypto.Cipher._raw_aes",
- include_dirs=['src/'],
- sources=["src/AES.c"]),
- Extension("Crypto.Cipher._raw_aesni",
- include_dirs=['src/'],
- sources=["src/AESNI.c"]),
- Extension("Crypto.Cipher._raw_arc2",
- include_dirs=['src/'],
- sources=["src/ARC2.c"]),
- Extension("Crypto.Cipher._raw_blowfish",
- include_dirs=['src/'],
- sources=["src/Blowfish.c"]),
- Extension("Crypto.Cipher._raw_cast",
- include_dirs=['src/'],
- sources=["src/CAST.c"]),
- Extension("Crypto.Cipher._raw_des",
- include_dirs=['src/', 'src/libtom/'],
- sources=["src/DES.c"]),
- Extension("Crypto.Cipher._raw_des3",
- include_dirs=['src/', 'src/libtom/'],
- sources=["src/DES3.c"]),
- Extension("Crypto.Util._galois",
- include_dirs=['src/'],
- sources=['src/galois.c']),
- Extension("Crypto.Util._cpuid",
- include_dirs=['src/'],
- sources=['src/cpuid.c']),
- # Chaining modes
- Extension("Crypto.Cipher._raw_ecb",
- include_dirs=['src/'],
- sources=["src/raw_ecb.c"]),
- Extension("Crypto.Cipher._raw_cbc",
- include_dirs=['src/'],
- sources=["src/raw_cbc.c"]),
- Extension("Crypto.Cipher._raw_cfb",
- include_dirs=['src/'],
- sources=["src/raw_cfb.c"]),
- Extension("Crypto.Cipher._raw_ofb",
- include_dirs=['src/'],
- sources=["src/raw_ofb.c"]),
- Extension("Crypto.Cipher._raw_ctr",
- include_dirs=['src/'],
- sources=["src/raw_ctr.c"]),
- Extension("Crypto.Cipher._raw_ocb",
- include_dirs=['src/'],
- sources=["src/raw_ocb.c"]),
- # Stream ciphers
- Extension("Crypto.Cipher._ARC4",
- include_dirs=['src/'],
- sources=["src/ARC4.c"]),
- Extension("Crypto.Cipher._Salsa20",
- include_dirs=['src/', 'src/libtom/'],
- sources=["src/Salsa20.c"]),
- Extension("Crypto.Cipher._chacha20",
- include_dirs=['src/'],
- sources=["src/chacha20.c"]),
- # Others
- Extension("Crypto.Protocol._scrypt",
- include_dirs=['src/'],
- sources=["src/scrypt.c"]),
- # Utility modules
- Extension("Crypto.Util._strxor",
- include_dirs=['src/'],
- sources=['src/strxor.c']),
- ]
- )
|