xref: /freebsd/crypto/heimdal/doc/doxyout/hx509/html/group__hx509__peer.html (revision 6a068746777241722b2b32c5d0bc443a2a64d80b)
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>Heimdalx509library: hx509 certificate selecting 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&nbsp;Page</span></a></li>
16ae771770SStanislav Sedov      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
17ae771770SStanislav Sedov      <li><a href="modules.html"><span>Modules</span></a></li>
18ae771770SStanislav Sedov    </ul>
19ae771770SStanislav Sedov  </div>
20ae771770SStanislav Sedov</div>
21ae771770SStanislav Sedov<div class="contents">
22ae771770SStanislav Sedov<h1>hx509 certificate selecting 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">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>
26ae771770SStanislav Sedov
27ae771770SStanislav Sedov<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>
28ae771770SStanislav Sedov
29ae771770SStanislav Sedov<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>
30ae771770SStanislav Sedov
31ae771770SStanislav Sedov<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>
32ae771770SStanislav Sedov
33ae771770SStanislav Sedov<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>
34ae771770SStanislav Sedov
35ae771770SStanislav Sedov</table>
36ae771770SStanislav Sedov<hr><a name="_details"></a><h2>Detailed Description</h2>
37ae771770SStanislav Sedov<hr><h2>Function Documentation</h2>
38ae771770SStanislav Sedov<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)" -->
39ae771770SStanislav Sedov<div class="memitem">
40ae771770SStanislav Sedov<div class="memproto">
41ae771770SStanislav Sedov      <table class="memname">
42ae771770SStanislav Sedov        <tr>
43ae771770SStanislav Sedov          <td class="memname">int hx509_peer_info_add_cms_alg           </td>
44ae771770SStanislav Sedov          <td>(</td>
45ae771770SStanislav Sedov          <td class="paramtype">hx509_context&nbsp;</td>
46ae771770SStanislav Sedov          <td class="paramname"> <em>context</em>, </td>
47ae771770SStanislav Sedov        </tr>
48ae771770SStanislav Sedov        <tr>
49ae771770SStanislav Sedov          <td class="paramkey"></td>
50ae771770SStanislav Sedov          <td></td>
51ae771770SStanislav Sedov          <td class="paramtype">hx509_peer_info&nbsp;</td>
52ae771770SStanislav Sedov          <td class="paramname"> <em>peer</em>, </td>
53ae771770SStanislav Sedov        </tr>
54ae771770SStanislav Sedov        <tr>
55ae771770SStanislav Sedov          <td class="paramkey"></td>
56ae771770SStanislav Sedov          <td></td>
57ae771770SStanislav Sedov          <td class="paramtype">const AlgorithmIdentifier *&nbsp;</td>
58ae771770SStanislav Sedov          <td class="paramname"> <em>val</em></td><td>&nbsp;</td>
59ae771770SStanislav Sedov        </tr>
60ae771770SStanislav Sedov        <tr>
61ae771770SStanislav Sedov          <td></td>
62ae771770SStanislav Sedov          <td>)</td>
63ae771770SStanislav Sedov          <td></td><td></td><td></td>
64ae771770SStanislav Sedov        </tr>
65ae771770SStanislav Sedov      </table>
66ae771770SStanislav Sedov</div>
67ae771770SStanislav Sedov<div class="memdoc">
68ae771770SStanislav Sedov
69ae771770SStanislav Sedov<p>
70ae771770SStanislav SedovAdd an additional algorithm that the peer supports.<p>
71ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd>
72ae771770SStanislav Sedov  <table border="0" cellspacing="2" cellpadding="0">
73ae771770SStanislav Sedov    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>A hx509 context. </td></tr>
74ae771770SStanislav Sedov    <tr><td valign="top"></td><td valign="top"><em>peer</em>&nbsp;</td><td>the peer to set the new algorithms for </td></tr>
75ae771770SStanislav Sedov    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>an AlgorithmsIdentier to add</td></tr>
76ae771770SStanislav Sedov  </table>
77ae771770SStanislav Sedov</dl>
78ae771770SStanislav Sedov<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>
79ae771770SStanislav Sedov
80ae771770SStanislav Sedov</div>
81ae771770SStanislav Sedov</div><p>
82ae771770SStanislav Sedov<a class="anchor" name="gf4093f25751c1974c7fc65b882aac4d8"></a><!-- doxytag: member="peer.c::hx509_peer_info_alloc" ref="gf4093f25751c1974c7fc65b882aac4d8" args="(hx509_context context, hx509_peer_info *peer)" -->
83ae771770SStanislav Sedov<div class="memitem">
84ae771770SStanislav Sedov<div class="memproto">
85ae771770SStanislav Sedov      <table class="memname">
86ae771770SStanislav Sedov        <tr>
87ae771770SStanislav Sedov          <td class="memname">int hx509_peer_info_alloc           </td>
88ae771770SStanislav Sedov          <td>(</td>
89ae771770SStanislav Sedov          <td class="paramtype">hx509_context&nbsp;</td>
90ae771770SStanislav Sedov          <td class="paramname"> <em>context</em>, </td>
91ae771770SStanislav Sedov        </tr>
92ae771770SStanislav Sedov        <tr>
93ae771770SStanislav Sedov          <td class="paramkey"></td>
94ae771770SStanislav Sedov          <td></td>
95ae771770SStanislav Sedov          <td class="paramtype">hx509_peer_info *&nbsp;</td>
96ae771770SStanislav Sedov          <td class="paramname"> <em>peer</em></td><td>&nbsp;</td>
97ae771770SStanislav Sedov        </tr>
98ae771770SStanislav Sedov        <tr>
99ae771770SStanislav Sedov          <td></td>
100ae771770SStanislav Sedov          <td>)</td>
101ae771770SStanislav Sedov          <td></td><td></td><td></td>
102ae771770SStanislav Sedov        </tr>
103ae771770SStanislav Sedov      </table>
104ae771770SStanislav Sedov</div>
105ae771770SStanislav Sedov<div class="memdoc">
106ae771770SStanislav Sedov
107ae771770SStanislav Sedov<p>
108ae771770SStanislav SedovAllocate a new peer info structure an init it to default values.<p>
109ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd>
110ae771770SStanislav Sedov  <table border="0" cellspacing="2" cellpadding="0">
111ae771770SStanislav Sedov    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>A hx509 context. </td></tr>
112ae771770SStanislav Sedov    <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>
113ae771770SStanislav Sedov  </table>
114ae771770SStanislav Sedov</dl>
115ae771770SStanislav Sedov<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>
116ae771770SStanislav Sedov
117ae771770SStanislav Sedov</div>
118ae771770SStanislav Sedov</div><p>
119ae771770SStanislav Sedov<a class="anchor" name="ge7b541b7b98303050e8ecc85935d2abc"></a><!-- doxytag: member="peer.c::hx509_peer_info_free" ref="ge7b541b7b98303050e8ecc85935d2abc" args="(hx509_peer_info peer)" -->
120ae771770SStanislav Sedov<div class="memitem">
121ae771770SStanislav Sedov<div class="memproto">
122ae771770SStanislav Sedov      <table class="memname">
123ae771770SStanislav Sedov        <tr>
124ae771770SStanislav Sedov          <td class="memname">void hx509_peer_info_free           </td>
125ae771770SStanislav Sedov          <td>(</td>
126ae771770SStanislav Sedov          <td class="paramtype">hx509_peer_info&nbsp;</td>
127ae771770SStanislav Sedov          <td class="paramname"> <em>peer</em>          </td>
128ae771770SStanislav Sedov          <td>&nbsp;)&nbsp;</td>
129ae771770SStanislav Sedov          <td></td>
130ae771770SStanislav Sedov        </tr>
131ae771770SStanislav Sedov      </table>
132ae771770SStanislav Sedov</div>
133ae771770SStanislav Sedov<div class="memdoc">
134ae771770SStanislav Sedov
135ae771770SStanislav Sedov<p>
136ae771770SStanislav SedovFree a peer info structure.<p>
137ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd>
138ae771770SStanislav Sedov  <table border="0" cellspacing="2" cellpadding="0">
139ae771770SStanislav Sedov    <tr><td valign="top"></td><td valign="top"><em>peer</em>&nbsp;</td><td>peer info to be freed. </td></tr>
140ae771770SStanislav Sedov  </table>
141ae771770SStanislav Sedov</dl>
142ae771770SStanislav Sedov
143ae771770SStanislav Sedov</div>
144ae771770SStanislav Sedov</div><p>
145ae771770SStanislav Sedov<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)" -->
146ae771770SStanislav Sedov<div class="memitem">
147ae771770SStanislav Sedov<div class="memproto">
148ae771770SStanislav Sedov      <table class="memname">
149ae771770SStanislav Sedov        <tr>
150ae771770SStanislav Sedov          <td class="memname">int hx509_peer_info_set_cert           </td>
151ae771770SStanislav Sedov          <td>(</td>
152ae771770SStanislav Sedov          <td class="paramtype">hx509_peer_info&nbsp;</td>
153ae771770SStanislav Sedov          <td class="paramname"> <em>peer</em>, </td>
154ae771770SStanislav Sedov        </tr>
155ae771770SStanislav Sedov        <tr>
156ae771770SStanislav Sedov          <td class="paramkey"></td>
157ae771770SStanislav Sedov          <td></td>
158ae771770SStanislav Sedov          <td class="paramtype">hx509_cert&nbsp;</td>
159ae771770SStanislav Sedov          <td class="paramname"> <em>cert</em></td><td>&nbsp;</td>
160ae771770SStanislav Sedov        </tr>
161ae771770SStanislav Sedov        <tr>
162ae771770SStanislav Sedov          <td></td>
163ae771770SStanislav Sedov          <td>)</td>
164ae771770SStanislav Sedov          <td></td><td></td><td></td>
165ae771770SStanislav Sedov        </tr>
166ae771770SStanislav Sedov      </table>
167ae771770SStanislav Sedov</div>
168ae771770SStanislav Sedov<div class="memdoc">
169ae771770SStanislav Sedov
170ae771770SStanislav Sedov<p>
171ae771770SStanislav SedovSet the certificate that remote peer is using.<p>
172ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd>
173ae771770SStanislav Sedov  <table border="0" cellspacing="2" cellpadding="0">
174ae771770SStanislav Sedov    <tr><td valign="top"></td><td valign="top"><em>peer</em>&nbsp;</td><td>peer info to update </td></tr>
175ae771770SStanislav Sedov    <tr><td valign="top"></td><td valign="top"><em>cert</em>&nbsp;</td><td>cerificate of the remote peer.</td></tr>
176ae771770SStanislav Sedov  </table>
177ae771770SStanislav Sedov</dl>
178ae771770SStanislav Sedov<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>
179ae771770SStanislav Sedov
180ae771770SStanislav Sedov</div>
181ae771770SStanislav Sedov</div><p>
182ae771770SStanislav Sedov<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)" -->
183ae771770SStanislav Sedov<div class="memitem">
184ae771770SStanislav Sedov<div class="memproto">
185ae771770SStanislav Sedov      <table class="memname">
186ae771770SStanislav Sedov        <tr>
187ae771770SStanislav Sedov          <td class="memname">int hx509_peer_info_set_cms_algs           </td>
188ae771770SStanislav Sedov          <td>(</td>
189ae771770SStanislav Sedov          <td class="paramtype">hx509_context&nbsp;</td>
190ae771770SStanislav Sedov          <td class="paramname"> <em>context</em>, </td>
191ae771770SStanislav Sedov        </tr>
192ae771770SStanislav Sedov        <tr>
193ae771770SStanislav Sedov          <td class="paramkey"></td>
194ae771770SStanislav Sedov          <td></td>
195ae771770SStanislav Sedov          <td class="paramtype">hx509_peer_info&nbsp;</td>
196ae771770SStanislav Sedov          <td class="paramname"> <em>peer</em>, </td>
197ae771770SStanislav Sedov        </tr>
198ae771770SStanislav Sedov        <tr>
199ae771770SStanislav Sedov          <td class="paramkey"></td>
200ae771770SStanislav Sedov          <td></td>
201ae771770SStanislav Sedov          <td class="paramtype">const AlgorithmIdentifier *&nbsp;</td>
202ae771770SStanislav Sedov          <td class="paramname"> <em>val</em>, </td>
203ae771770SStanislav Sedov        </tr>
204ae771770SStanislav Sedov        <tr>
205ae771770SStanislav Sedov          <td class="paramkey"></td>
206ae771770SStanislav Sedov          <td></td>
207ae771770SStanislav Sedov          <td class="paramtype">size_t&nbsp;</td>
208ae771770SStanislav Sedov          <td class="paramname"> <em>len</em></td><td>&nbsp;</td>
209ae771770SStanislav Sedov        </tr>
210ae771770SStanislav Sedov        <tr>
211ae771770SStanislav Sedov          <td></td>
212ae771770SStanislav Sedov          <td>)</td>
213ae771770SStanislav Sedov          <td></td><td></td><td></td>
214ae771770SStanislav Sedov        </tr>
215ae771770SStanislav Sedov      </table>
216ae771770SStanislav Sedov</div>
217ae771770SStanislav Sedov<div class="memdoc">
218ae771770SStanislav Sedov
219ae771770SStanislav Sedov<p>
220ae771770SStanislav SedovSet the algorithms that the peer supports.<p>
221ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd>
222ae771770SStanislav Sedov  <table border="0" cellspacing="2" cellpadding="0">
223ae771770SStanislav Sedov    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>A hx509 context. </td></tr>
224ae771770SStanislav Sedov    <tr><td valign="top"></td><td valign="top"><em>peer</em>&nbsp;</td><td>the peer to set the new algorithms for </td></tr>
225ae771770SStanislav Sedov    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>array of supported AlgorithmsIdentiers </td></tr>
226ae771770SStanislav Sedov    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>length of array val.</td></tr>
227ae771770SStanislav Sedov  </table>
228ae771770SStanislav Sedov</dl>
229ae771770SStanislav Sedov<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>
230ae771770SStanislav Sedov
231ae771770SStanislav Sedov</div>
232ae771770SStanislav Sedov</div><p>
233ae771770SStanislav Sedov</div>
234ae771770SStanislav Sedov<hr size="1"><address style="text-align: right;"><small>
235*cf771f22SStanislav SedovGenerated 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>
236ae771770SStanislav Sedov</body>
237ae771770SStanislav Sedov</html>
238