Merge pull request #8 from cconlon/pyupdate

Update wolfssl-py for use with urllib3 and websocket-client

Author: toddouska

.travis.yml

@@ -1,9 +1,5 @@
 sudo: required
 
-branches:
-  only:
-    - master
-
 matrix:
   include:
     - dist: trusty
@@ -13,7 +9,7 @@ matrix:
       script:
         - ./make/manylinux1/build_wheels.sh
     - os: osx
-      osx_image: xcode8.3
+      osx_image: xcode9.4
       script:
         - ./make/osx/build_wheels.sh
 

README.rst

@@ -8,7 +8,7 @@ Welcome
 that encapsulates `wolfSSL's SSL/TLS library
 <https://wolfssl.com/wolfSSL/Products-wolfssl.html>`_.
 
-**wolfSSL's SSL/TLS library** is a lightweight, portable, C-language-based
+The **wolfSSL SSL/TLS library** is a lightweight, portable, C-language-based
 library targeted at IoT, embedded, and RTOS environments primarily because of
 its size, speed, and feature set. It works seamlessly in desktop, enterprise,
 and cloud environments as well.
@@ -22,3 +22,42 @@ We provide Python wheels (prebuilt binaries) for OSX 64 bits and Linux 64 bits:
 .. code-block:: bash
 
     $ pip install wolfssl
+
+To build wolfssl-py from source:
+
+.. code-block:: bash
+
+    $ cd wolfssl-py
+    $ pip install .
+
+The default pip install clones wolfSSL from GitHub. To build wolfssl-py using a
+local installation of the native wolfSSL C library, the USE_LOCAL_WOLFSSL
+environment variable should be set.  USE_LOCAL_WOLFSSL can be set to "1" to use
+the default library installation location (/usr/local/lib, /usr/local/include),
+or to use a custom location it can be set to the install locaiton of your native
+wolfSSL library.  For example:
+
+.. code-block:: bash
+
+    # Uses default install location
+    $ USE_LOCAL_WOLFSSL=1 pip install .
+
+    # Uses custom install location
+    $ USE_LOCAL_WOLFSSL=/tmp/install pip install .
+
+Tests
+=====
+
+To run the tests that ship with wolfssl-py, after compiling the library run
+one of the following commands:
+
+.. code-block:: bash
+
+    $ pytest
+    $ py.test tests
+
+Support
+=======
+
+For support and questions, please email support@wolfssl.com.
+

docs/Makefile

@@ -1,6 +1,6 @@
 # Makefile for Sphinx documentation
 #
-# Copyright (C) 2006-2018 wolfSSL Inc.
+# Copyright (C) 2006-2019 wolfSSL Inc.
 #
 # This file is part of wolfSSL. (formerly known as CyaSSL)
 #

docs/conf.py

@@ -52,7 +52,7 @@
 
 # General information about the project.
 project = u'wolfssl Python'
-copyright = u'2018, wolfSSL Inc. All rights reserved'
+copyright = u'2019, wolfSSL Inc. All rights reserved'
 author = u'wolfSSL'
 
 # The version info for the project you're documenting, acts as replacement for

examples/client.py

@@ -4,7 +4,7 @@
 #
 # client.py
 #
-# Copyright (C) 2006-2017 wolfSSL Inc.
+# Copyright (C) 2006-2019 wolfSSL Inc.
 #
 # This file is part of wolfSSL. (formerly known as CyaSSL)
 #
@@ -105,6 +105,9 @@ def main():
 
     bind_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0)
 
+    # enable debug, if native wolfSSL has been compiled with '--enable-debug'
+    wolfssl.WolfSSL.enable_debug()
+
     context = wolfssl.SSLContext(get_method(args.v))
 
     context.load_cert_chain(args.c, args.k)

examples/server.py

@@ -4,7 +4,7 @@
 #
 # server.py
 #
-# Copyright (C) 2006-2017 wolfSSL Inc.
+# Copyright (C) 2006-2019 wolfSSL Inc.
 #
 # This file is part of wolfSSL. (formerly known as CyaSSL)
 #
@@ -109,6 +109,9 @@ def main():
 
     print("Server listening on port", bind_socket.getsockname()[1])
 
+    # enable debug, if native wolfSSL has been compiled with '--enable-debug'
+    wolfssl.WolfSSL.enable_debug()
+
     context = wolfssl.SSLContext(get_method(args.v), server_side=True)
 
     context.load_cert_chain(args.c, args.k)

make/manylinux1/build.sh

