<!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: OpenSSL interface</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><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>OpenSSL interface</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Files</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs11h-openssl_8h.html">pkcs11h-openssl.h</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>pkcs11-helper OpenSSL interface. </p>
<br/></td></tr>
</p>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__openssl.html#ga0184db296927cd3fc7a1fd6556849df4">pkcs11h_hook_openssl_cleanup_t</a> )(IN const <a class="el" href="group__pkcs11h__certificate.html#ga7cb08e46261d4454b2330c7173db88b6">pkcs11h_certificate_t</a> certificate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">OpenSSL RSA cleanup hook. <a href="#ga0184db296927cd3fc7a1fd6556849df4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga98b8db04d6ab32fd2529ff2602beaabb"></a><!-- doxytag: member="pkcs11h_openssl::pkcs11h_openssl_session_t" ref="ga98b8db04d6ab32fd2529ff2602beaabb" args="" -->
typedef struct <br class="typebreak"/>
pkcs11h_openssl_session_s * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">OpenSSL session reference. <br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">X509 * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__openssl.html#gad1539e531d6a356be00c9384411759b7">pkcs11h_openssl_getX509</a> (IN const <a class="el" href="group__pkcs11h__certificate.html#ga7cb08e46261d4454b2330c7173db88b6">pkcs11h_certificate_t</a> certificate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an X509 object out of the openssl_session object. <a href="#gad1539e531d6a356be00c9384411759b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__openssl.html#gaa52a32e94ce61e3df1da4155e29502d0">pkcs11h_openssl_createSession</a> (IN const <a class="el" href="group__pkcs11h__certificate.html#ga7cb08e46261d4454b2330c7173db88b6">pkcs11h_certificate_t</a> certificate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create OpenSSL session based on a certificate object. <a href="#gaa52a32e94ce61e3df1da4155e29502d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__pkcs11h__openssl.html#ga0184db296927cd3fc7a1fd6556849df4">pkcs11h_hook_openssl_cleanup_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__openssl.html#ga78bfd6a4253623ca96fd70dd18c56a10">pkcs11h_openssl_getCleanupHook</a> (IN const <a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a> openssl_session)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets cleanup hook. <a href="#ga78bfd6a4253623ca96fd70dd18c56a10"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__openssl.html#ga5405a9059fd74a6a5ab06fb70f2e04cb">pkcs11h_openssl_setCleanupHook</a> (IN const <a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a> openssl_session, IN const <a class="el" href="group__pkcs11h__openssl.html#ga0184db296927cd3fc7a1fd6556849df4">pkcs11h_hook_openssl_cleanup_t</a> cleanup)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets cleanup hook. <a href="#ga5405a9059fd74a6a5ab06fb70f2e04cb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__openssl.html#gaff2d59ccb302b172a30839fc416162b6">pkcs11h_openssl_freeSession</a> (IN const <a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a> openssl_session)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free OpenSSL session. <a href="#gaff2d59ccb302b172a30839fc416162b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">RSA * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__openssl.html#ga6c6f9f0ac5a5adee7b8343ef03f9dd93">pkcs11h_openssl_session_getRSA</a> (IN const <a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a> openssl_session)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an RSA object out of the openssl_session object. <a href="#ga6c6f9f0ac5a5adee7b8343ef03f9dd93"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">X509 * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__openssl.html#ga820136d6ebbed75228e8c9d7e9a4b91d">pkcs11h_openssl_session_getX509</a> (IN const <a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a> openssl_session)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an X509 object out of the openssl_session object. <a href="#ga820136d6ebbed75228e8c9d7e9a4b91d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>OpenSSL engine to be used by OpenSSL enabled applications. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga0184db296927cd3fc7a1fd6556849df4"></a><!-- doxytag: member="pkcs11h-openssl.h::pkcs11h_hook_openssl_cleanup_t" ref="ga0184db296927cd3fc7a1fd6556849df4" args=")(IN const pkcs11h_certificate_t certificate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="group__pkcs11h__openssl.html#ga0184db296927cd3fc7a1fd6556849df4">pkcs11h_hook_openssl_cleanup_t</a>)(IN const <a class="el" href="group__pkcs11h__certificate.html#ga7cb08e46261d4454b2330c7173db88b6">pkcs11h_certificate_t</a> certificate)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>OpenSSL RSA cleanup hook. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>certificate</em> </td><td>Certificate attached to the RSA object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaa52a32e94ce61e3df1da4155e29502d0"></a><!-- doxytag: member="pkcs11h-openssl.h::pkcs11h_openssl_createSession" ref="gaa52a32e94ce61e3df1da4155e29502d0" args="(IN const pkcs11h_certificate_t certificate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a> pkcs11h_openssl_createSession </td>
<td>(</td>
<td class="paramtype">IN const <a class="el" href="group__pkcs11h__certificate.html#ga7cb08e46261d4454b2330c7173db88b6">pkcs11h_certificate_t</a> </td>
<td class="paramname"> <em>certificate</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create OpenSSL session based on a certificate object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>certificate</em> </td><td>Certificate object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>OpenSSL session reference. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The certificate object will be freed by the OpenSSL interface on session end. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__pkcs11h__openssl.html#gaff2d59ccb302b172a30839fc416162b6" title="Free OpenSSL session.">pkcs11h_openssl_freeSession()</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="gaff2d59ccb302b172a30839fc416162b6"></a><!-- doxytag: member="pkcs11h-openssl.h::pkcs11h_openssl_freeSession" ref="gaff2d59ccb302b172a30839fc416162b6" args="(IN const pkcs11h_openssl_session_t openssl_session)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pkcs11h_openssl_freeSession </td>
<td>(</td>
<td class="paramtype">IN const <a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a> </td>
<td class="paramname"> <em>openssl_session</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free OpenSSL session. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>openssl_session</em> </td><td>OpenSSL session reference. </td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The openssl_session object has a reference count just like other OpenSSL objects. </dd></dl>
</div>
</div>
<a class="anchor" id="ga78bfd6a4253623ca96fd70dd18c56a10"></a><!-- doxytag: member="pkcs11h-openssl.h::pkcs11h_openssl_getCleanupHook" ref="ga78bfd6a4253623ca96fd70dd18c56a10" args="(IN const pkcs11h_openssl_session_t openssl_session)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__pkcs11h__openssl.html#ga0184db296927cd3fc7a1fd6556849df4">pkcs11h_hook_openssl_cleanup_t</a> pkcs11h_openssl_getCleanupHook </td>
<td>(</td>
<td class="paramtype">IN const <a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a> </td>
<td class="paramname"> <em>openssl_session</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets cleanup hook. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>openssl_session</em> </td><td>OpenSSL session reference. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Current hook. </dd></dl>
</div>
</div>
<a class="anchor" id="gad1539e531d6a356be00c9384411759b7"></a><!-- doxytag: member="pkcs11h-openssl.h::pkcs11h_openssl_getX509" ref="gad1539e531d6a356be00c9384411759b7" args="(IN const pkcs11h_certificate_t certificate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">X509* pkcs11h_openssl_getX509 </td>
<td>(</td>
<td class="paramtype">IN const <a class="el" href="group__pkcs11h__certificate.html#ga7cb08e46261d4454b2330c7173db88b6">pkcs11h_certificate_t</a> </td>
<td class="paramname"> <em>certificate</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns an X509 object out of the openssl_session object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>certificate</em> </td><td>Certificate object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>X509. </dd></dl>
</div>
</div>
<a class="anchor" id="ga6c6f9f0ac5a5adee7b8343ef03f9dd93"></a><!-- doxytag: member="pkcs11h-openssl.h::pkcs11h_openssl_session_getRSA" ref="ga6c6f9f0ac5a5adee7b8343ef03f9dd93" args="(IN const pkcs11h_openssl_session_t openssl_session)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RSA* pkcs11h_openssl_session_getRSA </td>
<td>(</td>
<td class="paramtype">IN const <a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a> </td>
<td class="paramname"> <em>openssl_session</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns an RSA object out of the openssl_session object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>openssl_session</em> </td><td>OpenSSL session reference. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>RSA. </dd></dl>
</div>
</div>
<a class="anchor" id="ga820136d6ebbed75228e8c9d7e9a4b91d"></a><!-- doxytag: member="pkcs11h-openssl.h::pkcs11h_openssl_session_getX509" ref="ga820136d6ebbed75228e8c9d7e9a4b91d" args="(IN const pkcs11h_openssl_session_t openssl_session)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">X509* pkcs11h_openssl_session_getX509 </td>
<td>(</td>
<td class="paramtype">IN const <a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a> </td>
<td class="paramname"> <em>openssl_session</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns an X509 object out of the openssl_session object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>openssl_session</em> </td><td>OpenSSL session reference. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>X509. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5405a9059fd74a6a5ab06fb70f2e04cb"></a><!-- doxytag: member="pkcs11h-openssl.h::pkcs11h_openssl_setCleanupHook" ref="ga5405a9059fd74a6a5ab06fb70f2e04cb" args="(IN const pkcs11h_openssl_session_t openssl_session, IN const pkcs11h_hook_openssl_cleanup_t cleanup)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pkcs11h_openssl_setCleanupHook </td>
<td>(</td>
<td class="paramtype">IN const <a class="el" href="group__pkcs11h__openssl.html#ga98b8db04d6ab32fd2529ff2602beaabb">pkcs11h_openssl_session_t</a> </td>
<td class="paramname"> <em>openssl_session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IN const <a class="el" href="group__pkcs11h__openssl.html#ga0184db296927cd3fc7a1fd6556849df4">pkcs11h_hook_openssl_cleanup_t</a> </td>
<td class="paramname"> <em>cleanup</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets cleanup hook. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>openssl_session</em> </td><td>OpenSSL session reference. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cleanup</em> </td><td>hook. </td></tr>
</table>
</dd>
</dl>
</div>
</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>
