Skip to content

Commit

Permalink
Doc updates, GPShell version update to 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
kaoh committed Sep 25, 2020
1 parent d20134c commit bb2256f
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 17 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,21 @@ Use a suitable packet manager for your OS or install the programs and libraries
* [OpenSSL](http://www.openssl.org/) (MacOS is already providing this as LibreSSL)
* [zlib](http://www.zlib.net/) (MacOS should already bundle this, for Windows a pre-built version is included)
* [cmocka](https://cmocka.org/) for running the tests
* [Pandoc](https://pandoc.org/installing.html) for generating the man page the tests

## Unix

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

~~~
brew install openssl doxygen pandoc cmake cmocka zlib graphviz
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 .
Expand All @@ -55,6 +59,12 @@ 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](https://brew.sh) as package manager.
Expand Down
2 changes: 1 addition & 1 deletion globalplatform/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ CMAKE_MINIMUM_REQUIRED(VERSION 2.8)

cmake_policy(VERSION 2.8)

SET( ${PROJECT_NAME}_CURRENT 6+7 )
SET( ${PROJECT_NAME}_CURRENT 7 )
SET( ${PROJECT_NAME}_REVISION 0 )
SET( ${PROJECT_NAME}_AGE 0 )
SET(VERSION "${${PROJECT_NAME}_CURRENT}.${${PROJECT_NAME}_REVISION}.${${PROJECT_NAME}_AGE}")
Expand Down
11 changes: 10 additions & 1 deletion globalplatform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,14 @@ Use a suitable packet manager for your OS or install the programs and libraries
Install the dependencies with `brew` or your distribution's package system:

~~~
brew install openssl doxygen pandoc cmake cmocka zlib graphviz
brew install openssl doxygen 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 .
Expand All @@ -41,6 +44,12 @@ 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
~~~

### Set Library Search Directory

It might be necessary to create a symlink to the correct library search directory, e.g. under Ubuntu 18.04 execute:
Expand Down
5 changes: 1 addition & 4 deletions gppcscconnectionplugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,10 @@ Use a suitable packet manager for your OS or install the programs and libraries
* Windows: Visual Studio and SDK
* [CMake 3.5.0](http://www.cmake.org/) or higher is needed
* [PC/SC Lite](https://pcsclite.apdu.fr) (only for UNIXes, Windows and MacOS is already including this)
* [GlobalPlatform](http://sourceforge.net/projects/globalplatform/)
* [GlobalPlatform](https://github.com/kaoh/globalplatform)

## Unix/MacOS

You must have CMake installed. http://www.cmake.org/
This can be obtained in standard Unix distributions over the integrated package system.

On a command line type:

```
Expand Down
6 changes: 3 additions & 3 deletions gpshell/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ CMAKE_MINIMUM_REQUIRED(VERSION 2.8)

cmake_policy(VERSION 2.8)

SET( ${PROJECT_NAME}_CURRENT 1 )
SET( ${PROJECT_NAME}_REVISION 4 )
SET( ${PROJECT_NAME}_AGE 4+5 )
SET( ${PROJECT_NAME}_CURRENT 2 )
SET( ${PROJECT_NAME}_REVISION 0 )
SET( ${PROJECT_NAME}_AGE 0 )
SET(VERSION "${${PROJECT_NAME}_CURRENT}.${${PROJECT_NAME}_REVISION}.${${PROJECT_NAME}_AGE}")

SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake_modules/;${PROJECT_SOURCE_DIR}/../globalplatform/cmake_modules/)
Expand Down
4 changes: 3 additions & 1 deletion gpshell/ChangeLog
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ SCP03 supported
getting key information templates
getting extended card resources information

06/01/2020 1.4.5 Karsten Ohme
09/26/2020 2.0.0 Karsten Ohme
CMake Build System
SCP03 supported
SCP03 AES-192 and AES-256 keys supported
getting key information templates
getting extended card resources information
noStop option added
Added LGPL OpenSSL Exception
Compiled against GlobalPlatform 7.0.0

Expand Down
5 changes: 1 addition & 4 deletions gpshell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,10 @@ Use a suitable packet manager for your OS or install the programs and libraries
* [CMake 3.5.0](http://www.cmake.org/) or higher is needed
* [PC/SC Lite](https://pcsclite.apdu.fr) (only for UNIXes, Windows and MacOS is already including this)
* [zlib](http://www.zlib.net/) (MacOS should already bundle this, for Windows a pre-built version is included)
* [GlobalPlatform](http://sourceforge.net/projects/globalplatform/)
* [GlobalPlatform](https://github.com/kaoh/globalplatform)

## Unix/MacOS

You must have CMake installed. http://www.cmake.org/
This can be obtained in standard Unix distributions over the integrated package system.

On a command line type:

```
Expand Down
5 changes: 4 additions & 1 deletion gpshell/src/gpshell.1.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% GPSHELL(1) 1.4.5 | GPShell Documentation
% GPSHELL(1) 2.0.0 | GPShell Documentation

# NAME

Expand All @@ -17,6 +17,9 @@ Additional key management commands are provided.

The most common way to use gpshell is a script file. But it is also possible to read the commands from stdin if no script file is provided.

Reading the commands from stdin allows to feed in the commands dynamically and use conditionals when using the [Expect](https://en.wikipedia.org/wiki/Expect) pattern. Tools
are available for a variety of script languages, shells and programming languages. Example are to support environment variables and handle results and output conditionally.

There are several `txt` example scripts provided which gets installed into `usr/local/share/docs` or `/home/linuxbrew/.linuxbrew/opt/globalplatform/share/doc/gpshell1/` or can be found [online](https://github.com/kaoh/globalplatform/tree/master/gpshell).

# COMMANDS
Expand Down

0 comments on commit bb2256f

Please sign in to comment.