opensc/doc/api/types/sc_app_info_t.xml

98 lines
2.8 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scappinfot">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<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>
#include &lt;opensc.h&gt;
#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 smart card 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>