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

include a summary in documentation and tools

Browse Source
This commit is contained in:
Frank Morgner
2013-06-16 09:58:07 +02:00
parent 7619b71b12
commit 59eaa16c45
25 changed files with 119 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
ccid/configure.ac
View File

@@ -113,6 +113,10 @@ AM_CONDITIONAL(WITH_PACE, test "${WITH_PACE}" = "yes")
AM_COND_IF(WITH_PACE, [AC_DEFINE(WITH_PACE, 1, [enable PACE support])]) AM_COND_IF(WITH_PACE, [AC_DEFINE(WITH_PACE, 1, [enable PACE support])])
PACKAGE_SUMMARY="Emulate a USB CCID compliant smart card reader"
AC_SUBST(PACKAGE_SUMMARY)
# Checks for header files. # Checks for header files.
AC_CHECK_HEADERS([arpa/inet.h fcntl.h memory.h stdint.h stdlib.h string.h sys/ioctl.h unistd.h]) AC_CHECK_HEADERS([arpa/inet.h fcntl.h memory.h stdint.h stdlib.h string.h sys/ioctl.h unistd.h])

1
ccid/doc/Makefile.am
View File

@@ -4,6 +4,7 @@ do_subst = $(SED) \
-e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \
-e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \
-e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \
-e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \
-e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \
-e 's,[@]RECOMMENDED_CONF_OPTS[@],,g' \ -e 's,[@]RECOMMENDED_CONF_OPTS[@],,g' \
-e 's,[@]builddir[@],$(builddir),g' \ -e 's,[@]builddir[@],$(builddir),g' \

16
ccid/doc/README.txt
View File

@@ -9,12 +9,16 @@
USB CCID Emulator USB CCID Emulator
################################################################################ ################################################################################
:Author: .. sidebar:: Summary
`Frank Morgner <morgner@informatik.hu-berlin.de>`_
:License: Emulate a USB CCID compliant smart card reader
GPL version 3
:Tested Platforms: :Author:
Linux (Debian, Ubuntu, OpenMoko) `Frank Morgner <morgner@informatik.hu-berlin.de>`_
:License:
GPL version 3
:Tested Platforms:
Linux (Debian, Ubuntu, OpenMoko)
The USB CCID Emulator forwards a locally present PC/SC smart card reader as a The USB CCID Emulator forwards a locally present PC/SC smart card reader as a
standard USB CCID reader. USB CCID Emulator can be used as trusted intermediary standard USB CCID reader. USB CCID Emulator can be used as trusted intermediary

16
ccid/doc/README.txt.in
View File

@@ -9,12 +9,16 @@
@PACKAGE_NAME@ @PACKAGE_NAME@
################################################################################ ################################################################################
:Author: .. sidebar:: Summary
`Frank Morgner <morgner@informatik.hu-berlin.de>`_
:License: @PACKAGE_SUMMARY@
GPL version 3
:Tested Platforms: :Author:
Linux (Debian, Ubuntu, OpenMoko) `Frank Morgner <morgner@informatik.hu-berlin.de>`_
:License:
GPL version 3
:Tested Platforms:
Linux (Debian, Ubuntu, OpenMoko)
The @PACKAGE_NAME@ forwards a locally present PC/SC smart card reader as a The @PACKAGE_NAME@ forwards a locally present PC/SC smart card reader as a
standard USB CCID reader. @PACKAGE_NAME@ can be used as trusted intermediary standard USB CCID reader. @PACKAGE_NAME@ can be used as trusted intermediary

1
ccid/src/Makefile.am
View File

@@ -4,6 +4,7 @@ do_subst = $(SED) \
-e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \
-e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \
-e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \
-e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \
-e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g'
BUILT_SOURCES = cmdline.h cmdline.c BUILT_SOURCES = cmdline.h cmdline.c

2
ccid/src/ccid-emulator.ggo.in
View File

@@ -1,4 +1,4 @@
purpose "Access the German electronic identity card (neuer Personalausweis, nPA)" purpose "@PACKAGE_SUMMARY@"
option "info" i option "info" i
"Print available readers and drivers." "Print available readers and drivers."

2
npa/configure.ac
View File

@@ -140,6 +140,8 @@ X509DIR="${x509dir}"
AC_SUBST(X509DIR) AC_SUBST(X509DIR)
PACKAGE_SUMMARY="Access the German electronic identity card (neuer Personalausweis/nPA)"
AC_SUBST(PACKAGE_SUMMARY)
# Checks for header files. # Checks for header files.

1
npa/doc/Makefile.am
View File

