1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>ssl_stream::set_verify_callback (1 of 2 overloads)</title> 5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../../index.html" title="Chapter 1. Boost.Beast"> 8<link rel="up" href="../set_verify_callback.html" title="ssl_stream::set_verify_callback"> 9<link rel="prev" href="../set_verify_callback.html" title="ssl_stream::set_verify_callback"> 10<link rel="next" href="overload2.html" title="ssl_stream::set_verify_callback (2 of 2 overloads)"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="../set_verify_callback.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_callback.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h6 class="title"> 27<a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1"></a><a class="link" href="overload1.html" title="ssl_stream::set_verify_callback (1 of 2 overloads)">ssl_stream::set_verify_callback 28 (1 of 2 overloads)</a> 29</h6></div></div></div> 30<p> 31 Set the callback used to verify peer certificates. 32 </p> 33<h7><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 36 <span class="keyword">class</span> <span class="identifier">VerifyCallback</span><span class="special">></span> 37<span class="keyword">void</span> 38<span class="identifier">set_verify_callback</span><span class="special">(</span> 39 <span class="identifier">VerifyCallback</span> <span class="identifier">callback</span><span class="special">);</span> 40</pre> 41<h7><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.h1"></a> 42 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.description">Description</a> 43 </h7><p> 44 This function is used to specify a callback function that will be called 45 by the implementation when it needs to verify a peer certificate. 46 </p> 47<h7><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.h2"></a> 48 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.parameters">Parameters</a> 49 </h7><div class="informaltable"><table class="table"> 50<colgroup> 51<col> 52<col> 53</colgroup> 54<thead><tr> 55<th> 56 <p> 57 Name 58 </p> 59 </th> 60<th> 61 <p> 62 Description 63 </p> 64 </th> 65</tr></thead> 66<tbody><tr> 67<td> 68 <p> 69 <code class="computeroutput"><span class="identifier">callback</span></code> 70 </p> 71 </td> 72<td> 73 <p> 74 The function object to be used for verifying a certificate. 75 The function signature of the handler must be: 76 </p> 77<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"> <span class="keyword">bool</span> <span class="identifier">verify_callback</span><span class="special">(</span> 78 <span class="keyword">bool</span> <span class="identifier">preverified</span><span class="special">,</span> <span class="comment">// True if the certificate passed pre-verification.</span> 79 <span class="identifier">verify_context</span><span class="special">&</span> <span class="identifier">ctx</span> <span class="comment">// The peer certificate and other context.</span> 80<span class="special">);</span> 81</pre> 82 <p> 83 The return value of the callback is true if the certificate 84 has passed verification, false otherwise. 85 </p> 86 </td> 87</tr></tbody> 88</table></div> 89<h7><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.h3"></a> 90 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.exceptions"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.exceptions">Exceptions</a> 91 </h7><div class="informaltable"><table class="table"> 92<colgroup> 93<col> 94<col> 95</colgroup> 96<thead><tr> 97<th> 98 <p> 99 Type 100 </p> 101 </th> 102<th> 103 <p> 104 Thrown On 105 </p> 106 </th> 107</tr></thead> 108<tbody><tr> 109<td> 110 <p> 111 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">system_error</span></code> 112 </p> 113 </td> 114<td> 115 <p> 116 Thrown on failure. 117 </p> 118 </td> 119</tr></tbody> 120</table></div> 121<h7><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.h4"></a> 122 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.remarks"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.set_verify_callback.overload1.remarks">Remarks</a> 123 </h7><p> 124 Calls <code class="computeroutput"><span class="identifier">SSL_set_verify</span></code>. 125 </p> 126</div> 127<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 128<td align="left"></td> 129<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 130 Falco<p> 131 Distributed under the Boost Software License, Version 1.0. (See accompanying 132 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 133 </p> 134</div></td> 135</tr></table> 136<hr> 137<div class="spirit-nav"> 138<a accesskey="p" href="../set_verify_callback.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_callback.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 139</div> 140</body> 141</html> 142
