diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/installation.rst | 31 | ||||
| -rw-r--r-- | docs/security.rst | 10 |
2 files changed, 35 insertions, 6 deletions
diff --git a/docs/installation.rst b/docs/installation.rst index 8fbbcb30..339d8b76 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -35,16 +35,35 @@ OpenSSL releases: On Windows ---------- -If you're on Windows you'll need to make sure you have OpenSSL installed. -There are `pre-compiled binaries`_ available. If your installation is in -an unusual location set the ``LIB`` and ``INCLUDE`` environment variables -to include the corresponding locations. For example: +The wheel package on Windows is a statically linked build (as of 0.5) so all +dependencies are included. Just run + +.. code-block:: console + + $ pip install cryptography + +If you prefer to compile it yourself you'll need to have OpenSSL installed. +There are `pre-compiled binaries`_ available. If your installation is in an +unusual location set the ``LIB`` and ``INCLUDE`` environment variables to +include the corresponding locations.For example: + +.. code-block:: console + + C:\> \path\to\vcvarsall.bat x86_amd64 + C:\> set LIB=C:\OpenSSL\lib\VC\static;C:\OpenSSL\lib;%LIB% + C:\> set INCLUDE=C:\OpenSSL\include;%INCLUDE% + C:\> pip install cryptography + +You can also choose to build statically or dynamically using the +``PYCA_WINDOWS_LINK_TYPE`` variable. Allowed values are ``static`` (default) +and ``dynamic``. .. code-block:: console C:\> \path\to\vcvarsall.bat x86_amd64 - C:\> set LIB=C:\OpenSSL-1.0.1g-64bit\lib;%LIB% - C:\> set INCLUDE=C:\OpenSSL-1.0.1g-64bit\include;%INCLUDE% + C:\> set LIB=C:\OpenSSL\lib\VC\static;C:\OpenSSL\lib;%LIB% + C:\> set INCLUDE=C:\OpenSSL\include;%INCLUDE% + C:\> set PYCA_WINDOWS_LINK_TYPE=dynamic C:\> pip install cryptography Building cryptography on Linux diff --git a/docs/security.rst b/docs/security.rst index 3d44cd3d..3bb10fa4 100644 --- a/docs/security.rst +++ b/docs/security.rst @@ -27,6 +27,16 @@ Supported Versions At any given time, we will provide security support for the `master`_ branch as well as the 2 most recent releases. +New releases for OpenSSL updates +-------------------------------- + +As of version 0.5, ``cryptography`` statically links OpenSSL on Windows to ease +installation. Due to this, ``cryptography`` will release a new version whenever +OpenSSL has a security or bug fix release to avoid shipping insecure software. + +Like all our other releases, this will be announced on the mailing list and we +strongly recommend that you upgrade as soon as possible. + Disclosure Process ------------------ |