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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>rabbitmq-c: amqp_ssl_socket.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">rabbitmq-c
 <span id="projectnumber">0.8.0</span>
</div>
<div id="projectbrief">C AMQP Client library for RabbitMQ</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_df8d7e2f392872630f707837372814f7.html">librabbitmq</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">amqp_ssl_socket.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="amqp__ssl__socket_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a6607a4a1159d188b6ee701594a27813b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>amqp_tls_version_t</b> { <b>AMQP_TLSv1</b> = 1,
<b>AMQP_TLSv1_1</b> = 2,
<b>AMQP_TLSv1_2</b> = 3,
<b>AMQP_TLSvLATEST</b> = 0xFFFF
}</td></tr>
<tr class="separator:a6607a4a1159d188b6ee701594a27813b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a18ba2a9523640d277addd7d42f3a4ddd"><td class="memItemLeft" align="right" valign="top">amqp_socket_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="amqp__ssl__socket_8h.html#a18ba2a9523640d277addd7d42f3a4ddd">amqp_ssl_socket_new</a> (<a class="el" href="amqp_8h.html#a59cfdff3bfbf28aba201be5636365fa4">amqp_connection_state_t</a> state)</td></tr>
<tr class="memdesc:a18ba2a9523640d277addd7d42f3a4ddd"><td class="mdescLeft"> </td><td class="mdescRight">Create a new SSL/TLS socket object. <a href="#a18ba2a9523640d277addd7d42f3a4ddd">More...</a><br/></td></tr>
<tr class="separator:a18ba2a9523640d277addd7d42f3a4ddd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ae1182330eb88aec6bb3142e916c120"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="amqp__ssl__socket_8h.html#a8ae1182330eb88aec6bb3142e916c120">amqp_ssl_socket_set_cacert</a> (amqp_socket_t *self, const char *cacert)</td></tr>
<tr class="memdesc:a8ae1182330eb88aec6bb3142e916c120"><td class="mdescLeft"> </td><td class="mdescRight">Set the CA certificate. <a href="#a8ae1182330eb88aec6bb3142e916c120">More...</a><br/></td></tr>
<tr class="separator:a8ae1182330eb88aec6bb3142e916c120"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab524d43fc8f37ff2bc63942fc56d6d32"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="amqp__ssl__socket_8h.html#ab524d43fc8f37ff2bc63942fc56d6d32">amqp_ssl_socket_set_key</a> (amqp_socket_t *self, const char *cert, const char *key)</td></tr>
<tr class="memdesc:ab524d43fc8f37ff2bc63942fc56d6d32"><td class="mdescLeft"> </td><td class="mdescRight">Set the client key. <a href="#ab524d43fc8f37ff2bc63942fc56d6d32">More...</a><br/></td></tr>
<tr class="separator:ab524d43fc8f37ff2bc63942fc56d6d32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d338d4ff56266e9300095545d2bde82"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="amqp__ssl__socket_8h.html#a5d338d4ff56266e9300095545d2bde82">amqp_ssl_socket_set_key_buffer</a> (amqp_socket_t *self, const char *cert, const void *key, size_t n)</td></tr>
<tr class="memdesc:a5d338d4ff56266e9300095545d2bde82"><td class="mdescLeft"> </td><td class="mdescRight">Set the client key from a buffer. <a href="#a5d338d4ff56266e9300095545d2bde82">More...</a><br/></td></tr>
<tr class="separator:a5d338d4ff56266e9300095545d2bde82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b812546139cc95e493c385fb2c0898b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="amqp__ssl__socket_8h.html#a0b812546139cc95e493c385fb2c0898b">amqp_ssl_socket_set_verify</a> (amqp_socket_t *self, <a class="el" href="amqp_8h.html#a67852bce88f5784b60b8f873fd4673f2">amqp_boolean_t</a> verify)</td></tr>
<tr class="memdesc:a0b812546139cc95e493c385fb2c0898b"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable peer verification. <a href="#a0b812546139cc95e493c385fb2c0898b">More...</a><br/></td></tr>
<tr class="separator:a0b812546139cc95e493c385fb2c0898b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66de25b7a36144f849cee2e680f1b802"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="amqp__ssl__socket_8h.html#a66de25b7a36144f849cee2e680f1b802">amqp_ssl_socket_set_verify_peer</a> (amqp_socket_t *self, <a class="el" href="amqp_8h.html#a67852bce88f5784b60b8f873fd4673f2">amqp_boolean_t</a> verify)</td></tr>
<tr class="memdesc:a66de25b7a36144f849cee2e680f1b802"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable peer verification. <a href="#a66de25b7a36144f849cee2e680f1b802">More...</a><br/></td></tr>
<tr class="separator:a66de25b7a36144f849cee2e680f1b802"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6c56816db2c6c408138449944fa9da8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="amqp__ssl__socket_8h.html#ae6c56816db2c6c408138449944fa9da8">amqp_ssl_socket_set_verify_hostname</a> (amqp_socket_t *self, <a class="el" href="amqp_8h.html#a67852bce88f5784b60b8f873fd4673f2">amqp_boolean_t</a> verify)</td></tr>
<tr class="memdesc:ae6c56816db2c6c408138449944fa9da8"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable hostname verification. <a href="#ae6c56816db2c6c408138449944fa9da8">More...</a><br/></td></tr>
<tr class="separator:ae6c56816db2c6c408138449944fa9da8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae58f254f29772a40b43664804ff2cec6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="amqp__ssl__socket_8h.html#ae58f254f29772a40b43664804ff2cec6">amqp_ssl_socket_set_ssl_versions</a> (amqp_socket_t *self, amqp_tls_version_t min, amqp_tls_version_t max)</td></tr>
<tr class="memdesc:ae58f254f29772a40b43664804ff2cec6"><td class="mdescLeft"> </td><td class="mdescRight">Set min and max TLS versions. <a href="#ae58f254f29772a40b43664804ff2cec6">More...</a><br/></td></tr>
<tr class="separator:ae58f254f29772a40b43664804ff2cec6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9daaddeaf204c9ff0d9e23bbef7af33a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="amqp__ssl__socket_8h.html#a9daaddeaf204c9ff0d9e23bbef7af33a">amqp_set_initialize_ssl_library</a> (<a class="el" href="amqp_8h.html#a67852bce88f5784b60b8f873fd4673f2">amqp_boolean_t</a> do_initialize)</td></tr>
<tr class="memdesc:a9daaddeaf204c9ff0d9e23bbef7af33a"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether rabbitmq-c initializes the underlying SSL library. <a href="#a9daaddeaf204c9ff0d9e23bbef7af33a">More...</a><br/></td></tr>
<tr class="separator:a9daaddeaf204c9ff0d9e23bbef7af33a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a9daaddeaf204c9ff0d9e23bbef7af33a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void amqp_set_initialize_ssl_library </td>
<td>(</td>
<td class="paramtype"><a class="el" href="amqp_8h.html#a67852bce88f5784b60b8f873fd4673f2">amqp_boolean_t</a> </td>
<td class="paramname"><em>do_initialize</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether rabbitmq-c initializes the underlying SSL library. </p>
<p>For SSL libraries that require a one-time initialization across a whole program (e.g., OpenSSL) this sets whether or not rabbitmq-c will initialize the SSL library when the first call to <a class="el" href="amqp_8h.html#a019214cc135f14a88ce4ed37976d5e40" title="Open a socket to a remote host. ">amqp_open_socket()</a> is made. You should call this function with do_init = 0 if the underlying SSL library is initialized somewhere else the program.</p>
<p>Failing to initialize or double initialization of the SSL library will result in undefined behavior</p>
<p>By default rabbitmq-c will initialize the underlying SSL library</p>
<p>NOTE: calling this function after the first socket has been opened with <a class="el" href="amqp_8h.html#a019214cc135f14a88ce4ed37976d5e40" title="Open a socket to a remote host. ">amqp_open_socket()</a> will not have any effect.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">do_initialize</td><td>If 0 rabbitmq-c will not initialize the SSL library, otherwise rabbitmq-c will initialize the SSL library</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>v0.4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a18ba2a9523640d277addd7d42f3a4ddd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">amqp_socket_t* amqp_ssl_socket_new </td>
<td>(</td>
<td class="paramtype"><a class="el" href="amqp_8h.html#a59cfdff3bfbf28aba201be5636365fa4">amqp_connection_state_t</a> </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new SSL/TLS socket object. </p>
<p>The returned socket object is owned by the <a class="el" href="amqp_8h.html#a59cfdff3bfbf28aba201be5636365fa4">amqp_connection_state_t</a> object and will be destroyed when the state object is destroyed or a new socket object is created.</p>
<p>If the socket object creation fails, the <a class="el" href="amqp_8h.html#a59cfdff3bfbf28aba201be5636365fa4">amqp_connection_state_t</a> object will not be changed.</p>
<p>The object returned by this function can be retrieved from the amqp_connection_state_t object later using the <a class="el" href="amqp_8h.html#a3b278d46595f88213c486772d969ae1a" title="Get the socket object associated with a amqp_connection_state_t. ">amqp_get_socket()</a> function.</p>
<p>Calling this function may result in the underlying SSL library being initialized. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="amqp__ssl__socket_8h.html#a9daaddeaf204c9ff0d9e23bbef7af33a" title="Sets whether rabbitmq-c initializes the underlying SSL library. ">amqp_set_initialize_ssl_library()</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">state</td><td>The connection object that owns the SSL/TLS socket </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new socket object or NULL if an error occurred.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>v0.4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a8ae1182330eb88aec6bb3142e916c120"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int amqp_ssl_socket_set_cacert </td>
<td>(</td>
<td class="paramtype">amqp_socket_t * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cacert</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the CA certificate. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">self</td><td>An SSL/TLS socket object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cacert</td><td>Path to the CA cert file in PEM format.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="amqp_8h.html#a05dadc32b3a59918206ac38a53606723aa108d3c3d0cfc8e04aa123309b03708d">AMQP_STATUS_OK</a> on success an <a class="el" href="amqp_8h.html#a05dadc32b3a59918206ac38a53606723">amqp_status_enum</a> value on failure.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>v0.4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ab524d43fc8f37ff2bc63942fc56d6d32"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int amqp_ssl_socket_set_key </td>
<td>(</td>
<td class="paramtype">amqp_socket_t * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cert</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the client key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">self</td><td>An SSL/TLS socket object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cert</td><td>Path to the client certificate in PEM foramt. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>Path to the client key in PEM format.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="amqp_8h.html#a05dadc32b3a59918206ac38a53606723aa108d3c3d0cfc8e04aa123309b03708d">AMQP_STATUS_OK</a> on success an <a class="el" href="amqp_8h.html#a05dadc32b3a59918206ac38a53606723">amqp_status_enum</a> value on failure.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>v0.4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a5d338d4ff56266e9300095545d2bde82"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int amqp_ssl_socket_set_key_buffer </td>
<td>(</td>
<td class="paramtype">amqp_socket_t * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cert</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>n</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the client key from a buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">self</td><td>An SSL/TLS socket object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cert</td><td>Path to the client certificate in PEM foramt. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>A buffer containing client key in PEM format. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>The length of the buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="amqp_8h.html#a05dadc32b3a59918206ac38a53606723aa108d3c3d0cfc8e04aa123309b03708d">AMQP_STATUS_OK</a> on success an <a class="el" href="amqp_8h.html#a05dadc32b3a59918206ac38a53606723">amqp_status_enum</a> value on failure.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>v0.4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ae58f254f29772a40b43664804ff2cec6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int amqp_ssl_socket_set_ssl_versions </td>
<td>(</td>
<td class="paramtype">amqp_socket_t * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">amqp_tls_version_t </td>
<td class="paramname"><em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">amqp_tls_version_t </td>
<td class="paramname"><em>max</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set min and max TLS versions. </p>
<p>Set the oldest and newest acceptable TLS versions that are acceptable when connecting to the broker. Set min == max to restrict to just that version.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">self</td><td>An SSL/TLS socket object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">min</td><td>the minimum acceptable TLS version </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">max</td><td>the maxmium acceptable TLS version </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>AMQP_STATUS_OK on success, AMQP_STATUS_UNSUPPORTED if OpenSSL does not support the requested TLS version, AMQP_STATUS_INVALID_PARAMETER if an invalid combination of parameters is passed.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>v0.8.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a0b812546139cc95e493c385fb2c0898b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void amqp_ssl_socket_set_verify </td>
<td>(</td>
<td class="paramtype">amqp_socket_t * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="amqp_8h.html#a67852bce88f5784b60b8f873fd4673f2">amqp_boolean_t</a> </td>
<td class="paramname"><em>verify</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable or disable peer verification. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>use and instead.</dd></dl>
<p>If peer verification is enabled then the common name in the server certificate must match the server name. Peer verification is enabled by default.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">self</td><td>An SSL/TLS socket object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">verify</td><td>Enable or disable peer verification.</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>v0.4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ae6c56816db2c6c408138449944fa9da8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void amqp_ssl_socket_set_verify_hostname </td>
<td>(</td>
<td class="paramtype">amqp_socket_t * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="amqp_8h.html#a67852bce88f5784b60b8f873fd4673f2">amqp_boolean_t</a> </td>
<td class="paramname"><em>verify</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable or disable hostname verification. </p>
<p>Hostname verification checks the broker cert for a CN or SAN that matches the hostname that <a class="el" href="amqp_8h.html#aaa1a4f870da40120d8c544822bf63f51" title="Open a socket connection. ">amqp_socket_open()</a> is presented. Peer verification is controlled by </p>
<dl class="section since"><dt>Since</dt><dd>v0.8.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a66de25b7a36144f849cee2e680f1b802"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void amqp_ssl_socket_set_verify_peer </td>
<td>(</td>
<td class="paramtype">amqp_socket_t * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="amqp_8h.html#a67852bce88f5784b60b8f873fd4673f2">amqp_boolean_t</a> </td>
<td class="paramname"><em>verify</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable or disable peer verification. </p>
<p>Peer verification validates the certificate chain that is sent by the broker. Hostname validation is controlled by .</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">self</td><td>An SSL/TLS socket object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">verify</td><td>enable or disable peer validation</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>v0.8.0 </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Apr 9 2016 21:59:28 for rabbitmq-c by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|
