diff --git a/npa/doc/Makefile.am b/npa/doc/Makefile.am index 60a2bd7..cab92b0 100644 --- a/npa/doc/Makefile.am +++ b/npa/doc/Makefile.am @@ -18,6 +18,8 @@ do_subst = $(SED) \ EXTRA_DIST = README.rst.in README.rst Doxyfile.in example.c autotools.rst autotools.rst.in questions.rst questions.rst.in +DOXYGEN = doxygen + doc: $(top_srcdir)/src/npa/*.h *.in $(do_subst) < Doxyfile.in > Doxyfile $(DOXYGEN) Doxyfile diff --git a/npa/doc/README.rst.in b/npa/doc/README.rst.in index 64e480c..76eae86 100644 --- a/npa/doc/README.rst.in +++ b/npa/doc/README.rst.in @@ -30,8 +30,10 @@ The @PACKAGE_NAME@ offers an easy to use API for the new German identity card which could also be used for other cards. The included |npa-tool| can be used for PIN management or to send APDUs inside a secure channel. -The @PACKAGE_NAME@ is implemented using OpenPACE_. Some fragments of the -source code are based on the source code of the OpenSC_ tools. +The @PACKAGE_NAME@ is implemented using OpenPACE_ and OpenSC_. @PACKAGE_NAME@ +implements and initializes Secure Messaging wrappers of OpenSC to allow a +transparent SM usage in OpenSC. This allows @PACKAGE_NAME@ to be fully +compatible with OpenSC. .. _npa-install: diff --git a/npa/doc/api.rst b/npa/doc/api.rst index 070ee9b..d61c909 100644 --- a/npa/doc/api.rst +++ b/npa/doc/api.rst @@ -26,9 +26,9 @@ Please consider the following overview to the API as incomplete. The `Doxygen documentation <../_static/doxygen-npa/modules.html>`_ should be used as programmer's reference since it is more detailed. -===================== -Secure Messaging (SM) -===================== +====================================== +Generic ISO 7816 Secure Messaging (SM) +====================================== The complete documentation can be found `here <../_static/doxygen-npa/group__sm.html>`__. @@ -36,13 +36,15 @@ The complete documentation can be found `here ----- Types ----- -.. doxygenstruct:: sm_ctx +.. doxygenstruct:: iso_sm_ctx --------- Functions --------- -.. doxygenfunction:: sm_transmit_apdu -.. doxygenfunction:: sm_ctx_clear_free +.. doxygenfunction:: iso_sm_ctx_create +.. doxygenfunction:: iso_sm_ctx_clear_free +.. doxygenfunction:: iso_sm_start +.. doxygenfunction:: sm_stop ============================================================== Interface to German identity card (neuer Personalausweis, nPA) @@ -54,7 +56,9 @@ The complete documentation can be found `here --------- Functions --------- -.. doxygenfunction:: EstablishPACEChannel +.. doxygenfunction:: perform_pace +.. doxygenfunction:: perform_terminal_authentication +.. doxygenfunction:: perform_chip_authentication .. doxygenfunction:: npa_reset_retry_counter -------