VivoKey/vsmartcard
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

updated documentation

Browse Source 
git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@422 96b47cad-a561-4643-ad3b-153ac7d7599c
This commit is contained in:
frankmorgner
2011-05-20 08:55:03 +00:00
parent 6fdd7bf560
commit 7e7f6ed570
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
npa/README.dox
View File

@@ -4,7 +4,7 @@ Welcome to npa. The purpose of npa is to offer an easy to use API for the new
German identity card (neuer Personalausweis, nPA). The library also implements German identity card (neuer Personalausweis, nPA). The library also implements
secure messaging, which could also be used for other cards. secure messaging, which could also be used for other cards.
npa is implemented using OpenPACE (http://sourceforge.net/projects/openpace/). npa is implemented using OpenPACE 0.6 (http://sourceforge.net/projects/openpace/).
Some fragments of the source code are on the source code of the OpenSC tools. Some fragments of the source code are on the source code of the OpenSC tools.
The included npa-tool has support for Password Authenticated Connection The included npa-tool has support for Password Authenticated Connection
@@ -23,17 +23,21 @@ libnpa links against libopensc, which is discouraged and hindered since
opensc>=0.12. We really need to get rid of this dependency. You need the opensc opensc>=0.12. We really need to get rid of this dependency. You need the opensc
components to be installed (especially libopensc.so). But you might need to components to be installed (especially libopensc.so). But you might need to
adjust the opensc library flags: adjust the opensc library flags:
@code
./configure \ ./configure \
OPENSC_LIBS="-L/path/to/opensc/libdir -lopensc" OPENSC_LIBS="-L/path/to/opensc/libdir -lopensc"
@endcode
@subsection o HINTS ON OPENSSL @subsection o HINTS ON OPENSSL
If you have a local build of OpenSSL with OpenPACE, that you want to link If you have a local build of OpenSSL with OpenPACE, that you want to link
against use something like the following command: against use something like the following command:
@code
./configure \ ./configure \
OPENSSL_CFLAGS="-I/path/to/openssl-1.0.0c_with_openpace-0.4/include" \ OPENSSL_CFLAGS="-I/path/to/openssl-1.0.0d_with_openpace-0.6/include" \
OPENSSL_LIBS="-L/path/to/openssl-1.0.0c_with_openpace-0.4 -lcrypto" OPENSSL_LIBS="-L/path/to/openssl-1.0.0d_with_openpace-0.6 -lcrypto"
@endcode
@section u USAGE @section u USAGE
@@ -51,15 +55,19 @@ npa-tool will show a password prompt.
If you have a local build of libnpa and OpenPACE, the preferred way to adjust If you have a local build of libnpa and OpenPACE, the preferred way to adjust
libraries and cflags for foreign code is to use pkg-config: libraries and cflags for foreign code is to use pkg-config:
@code
./configure \ ./configure \
PKG_CONFIG_PATH=/path/to/openssl-1.0.0c_with_openpace-0.4/lib/pkgconfig:/path/to/libnpa/lib/pkgconfig" PKG_CONFIG_PATH=/path/to/openssl-1.0.0d_with_openpace-0.6/lib/pkgconfig:/path/to/libnpa/lib/pkgconfig"
@endcode
Alternatively you can define libs and cflags by hand: Alternatively you can define libs and cflags by hand:
@code
./configure \ ./configure \
OPENSSL_CFLAGS="-I/path/to/openssl-1.0.0c_with_openpace-0.4/include" \ OPENSSL_CFLAGS="-I/path/to/openssl-1.0.0d_with_openpace-0.6/include" \
LIBNPA_CFLAGS="-I/path/to/openssl-1.0.0c_with_openpace-0.4/include -I/path/to/libnpa-0.1/src" \ LIBNPA_CFLAGS="-I/path/to/openssl-1.0.0d_with_openpace-0.6/include -I/path/to/libnpa-0.1/src" \
OPENSSL_LIBS="-L/path/to/openssl-1.0.0c_with_openpace-0.4 -lcrypto" \ OPENSSL_LIBS="-L/path/to/openssl-1.0.0d_with_openpace-0.6 -lcrypto" \
LIBNPA_LIBS="-L/path/to/openssl-1.0.0c_with_openpace-0.4 -lcrypto -L/path/to/libnpa-0.1/src/.libs -lnpa" LIBNPA_LIBS="-L/path/to/openssl-1.0.0d_with_openpace-0.6 -lcrypto -L/path/to/libnpa-0.1/src/.libs -lnpa"
@endcode
@section q QUESTIONS @section q QUESTIONS