<!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/html;charset=UTF-8"/>
<title>pkcs11-helper: pkcs11-helper-1.0/pkcs11h-token.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.0 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<h1>pkcs11-helper-1.0/pkcs11h-token.h</h1><a href="pkcs11h-token_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2005-2008 Alon Bar-Lev <alon.barlev@gmail.com></span>
<a name="l00003"></a>00003 <span class="comment"> * All rights reserved.</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * This software is available to you under a choice of one of two</span>
<a name="l00006"></a>00006 <span class="comment"> * licenses. You may choose to be licensed under the terms of the GNU</span>
<a name="l00007"></a>00007 <span class="comment"> * General Public License (GPL) Version 2, or the BSD license.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * GNU General Public License (GPL) Version 2</span>
<a name="l00010"></a>00010 <span class="comment"> * ===========================================</span>
<a name="l00011"></a>00011 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00012"></a>00012 <span class="comment"> * it under the terms of the GNU General Public License version 2</span>
<a name="l00013"></a>00013 <span class="comment"> * as published by the Free Software Foundation.</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00016"></a>00016 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00017"></a>00017 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00018"></a>00018 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00021"></a>00021 <span class="comment"> * along with this program (see the file COPYING.GPL included with this</span>
<a name="l00022"></a>00022 <span class="comment"> * distribution); if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00023"></a>00023 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span>
<a name="l00024"></a>00024 <span class="comment"> *</span>
<a name="l00025"></a>00025 <span class="comment"> * BSD License</span>
<a name="l00026"></a>00026 <span class="comment"> * ============</span>
<a name="l00027"></a>00027 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span>
<a name="l00028"></a>00028 <span class="comment"> * modification, are permitted provided that the following conditions are met:</span>
<a name="l00029"></a>00029 <span class="comment"> *</span>
<a name="l00030"></a>00030 <span class="comment"> * o Redistributions of source code must retain the above copyright notice,</span>
<a name="l00031"></a>00031 <span class="comment"> * this list of conditions and the following disclaimer.</span>
<a name="l00032"></a>00032 <span class="comment"> * o Redistributions in binary form must reproduce the above copyright</span>
<a name="l00033"></a>00033 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span>
<a name="l00034"></a>00034 <span class="comment"> * documentation and/or other materials provided with the distribution.</span>
<a name="l00035"></a>00035 <span class="comment"> * o Neither the name of the <ORGANIZATION> nor the names of its</span>
<a name="l00036"></a>00036 <span class="comment"> * contributors may be used to endorse or promote products derived from</span>
<a name="l00037"></a>00037 <span class="comment"> * this software without specific prior written permission.</span>
<a name="l00038"></a>00038 <span class="comment"> *</span>
<a name="l00039"></a>00039 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span>
<a name="l00040"></a>00040 <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
<a name="l00041"></a>00041 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span>
<a name="l00042"></a>00042 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span>
<a name="l00043"></a>00043 <span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span>
<a name="l00044"></a>00044 <span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span>
<a name="l00045"></a>00045 <span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span>
<a name="l00046"></a>00046 <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span>
<a name="l00047"></a>00047 <span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span>
<a name="l00048"></a>00048 <span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span>
<a name="l00049"></a>00049 <span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00050"></a>00050 <span class="comment"> */</span>
<a name="l00051"></a>00051
<a name="l00067"></a>00067 <span class="preprocessor">#ifndef __PKCS11H_TOKEN_H</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span><span class="preprocessor">#define __PKCS11H_TOKEN_H</span>
<a name="l00069"></a>00069 <span class="preprocessor"></span>
<a name="l00070"></a>00070 <span class="preprocessor">#include <<a class="code" href="pkcs11h-core_8h.html" title="pkcs11-helper core.">pkcs11-helper-1.0/pkcs11h-core.h</a>></span>
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="preprocessor">#if defined(__cplusplus)</span>
<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00074"></a>00074 <span class="preprocessor">#endif</span>
<a name="l00075"></a>00075 <span class="preprocessor"></span>
<a name="l00076"></a>00076 <span class="keyword">struct </span><a class="code" href="structpkcs11h__token__id__list__s.html" title="Token identifier list.">pkcs11h_token_id_list_s</a>;
<a name="l00077"></a>00077
<a name="l00081"></a><a class="code" href="group__pkcs11h__token.html#gae301779fc460751b16a9769ca6cbee6a">00081</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structpkcs11h__token__id__list__s.html" title="Token identifier list.">pkcs11h_token_id_list_s</a> *<a class="code" href="structpkcs11h__token__id__list__s.html" title="Token identifier list.">pkcs11h_token_id_list_t</a>;
<a name="l00082"></a>00082
<a name="l00086"></a><a class="code" href="structpkcs11h__token__id__list__s.html">00086</a> <span class="keyword">struct </span><a class="code" href="structpkcs11h__token__id__list__s.html" title="Token identifier list.">pkcs11h_token_id_list_s</a> {
<a name="l00088"></a><a class="code" href="structpkcs11h__token__id__list__s.html#a58b26367c355a46c29492d8e7a38a2e0">00088</a> pkcs11h_token_id_list_t <a class="code" href="structpkcs11h__token__id__list__s.html#a58b26367c355a46c29492d8e7a38a2e0">next</a>;
<a name="l00090"></a><a class="code" href="structpkcs11h__token__id__list__s.html#a3ca8a93dad5a382dc1092d89aa826c64">00090</a> <a class="code" href="structpkcs11h__token__id__s.html" title="Token identifier.">pkcs11h_token_id_t</a> <a class="code" href="structpkcs11h__token__id__list__s.html#a3ca8a93dad5a382dc1092d89aa826c64">token_id</a>;
<a name="l00091"></a>00091 };
<a name="l00092"></a>00092
<a name="l00098"></a>00098 CK_RV
<a name="l00099"></a>00099 <a class="code" href="group__pkcs11h__token.html#gaf71b0160fbc09cb3f211ef56c54ec6a9" title="Free token_id object.">pkcs11h_token_freeTokenId</a> (
<a name="l00100"></a>00100 IN <a class="code" href="structpkcs11h__token__id__s.html" title="Token identifier.">pkcs11h_token_id_t</a> token_id
<a name="l00101"></a>00101 );
<a name="l00102"></a>00102
<a name="l00110"></a>00110 CK_RV
<a name="l00111"></a>00111 <a class="code" href="group__pkcs11h__token.html#ga1cc035ba9702da2333a391d60962ba8d" title="Duplicate token_id object.">pkcs11h_token_duplicateTokenId</a> (
<a name="l00112"></a>00112 OUT <a class="code" href="structpkcs11h__token__id__s.html" title="Token identifier.">pkcs11h_token_id_t</a> * <span class="keyword">const</span> to,
<a name="l00113"></a>00113 IN <span class="keyword">const</span> <a class="code" href="structpkcs11h__token__id__s.html" title="Token identifier.">pkcs11h_token_id_t</a> from
<a name="l00114"></a>00114 );
<a name="l00115"></a>00115
<a name="l00122"></a>00122 PKCS11H_BOOL
<a name="l00123"></a>00123 <a class="code" href="group__pkcs11h__token.html#ga2c9b4af25af431496856d18065c93bf0" title="Returns TRUE if same token id.">pkcs11h_token_sameTokenId</a> (
<a name="l00124"></a>00124 IN <span class="keyword">const</span> <a class="code" href="structpkcs11h__token__id__s.html" title="Token identifier.">pkcs11h_token_id_t</a> a,
<a name="l00125"></a>00125 IN <span class="keyword">const</span> <a class="code" href="structpkcs11h__token__id__s.html" title="Token identifier.">pkcs11h_token_id_t</a> b
<a name="l00126"></a>00126 );
<a name="l00127"></a>00127
<a name="l00133"></a>00133 CK_RV
<a name="l00134"></a>00134 <a class="code" href="group__pkcs11h__token.html#ga42f75b82a5210342fa3a523a1859dc33" title="Force logout.">pkcs11h_token_logout</a> (
<a name="l00135"></a>00135 IN <span class="keyword">const</span> <a class="code" href="structpkcs11h__token__id__s.html" title="Token identifier.">pkcs11h_token_id_t</a> token_id
<a name="l00136"></a>00136 );
<a name="l00137"></a>00137
<a name="l00145"></a>00145 CK_RV
<a name="l00146"></a>00146 <a class="code" href="group__pkcs11h__token.html#ga1e1c4fef0571b30f7351561afea7ad2f" title="Force login, avoid hooks.">pkcs11h_token_login</a> (
<a name="l00147"></a>00147 IN <span class="keyword">const</span> <a class="code" href="structpkcs11h__token__id__s.html" title="Token identifier.">pkcs11h_token_id_t</a> token_id,
<a name="l00148"></a>00148 IN <span class="keyword">const</span> PKCS11H_BOOL readonly,
<a name="l00149"></a>00149 IN <span class="keyword">const</span> <span class="keywordtype">char</span> * <span class="keyword">const</span> pin
<a name="l00150"></a>00150 );
<a name="l00151"></a>00151
<a name="l00159"></a>00159 CK_RV
<a name="l00160"></a>00160 <a class="code" href="group__pkcs11h__token.html#gad8b8d0c1c11f8e684fdd18f591810975" title="Ensure token is accessible.">pkcs11h_token_ensureAccess</a> (
<a name="l00161"></a>00161 IN <span class="keyword">const</span> <a class="code" href="structpkcs11h__token__id__s.html" title="Token identifier.">pkcs11h_token_id_t</a> token_id,
<a name="l00162"></a>00162 IN <span class="keywordtype">void</span> * <span class="keyword">const</span> user_data,
<a name="l00163"></a>00163 IN <span class="keyword">const</span> <span class="keywordtype">unsigned</span> mask_prompt
<a name="l00164"></a>00164 );
<a name="l00165"></a>00165
<a name="l00171"></a>00171 CK_RV
<a name="l00172"></a>00172 <a class="code" href="group__pkcs11h__token.html#ga554dad08a75b44c5e858c9b8285a4aaa" title="Free certificate_id list.">pkcs11h_token_freeTokenIdList</a> (
<a name="l00173"></a>00173 IN <span class="keyword">const</span> pkcs11h_token_id_list_t token_id_list
<a name="l00174"></a>00174 );
<a name="l00175"></a>00175
<a name="l00184"></a>00184 CK_RV
<a name="l00185"></a>00185 <a class="code" href="group__pkcs11h__token.html#ga0073305e8cdefe8d45b83c246c81f08d" title="Enumerate available tokens.">pkcs11h_token_enumTokenIds</a> (
<a name="l00186"></a>00186 IN <span class="keyword">const</span> <span class="keywordtype">unsigned</span> method,
<a name="l00187"></a>00187 OUT pkcs11h_token_id_list_t * <span class="keyword">const</span> p_token_id_list
<a name="l00188"></a>00188 );
<a name="l00189"></a>00189
<a name="l00198"></a>00198 CK_RV
<a name="l00199"></a>00199 <a class="code" href="group__pkcs11h__token.html#ga5bd20f17e1ba368cb63db6e364aa3b1e" title="Serialize token_id into string.">pkcs11h_token_serializeTokenId</a> (
<a name="l00200"></a>00200 OUT <span class="keywordtype">char</span> * <span class="keyword">const</span> sz,
<a name="l00201"></a>00201 IN OUT <span class="keywordtype">size_t</span> *max,
<a name="l00202"></a>00202 IN <span class="keyword">const</span> <a class="code" href="structpkcs11h__token__id__s.html" title="Token identifier.">pkcs11h_token_id_t</a> token_id
<a name="l00203"></a>00203 );
<a name="l00204"></a>00204
<a name="l00213"></a>00213 CK_RV
<a name="l00214"></a>00214 <a class="code" href="group__pkcs11h__token.html#gab08544b49b89e86a376ed74d0b45cdbb" title="Deserialize token_id from string.">pkcs11h_token_deserializeTokenId</a> (
<a name="l00215"></a>00215 OUT <a class="code" href="structpkcs11h__token__id__s.html" title="Token identifier.">pkcs11h_token_id_t</a> *p_token_id,
<a name="l00216"></a>00216 IN <span class="keyword">const</span> <span class="keywordtype">char</span> * <span class="keyword">const</span> sz
<a name="l00217"></a>00217 );
<a name="l00218"></a>00218
<a name="l00219"></a>00219 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00220"></a>00220 <span class="preprocessor"></span>}
<a name="l00221"></a>00221 <span class="preprocessor">#endif</span>
<a name="l00222"></a>00222 <span class="preprocessor"></span>
<a name="l00225"></a>00225 <span class="preprocessor">#endif </span><span class="comment">/* __PKCS11H_TOKEN_H */</span>
</pre></div></div>
<hr>
<table width="100%"><tr><td>pkcs11-helper, Copyright (C) Alon Bar-Lev <alon.barlev@gmail.com></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>
