From: Daira Hopwood <daira@jacaranda.org>
Date: Fri, 1 May 2015 17:45:19 +0000 (+0100)
Subject: Add doc for building pyOpenSSL.
X-Git-Tag: allmydata-tahoe-1.10.1a1~21
X-Git-Url: https://git.rkrishnan.org/?a=commitdiff_plain;h=b0fb800a41725b3d622303c87c5adc6a6e4e5def;p=tahoe-lafs%2Ftahoe-lafs.git

Add doc for building pyOpenSSL.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
---

diff --git a/docs/build/build-pyOpenSSL.rst b/docs/build/build-pyOpenSSL.rst
new file mode 100644
index 00000000..7c6189a9
--- /dev/null
+++ b/docs/build/build-pyOpenSSL.rst
@@ -0,0 +1,95 @@
+Building pyOpenSSL on Windows-7 (64-bit)
+========================================
+
+This document details the steps to build an pyOpenSSL egg with embedded
+OpenSSL library, for use by Tahoe-LAFS on Windows.
+
+The instructions were tried on Windows-7 64-bit. Building on a 32-bit machine
+shouldn't be too different.
+
+
+Download and install Microsoft Visual C++ compiler for Python 2.7
+-----------------------------------------------------------------
+
+For reasons detailed in `the Python documentation`_, Python extension modules
+need to be built using a compiler compatible with the same version of Visual C++
+that was used to build Python itself. Until recently, this meant downloading
+Microsoft Visual Studio 2008 Express Edition and Windows SDK 3.5. The recent
+release of the Microsoft Visual C++ compiler for Python 2.7 made things a lot
+simpler.
+
+So, the first step is to download and install the C++ compiler from Microsoft
+from `this link`_.
+
+.. _the Python documentation: https://docs.python.org/2/extending/windows.html
+.. _this link: https://www.microsoft.com/en-us/download/details.aspx?id=44266
+
+
+Download and install Perl
+-------------------------
+
+Download and install ActiveState Perl:
+
+* go to `the ActiveState Perl download page`_.
+* identify the correct link and manually change it from http to https.
+
+.. _the ActiveState Perl download page: https://www.activestate.com/activeperl/downloads
+
+
+Download and install the latest OpenSSL version
+-----------------------------------------------
+
+* Download the latest OpenSSL from `the OpenSSL source download page`_ and untar it.
+  At the time of writing, the latest version was OpenSSL 1.0.1m.
+
+* Set up the build environment::
+
+    "%USERPROFILE%\AppData\Local\Programs\Common\Microsoft\Visual C++ for Python\9.0\vcvarsall.bat" amd64
+
+* Go to the untar'ed OpenSSL source base directory and run the following commands::
+
+    mkdir c:\dist
+    perl Configure VC-WIN64A --prefix=c:\dist\openssl64 no-asm enable-tlsext
+    ms\do_win64a.bat
+    nmake -f ms\ntdll.mak
+    nmake -f ms\ntdll.mak install
+
+
+To check that it is working, run ``c:\dist\openssl64\bin\openssl version``.
+
+.. _the OpenSSL source download page: https://www.openssl.org/source/
+
+
+Building PyOpenSSL
+------------------
+
+* Download and untar pyOpenSSL 0.13.1 (see `ticket #2221`_ for why we
+  currently use this version). The MD5 hash of pyOpenSSL-0.13.1.tar.gz is
+  e27a3b76734c39ea03952ca94cc56715.
+
+* Set up the build environment::
+
+    "%USERPROFILE%\AppData\Local\Programs\Common\Microsoft\Visual C++ for Python\9.0\vcvarsall.bat" amd64
+
+* Set OpenSSL ``LIB``, ``INCLUDE`` and ``PATH``::
+
+    set LIB=c:\dist\openssl64\lib;%LIB%
+    set INCLUDE=c:\dist\openssl64\include;%INCLUDE%
+    set PATH=c:\dist\openssl64\bin;%PATH%
+
+* A workaround is needed to ensure that the setuptools ``bdist_egg`` command
+  is available. Edit pyOpenSSL's ``setup.py`` around line 13 as follows::
+
+    < from distutils.core import Extension, setup
+    ---
+    > from setuptools import setup
+    > from distutils.core import Extension
+
+* Run ``python setup.py bdist_egg``
+
+The generated egg will be in the ``dist`` directory. It is a good idea
+to check that Tahoe-LAFS is able to use it before uploading the egg to
+tahoe-lafs.org. This can be done by putting it in the ``tahoe-deps`` directory
+of a Tahoe-LAFS checkout or release, then running ``python setup.py test``.
+
+.. _ticket #2221: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2221