@@ -11,7 +11,7 @@ for PYBIN in /opt/python/*/bin; do
 done
 
 # Bundle external shared libraries into the wheels
-for whl in dist/*.whl; do
+for whl in dist/wolfssl*.whl; do
     auditwheel repair "$whl" -w tmpdist/
 done
 

make/osx/build_wheels.sh

@@ -2,16 +2,30 @@ set -e
 set +x
 
 for PYVERSION in 2.7 3.4 3.5 3.6; do
-    virtualenv -p /Library/Frameworks/Python.framework/Versions/${PYVERSION}/bin/python${PYVERSION} venv_${PYVERSION}
+    PYTHONBIN=/Library/Frameworks/Python.framework/Versions/${PYVERSION}/bin
+    PYTHONEXE=${PYTHONBIN}/python${PYVERSION}
+    export PATH="${PYTHONBIN}":$PATH
+
+    # update pip for newer TLS support
+    curl https://bootstrap.pypa.io/get-pip.py | ${PYTHONEXE}
+    "${PYTHONBIN}/pip" install --upgrade pip
+
+    # update virtualenv
+    ${PYTHONEXE} -m pip install virtualenv
+
+    virtualenv -p ${PYTHONEXE} venv_${PYVERSION}
     . ./venv_${PYVERSION}/bin/activate
-    pip install -r requirements/setup.txt
-    python setup.py bdist_wheel
-    pip install -r requirements/test.txt
+
+    # install cffi module
+    ${PYTHONEXE} -m pip install cffi
+
+    ${PYTHONEXE} setup.py bdist_wheel
+    "${PYTHONBIN}/pip" install -r requirements/test.txt
     set +e
-    pip uninstall -y wolfssl
+    "${PYTHONBIN}/pip" uninstall -y wolfssl
     set -e
-    pip install wolfssl --no-index -f dist
+    "${PYTHONBIN}/pip" install wolfssl --no-index -f dist
     rm -rf tests/__pycache__
     py.test tests
     deactivate
-done
+done

setup.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2006-2018 wolfSSL Inc.
+# Copyright (C) 2006-2019 wolfSSL Inc.
 #
 # This file is part of wolfSSL. (formerly known as CyaSSL)
 #
@@ -44,29 +44,18 @@
     long_description = long_description.replace(".. include:: LICENSING.rst\n",
                                                 licensing_file.read())
 
-
-# requirements
-def _parse_requirements(filepath):
-    raw = pip.req.parse_requirements(
-        filepath, session=pip.download.PipSession())
-
-    return [str(i.req) for i in raw]
-
-
-install_requirements = _parse_requirements("requirements/prod.txt")
-setup_requirements = _parse_requirements("requirements/setup.txt")
-test_requirements = _parse_requirements("requirements/test.txt")
-
-
 class cffiBuilder(build_ext, object):
 
     def build_extension(self, ext):
         """ Compile manually the wolfssl-py extension, bypass setuptools
         """
-        build_wolfssl(wolfssl.__wolfssl_version__)
 
-        super(cffiBuilder, self).build_extension(ext)
+        # if USE_LOCAL_WOLFSSL environment variable has been defined,
+        # do not clone and compile wolfSSL from GitHub
+        if os.environ.get("USE_LOCAL_WOLFSSL") is None:
+            build_wolfssl(wolfssl.__wolfssl_version__)
 
+        super(cffiBuilder, self).build_extension(ext)
 
 setup(
     name=wolfssl.__title__,
@@ -82,7 +71,6 @@ def build_extension(self, ext):
     package_dir={"":package_dir},
 
     zip_safe=False,
-    cffi_modules=["./src/wolfssl/_build_ffi.py:ffi"],
 
     keywords="wolfssl, wolfcrypt, security, cryptography",
     classifiers=[
@@ -98,9 +86,10 @@ def build_extension(self, ext):
         u"Topic :: Software Development"
     ],
 
-    setup_requires=setup_requirements,
-    install_requires=install_requirements,
+    setup_requires=["cffi"],
+    cffi_modules=["./src/wolfssl/_build_ffi.py:ffi"],
+    install_requires=["cffi"],
     test_suite="tests",
-    tests_require=test_requirements,
+    tests_require=["tox", "pytest"],
     cmdclass={"build_ext" : cffiBuilder}
 )

src/wolfssl/__about__.py

@@ -2,7 +2,7 @@
 #
 # __about__.py
 #
-# Copyright (C) 2006-2017 wolfSSL Inc.
+# Copyright (C) 2006-2019 wolfSSL Inc.
 #
 # This file is part of wolfSSL. (formerly known as CyaSSL)
 #
@@ -26,21 +26,21 @@
 
 # When bumping the C library version, reset the POST count to 0
 
-__wolfssl_version__ = "v3.14.0b"
+__wolfssl_version__ = "v3.15.7-stable"
 
 # We're using implicit post releases [PEP 440] to bump package version
 # while maintaining the C library version intact for better reference.
 # https://www.python.org/dev/peps/pep-0440/#implicit-post-releases
 #
 # MAJOR.MINOR.BUILD-POST
 
-__version__ = __wolfssl_version__[1:].replace("b", "-1")
+__version__ = __wolfssl_version__[1:].replace("stable", "0")
 
 __author__ = "wolfSSL Inc."
 __email__ = "info@wolfssl.com"
 
 __license__ = "GPLv2 or Commercial License"
-__copyright__ = "Copyright (C) 2006-2017 wolfSSL Inc"
+__copyright__ = "Copyright (C) 2006-2019 wolfSSL Inc"
 
 __all__ = [
     "__title__", "__summary__", "__uri__", "__version__",