~ubuntu-branches/debian/sid/boost1.49/sid

« back to all changes in this revision

Viewing changes to doc/html/boost_asio/reference/ssl__context/set_verify_callback/overload2.html

  • Committer: Package Import Robot
  • Author(s): Steve M. Robbins
  • Date: 2012-02-26 00:31:44 UTC
  • Revision ID: package-import@ubuntu.com-20120226003144-eaytp12cbf6ubpms
Tags: upstream-1.49.0
ImportĀ upstreamĀ versionĀ 1.49.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>ssl::context::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.76.1">
 
7
<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
 
8
<link rel="up" href="../set_verify_callback.html" title="ssl::context::set_verify_callback">
 
9
<link rel="prev" href="overload1.html" title="ssl::context::set_verify_callback (1 of 2 overloads)">
 
10
<link rel="next" href="../set_verify_mode.html" title="ssl::context::set_verify_mode">
 
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="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../set_verify_mode.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 
24
</div>
 
25
<div class="section">
 
26
<div class="titlepage"><div><div><h5 class="title">
 
27
<a name="boost_asio.reference.ssl__context.set_verify_callback.overload2"></a><a class="link" href="overload2.html" title="ssl::context::set_verify_callback (2 of 2 overloads)">ssl::context::set_verify_callback
 
28
          (2 of 2 overloads)</a>
 
29
</h5></div></div></div>
 
30
<p>
 
31
            Set the callback used to verify peer certificates.
 
32
          </p>
 
33
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
 
34
    <span class="keyword">typename</span> <span class="identifier">VerifyCallback</span><span class="special">&gt;</span>
 
35
<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="identifier">set_verify_callback</span><span class="special">(</span>
 
36
    <span class="identifier">VerifyCallback</span> <span class="identifier">callback</span><span class="special">,</span>
 
37
    <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>
 
38
</pre>
 
39
<p>
 
40
            This function is used to specify a callback function that will be called
 
41
            by the implementation when it needs to verify a peer certificate.
 
42
          </p>
 
43
<h6>
 
44
<a name="boost_asio.reference.ssl__context.set_verify_callback.overload2.h0"></a>
 
45
            <span><a name="boost_asio.reference.ssl__context.set_verify_callback.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.ssl__context.set_verify_callback.overload2.parameters">Parameters</a>
 
46
          </h6>
 
47
<div class="variablelist">
 
48
<p class="title"><b></b></p>
 
49
<dl>
 
50
<dt><span class="term">callback</span></dt>
 
51
<dd>
 
52
<p>
 
53
                  The function object to be used for verifying a certificate. The
 
54
                  function signature of the handler must be:
 
55
</p>
 
56
<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">verify_callback</span><span class="special">(</span>
 
57
  <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>
 
58
  <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>
 
59
<span class="special">);</span>
 
60
</pre>
 
61
<p>
 
62
                  The return value of the callback is true if the certificate has
 
63
                  passed verification, false otherwise.
 
64
                </p>
 
65
</dd>
 
66
<dt><span class="term">ec</span></dt>
 
67
<dd><p>
 
68
                  Set to indicate what error occurred, if any.
 
69
                </p></dd>
 
70
</dl>
 
71
</div>
 
72
<h6>
 
73
<a name="boost_asio.reference.ssl__context.set_verify_callback.overload2.h1"></a>
 
74
            <span><a name="boost_asio.reference.ssl__context.set_verify_callback.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.ssl__context.set_verify_callback.overload2.remarks">Remarks</a>
 
75
          </h6>
 
76
<p>
 
77
            Calls <code class="computeroutput"><span class="identifier">SSL_CTX_set_verify</span></code>.
 
78
          </p>
 
79
</div>
 
80
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 
81
<td align="left"></td>
 
82
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2012 Christopher M. Kohlhoff<p>
 
83
        Distributed under the Boost Software License, Version 1.0. (See accompanying
 
84
        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>)
 
85
      </p>
 
86
</div></td>
 
87
</tr></table>
 
88
<hr>
 
89
<div class="spirit-nav">
 
90
<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="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../set_verify_mode.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 
91
</div>
 
92
</body>
 
93
</html>