prepare_ssl.py

#! /usr/bin/env python3
# Script for preparing OpenSSL for building on Windows.
# Uses Perl to create nmake makefiles and otherwise prepare the way
# for building on 32 or 64 bit platforms.

# Script originally authored by Mark Hammond.
# Major revisions by:
# Martin v. Löwis
# Christian Heimes
# Zachary Ware

# THEORETICALLY, you can:
# * Unpack the latest OpenSSL release where $(opensslDir) in
# PCbuild\pyproject.props expects it to be.
# * Install ActivePerl and ensure it is somewhere on your path.
# * Run this script with the OpenSSL source dir as the only argument.
#
# it should configure OpenSSL such that it is ready to be built by
# ssl.vcxproj on 32 or 64 bit platforms.

from __future__ importprint_function

importos
importre
importsys
importsubprocess
fromshutilimportcopy

# Find all "foo.exe" files on the PATH.
deffind_all_on_path(filename, extras=None):
entries=os.environ["PATH"].split(os.pathsep)
ret= []
forpinentries:
fname=os.path.abspath(os.path.join(p, filename))
ifos.path.isfile(fname) andfnamenotinret:
ret.append(fname)
ifextras:
forpinextras:
fname=os.path.abspath(os.path.join(p, filename))
ifos.path.isfile(fname) andfnamenotinret:
ret.append(fname)
returnret


# Find a suitable Perl installation for OpenSSL.
# cygwin perl does *not* work. ActivePerl does.
# Being a Perl dummy, the simplest way I can check is if the "Win32" package
# is available.
deffind_working_perl(perls):
forperlinperls:
try:
subprocess.check_output([perl, "-e", "use Win32;"])
exceptsubprocess.CalledProcessError:
continue
else:
returnperl

ifperls:
print("The following perl interpreters were found:")
forpinperls:
print(" ", p)
print(" None of these versions appear suitable for building OpenSSL")
else:
print("NO perl interpreters were found on this machine at all!")
print(" Please install ActivePerl and ensure it appears on your path")


defcopy_includes(makefile, suffix):
dir='inc'+suffix+'\\openssl'
try:
os.makedirs(dir)
exceptOSError:
pass
copy_if_different=r'$(PERL) $(SRC_D)\util\copy-if-different.pl'
withopen(makefile) asfin:
forlineinfin:
ifcopy_if_differentinline:
perl, script, src, dest=line.split()
ifnot'$(INCO_D)'indest:
continue
# We're in the root of the source tree
src=src.replace('$(SRC_D)', '.').strip('"')
dest=dest.strip('"').replace('$(INCO_D)', dir)
print('copying', src, 'to', dest)
copy(src, dest)


defrun_configure(configure, do_script):
print("perl Configure "+configure+" no-idea no-mdc2")
os.system("perl Configure "+configure+" no-idea no-mdc2")
print(do_script)
os.system(do_script)

deffix_uplink():
# uplink.c tries to find the OPENSSL_Applink function exported from the current
# executable. However, we export it from _ssl[_d].pyd instead. So we update the
# module name here before building.
withopen('ms\\uplink.c', 'r', encoding='utf-8') asf1:
code=list(f1)
os.replace('ms\\uplink.c', 'ms\\uplink.c.orig')
already_patched=False
withopen('ms\\uplink.c', 'w', encoding='utf-8') asf2:
forlineincode:
ifnotalready_patched:
ifre.search('MODIFIED FOR CPYTHON _ssl MODULE', line):
already_patched=True
elifre.match(r'^\s+if\s*\(\(h\s*=\s*GetModuleHandle[AW]?\(NULL\)\)\s*==\s*NULL\)', line):
f2.write("/* MODIFIED FOR CPYTHON _ssl MODULE */\n")
f2.write('if ((h = GetModuleHandleW(L"_ssl.pyd")) == NULL) if ((h = GetModuleHandleW(L"_ssl_d.pyd")) == NULL)\n')
already_patched=True
f2.write(line)
ifnotalready_patched:
print("WARN: failed to patch ms\\uplink.c")

defprep(arch):
makefile_template="ms\\ntdll{}.mak"
generated_makefile=makefile_template.format('')
ifarch=="x86":
configure="VC-WIN32"
do_script="ms\\do_nasm"
suffix="32"
elifarch=="amd64":
configure="VC-WIN64A"
do_script="ms\\do_win64a"
suffix="64"
else:
raiseValueError('Unrecognized platform: %s'%arch)

print("Creating the makefiles...")
sys.stdout.flush()
# run configure, copy includes, patch files
run_configure(configure, do_script)
makefile=makefile_template.format(suffix)
try:
os.unlink(makefile)
exceptFileNotFoundError:
pass
os.rename(generated_makefile, makefile)
copy_includes(makefile, suffix)

print('patching ms\\uplink.c...')
fix_uplink()

defmain():
iflen(sys.argv) ==1:
print("Not enough arguments: directory containing OpenSSL",
"sources must be supplied")
sys.exit(1)

iflen(sys.argv) ==3andsys.argv[2] notin ('x86', 'amd64'):
print("Second argument must be x86 or amd64")
sys.exit(1)

iflen(sys.argv) >3:
print("Too many arguments supplied, all we need is the directory",
"containing OpenSSL sources and optionally the architecture")
sys.exit(1)

ssl_dir=sys.argv[1]
arch=sys.argv[2] iflen(sys.argv) >=3elseNone

ifnotos.path.isdir(ssl_dir):
print(ssl_dir, "is not an existing directory!")
sys.exit(1)

# perl should be on the path, but we also look in "\perl" and "c:\\perl"
# as "well known" locations
perls=find_all_on_path("perl.exe", [r"\perl\bin",
r"C:\perl\bin",
r"\perl64\bin",
r"C:\perl64\bin",
 ])
perl=find_working_perl(perls)
ifperl:
print("Found a working perl at '%s'"% (perl,))
else:
sys.exit(1)
ifnotfind_all_on_path('nmake.exe'):
print('Could not find nmake.exe, try running env.bat')
sys.exit(1)
ifnotfind_all_on_path('nasm.exe'):
print('Could not find nasm.exe, please add to PATH')
sys.exit(1)
sys.stdout.flush()

# Put our working Perl at the front of our path
os.environ["PATH"] =os.path.dirname(perl) + \
os.pathsep+ \
os.environ["PATH"]

old_cwd=os.getcwd()
try:
os.chdir(ssl_dir)
ifarch:
prep(arch)
else:
forarchin ['amd64', 'x86']:
prep(arch)
finally:
os.chdir(old_cwd)

if__name__=='__main__':
main()