• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>ssl_stream::set_verify_callback (2 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="overload1.html" title="ssl_stream::set_verify_callback (1 of 2 overloads)">
10<link rel="next" href="../handshake.html" title="ssl_stream::handshake">
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="overload1.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="../handshake.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.overload2"></a><a class="link" href="overload2.html" title="ssl_stream::set_verify_callback (2 of 2 overloads)">ssl_stream::set_verify_callback
28          (2 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.overload2.h0"></a>
34            <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload2.synopsis"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__ssl_stream.set_verify_callback.overload2.synopsis">Synopsis</a>
35          </h7><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
36    <span class="keyword">class</span> <span class="identifier">VerifyCallback</span><span class="special">&gt;</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    <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
41</pre>
42<h7><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload2.h1"></a>
43            <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload2.description"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__ssl_stream.set_verify_callback.overload2.description">Description</a>
44          </h7><p>
45            This function is used to specify a callback function that will be called
46            by the implementation when it needs to verify a peer certificate.
47          </p>
48<h7><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload2.h2"></a>
49            <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload2.parameters"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__ssl_stream.set_verify_callback.overload2.parameters">Parameters</a>
50          </h7><div class="informaltable"><table class="table">
51<colgroup>
52<col>
53<col>
54</colgroup>
55<thead><tr>
56<th>
57                    <p>
58                      Name
59                    </p>
60                  </th>
61<th>
62                    <p>
63                      Description
64                    </p>
65                  </th>
66</tr></thead>
67<tbody>
68<tr>
69<td>
70                    <p>
71                      <code class="computeroutput"><span class="identifier">callback</span></code>
72                    </p>
73                  </td>
74<td>
75                    <p>
76                      The function object to be used for verifying a certificate.
77                      The function signature of the handler must be:
78                    </p>
79<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>
80  <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>
81  <span class="identifier">net</span><span class="special">::</span><span class="identifier">verify_context</span><span class="special">&amp;</span> <span class="identifier">ctx</span> <span class="comment">// The peer certificate and other context.</span>
82<span class="special">);</span>
83</pre>
84                    <p>
85                      The return value of the callback is true if the certificate
86                      has passed verification, false otherwise.
87                    </p>
88                  </td>
89</tr>
90<tr>
91<td>
92                    <p>
93                      <code class="computeroutput"><span class="identifier">ec</span></code>
94                    </p>
95                  </td>
96<td>
97                    <p>
98                      Set to indicate what error occurred, if any.
99                    </p>
100                  </td>
101</tr>
102</tbody>
103</table></div>
104<h7><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload2.h3"></a>
105            <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.set_verify_callback.overload2.remarks"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__ssl_stream.set_verify_callback.overload2.remarks">Remarks</a>
106          </h7><p>
107            Calls <code class="computeroutput"><span class="identifier">SSL_set_verify</span></code>.
108          </p>
109</div>
110<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
111<td align="left"></td>
112<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
113      Falco<p>
114        Distributed under the Boost Software License, Version 1.0. (See accompanying
115        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>)
116      </p>
117</div></td>
118</tr></table>
119<hr>
120<div class="spirit-nav">
121<a accesskey="p" href="overload1.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="../handshake.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
122</div>
123</body>
124</html>
125