diff --git a/doc/src/api/api.css b/doc/src/api/api.css index 6bd8d383..f0ea3b36 100644 --- a/doc/src/api/api.css +++ b/doc/src/api/api.css @@ -41,4 +41,3 @@ span.errorname { span.errortext { font-style: italic; } - diff --git a/doc/src/api/api.xml b/doc/src/api/api.xml index f62a1dbc..eda671d8 100644 --- a/doc/src/api/api.xml +++ b/doc/src/api/api.xml @@ -1,4 +1,5 @@ + + + + sc_app_info_t + 3 + opensc + + + + sc_app_info_t + OpenSC application structure + + + + Synopsis + + +#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; + + + + + + Description + + This structure describes a smartcard application. It contains the following + members: + + + + aid + 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. + + + + + aid_len + The length of the AID in bytes. + + + + label + A UTF-8 string describing the application. + + + + path + The application's full path on the card, starting at the MF. + + + + ddo + + + + + ddo_len + + + + + desc + A description of the application, if available. + + + + rec_nr + If the EF(DIR) file is record-structured, this has the + record number in which this application is stored. Otherwise, this is -1. + + + + + + + + diff --git a/doc/src/api/types/sc_asn1_entry.xml b/doc/src/api/types/sc_asn1_entry.xml new file mode 100644 index 00000000..0c9c1a42 --- /dev/null +++ b/doc/src/api/types/sc_asn1_entry.xml @@ -0,0 +1,69 @@ + + + + sc_asn1_entry + 3 + opensc + + + + sc_asn1_entry + OpenSC ASN1 entry structure + + + + Synopsis + + +struct sc_asn1_entry { + const char *name; + unsigned int type; + unsigned int tag; + unsigned int flags; + void *parm; + void *arg; +}; + + + + + + Description + + This structure describes an ASN1 entry structure. It contains the following + members: + + + name + + + + + type + + + + + tag + + + + + flags + + + + + parm + + + + + arg + + + + + + + diff --git a/doc/src/api/util/sc_strerror.xml b/doc/src/api/util/sc_strerror.xml new file mode 100644 index 00000000..47f7b026 --- /dev/null +++ b/doc/src/api/util/sc_strerror.xml @@ -0,0 +1,31 @@ + + + sc_strerror + 3 + opensc + + + + sc_strerror + Return string describing error code + + + + Synopsis + + +#include <opensc.h> + +const char *sc_strerror(int error); + + + + + + Description + + This function returns a string describing error. It may + be used with a negative errorcode returned by any OpenSC function call. + + +