giomba
/
opensc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added sc_app_info_t, sc_asn1_entry and sc_strerror() 

git-svn-id: https://www.opensc-project.org/svnp/opensc/trunk@2204 c6295689-39f2-0310-b995-f0e70906c6a9
This commit is contained in:
bert 2005-02-25 23:57:53 +00:00
parent d8eff12521
commit 5a12e5f920
5 changed files with 195 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/src/api/api.css
View File

@ -41,4 +41,3 @@ span.errorname {
span.errortext {
font-style: italic;
}

1
doc/src/api/api.xml
View File

@ -1,4 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet href="api.xsl" type="text/xsl"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

94
doc/src/api/types/sc_app_info_t.xml Normal file
View File

@ -0,0 +1,94 @@
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scappinfot">
<refmeta>
<refentrytitle>sc_app_info_t</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_app_info_t</refname>
<refpurpose>OpenSC application structure</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
#define SC_MAX_AID_SIZE 16
typedef struct sc_app_info {
unsigned char aid[SC_MAX_AID_SIZE];
size_t aid_len;
char *label;
sc_path_t path;
unsigned char *ddo;
size_t ddo_len;
const char *desc;
int rec_nr;
} sc_app_info_t;
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This structure describes a smartcard application. It contains the following
members:
<variablelist>
<varlistentry>
<term><structfield>aid</structfield></term>
<listitem><para>The applications's AID. An AID uniquely identifies an
application, and consists of an RID (a 5-byte "Registered Application
Provider Identifier") and a PIX, which identifies an application by that
provider. For example, the RID for PKCS#15 consists of the bytes A0 00 00
00 63, and the PIX is the string "PKCS-15". Thus, the AID of a PKCS#15
application on a smart card is A0 00 00 00 63 50 4B 43 53 2D 31.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><structfield>aid_len</structfield></term>
<listitem><para>The length of the AID in bytes.</para></listitem>
</varlistentry>
<varlistentry>
<term><structfield>label</structfield></term>
<listitem><para>A UTF-8 string describing the application.</para></listitem>
</varlistentry>
<varlistentry>
<term><structfield>path</structfield></term>
<listitem><para>The application's full path on the card, starting at the MF.</para></listitem>
</varlistentry>
<varlistentry>
<term><structfield>ddo</structfield></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><structfield>ddo_len</structfield></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><structfield>desc</structfield></term>
<listitem><para>A description of the application, if available.</para></listitem>
</varlistentry>
<varlistentry>
<term><structfield>rec_nr</structfield></term>
<listitem><para>If the EF(DIR) file is record-structured, this has the
record number in which this application is stored. Otherwise, this is -1.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>

69
doc/src/api/types/sc_asn1_entry.xml Normal file
View File

@ -0,0 +1,69 @@
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scasn1entry">
<refmeta>
<refentrytitle>sc_asn1_entry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_asn1_entry</refname>
<refpurpose>OpenSC ASN1 entry structure</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
struct sc_asn1_entry {
const char *name;
unsigned int type;
unsigned int tag;
unsigned int flags;
void *parm;
void *arg;
};
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This structure describes an ASN1 entry structure. It contains the following
members:
<variablelist>
<varlistentry>
<term><structfield>name</structfield></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><structfield>type</structfield></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><structfield>tag</structfield></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><structfield>flags</structfield></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><structfield>parm</structfield></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><structfield>arg</structfield></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>

31
doc/src/api/util/sc_strerror.xml Normal file
View File

@ -0,0 +1,31 @@
<refentry id="scstrerror">
<refmeta>
<refentrytitle>sc_strerror</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_strerror</refname>
<refpurpose>Return string describing error code</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
#include &lt;opensc.h&gt;
const char *sc_strerror(int error);
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This function returns a string describing <emphasis>error</emphasis>. It may
be used with a negative errorcode returned by any OpenSC function call.
</para>
</refsect1>
</refentry>