aboutsummaryrefslogtreecommitdiffstats
path: root/doc/doxyout/hx509/html/group__hx509__peer.html
blob: b266208f53c70260e9a48a6bc92a626de4fce6ba (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>hx509 certificate selecting functions</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<p>
<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
</p>
<!-- end of header marker -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">hx509 certificate selecting functions</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<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>
<tr class="separator:gaf4093f25751c1974c7fc65b882aac4d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:gae7b541b7b98303050e8ecc85935d2abc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ga6462bcb987ee03fcb181834f127e5d3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ga5ca456f9cc2d27e4cf034f342324f0d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ga4f61c86442845518d86bc2c5b30fcdb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga5ca456f9cc2d27e4cf034f342324f0d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5ca456f9cc2d27e4cf034f342324f0d1">&#9670;&nbsp;</a></span>hx509_peer_info_add_cms_alg()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int hx509_peer_info_add_cms_alg </td>
          <td>(</td>
          <td class="paramtype">hx509_context&#160;</td>
          <td class="paramname"><em>context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">hx509_peer_info&#160;</td>
          <td class="paramname"><em>peer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const AlgorithmIdentifier *&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Add an additional algorithm that the peer supports.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>A hx509 context. </td></tr>
    <tr><td class="paramname">peer</td><td>the peer to set the new algorithms for </td></tr>
    <tr><td class="paramname">val</td><td>an AlgorithmsIdentier to add</td></tr>
  </table>
  </dd>
</dl>
<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>

</div>
</div>
<a id="gaf4093f25751c1974c7fc65b882aac4d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf4093f25751c1974c7fc65b882aac4d8">&#9670;&nbsp;</a></span>hx509_peer_info_alloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int hx509_peer_info_alloc </td>
          <td>(</td>
          <td class="paramtype">hx509_context&#160;</td>
          <td class="paramname"><em>context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">hx509_peer_info *&#160;</td>
          <td class="paramname"><em>peer</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Allocate a new peer info structure an init it to default values.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>A hx509 context. </td></tr>
    <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>
  </table>
  </dd>
</dl>
<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>

</div>
</div>
<a id="gae7b541b7b98303050e8ecc85935d2abc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae7b541b7b98303050e8ecc85935d2abc">&#9670;&nbsp;</a></span>hx509_peer_info_free()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void hx509_peer_info_free </td>
          <td>(</td>
          <td class="paramtype">hx509_peer_info&#160;</td>
          <td class="paramname"><em>peer</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Free a peer info structure.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">peer</td><td>peer info to be freed. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga6462bcb987ee03fcb181834f127e5d3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6462bcb987ee03fcb181834f127e5d3e">&#9670;&nbsp;</a></span>hx509_peer_info_set_cert()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int hx509_peer_info_set_cert </td>
          <td>(</td>
          <td class="paramtype">hx509_peer_info&#160;</td>
          <td class="paramname"><em>peer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">hx509_cert&#160;</td>
          <td class="paramname"><em>cert</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the certificate that remote peer is using.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">peer</td><td>peer info to update </td></tr>
    <tr><td class="paramname">cert</td><td>cerificate of the remote peer.</td></tr>
  </table>
  </dd>
</dl>
<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>

</div>
</div>
<a id="ga4f61c86442845518d86bc2c5b30fcdb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4f61c86442845518d86bc2c5b30fcdb5">&#9670;&nbsp;</a></span>hx509_peer_info_set_cms_algs()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int hx509_peer_info_set_cms_algs </td>
          <td>(</td>
          <td class="paramtype">hx509_context&#160;</td>
          <td class="paramname"><em>context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">hx509_peer_info&#160;</td>
          <td class="paramname"><em>peer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const AlgorithmIdentifier *&#160;</td>
          <td class="paramname"><em>val</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the algorithms that the peer supports.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>A hx509 context. </td></tr>
    <tr><td class="paramname">peer</td><td>the peer to set the new algorithms for </td></tr>
    <tr><td class="paramname">val</td><td>array of supported AlgorithmsIdentiers </td></tr>
    <tr><td class="paramname">len</td><td>length of array val.</td></tr>
  </table>
  </dd>
</dl>
<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>

</div>
</div>
</div><!-- contents -->
<hr size="1"><address style="text-align: right;"><small>
Generated on Fri Dec 8 2017 03:48:58 for Heimdalx509library by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.8.13</small></address>
</body>
</html>