@@ -4,6 +4,7 @@ do_subst = $(SED) \
-e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \
-e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \
-e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \
-e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \
-e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \
-e 's,[@]RECOMMENDED_CONF_OPTS[@],,g' \ -e 's,[@]RECOMMENDED_CONF_OPTS[@],,g' \
-e 's,[@]builddir[@],$(builddir),g' \ -e 's,[@]builddir[@],$(builddir),g' \

20
npa/doc/README.txt
View File

@@ -13,15 +13,17 @@
nPA Smart Card Library nPA Smart Card Library
################################################################################ ################################################################################
:Author: .. sidebar:: Summary
`Frank Morgner <morgner@informatik.hu-berlin.de>`_
:License: Access the German electronic identity card (neuer Personalausweis/nPA)
GPL version 3
:Tested Platforms: :Author:
- Windows `Frank Morgner <morgner@informatik.hu-berlin.de>`_
- Linux (Debian, Ubuntu, OpenMoko) :License:
:Potential Platforms: GPL version 3
Unix-like operating systems (Mac OS, Solaris, BSD, ...) :Tested Platforms:
- Windows
- Linux (Debian, Ubuntu, OpenMoko)
The nPA Smart Card Library offers an easy to use API for the new German identity card The nPA Smart Card Library offers an easy to use API for the new German identity card
(neuer Personalausweis, nPA). The library also implements secure messaging, (neuer Personalausweis, nPA). The library also implements secure messaging,

20
npa/doc/README.txt.in
View File

@@ -13,15 +13,17 @@
@PACKAGE_NAME@ @PACKAGE_NAME@
################################################################################ ################################################################################
:Author: .. sidebar:: Summary
`Frank Morgner <morgner@informatik.hu-berlin.de>`_
:License: @PACKAGE_SUMMARY@
GPL version 3
:Tested Platforms: :Author:
- Windows `Frank Morgner <morgner@informatik.hu-berlin.de>`_
- Linux (Debian, Ubuntu, OpenMoko) :License:
:Potential Platforms: GPL version 3
Unix-like operating systems (Mac OS, Solaris, BSD, ...) :Tested Platforms:
- Windows
- Linux (Debian, Ubuntu, OpenMoko)
The @PACKAGE_NAME@ offers an easy to use API for the new German identity card The @PACKAGE_NAME@ offers an easy to use API for the new German identity card
(neuer Personalausweis, nPA). The library also implements secure messaging, (neuer Personalausweis, nPA). The library also implements secure messaging,

2
npa/doc/api.txt
View File

@@ -29,7 +29,7 @@ used to read identity attributes, for example.
.. note:: .. note::
Please consider the following overview to the API as incomplete. The Please consider the following overview to the API as incomplete. The
`Doxygen documentation <../_static/doxygen-npa/modules.html>`_ should be `Doxygen documentation <../_static/doxygen-npa/modules.html>`_ should be
used as programmer's. used as programmer's reference.
============================================================== ==============================================================

3
npa/src/Makefile.am
View File

@@ -5,7 +5,8 @@ do_subst = $(SED) \
-e 's,[@]PACKAGE_NAME[@],$(PACKAGE_NAME),g' \ -e 's,[@]PACKAGE_NAME[@],$(PACKAGE_NAME),g' \
-e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \
-e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \
-e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ -e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \
-e 's,[@]PACKAGE_VERSION[@],"$(PACKAGE_VERSION)",g' \
-e 's,[@]X509DIR[@],$(X509DIR),g' -e 's,[@]X509DIR[@],$(X509DIR),g'
BUILT_SOURCES = cmdline.h cmdline.c BUILT_SOURCES = cmdline.h cmdline.c

2
npa/src/npa-tool.ggo.in
View File

@@ -1,5 +1,5 @@
package "npa-tool" package "npa-tool"
purpose "Access the German electronic identity card (neuer Personalausweis, nPA)" purpose "@PACKAGE_SUMMARY@"
option "info" i option "info" i
"Print available readers and drivers." "Print available readers and drivers."

5
pcsc-relay/configure.ac
View File

@@ -78,6 +78,11 @@ AC_ARG_ENABLE(piccdev,
[piccdev="${enableval}"], [piccdev="/dev/ttyACM0"]) [piccdev="${enableval}"], [piccdev="/dev/ttyACM0"])
AC_DEFINE_UNQUOTED(PICCDEV, "${piccdev}", [OpenPICC character device]) AC_DEFINE_UNQUOTED(PICCDEV, "${piccdev}", [OpenPICC character device])
PACKAGE_SUMMARY="Relay a smart card to a contactless interface"
AC_SUBST(PACKAGE_SUMMARY)
# Checks for header files. # Checks for header files.
AC_CHECK_HEADERS([fcntl.h stdint.h stdlib.h string.h unistd.h termios.h]) AC_CHECK_HEADERS([fcntl.h stdint.h stdlib.h string.h unistd.h termios.h])

