Skip to content

Latest commit

 

History

History
148 lines (97 loc) · 4.89 KB

README.md

File metadata and controls

148 lines (97 loc) · 4.89 KB
Raw

HOW TO KEEP THE FORK UP-TO-DATE

  1. Clone the repository locally and set the upstream (for syncing with upstream):

    git remote add upstream https://github.com/nabla-c0d3/nassl.git

  2. If you need to sync with upstream on a previously cloned repo run:

    git fetch upstream master
git checkout master
git merge upstream/master
git push

  3. Remember to checkout the proper branch again since we don't want any changes on master:

    git checkout internetnl

nassl

Build Status Coverage Status PyPI version

Experimental OpenSSL wrapper for Python 2.7 / 3.4+ and SSLyze. Do NOT use for anything serious. This code has not been properly tested/reviewed and is absolutely not production ready.

Quick Start

Nassl can be installed directly via pip:

pip install nassl

On OS X and Linux, it is also easy to directly clone the repository, build the _nassl C extension and then run the sample client:

git clone https://github.com/nabla-c0d3/nassl.git
cd nassl
pip install -r requirements.txt
python setup.py build_ext -i
python sample_client.py

Building the C extension

Nassl relies on a C extension to call into OpenSSL; the extension can be directly built using the pre-compiled OpenSSL binaries available in ./bin, by running the following command:

python setup.py build_ext -i

On Windows, a "Platform Wheel" can be built using:

python setup.py bdist_wheel

Building everything from scratch

If you do not want to use the pre-compiled binaries, compiling the C extension requires successively building:

The whole build process is all taken care of by the build_from_scratch.py script:

git clone https://github.com/nabla-c0d3/nassl.git
cd nassl
pip install -r requirements.txt
wget http://zlib.net/zlib-1.2.11.tar.gz
tar xvfz  zlib-1.2.11.tar.gz
wget https://ftp.openssl.org/source/old/1.0.2/openssl-1.0.2e.tar.gz
tar xvfz openssl-1.0.2e.tar.gz
git clone -b tls1.3-draft-18 https://github.com/openssl/openssl.git ./openssl-tls1.3-draft-18
python build_from_scratch.py

For Windows builds, Visual Studio is expected to be installed at the default location.

The build script was tested on the following platforms: Windows 7 (32 and 64 bits), Debian 7 (32 and 64 bits), macOS Sierra. It will build the C extension for the interpreter and platform that was used to run the script (ie. no cross-compiling).

Building Linux wheels using Docker

The manylinux Docker image can be used to build the C extension and its dependencies, and package everything into a Python wheel for all the supported versions of Python.

To build the linux32 nassl wheels:

docker run --rm -v C:\path\to\nassl\:/io quay.io/pypa/manylinux1_i686 bash /io/build_linux_wheels.sh

To build the linux64 nassl wheels:

docker run --rm -v C:\path\to\nassl\:/io quay.io/pypa/manylinux1_x86_64 bash /io/build_linux_wheels.sh

Project structure

nassl/

Classes implemented in Python are part of the nassl namespace; they are designed to provide a simpler, higher-level interface to perform SSL connections.

nassl/_nassl/

Classes implemented in C are part of the nassl._nassl namespace; they try to stay as close as possible to OpenSSL's API. In most cases, Python methods of such objects directly match the OpenSSL function with same name. For example the _nassl.SSL.read() Python method matches OpenSSL's SSL_read() function.

These classes should be considered internal.

Why another SSL library?

I'm the author of SSLyze, an SSL scanner written in Python. Scanning SSL servers requires access to low-level SSL functions within the OpenSSL API, for example to test for things like insecure renegotiation or session resumption.

None of the existing OpenSSL wrappers for Python (including ssl, M2Crypto and pyOpenSSL) expose the APIs that I need for SSLyze, so I had to write my own wrapper.

License

See ./LICENSE.txt

Please contact me if this license doesn't work for you.

Author

Alban Diquet - @nabla_c0d3 - https://nabla-c0d3.github.io