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

generate the correct links to class documentation

Browse Source 
git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@655 96b47cad-a561-4643-ad3b-153ac7d7599c
This commit is contained in:
frankmorgner
2011-12-08 23:15:11 +00:00
parent dedb627e82
commit 348bc34ed6
1 changed files with 17 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
virtualsmartcard/doc/api.rst
View File

@@ -42,13 +42,16 @@ ISO 7816. But as for most complex software you need to know where you need to
hook into. Here we only want to give an overview to the design, the complete hook into. Here we only want to give an overview to the design, the complete
details can be found in section `Documentation to Virtual Smart Card`_ details can be found in section `Documentation to Virtual Smart Card`_
Back to the cryptoflex example. :class:`VirtualICC` provides the connection to Back to the cryptoflex example.
the virtual smart card reader. It fetches an |APDU| and other requests from the :class:`virtualsmartcard.VirtualSmartcard.VirtualICC` provides the connection
|vpcd|. In :class:`VirtualICC` an |APDU| is only a buffer that is forwarded to to the virtual smart card reader. It fetches an |APDU| and other requests from
the smart card OS. First we modify :class:`VirtualICC` to recognize a new type the |vpcd|. In :class:`virtualsmartcard.VirtualSmartcard.VirtualICC` an |APDU|
``"cryptoflex"`` and to load :class:`CryptoflexOS`. The :class:`CardGenerator` is only a buffer that is forwarded to the smart card OS. First we modify
is used to create a file system and a |SAM| specific to the cryptoflex (we come :class:`virtualsmartcard.VirtualSmartcard.VirtualICC` to recognize a new type
back to this later). ``"cryptoflex"`` and to load
:class:`virtualsmartcard.VirtualSmartcard.CryptoflexOS`. The
:class:`virtualsmartcard.CardGenerator` is used to create a file system and a
|SAM| specific to the cryptoflex (we come back to this later).
.. literalinclude:: virtualsmartcard/VirtualSmartcard.py .. literalinclude:: virtualsmartcard/VirtualSmartcard.py
:pyobject: VirtualICC.__init__ :pyobject: VirtualICC.__init__
@@ -56,22 +59,25 @@ back to this later).
Responses from our cryptoflex card look the same as for the 7816 card. But when Responses from our cryptoflex card look the same as for the 7816 card. But when
a command was successfull (or not) there is a little difference in what is a command was successfull (or not) there is a little difference in what is
returned. So we need to edit :class:`CryptoflexOS.formatResult`, which is returned. So we need to edit
:class:`virtualsmartcard.VirtualSmartcard.CryptoflexOS.formatResult`, which is
called to encode the |SWs| and the resulting data. called to encode the |SWs| and the resulting data.
.. literalinclude:: virtualsmartcard/VirtualSmartcard.py .. literalinclude:: virtualsmartcard/VirtualSmartcard.py
:pyobject: CryptoflexOS.formatResult :pyobject: CryptoflexOS.formatResult
Note that this also requires some insight knowledge about how Note that this also requires some insight knowledge about how
:class:`Iso7816OS` works (see `below <Documentation to Virtual Smart Card>`_). :class:`virtualsmartcard.Iso7816OS` works (see `below <Documentation to Virtual
Smart Card>`_).
The previously created |SAM| handles keys, encryption, secure messaging and so The previously created |SAM| handles keys, encryption, secure messaging and so
on (we will not go into more details here). The file system creates, selects on (we will not go into more details here). The file system creates, selects
and reads contents of files or directories. File handling for our cryptoflex and reads contents of files or directories. File handling for our cryptoflex
card is similar to ISO 7816, but the meaning of P1, P2 and the |APDU| data is card is similar to ISO 7816, but the meaning of P1, P2 and the |APDU| data is
completely different when creating a file on the smart card. So we derive completely different when creating a file on the smart card. So we derive
:class:`CryptoflexMF` from :class:`MF` and modify :class:`CryptoflexMF.create` :class:`virtualsmartcard.cards.cryptoflex.CryptoflexMF` from
to our needs. :class:`virtualsmartcard.SmartcardFilesystem.MF` and modify
:class:`virtualsmartcard.cards.cryptoflex.CryptoflexMF.create` to our needs.
.. literalinclude:: virtualsmartcard/cards/cryptoflex.py .. literalinclude:: virtualsmartcard/cards/cryptoflex.py
:pyobject: CryptoflexMF.create :pyobject: CryptoflexMF.create