xref: /netbsd-src/crypto/external/bsd/heimdal/dist/doc/doxyout/hx509/html/group__hx509__peer.html (revision dd75ac5b443e967e26b4d18cc8cd5eb98512bfbf)
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>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.9.1 -->
12<script type="text/javascript" src="menudata.js"></script>
13<script type="text/javascript" src="menu.js"></script>
14<script type="text/javascript">
15/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
16$(function() {
17  initMenu('',false,false,'search.php','Search');
18});
19/* @license-end */</script>
20<div id="main-nav"></div>
21</div><!-- top -->
22<div class="header">
23  <div class="summary">
24<a href="#func-members">Functions</a>  </div>
25  <div class="headertitle">
26<div class="title">hx509 certificate selecting functions</div>  </div>
27</div><!--header-->
28<div class="contents">
29<table class="memberdecls">
30<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
31Functions</h2></td></tr>
32<tr class="memitem:gaf4093f25751c1974c7fc65b882aac4d8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__peer.html#gaf4093f25751c1974c7fc65b882aac4d8">hx509_peer_info_alloc</a> (hx509_context context, hx509_peer_info *peer)</td></tr>
33<tr class="separator:gaf4093f25751c1974c7fc65b882aac4d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
34<tr class="memitem:gae7b541b7b98303050e8ecc85935d2abc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__peer.html#gae7b541b7b98303050e8ecc85935d2abc">hx509_peer_info_free</a> (hx509_peer_info peer)</td></tr>
35<tr class="separator:gae7b541b7b98303050e8ecc85935d2abc"><td class="memSeparator" colspan="2">&#160;</td></tr>
36<tr class="memitem:ga6462bcb987ee03fcb181834f127e5d3e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__peer.html#ga6462bcb987ee03fcb181834f127e5d3e">hx509_peer_info_set_cert</a> (hx509_peer_info peer, hx509_cert cert)</td></tr>
37<tr class="separator:ga6462bcb987ee03fcb181834f127e5d3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
38<tr class="memitem:ga5ca456f9cc2d27e4cf034f342324f0d1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__peer.html#ga5ca456f9cc2d27e4cf034f342324f0d1">hx509_peer_info_add_cms_alg</a> (hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier *val)</td></tr>
39<tr class="separator:ga5ca456f9cc2d27e4cf034f342324f0d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
40<tr class="memitem:ga4f61c86442845518d86bc2c5b30fcdb5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__peer.html#ga4f61c86442845518d86bc2c5b30fcdb5">hx509_peer_info_set_cms_algs</a> (hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier *val, size_t len)</td></tr>
41<tr class="separator:ga4f61c86442845518d86bc2c5b30fcdb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
42</table>
43<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
44<h2 class="groupheader">Function Documentation</h2>
45<a id="ga5ca456f9cc2d27e4cf034f342324f0d1"></a>
46<h2 class="memtitle"><span class="permalink"><a href="#ga5ca456f9cc2d27e4cf034f342324f0d1">&#9670;&nbsp;</a></span>hx509_peer_info_add_cms_alg()</h2>
47
48<div class="memitem">
49<div class="memproto">
50      <table class="memname">
51        <tr>
52          <td class="memname">int hx509_peer_info_add_cms_alg </td>
53          <td>(</td>
54          <td class="paramtype">hx509_context&#160;</td>
55          <td class="paramname"><em>context</em>, </td>
56        </tr>
57        <tr>
58          <td class="paramkey"></td>
59          <td></td>
60          <td class="paramtype">hx509_peer_info&#160;</td>
61          <td class="paramname"><em>peer</em>, </td>
62        </tr>
63        <tr>
64          <td class="paramkey"></td>
65          <td></td>
66          <td class="paramtype">const AlgorithmIdentifier *&#160;</td>
67          <td class="paramname"><em>val</em>&#160;</td>
68        </tr>
69        <tr>
70          <td></td>
71          <td>)</td>
72          <td></td><td></td>
73        </tr>
74      </table>
75</div><div class="memdoc">
76<p>Add an additional algorithm that the peer supports.</p>
77<dl class="params"><dt>Parameters</dt><dd>
78  <table class="params">
79    <tr><td class="paramname">context</td><td>A hx509 context. </td></tr>
80    <tr><td class="paramname">peer</td><td>the peer to set the new algorithms for </td></tr>
81    <tr><td class="paramname">val</td><td>an AlgorithmsIdentier to add</td></tr>
82  </table>
83  </dd>
84</dl>
85<dl class="section return"><dt>Returns</dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
86
87</div>
88</div>
89<a id="gaf4093f25751c1974c7fc65b882aac4d8"></a>
90<h2 class="memtitle"><span class="permalink"><a href="#gaf4093f25751c1974c7fc65b882aac4d8">&#9670;&nbsp;</a></span>hx509_peer_info_alloc()</h2>
91
92<div class="memitem">
93<div class="memproto">
94      <table class="memname">
95        <tr>
96          <td class="memname">int hx509_peer_info_alloc </td>
97          <td>(</td>
98          <td class="paramtype">hx509_context&#160;</td>
99          <td class="paramname"><em>context</em>, </td>
100        </tr>
101        <tr>
102          <td class="paramkey"></td>
103          <td></td>
104          <td class="paramtype">hx509_peer_info *&#160;</td>
105          <td class="paramname"><em>peer</em>&#160;</td>
106        </tr>
107        <tr>
108          <td></td>
109          <td>)</td>
110          <td></td><td></td>
111        </tr>
112      </table>
113</div><div class="memdoc">
114<p>Allocate a new peer info structure an init it to default values.</p>
115<dl class="params"><dt>Parameters</dt><dd>
116  <table class="params">
117    <tr><td class="paramname">context</td><td>A hx509 context. </td></tr>
118    <tr><td class="paramname">peer</td><td>return an allocated peer, free with <a class="el" href="group__hx509__peer.html#gae7b541b7b98303050e8ecc85935d2abc">hx509_peer_info_free()</a>.</td></tr>
119  </table>
120  </dd>
121</dl>
122<dl class="section return"><dt>Returns</dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
123
124</div>
125</div>
126<a id="gae7b541b7b98303050e8ecc85935d2abc"></a>
127<h2 class="memtitle"><span class="permalink"><a href="#gae7b541b7b98303050e8ecc85935d2abc">&#9670;&nbsp;</a></span>hx509_peer_info_free()</h2>
128
129<div class="memitem">
130<div class="memproto">
131      <table class="memname">
132        <tr>
133          <td class="memname">void hx509_peer_info_free </td>
134          <td>(</td>
135          <td class="paramtype">hx509_peer_info&#160;</td>
136          <td class="paramname"><em>peer</em></td><td>)</td>
137          <td></td>
138        </tr>
139      </table>
140</div><div class="memdoc">
141<p>Free a peer info structure.</p>
142<dl class="params"><dt>Parameters</dt><dd>
143  <table class="params">
144    <tr><td class="paramname">peer</td><td>peer info to be freed. </td></tr>
145  </table>
146  </dd>
147</dl>
148
149</div>
150</div>
151<a id="ga6462bcb987ee03fcb181834f127e5d3e"></a>
152<h2 class="memtitle"><span class="permalink"><a href="#ga6462bcb987ee03fcb181834f127e5d3e">&#9670;&nbsp;</a></span>hx509_peer_info_set_cert()</h2>
153
154<div class="memitem">
155<div class="memproto">
156      <table class="memname">
157        <tr>
158          <td class="memname">int hx509_peer_info_set_cert </td>
159          <td>(</td>
160          <td class="paramtype">hx509_peer_info&#160;</td>
161          <td class="paramname"><em>peer</em>, </td>
162        </tr>
163        <tr>
164          <td class="paramkey"></td>
165          <td></td>
166          <td class="paramtype">hx509_cert&#160;</td>
167          <td class="paramname"><em>cert</em>&#160;</td>
168        </tr>
169        <tr>
170          <td></td>
171          <td>)</td>
172          <td></td><td></td>
173        </tr>
174      </table>
175</div><div class="memdoc">
176<p>Set the certificate that remote peer is using.</p>
177<dl class="params"><dt>Parameters</dt><dd>
178  <table class="params">
179    <tr><td class="paramname">peer</td><td>peer info to update </td></tr>
180    <tr><td class="paramname">cert</td><td>cerificate of the remote peer.</td></tr>
181  </table>
182  </dd>
183</dl>
184<dl class="section return"><dt>Returns</dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
185
186</div>
187</div>
188<a id="ga4f61c86442845518d86bc2c5b30fcdb5"></a>
189<h2 class="memtitle"><span class="permalink"><a href="#ga4f61c86442845518d86bc2c5b30fcdb5">&#9670;&nbsp;</a></span>hx509_peer_info_set_cms_algs()</h2>
190
191<div class="memitem">
192<div class="memproto">
193      <table class="memname">
194        <tr>
195          <td class="memname">int hx509_peer_info_set_cms_algs </td>
196          <td>(</td>
197          <td class="paramtype">hx509_context&#160;</td>
198          <td class="paramname"><em>context</em>, </td>
199        </tr>
200        <tr>
201          <td class="paramkey"></td>
202          <td></td>
203          <td class="paramtype">hx509_peer_info&#160;</td>
204          <td class="paramname"><em>peer</em>, </td>
205        </tr>
206        <tr>
207          <td class="paramkey"></td>
208          <td></td>
209          <td class="paramtype">const AlgorithmIdentifier *&#160;</td>
210          <td class="paramname"><em>val</em>, </td>
211        </tr>
212        <tr>
213          <td class="paramkey"></td>
214          <td></td>
215          <td class="paramtype">size_t&#160;</td>
216          <td class="paramname"><em>len</em>&#160;</td>
217        </tr>
218        <tr>
219          <td></td>
220          <td>)</td>
221          <td></td><td></td>
222        </tr>
223      </table>
224</div><div class="memdoc">
225<p>Set the algorithms that the peer supports.</p>
226<dl class="params"><dt>Parameters</dt><dd>
227  <table class="params">
228    <tr><td class="paramname">context</td><td>A hx509 context. </td></tr>
229    <tr><td class="paramname">peer</td><td>the peer to set the new algorithms for </td></tr>
230    <tr><td class="paramname">val</td><td>array of supported AlgorithmsIdentiers </td></tr>
231    <tr><td class="paramname">len</td><td>length of array val.</td></tr>
232  </table>
233  </dd>
234</dl>
235<dl class="section return"><dt>Returns</dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
236
237</div>
238</div>
239</div><!-- contents -->
240<hr size="1"><address style="text-align: right;"><small>
241Generated on Tue Nov 15 2022 14:04:25 for Heimdal x509 library by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.9.1</small></address>
242</body>
243</html>
244