OpenSC Windows installer

The purpose of the OpenSC installer is to distribute pre-built binary components of OpenSC and sub-projects to the end-user computer, manage simple configuration entries (like required registry keys) and removal of the components.

The contents of the package is:

• OpenSC core (and dependencies):
  • OpenSSL
  • iconv
  • libltdl
  • zlib
• OpenSSL PKCS#11 engine (and dependencies)
  • libp11

Possible installer steps / Windows environment description

• The default installation location is C:\Program Files\OpenSC or equivalent.
  • Only *.exe, *.profile and opensc.conf files are installed to the installation directory. To make applications like Firefox find the .dll dependancies, *.dll are installed to C:\Windows\system32 or equivalent.
• Registry keys that OpenSC can use:
  • OpenSC: common key "Software\\OpenSC" (names are case-preserved, but not case-sensitive)
    • ConfigFile - path to OpenSC config, searched from HKCU and HKLM, HKLM set to
    • ProfileDir - path to OpenSC PKCS#15 initialization profiles, searched from HKCU and HKLM, HKLM set to C:\Program Files\OpenSC\profiles on install
  • pkcs11-spy: common key "Software\\PKCS11-Spy"
    • Module - path to the real PKCS#11 module to load, searched from HKLM, HKCU
    • Output - path to the log output file, searched from HKLM, HKCU

Experimental downloads

OpenSC installer should not be confused with OpenSC software bundle, which includes extra applications that can be used with OpenSC PKCS#11 (or any other PKCS#11 provider in that matter)

• An experimental installer with  Inno Setup can be downloaded from http://www.opensc-project.org/files/contrib/OpenSC-0.12.0.exe
• An experimental installer with  NSIS can be downloaded from: http://www.opensc-project.org/downloads/users/alonbl/temp/

Open questions

• TODO-s on this page.
• Should development files be added to the default package or two separate version be built (XXX.exe and XXX-dev.exe) ?
• What kind of documentation should be provided with the installer package?
• How to harmonize the versioning of OpenSC and sub-projects.
• Deal with locked files on installation (reboot-after-install) and uninstall (remove-after-reboot)

Build instructions

The following has been done on Ubuntu 10.04, x86_64

• Building the .exe installer requires a Linux machine with Mingw32 and Wine (for running Inno Setup)

  $ sudo apt-get install wine mingw32
  

• You'll need Inno Setup, so fetch and install it (with defaults)

  $ wget http://www.jrsoftware.org/download.php/is.exe
  $ wine isetup-5.3.10.exe
  

• check out the "build" project:

  $ svn co https://www.opensc-project.org/svnp/build/trunk build
  

• Check out OpenSC:

  $ git clone git://github.com/martinpaljak/OpenSC.git
  $ cd OpenSC
  

• Create a up-to-date snapshot of OpenSC, to be built with build:

  $ ./bootstrap && ./configure --disable-doc && make dist
  $ mkdir -p ../build/sources
  $ cp opensc-0.12.0-svn.tar.gz ../build/sources
  

• Build the installer, first building OpenSC:

  $ ./win32/installer_from_build.sh ../build
   # build log removed
  Successful compile (2.170 sec). Resulting Setup program filename is:
  Z:\home\martin\OpenSC\win32\Output\OpenSC-0.12.0.exe
  
  real	5m53.208s
  user	5m4.780s
  sys	1m21.990s
  
  

• Use the installer .exe from win32/Output/OpenSC-0.12.0.exe