1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>ssl::context::set_password_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="../../../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../set_password_callback.html" title="ssl::context::set_password_callback"> 9<link rel="prev" href="../set_password_callback.html" title="ssl::context::set_password_callback"> 10<link rel="next" href="overload2.html" title="ssl::context::set_password_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_password_callback.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set_password_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="overload2.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_password_callback.overload1"></a><a class="link" href="overload1.html" title="ssl::context::set_password_callback (1 of 2 overloads)">ssl::context::set_password_callback 28 (1 of 2 overloads)</a> 29</h5></div></div></div> 30<p> 31 Set the password callback. 32 </p> 33<pre class="programlisting">template< 34 typename PasswordCallback> 35void set_password_callback( 36 PasswordCallback callback); 37</pre> 38<p> 39 This function is used to specify a callback function to obtain password 40 information about an encrypted key in PEM format. 41 </p> 42<h6> 43<a name="boost_asio.reference.ssl__context.set_password_callback.overload1.h0"></a> 44 <span class="phrase"><a name="boost_asio.reference.ssl__context.set_password_callback.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.ssl__context.set_password_callback.overload1.parameters">Parameters</a> 45 </h6> 46<div class="variablelist"> 47<p class="title"><b></b></p> 48<dl class="variablelist"> 49<dt><span class="term">callback</span></dt> 50<dd> 51<p> 52 The function object to be used for obtaining the password. The 53 function signature of the handler must be: 54</p> 55<pre class="programlisting">std::string password_callback( 56 std::size_t max_length, // The maximum size for a password. 57 password_purpose purpose // Whether password is for reading or writing. 58); 59</pre> 60<p> 61 The return value of the callback is a string containing the password. 62 </p> 63</dd> 64</dl> 65</div> 66<h6> 67<a name="boost_asio.reference.ssl__context.set_password_callback.overload1.h1"></a> 68 <span class="phrase"><a name="boost_asio.reference.ssl__context.set_password_callback.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.ssl__context.set_password_callback.overload1.exceptions">Exceptions</a> 69 </h6> 70<div class="variablelist"> 71<p class="title"><b></b></p> 72<dl class="variablelist"> 73<dt><span class="term">boost::system::system_error</span></dt> 74<dd><p> 75 Thrown on failure. 76 </p></dd> 77</dl> 78</div> 79<h6> 80<a name="boost_asio.reference.ssl__context.set_password_callback.overload1.h2"></a> 81 <span class="phrase"><a name="boost_asio.reference.ssl__context.set_password_callback.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.ssl__context.set_password_callback.overload1.remarks">Remarks</a> 82 </h6> 83<p> 84 Calls <code class="computeroutput">SSL_CTX_set_default_passwd_cb</code>. 85 </p> 86</div> 87<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 88<td align="left"></td> 89<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 90 Kohlhoff<p> 91 Distributed under the Boost Software License, Version 1.0. (See accompanying 92 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>) 93 </p> 94</div></td> 95</tr></table> 96<hr> 97<div class="spirit-nav"> 98<a accesskey="p" href="../set_password_callback.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set_password_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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 99</div> 100</body> 101</html> 102
