crypto/heimdal/doc/doxyout/hx509/html/group__hx509__peer.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Heimdalx509library: hx509 certificate selecting functions</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <p>
   8 <a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
   9 </p>
  10 <!-- end of header marker -->
  11 <!-- Generated by Doxygen 1.5.6 -->
  12 <div class="navigation" id="top">
  13   <div class="tabs">
  14     <ul>
  15       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  16       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  17       <li><a href="modules.html"><span>Modules</span></a></li>
  18     </ul>
  19   </div>
  20 </div>
  21 <div class="contents">
  22 <h1>hx509 certificate selecting functions</h1><table border="0" cellpadding="0" cellspacing="0">
  23 <tr><td></td></tr>
  24 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
  25 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__peer.html#gf4093f25751c1974c7fc65b882aac4d8">hx509_peer_info_alloc</a> (hx509_context context, hx509_peer_info *peer)</td></tr>
  26
  27 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__peer.html#ge7b541b7b98303050e8ecc85935d2abc">hx509_peer_info_free</a> (hx509_peer_info peer)</td></tr>
  28
  29 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__peer.html#g6462bcb987ee03fcb181834f127e5d3e">hx509_peer_info_set_cert</a> (hx509_peer_info peer, hx509_cert cert)</td></tr>
  30
  31 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__peer.html#g5ca456f9cc2d27e4cf034f342324f0d1">hx509_peer_info_add_cms_alg</a> (hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier *val)</td></tr>
  32
  33 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__peer.html#g4f61c86442845518d86bc2c5b30fcdb5">hx509_peer_info_set_cms_algs</a> (hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier *val, size_t len)</td></tr>
  34
  35 </table>
  36 <hr><a name="_details"></a><h2>Detailed Description</h2>
  37 <hr><h2>Function Documentation</h2>
  38 <a class="anchor" name="g5ca456f9cc2d27e4cf034f342324f0d1"></a><!-- doxytag: member="peer.c::hx509_peer_info_add_cms_alg" ref="g5ca456f9cc2d27e4cf034f342324f0d1" args="(hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier *val)" -->
  39 <div class="memitem">
  40 <div class="memproto">
  41       <table class="memname">
  42         <tr>
  43           <td class="memname">int hx509_peer_info_add_cms_alg           </td>
  44           <td>(</td>
  45           <td class="paramtype">hx509_context&nbsp;</td>
  46           <td class="paramname"> <em>context</em>, </td>
  47         </tr>
  48         <tr>
  49           <td class="paramkey"></td>
  50           <td></td>
  51           <td class="paramtype">hx509_peer_info&nbsp;</td>
  52           <td class="paramname"> <em>peer</em>, </td>
  53         </tr>
  54         <tr>
  55           <td class="paramkey"></td>
  56           <td></td>
  57           <td class="paramtype">const AlgorithmIdentifier *&nbsp;</td>
  58           <td class="paramname"> <em>val</em></td><td>&nbsp;</td>
  59         </tr>
  60         <tr>
  61           <td></td>
  62           <td>)</td>
  63           <td></td><td></td><td></td>
  64         </tr>
  65       </table>
  66 </div>
  67 <div class="memdoc">
  68
  69 <p>
  70 Add an additional algorithm that the peer supports.<p>
  71 <dl compact><dt><b>Parameters:</b></dt><dd>
  72   <table border="0" cellspacing="2" cellpadding="0">
  73     <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>A hx509 context. </td></tr>
  74     <tr><td valign="top"></td><td valign="top"><em>peer</em>&nbsp;</td><td>the peer to set the new algorithms for </td></tr>
  75     <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>an AlgorithmsIdentier to add</td></tr>
  76   </table>
  77 </dl>
  78 <dl class="return" compact><dt><b>Returns:</b></dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#g15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
  79
  80 </div>
  81 </div><p>
  82 <a class="anchor" name="gf4093f25751c1974c7fc65b882aac4d8"></a><!-- doxytag: member="peer.c::hx509_peer_info_alloc" ref="gf4093f25751c1974c7fc65b882aac4d8" args="(hx509_context context, hx509_peer_info *peer)" -->
  83 <div class="memitem">
  84 <div class="memproto">
  85       <table class="memname">
  86         <tr>
  87           <td class="memname">int hx509_peer_info_alloc           </td>
  88           <td>(</td>
  89           <td class="paramtype">hx509_context&nbsp;</td>
  90           <td class="paramname"> <em>context</em>, </td>
  91         </tr>
  92         <tr>
  93           <td class="paramkey"></td>
  94           <td></td>
  95           <td class="paramtype">hx509_peer_info *&nbsp;</td>
  96           <td class="paramname"> <em>peer</em></td><td>&nbsp;</td>
  97         </tr>
  98         <tr>
  99           <td></td>
 100           <td>)</td>
 101           <td></td><td></td><td></td>
 102         </tr>
 103       </table>
 104 </div>
 105 <div class="memdoc">
 106
 107 <p>
 108 Allocate a new peer info structure an init it to default values.<p>
 109 <dl compact><dt><b>Parameters:</b></dt><dd>
 110   <table border="0" cellspacing="2" cellpadding="0">
 111     <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>A hx509 context. </td></tr>
 112     <tr><td valign="top"></td><td valign="top"><em>peer</em>&nbsp;</td><td>return an allocated peer, free with <a class="el" href="group__hx509__peer.html#ge7b541b7b98303050e8ecc85935d2abc">hx509_peer_info_free()</a>.</td></tr>
 113   </table>
 114 </dl>
 115 <dl class="return" compact><dt><b>Returns:</b></dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#g15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
 116
 117 </div>
 118 </div><p>
 119 <a class="anchor" name="ge7b541b7b98303050e8ecc85935d2abc"></a><!-- doxytag: member="peer.c::hx509_peer_info_free" ref="ge7b541b7b98303050e8ecc85935d2abc" args="(hx509_peer_info peer)" -->
 120 <div class="memitem">
 121 <div class="memproto">
 122       <table class="memname">
 123         <tr>
 124           <td class="memname">void hx509_peer_info_free           </td>
 125           <td>(</td>
 126           <td class="paramtype">hx509_peer_info&nbsp;</td>
 127           <td class="paramname"> <em>peer</em>          </td>
 128           <td>&nbsp;)&nbsp;</td>
 129           <td></td>
 130         </tr>
 131       </table>
 132 </div>
 133 <div class="memdoc">
 134
 135 <p>
 136 Free a peer info structure.<p>
 137 <dl compact><dt><b>Parameters:</b></dt><dd>
 138   <table border="0" cellspacing="2" cellpadding="0">
 139     <tr><td valign="top"></td><td valign="top"><em>peer</em>&nbsp;</td><td>peer info to be freed. </td></tr>
 140   </table>
 141 </dl>
 142
 143 </div>
 144 </div><p>
 145 <a class="anchor" name="g6462bcb987ee03fcb181834f127e5d3e"></a><!-- doxytag: member="peer.c::hx509_peer_info_set_cert" ref="g6462bcb987ee03fcb181834f127e5d3e" args="(hx509_peer_info peer, hx509_cert cert)" -->
 146 <div class="memitem">
 147 <div class="memproto">
 148       <table class="memname">
 149         <tr>
 150           <td class="memname">int hx509_peer_info_set_cert           </td>
 151           <td>(</td>
 152           <td class="paramtype">hx509_peer_info&nbsp;</td>
 153           <td class="paramname"> <em>peer</em>, </td>
 154         </tr>
 155         <tr>
 156           <td class="paramkey"></td>
 157           <td></td>
 158           <td class="paramtype">hx509_cert&nbsp;</td>
 159           <td class="paramname"> <em>cert</em></td><td>&nbsp;</td>
 160         </tr>
 161         <tr>
 162           <td></td>
 163           <td>)</td>
 164           <td></td><td></td><td></td>
 165         </tr>
 166       </table>
 167 </div>
 168 <div class="memdoc">
 169
 170 <p>
 171 Set the certificate that remote peer is using.<p>
 172 <dl compact><dt><b>Parameters:</b></dt><dd>
 173   <table border="0" cellspacing="2" cellpadding="0">
 174     <tr><td valign="top"></td><td valign="top"><em>peer</em>&nbsp;</td><td>peer info to update </td></tr>
 175     <tr><td valign="top"></td><td valign="top"><em>cert</em>&nbsp;</td><td>cerificate of the remote peer.</td></tr>
 176   </table>
 177 </dl>
 178 <dl class="return" compact><dt><b>Returns:</b></dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#g15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
 179
 180 </div>
 181 </div><p>
 182 <a class="anchor" name="g4f61c86442845518d86bc2c5b30fcdb5"></a><!-- doxytag: member="peer.c::hx509_peer_info_set_cms_algs" ref="g4f61c86442845518d86bc2c5b30fcdb5" args="(hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier *val, size_t len)" -->
 183 <div class="memitem">
 184 <div class="memproto">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname">int hx509_peer_info_set_cms_algs           </td>
 188           <td>(</td>
 189           <td class="paramtype">hx509_context&nbsp;</td>
 190           <td class="paramname"> <em>context</em>, </td>
 191         </tr>
 192         <tr>
 193           <td class="paramkey"></td>
 194           <td></td>
 195           <td class="paramtype">hx509_peer_info&nbsp;</td>
 196           <td class="paramname"> <em>peer</em>, </td>
 197         </tr>
 198         <tr>
 199           <td class="paramkey"></td>
 200           <td></td>
 201           <td class="paramtype">const AlgorithmIdentifier *&nbsp;</td>
 202           <td class="paramname"> <em>val</em>, </td>
 203         </tr>
 204         <tr>
 205           <td class="paramkey"></td>
 206           <td></td>
 207           <td class="paramtype">size_t&nbsp;</td>
 208           <td class="paramname"> <em>len</em></td><td>&nbsp;</td>
 209         </tr>
 210         <tr>
 211           <td></td>
 212           <td>)</td>
 213           <td></td><td></td><td></td>
 214         </tr>
 215       </table>
 216 </div>
 217 <div class="memdoc">
 218
 219 <p>
 220 Set the algorithms that the peer supports.<p>
 221 <dl compact><dt><b>Parameters:</b></dt><dd>
 222   <table border="0" cellspacing="2" cellpadding="0">
 223     <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>A hx509 context. </td></tr>
 224     <tr><td valign="top"></td><td valign="top"><em>peer</em>&nbsp;</td><td>the peer to set the new algorithms for </td></tr>
 225     <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>array of supported AlgorithmsIdentiers </td></tr>
 226     <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>length of array val.</td></tr>
 227   </table>
 228 </dl>
 229 <dl class="return" compact><dt><b>Returns:</b></dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#g15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
 230
 231 </div>
 232 </div><p>
 233 </div>
 234 <hr size="1"><address style="text-align: right;"><small>
 235 Generated on Wed Jan 11 14:07:41 2012 for Heimdalx509library by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
 236 </body>
 237 </html>