1
pcsc-relay/doc/Makefile.am
View File

@@ -4,6 +4,7 @@ do_subst = $(SED) \
-e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \
-e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \
-e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \
-e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \
-e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \
-e 's,[@]RECOMMENDED_CONF_OPTS[@],,g' \ -e 's,[@]RECOMMENDED_CONF_OPTS[@],,g' \
-e 's,[@]builddir[@],$(builddir),g' \ -e 's,[@]builddir[@],$(builddir),g' \

22
pcsc-relay/doc/README.txt
View File

@@ -6,16 +6,18 @@
PC/SC Relay PC/SC Relay
################################################################################ ################################################################################
:Authors: .. sidebar:: Summary
- `Frank Morgner <morgner@informatik.hu-berlin.de>`_
- `Dominik Oepen <oepen@informatik.hu-berlin.de>`_ Relay a smart card to a contactless interface
:License:
GPL version 3 :Authors:
:Tested Platforms: - `Frank Morgner <morgner@informatik.hu-berlin.de>`_
- Windows - `Dominik Oepen <oepen@informatik.hu-berlin.de>`_
- Linux (Debian, Ubuntu, OpenMoko) :License:
:Potential Platforms: GPL version 3
Unix-like operating systems (Mac OS, Solaris, BSD, ...) :Tested Platforms:
- Windows
- Linux (Debian, Ubuntu, OpenMoko)
Welcome to PC/SC Relay. The purpose of PC/SC Relay is to relay a smart Welcome to PC/SC Relay. The purpose of PC/SC Relay is to relay a smart
card using an contact-less interface. Currently the following contact-less card using an contact-less interface. Currently the following contact-less

22
pcsc-relay/doc/README.txt.in
View File

@@ -6,16 +6,18 @@
@PACKAGE_NAME@ @PACKAGE_NAME@
################################################################################ ################################################################################
:Authors: .. sidebar:: Summary
- `Frank Morgner <morgner@informatik.hu-berlin.de>`_
- `Dominik Oepen <oepen@informatik.hu-berlin.de>`_ @PACKAGE_SUMMARY@
:License:
GPL version 3 :Authors:
:Tested Platforms: - `Frank Morgner <morgner@informatik.hu-berlin.de>`_
- Windows - `Dominik Oepen <oepen@informatik.hu-berlin.de>`_
- Linux (Debian, Ubuntu, OpenMoko) :License:
:Potential Platforms: GPL version 3
Unix-like operating systems (Mac OS, Solaris, BSD, ...) :Tested Platforms:
- Windows
- Linux (Debian, Ubuntu, OpenMoko)
Welcome to @PACKAGE_NAME@. The purpose of @PACKAGE_NAME@ is to relay a smart Welcome to @PACKAGE_NAME@. The purpose of @PACKAGE_NAME@ is to relay a smart
card using an contact-less interface. Currently the following contact-less card using an contact-less interface. Currently the following contact-less

1
pcsc-relay/src/Makefile.am
View File

@@ -4,6 +4,7 @@ do_subst = $(SED) \
-e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \
-e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \
-e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \
-e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \
-e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g'
BUILT_SOURCES = cmdline.h cmdline.c BUILT_SOURCES = cmdline.h cmdline.c

2
pcsc-relay/src/pcsc-relay.ggo.in
View File

@@ -1,4 +1,4 @@
purpose "Emulate a contact-less smart card" purpose "@PACKAGE_SUMMARY@"
description "Using an contact-less interface (currently OpenPICC or libnfc) @PACKAGE@ receives command APDUs which are forwared to an existing smart card via PC/SC. @PACKAGE@ sends the response APDU back to the contact-less interface." description "Using an contact-less interface (currently OpenPICC or libnfc) @PACKAGE@ receives command APDUs which are forwared to an existing smart card via PC/SC. @PACKAGE@ sends the response APDU back to the contact-less interface."
option "emulator" e option "emulator" e

4
virtualsmartcard/configure.ac
View File

@@ -81,6 +81,10 @@ AC_ARG_ENABLE(confdir,
[confdir="${enableval}"], [confdir=/etc/reader.conf.d]) [confdir="${enableval}"], [confdir=/etc/reader.conf.d])
PACKAGE_SUMMARY="Smart card emulator written in Python"
AC_SUBST(PACKAGE_SUMMARY)
# Checks for header files. # Checks for header files.
AC_CHECK_HEADERS([arpa/inet.h stdint.h stdlib.h string.h sys/socket.h sys/time.h unistd.h]) AC_CHECK_HEADERS([arpa/inet.h stdint.h stdlib.h string.h sys/socket.h sys/time.h unistd.h])

