Skip to content

Latest commit

 

History

History
167 lines (107 loc) · 6.16 KB

README.md

File metadata and controls

167 lines (107 loc) · 6.16 KB
Raw

Summary

This is the top level project for the GlobalPlatform library for providing access to OpenPlatform 2.0.1' and GlobalPlatform 2.1.1 conforming smart cards and later, the command line shell GPShell using the GlobalPlatform library and the PC/SC connection plugin for the GlobalPlatform Library.

Pre-build Packages

There are Homebrew package for Linux and MacOS

Windows binaries can be downloaded from the GitHub release page or from SourceForge.

NOTE: The Microsoft Visual C++ 2015 Redistributable must be also installed.

Please read also the manual of GPShell if you are interested in the command line or use the installed man page with man gpshell under Unix like systems. There are several script examples available. See the .txt files or look into the local file systems under (/usr/ | /home/linuxbrew/.linuxbrew/) share/doc/gpshell1/.

Compilation

Cor lone the project from GitHub or download the zip file (also available under the Clone tab).

Consult the individual sub projects for further instructions and prerequisites. It is also possible to compile the sub projects individually.

Prerequisites

Use a suitable packet manager for your OS or install the programs and libraries manually if applicable.

  • Compiler Suite:
    • Linux: Termed build-essential in Debian based distributions (gcc, make)
    • MacOS: Xcode
    • Windows: Visual Studio and SDK
  • CMake 3.5.0 or higher is needed
  • PC/SC Lite (only for UNIXes, Windows and MacOS is already including this)
  • Doxygen for generating the documentation
  • Graphviz for generating graphics in the documentation
  • OpenSSL (MacOS is already providing this as LibreSSL)
  • zlib (MacOS should already bundle this, for Windows a pre-built version is included)
  • cmocka for running the tests
  • Pandoc for generating the man page the tests

Unix

Install the dependencies with brew or your distribution's package manager:

brew install openssl doxygen pandoc cmake cmocka zlib graphviz pcsc-lite

Compile

NOTE: If using Homebrew in parallel and having not used Homebrew for installing the dependencies but the distribution's package manager then several tools and libraries can be hidden by Homebrew or are not installed in Homebrew (pkgconfig, PC/SC Lite, cmocka, ...). One option is to install these tools and libraries with brew or remove the Homebrew path from the PATH variable temporarily (which should be ./home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin).

cd \path\to\globalplatform
cmake .
make
make doc
make install

NOTE: The Homebrew version of pcsc-lite is not a fully functional version. It is missing the USB drivers and is also not started as a system service. The distribution's version of pcscd should be installed. Under Linux the Homebrew version of pcsc-lite must be unlinked:

brew remove --ignore-dependencies pcsc-lite

MacOS

The compilation was executed on a system with Homebrew as package manager.

Install the dependencies with brew:

brew install openssl doxygen cmocka pandoc cmake graphviz

Compile

It can be necessary to set the OPENSSL_ROOT_DIR. In case of the usage of Homebrew this works:

cd \path\to\globalplatform
cmake . -DOPENSSL_ROOT_DIR=$(brew --prefix openssl)
make
make install

Windows

Install the dependencies with Chocolatey in an administrator's PowerShell or install the dependencies manually:

choco install cmake doxygen.install graphviz

NOTE: zlib must be installed manually. Copy the zlibwapi.dll to C:\Windows\System32 from the upper module's zlib-1.2.8/zlib-1.2.8.zip.

NOTE: OpenSSL must be installed manually. Chocolatey is using the systems architecture, which is nowadays 64 bit, but the compilation needs the 32 bit version. Download OpenSSL and choose the Win32 bit version and no light version.

Compile

Launch Visual Studio Command Prompt / Developer Command Prompt. It will be necessary to set the ZLIB_ROOT. Use the pre-built zlib version of the project for convenience.

cd \path\to\globalplatform
cmake -G "NMake Makefiles" -DZLIB_ROOT="C:\Users\john\Desktop\globalplatform\zlib-1.2.8\win32-build"
nmake

Documentation

Execute:

make/nmake doc

Binary Packages

Execute:

    make/nmake package

Source Packages

Execute:

make/nmake package_source

Debug Builds

To be able to debug the library enable the debug symbols:

cmake . -DDEBUG=ON

Testing

To generate the tests execute:

cmake . -DTESTING=ON -DDEBUG=ON
make
make test

Debug Output

The variable GLOBALPLATFORM_DEBUG=1 in the environment must be set. The logfile can be set with GLOBALPLATFORM_LOGFILE=<file>. Under Windows by default C:\Temp\GlobalPlatform.log is chosen, under Unix systems if syslog is available it will be used by default. The default log file under Unix systems is /tmp/GlobalPlatform.log if syslog is not available.

GitHub Documentation

The GitHub documentation is located under the docs folder and is using Jekyll.

Useful commands inside the docs folder:

  • Cleaning local generated site: bundle exec jekyll clean
  • Serving site in a local browser updating automatically on content changes: bundle exec jekyll serve
  • Update configuration in the Gemfile: bundle update

Issues

For issues please use the GitHub issue tracker.

You can also use the Mailing List or ask a question on Stack Overflow assigning the tags gpshell or globalplatform.