1ae771770SStanislav Sedov<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2ae771770SStanislav Sedov<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 3ae771770SStanislav Sedov<title>Heimdal crypto library: RSA functions</title> 4ae771770SStanislav Sedov<link href="doxygen.css" rel="stylesheet" type="text/css"> 5ae771770SStanislav Sedov<link href="tabs.css" rel="stylesheet" type="text/css"> 6ae771770SStanislav Sedov</head><body> 7ae771770SStanislav Sedov<p> 8ae771770SStanislav Sedov<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a> 9ae771770SStanislav Sedov</p> 10ae771770SStanislav Sedov<!-- end of header marker --> 11ae771770SStanislav Sedov<!-- Generated by Doxygen 1.5.6 --> 12ae771770SStanislav Sedov<div class="navigation" id="top"> 13ae771770SStanislav Sedov <div class="tabs"> 14ae771770SStanislav Sedov <ul> 15ae771770SStanislav Sedov <li><a href="index.html"><span>Main Page</span></a></li> 16ae771770SStanislav Sedov <li><a href="modules.html"><span>Modules</span></a></li> 17ae771770SStanislav Sedov <li><a href="examples.html"><span>Examples</span></a></li> 18ae771770SStanislav Sedov </ul> 19ae771770SStanislav Sedov </div> 20ae771770SStanislav Sedov</div> 21ae771770SStanislav Sedov<div class="contents"> 22ae771770SStanislav Sedov<h1>RSA functions</h1><table border="0" cellpadding="0" cellspacing="0"> 23ae771770SStanislav Sedov<tr><td></td></tr> 24ae771770SStanislav Sedov<tr><td colspan="2"><br><h2>Functions</h2></td></tr> 25ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">RSA * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rsa.html#gc7196620864c48d1d6b8377ad8521a4e">RSA_new</a> (void)</td></tr> 26ae771770SStanislav Sedov 27ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">RSA * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rsa.html#gd184201d41deee1d1d684974ecc44e5c">RSA_new_method</a> (ENGINE *engine)</td></tr> 28ae771770SStanislav Sedov 29ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rsa.html#gf0fbfb9641abf52a10e47c789bbba777">RSA_free</a> (RSA *rsa)</td></tr> 30ae771770SStanislav Sedov 31ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rsa.html#gdb710b16e5e5616f0693801cc60aa943">RSA_up_ref</a> (RSA *rsa)</td></tr> 32ae771770SStanislav Sedov 33ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">const RSA_METHOD * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rsa.html#g8a0ab0eaf85ef01f1cc31329558fd37a">RSA_get_method</a> (const RSA *rsa)</td></tr> 34ae771770SStanislav Sedov 35ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rsa.html#gee6501b3b0fe2917a2e40adce6862395">RSA_set_method</a> (RSA *rsa, const RSA_METHOD *method)</td></tr> 36ae771770SStanislav Sedov 37ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rsa.html#ge2af4ebfadf6a1450b823dfc6ca50687">RSA_set_app_data</a> (RSA *rsa, void *arg)</td></tr> 38ae771770SStanislav Sedov 39ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rsa.html#gfcdc9f15c7075cd8434f0c7e59d3db5c">RSA_get_app_data</a> (const RSA *rsa)</td></tr> 40ae771770SStanislav Sedov 41ae771770SStanislav Sedov</table> 42ae771770SStanislav Sedov<hr><a name="_details"></a><h2>Detailed Description</h2> 43ae771770SStanislav SedovSee the <a class="el" href="page_rsa.html">RSA - public-key cryptography</a> for description and examples. <hr><h2>Function Documentation</h2> 44ae771770SStanislav Sedov<a class="anchor" name="gf0fbfb9641abf52a10e47c789bbba777"></a><!-- doxytag: member="rsa.c::RSA_free" ref="gf0fbfb9641abf52a10e47c789bbba777" args="(RSA *rsa)" --> 45ae771770SStanislav Sedov<div class="memitem"> 46ae771770SStanislav Sedov<div class="memproto"> 47ae771770SStanislav Sedov <table class="memname"> 48ae771770SStanislav Sedov <tr> 49ae771770SStanislav Sedov <td class="memname">void RSA_free </td> 50ae771770SStanislav Sedov <td>(</td> 51ae771770SStanislav Sedov <td class="paramtype">RSA * </td> 52ae771770SStanislav Sedov <td class="paramname"> <em>rsa</em> </td> 53ae771770SStanislav Sedov <td> ) </td> 54ae771770SStanislav Sedov <td></td> 55ae771770SStanislav Sedov </tr> 56ae771770SStanislav Sedov </table> 57ae771770SStanislav Sedov</div> 58ae771770SStanislav Sedov<div class="memdoc"> 59ae771770SStanislav Sedov 60ae771770SStanislav Sedov<p> 61ae771770SStanislav SedovFree an allocation RSA object.<p> 62ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd> 63ae771770SStanislav Sedov <table border="0" cellspacing="2" cellpadding="0"> 64ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>rsa</em> </td><td>the RSA object to free. </td></tr> 65ae771770SStanislav Sedov </table> 66ae771770SStanislav Sedov</dl> 67ae771770SStanislav Sedov 68ae771770SStanislav Sedov</div> 69ae771770SStanislav Sedov</div><p> 70ae771770SStanislav Sedov<a class="anchor" name="gfcdc9f15c7075cd8434f0c7e59d3db5c"></a><!-- doxytag: member="rsa.c::RSA_get_app_data" ref="gfcdc9f15c7075cd8434f0c7e59d3db5c" args="(const RSA *rsa)" --> 71ae771770SStanislav Sedov<div class="memitem"> 72ae771770SStanislav Sedov<div class="memproto"> 73ae771770SStanislav Sedov <table class="memname"> 74ae771770SStanislav Sedov <tr> 75ae771770SStanislav Sedov <td class="memname">void* RSA_get_app_data </td> 76ae771770SStanislav Sedov <td>(</td> 77ae771770SStanislav Sedov <td class="paramtype">const RSA * </td> 78ae771770SStanislav Sedov <td class="paramname"> <em>rsa</em> </td> 79ae771770SStanislav Sedov <td> ) </td> 80ae771770SStanislav Sedov <td></td> 81ae771770SStanislav Sedov </tr> 82ae771770SStanislav Sedov </table> 83ae771770SStanislav Sedov</div> 84ae771770SStanislav Sedov<div class="memdoc"> 85ae771770SStanislav Sedov 86ae771770SStanislav Sedov<p> 87ae771770SStanislav SedovGet the application data for the RSA object.<p> 88ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd> 89ae771770SStanislav Sedov <table border="0" cellspacing="2" cellpadding="0"> 90ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>rsa</em> </td><td>the rsa object to get the parameter for</td></tr> 91ae771770SStanislav Sedov </table> 92ae771770SStanislav Sedov</dl> 93ae771770SStanislav Sedov<dl class="return" compact><dt><b>Returns:</b></dt><dd>the data object </dd></dl> 94ae771770SStanislav Sedov 95ae771770SStanislav Sedov</div> 96ae771770SStanislav Sedov</div><p> 97ae771770SStanislav Sedov<a class="anchor" name="g8a0ab0eaf85ef01f1cc31329558fd37a"></a><!-- doxytag: member="rsa.c::RSA_get_method" ref="g8a0ab0eaf85ef01f1cc31329558fd37a" args="(const RSA *rsa)" --> 98ae771770SStanislav Sedov<div class="memitem"> 99ae771770SStanislav Sedov<div class="memproto"> 100ae771770SStanislav Sedov <table class="memname"> 101ae771770SStanislav Sedov <tr> 102ae771770SStanislav Sedov <td class="memname">const RSA_METHOD* RSA_get_method </td> 103ae771770SStanislav Sedov <td>(</td> 104ae771770SStanislav Sedov <td class="paramtype">const RSA * </td> 105ae771770SStanislav Sedov <td class="paramname"> <em>rsa</em> </td> 106ae771770SStanislav Sedov <td> ) </td> 107ae771770SStanislav Sedov <td></td> 108ae771770SStanislav Sedov </tr> 109ae771770SStanislav Sedov </table> 110ae771770SStanislav Sedov</div> 111ae771770SStanislav Sedov<div class="memdoc"> 112ae771770SStanislav Sedov 113ae771770SStanislav Sedov<p> 114ae771770SStanislav SedovReturn the RSA_METHOD used for this RSA object.<p> 115ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd> 116ae771770SStanislav Sedov <table border="0" cellspacing="2" cellpadding="0"> 117ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>rsa</em> </td><td>the object to get the method from.</td></tr> 118ae771770SStanislav Sedov </table> 119ae771770SStanislav Sedov</dl> 120ae771770SStanislav Sedov<dl class="return" compact><dt><b>Returns:</b></dt><dd>the method used for this RSA object. </dd></dl> 121ae771770SStanislav Sedov 122ae771770SStanislav Sedov</div> 123ae771770SStanislav Sedov</div><p> 124ae771770SStanislav Sedov<a class="anchor" name="gc7196620864c48d1d6b8377ad8521a4e"></a><!-- doxytag: member="rsa.c::RSA_new" ref="gc7196620864c48d1d6b8377ad8521a4e" args="(void)" --> 125ae771770SStanislav Sedov<div class="memitem"> 126ae771770SStanislav Sedov<div class="memproto"> 127ae771770SStanislav Sedov <table class="memname"> 128ae771770SStanislav Sedov <tr> 129ae771770SStanislav Sedov <td class="memname">RSA* RSA_new </td> 130ae771770SStanislav Sedov <td>(</td> 131ae771770SStanislav Sedov <td class="paramtype">void </td> 132ae771770SStanislav Sedov <td class="paramname"> </td> 133ae771770SStanislav Sedov <td> ) </td> 134ae771770SStanislav Sedov <td></td> 135ae771770SStanislav Sedov </tr> 136ae771770SStanislav Sedov </table> 137ae771770SStanislav Sedov</div> 138ae771770SStanislav Sedov<div class="memdoc"> 139ae771770SStanislav Sedov 140ae771770SStanislav Sedov<p> 141ae771770SStanislav SedovSame as <a class="el" href="group__hcrypto__rsa.html#gd184201d41deee1d1d684974ecc44e5c">RSA_new_method()</a> using NULL as engine.<p> 142ae771770SStanislav Sedov<dl class="return" compact><dt><b>Returns:</b></dt><dd>a newly allocated RSA object. Free with <a class="el" href="group__hcrypto__rsa.html#gf0fbfb9641abf52a10e47c789bbba777">RSA_free()</a>. </dd></dl> 143ae771770SStanislav Sedov 144ae771770SStanislav Sedov</div> 145ae771770SStanislav Sedov</div><p> 146ae771770SStanislav Sedov<a class="anchor" name="gd184201d41deee1d1d684974ecc44e5c"></a><!-- doxytag: member="rsa.c::RSA_new_method" ref="gd184201d41deee1d1d684974ecc44e5c" args="(ENGINE *engine)" --> 147ae771770SStanislav Sedov<div class="memitem"> 148ae771770SStanislav Sedov<div class="memproto"> 149ae771770SStanislav Sedov <table class="memname"> 150ae771770SStanislav Sedov <tr> 151ae771770SStanislav Sedov <td class="memname">RSA* RSA_new_method </td> 152ae771770SStanislav Sedov <td>(</td> 153ae771770SStanislav Sedov <td class="paramtype">ENGINE * </td> 154ae771770SStanislav Sedov <td class="paramname"> <em>engine</em> </td> 155ae771770SStanislav Sedov <td> ) </td> 156ae771770SStanislav Sedov <td></td> 157ae771770SStanislav Sedov </tr> 158ae771770SStanislav Sedov </table> 159ae771770SStanislav Sedov</div> 160ae771770SStanislav Sedov<div class="memdoc"> 161ae771770SStanislav Sedov 162ae771770SStanislav Sedov<p> 163ae771770SStanislav SedovAllocate a new RSA object using the engine, if NULL is specified as the engine, use the default RSA engine as returned by ENGINE_get_default_RSA().<p> 164ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd> 165ae771770SStanislav Sedov <table border="0" cellspacing="2" cellpadding="0"> 166ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>engine</em> </td><td>Specific what ENGINE RSA provider should be used.</td></tr> 167ae771770SStanislav Sedov </table> 168ae771770SStanislav Sedov</dl> 169ae771770SStanislav Sedov<dl class="return" compact><dt><b>Returns:</b></dt><dd>a newly allocated RSA object. Free with <a class="el" href="group__hcrypto__rsa.html#gf0fbfb9641abf52a10e47c789bbba777">RSA_free()</a>. </dd></dl> 170ae771770SStanislav Sedov 171ae771770SStanislav Sedov</div> 172ae771770SStanislav Sedov</div><p> 173ae771770SStanislav Sedov<a class="anchor" name="ge2af4ebfadf6a1450b823dfc6ca50687"></a><!-- doxytag: member="rsa.c::RSA_set_app_data" ref="ge2af4ebfadf6a1450b823dfc6ca50687" args="(RSA *rsa, void *arg)" --> 174ae771770SStanislav Sedov<div class="memitem"> 175ae771770SStanislav Sedov<div class="memproto"> 176ae771770SStanislav Sedov <table class="memname"> 177ae771770SStanislav Sedov <tr> 178ae771770SStanislav Sedov <td class="memname">int RSA_set_app_data </td> 179ae771770SStanislav Sedov <td>(</td> 180ae771770SStanislav Sedov <td class="paramtype">RSA * </td> 181ae771770SStanislav Sedov <td class="paramname"> <em>rsa</em>, </td> 182ae771770SStanislav Sedov </tr> 183ae771770SStanislav Sedov <tr> 184ae771770SStanislav Sedov <td class="paramkey"></td> 185ae771770SStanislav Sedov <td></td> 186ae771770SStanislav Sedov <td class="paramtype">void * </td> 187ae771770SStanislav Sedov <td class="paramname"> <em>arg</em></td><td> </td> 188ae771770SStanislav Sedov </tr> 189ae771770SStanislav Sedov <tr> 190ae771770SStanislav Sedov <td></td> 191ae771770SStanislav Sedov <td>)</td> 192ae771770SStanislav Sedov <td></td><td></td><td></td> 193ae771770SStanislav Sedov </tr> 194ae771770SStanislav Sedov </table> 195ae771770SStanislav Sedov</div> 196ae771770SStanislav Sedov<div class="memdoc"> 197ae771770SStanislav Sedov 198ae771770SStanislav Sedov<p> 199ae771770SStanislav SedovSet the application data for the RSA object.<p> 200ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd> 201ae771770SStanislav Sedov <table border="0" cellspacing="2" cellpadding="0"> 202ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>rsa</em> </td><td>the rsa object to set the parameter for </td></tr> 203ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>arg</em> </td><td>the data object to store</td></tr> 204ae771770SStanislav Sedov </table> 205ae771770SStanislav Sedov</dl> 206ae771770SStanislav Sedov<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success. </dd></dl> 207ae771770SStanislav Sedov 208ae771770SStanislav Sedov</div> 209ae771770SStanislav Sedov</div><p> 210ae771770SStanislav Sedov<a class="anchor" name="gee6501b3b0fe2917a2e40adce6862395"></a><!-- doxytag: member="rsa.c::RSA_set_method" ref="gee6501b3b0fe2917a2e40adce6862395" args="(RSA *rsa, const RSA_METHOD *method)" --> 211ae771770SStanislav Sedov<div class="memitem"> 212ae771770SStanislav Sedov<div class="memproto"> 213ae771770SStanislav Sedov <table class="memname"> 214ae771770SStanislav Sedov <tr> 215ae771770SStanislav Sedov <td class="memname">int RSA_set_method </td> 216ae771770SStanislav Sedov <td>(</td> 217ae771770SStanislav Sedov <td class="paramtype">RSA * </td> 218ae771770SStanislav Sedov <td class="paramname"> <em>rsa</em>, </td> 219ae771770SStanislav Sedov </tr> 220ae771770SStanislav Sedov <tr> 221ae771770SStanislav Sedov <td class="paramkey"></td> 222ae771770SStanislav Sedov <td></td> 223ae771770SStanislav Sedov <td class="paramtype">const RSA_METHOD * </td> 224ae771770SStanislav Sedov <td class="paramname"> <em>method</em></td><td> </td> 225ae771770SStanislav Sedov </tr> 226ae771770SStanislav Sedov <tr> 227ae771770SStanislav Sedov <td></td> 228ae771770SStanislav Sedov <td>)</td> 229ae771770SStanislav Sedov <td></td><td></td><td></td> 230ae771770SStanislav Sedov </tr> 231ae771770SStanislav Sedov </table> 232ae771770SStanislav Sedov</div> 233ae771770SStanislav Sedov<div class="memdoc"> 234ae771770SStanislav Sedov 235ae771770SStanislav Sedov<p> 236ae771770SStanislav SedovSet a new method for the RSA keypair.<p> 237ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd> 238ae771770SStanislav Sedov <table border="0" cellspacing="2" cellpadding="0"> 239ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>rsa</em> </td><td>rsa parameter. </td></tr> 240ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>method</em> </td><td>the new method for the RSA parameter.</td></tr> 241ae771770SStanislav Sedov </table> 242ae771770SStanislav Sedov</dl> 243ae771770SStanislav Sedov<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success. </dd></dl> 244ae771770SStanislav Sedov 245ae771770SStanislav Sedov</div> 246ae771770SStanislav Sedov</div><p> 247ae771770SStanislav Sedov<a class="anchor" name="gdb710b16e5e5616f0693801cc60aa943"></a><!-- doxytag: member="rsa.c::RSA_up_ref" ref="gdb710b16e5e5616f0693801cc60aa943" args="(RSA *rsa)" --> 248ae771770SStanislav Sedov<div class="memitem"> 249ae771770SStanislav Sedov<div class="memproto"> 250ae771770SStanislav Sedov <table class="memname"> 251ae771770SStanislav Sedov <tr> 252ae771770SStanislav Sedov <td class="memname">int RSA_up_ref </td> 253ae771770SStanislav Sedov <td>(</td> 254ae771770SStanislav Sedov <td class="paramtype">RSA * </td> 255ae771770SStanislav Sedov <td class="paramname"> <em>rsa</em> </td> 256ae771770SStanislav Sedov <td> ) </td> 257ae771770SStanislav Sedov <td></td> 258ae771770SStanislav Sedov </tr> 259ae771770SStanislav Sedov </table> 260ae771770SStanislav Sedov</div> 261ae771770SStanislav Sedov<div class="memdoc"> 262ae771770SStanislav Sedov 263ae771770SStanislav Sedov<p> 264ae771770SStanislav SedovAdd an extra reference to the RSA object. The object should be free with <a class="el" href="group__hcrypto__rsa.html#gf0fbfb9641abf52a10e47c789bbba777">RSA_free()</a> to drop the reference.<p> 265ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd> 266ae771770SStanislav Sedov <table border="0" cellspacing="2" cellpadding="0"> 267ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>rsa</em> </td><td>the object to add reference counting too.</td></tr> 268ae771770SStanislav Sedov </table> 269ae771770SStanislav Sedov</dl> 270ae771770SStanislav Sedov<dl class="return" compact><dt><b>Returns:</b></dt><dd>the current reference count, can't safely be used except for debug printing. </dd></dl> 271ae771770SStanislav Sedov 272ae771770SStanislav Sedov</div> 273ae771770SStanislav Sedov</div><p> 274ae771770SStanislav Sedov</div> 275ae771770SStanislav Sedov<hr size="1"><address style="text-align: right;"><small> 276*cf771f22SStanislav SedovGenerated on Wed Jan 11 14:07:38 2012 for Heimdal crypto library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address> 277ae771770SStanislav Sedov</body> 278ae771770SStanislav Sedov</html> 279
