<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>OpenCT: openct.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_c35229a911af2f480aef06e8035e7826.html">openct</a>
</div>
</div>
<div class="contents">
<h1>openct.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Main OpenCT include file</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2003, Olaf Kirch <okir@suse.de></span>
<a name="l00005"></a>00005 <span class="comment"> */</span>
<a name="l00006"></a>00006
<a name="l00007"></a>00007 <span class="preprocessor">#ifndef OPENCT_OPENCT_H</span>
<a name="l00008"></a>00008 <span class="preprocessor"></span><span class="preprocessor">#define OPENCT_OPENCT_H</span>
<a name="l00009"></a>00009 <span class="preprocessor"></span>
<a name="l00010"></a>00010 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00012"></a>00012 <span class="preprocessor">#endif</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span>
<a name="l00014"></a>00014 <span class="preprocessor">#include <sys/types.h></span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="comment">/* Various implementation limits */</span>
<a name="l00017"></a>00017 <span class="preprocessor">#define OPENCT_MAX_READERS 16</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define OPENCT_MAX_SLOTS 8</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a><a class="code" href="structct__info.html">00020</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structct__info.html">ct_info</a> {
<a name="l00021"></a>00021 <span class="keywordtype">char</span> ct_name[64];
<a name="l00022"></a>00022 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ct_slots;
<a name="l00023"></a>00023 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ct_card[OPENCT_MAX_SLOTS];
<a name="l00024"></a>00024 <span class="keywordtype">unsigned</span> ct_display : 1,
<a name="l00025"></a>00025 ct_keypad : 1;
<a name="l00026"></a>00026 pid_t ct_pid;
<a name="l00027"></a>00027 } <a class="code" href="structct__info.html">ct_info_t</a>;
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">typedef</span> <span class="keyword">struct </span>ct_handle ct_handle;
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#define IFD_CARD_PRESENT 0x0001</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define IFD_CARD_STATUS_CHANGED 0x0002</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00034"></a>00034 <span class="comment">/* Lock types</span>
<a name="l00035"></a>00035 <span class="comment"> * - shared locks allow concurrent access from</span>
<a name="l00036"></a>00036 <span class="comment"> * other applications run by the same user.</span>
<a name="l00037"></a>00037 <span class="comment"> * Used e.g. by pkcs11 login.</span>
<a name="l00038"></a>00038 <span class="comment"> * - exclusive locks deny any access by other</span>
<a name="l00039"></a>00039 <span class="comment"> * applications.</span>
<a name="l00040"></a>00040 <span class="comment"> *</span>
<a name="l00041"></a>00041 <span class="comment"> * When a lock is granted, a lock handle is passed</span>
<a name="l00042"></a>00042 <span class="comment"> * to the client, which it must present in the</span>
<a name="l00043"></a>00043 <span class="comment"> * subsequent unlock call.</span>
<a name="l00044"></a>00044 <span class="comment"> */</span>
<a name="l00045"></a>00045 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ct_lock_handle;
<a name="l00046"></a>00046 <span class="keyword">enum</span> {
<a name="l00047"></a>00047 IFD_LOCK_SHARED,
<a name="l00048"></a>00048 IFD_LOCK_EXCLUSIVE
<a name="l00049"></a>00049 };
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">/*</span>
<a name="l00052"></a>00052 <span class="comment"> * PIN encoding types</span>
<a name="l00053"></a>00053 <span class="comment"> */</span>
<a name="l00054"></a>00054 <span class="keyword">enum</span> {
<a name="l00055"></a>00055 IFD_PIN_ENCODING_BCD,
<a name="l00056"></a>00056 IFD_PIN_ENCODING_ASCII
<a name="l00057"></a>00057 };
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_status(<span class="keyword">const</span> <a class="code" href="structct__info.html">ct_info_t</a> **);
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_reader_info(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>, <a class="code" href="structct__info.html">ct_info_t</a> *);
<a name="l00062"></a>00062 <span class="keyword">extern</span> ct_handle * ct_reader_connect(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>);
<a name="l00063"></a>00063 <span class="keyword">extern</span> <span class="keywordtype">void</span> ct_reader_disconnect(ct_handle *);
<a name="l00064"></a>00064 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_reader_status(ct_handle *, <a class="code" href="structct__info.html">ct_info_t</a> *);
<a name="l00065"></a>00065 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_card_status(ct_handle *h, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot, <span class="keywordtype">int</span> *status);
<a name="l00066"></a>00066 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_card_set_protocol(ct_handle *h, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00067"></a>00067 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> protocol);
<a name="l00068"></a>00068 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_card_reset(ct_handle *h, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00069"></a>00069 <span class="keywordtype">void</span> *atr, <span class="keywordtype">size_t</span> atr_len);
<a name="l00070"></a>00070 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_card_request(ct_handle *h, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00071"></a>00071 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeout, <span class="keyword">const</span> <span class="keywordtype">char</span> *message,
<a name="l00072"></a>00072 <span class="keywordtype">void</span> *atr, <span class="keywordtype">size_t</span> atr_len);
<a name="l00073"></a>00073 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_card_lock(ct_handle *h, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00074"></a>00074 <span class="keywordtype">int</span> type, ct_lock_handle *);
<a name="l00075"></a>00075 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_card_unlock(ct_handle *h, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00076"></a>00076 ct_lock_handle);
<a name="l00077"></a>00077 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_card_transact(ct_handle *h, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00078"></a>00078 <span class="keyword">const</span> <span class="keywordtype">void</span> *apdu, <span class="keywordtype">size_t</span> apdu_len,
<a name="l00079"></a>00079 <span class="keywordtype">void</span> *recv_buf, <span class="keywordtype">size_t</span> recv_len);
<a name="l00080"></a>00080 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_card_verify(ct_handle *h, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00081"></a>00081 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeout, <span class="keyword">const</span> <span class="keywordtype">char</span> *prompt,
<a name="l00082"></a>00082 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pin_encoding,
<a name="l00083"></a>00083 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pin_length,
<a name="l00084"></a>00084 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pin_offset,
<a name="l00085"></a>00085 <span class="keyword">const</span> <span class="keywordtype">void</span> *send_buf, <span class="keywordtype">size_t</span> send_len,
<a name="l00086"></a>00086 <span class="keywordtype">void</span> *recv_buf, <span class="keywordtype">size_t</span> recv_len);
<a name="l00087"></a>00087 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_card_read_memory(ct_handle *, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00088"></a>00088 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> address,
<a name="l00089"></a>00089 <span class="keywordtype">void</span> *recv_buf, <span class="keywordtype">size_t</span> recv_len);
<a name="l00090"></a>00090 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_card_write_memory(ct_handle *, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00091"></a>00091 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> address,
<a name="l00092"></a>00092 <span class="keyword">const</span> <span class="keywordtype">void</span> *send_buf, <span class="keywordtype">size_t</span> send_len);
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_status_destroy(<span class="keywordtype">void</span>);
<a name="l00095"></a>00095 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_status_clear(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *);
<a name="l00096"></a>00096 <span class="keyword">extern</span> <a class="code" href="structct__info.html">ct_info_t</a> * ct_status_alloc_slot(<span class="keywordtype">int</span> *);
<a name="l00097"></a>00097 <span class="keyword">extern</span> <span class="keywordtype">int</span> ct_status_update(<a class="code" href="structct__info.html">ct_info_t</a> *);
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span>}
<a name="l00101"></a>00101 <span class="preprocessor">#endif</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span>
<a name="l00103"></a>00103 <span class="preprocessor">#endif </span><span class="comment">/* OPENCT_OPENCT_H */</span>
</pre></div></div>
<hr>
<table width="100%"><tr><td>libp11, Copyright (C) 2005 Olaf Kirch <okir@lst.de></td><td align="right"><a href="http://www.opensc-project.org"><img src="opensc-logo.gif" alt="OpenSC-Project.org Logo" border="0"/></a></td></tr></table>