1
virtualsmartcard/doc/Makefile.am
View File

@@ -5,6 +5,7 @@ do_subst = $(SED) \
-e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \
-e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \
-e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \
-e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \
-e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \
-e 's,[@]RECOMMENDED_CONF_OPTS[@], --sysconfdir=/etc,g' \ -e 's,[@]RECOMMENDED_CONF_OPTS[@], --sysconfdir=/etc,g' \
-e 's,[@]builddir[@],$(builddir),g' \ -e 's,[@]builddir[@],$(builddir),g' \

22
virtualsmartcard/doc/README.txt
View File

@@ -14,16 +14,18 @@
Virtual Smart Card Virtual Smart Card
################################################################################ ################################################################################
:Authors: .. sidebar:: Summary
- `Frank Morgner <morgner@informatik.hu-berlin.de>`_
- `Dominik Oepen <oepen@informatik.hu-berlin.de>`_ Smart card emulator written in Python
:License:
GPL version 3 :Authors:
:Tested Platforms: - `Frank Morgner <morgner@informatik.hu-berlin.de>`_
- Linux (Debian, Ubuntu, OpenMoko) - `Dominik Oepen <oepen@informatik.hu-berlin.de>`_
- Windows (|vpicc| natively, |vpcd| only via Cygwin) :License:
:Potential Platforms: GPL version 3
Unix-like operating systems (Mac OS, Solaris, BSD, ...) :Tested Platforms:
- Linux (Debian, Ubuntu, OpenMoko)
- Windows (|vpicc| natively, |vpcd| only via Cygwin)
Virtual Smart Card emulates a smart card and makes it accessible through PC/SC. Virtual Smart Card emulates a smart card and makes it accessible through PC/SC.
Currently the Virtual Smart Card supports the following types of smart cards: Currently the Virtual Smart Card supports the following types of smart cards:

22
virtualsmartcard/doc/README.txt.in
View File

@@ -14,16 +14,18 @@
@PACKAGE_NAME@ @PACKAGE_NAME@
################################################################################ ################################################################################
:Authors: .. sidebar:: Summary
- `Frank Morgner <morgner@informatik.hu-berlin.de>`_
- `Dominik Oepen <oepen@informatik.hu-berlin.de>`_ @PACKAGE_SUMMARY@
:License:
GPL version 3 :Authors:
:Tested Platforms: - `Frank Morgner <morgner@informatik.hu-berlin.de>`_
- Linux (Debian, Ubuntu, OpenMoko) - `Dominik Oepen <oepen@informatik.hu-berlin.de>`_
- Windows (|vpicc| natively, |vpcd| only via Cygwin) :License:
:Potential Platforms: GPL version 3
Unix-like operating systems (Mac OS, Solaris, BSD, ...) :Tested Platforms:
- Linux (Debian, Ubuntu, OpenMoko)
- Windows (|vpicc| natively, |vpcd| only via Cygwin)
@PACKAGE_NAME@ emulates a smart card and makes it accessible through PC/SC. @PACKAGE_NAME@ emulates a smart card and makes it accessible through PC/SC.
Currently the @PACKAGE_NAME@ supports the following types of smart cards: Currently the @PACKAGE_NAME@ supports the following types of smart cards:

1
virtualsmartcard/src/vpicc/Makefile.am
View File

@@ -29,6 +29,7 @@ do_subst = $(SED) \
-e 's,[@]PYTHON[@],$(PYTHON),g' \ -e 's,[@]PYTHON[@],$(PYTHON),g' \
-e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \
-e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \
-e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \
-e 's,[@]PACKAGE_NAME[@],$(PACKAGE_NAME),g' -e 's,[@]PACKAGE_NAME[@],$(PACKAGE_NAME),g'
$(builddir)/vicc: vicc.in Makefile $(builddir)/vicc: vicc.in Makefile

2
virtualsmartcard/src/vpicc/vicc.in
View File

@@ -24,7 +24,7 @@ import argparse
parser = argparse.ArgumentParser( parser = argparse.ArgumentParser(
description=''' description='''
The @PACKAGE_NAME@ emulates different types of smart cards. @PACKAGE_SUMMARY@
The emulator connects to the virtual smart card reader reader (vpcd). Smart The emulator connects to the virtual smart card reader reader (vpcd). Smart
card applications can access the @PACKAGE_NAME@ through the vpcd via PC/SC. card applications can access the @PACKAGE_NAME@ through the vpcd via PC/SC.