boost/asio
2
0
Fork 0
mirror of https://github.com/boostorg/asio.git synced 2026-01-29 19:12:09 +00:00
Code Issues Projects Releases Wiki Activity

Fix errors in SSL overview and add a note about handshaking. Fixes #2617 and #2619.

Browse Source 
[SVN r50950]
This commit is contained in:
Christopher Kohlhoff
2009-02-01 13:42:33 +00:00
parent 82ed5cb275
commit ebd662f38f
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/overview/ssl.qbk
View File

@@ -16,7 +16,7 @@ context object. This object is used to set SSL options such as verification
mode, certificate files, and so on. As an illustration, client-side
initialisation may look something like:
ssl::context ctx(io_service, ssl::context::sslv23);
ssl::context ctx(my_io_service, ssl::context::sslv23);
ctx.set_verify_mode(ssl::context::verify_peer);
ctx.load_verify_file("ca.pem");
@@ -29,7 +29,7 @@ connection or accepting an incoming one, the underlying socket must first be
obtained using the `ssl::stream` template's [link
boost_asio.reference.ssl__stream.lowest_layer `lowest_layer()`] member function:
ip::tcp::socket& sock = ssl_sock.lowest_layer();
ip::tcp::socket::lowest_layer_type& sock = ssl_sock.lowest_layer();
sock.connect(my_endpoint);
In some use cases the underlying stream object will need to have a longer
@@ -39,6 +39,12 @@ reference to the stream type:
ip::tcp::socket sock(my_io_service);
ssl::stream<ip::tcp::socket&> ssl_sock(sock, ctx);
SSL handshaking must be performed prior to transmitting or receiving data over
an encrypted connection. This is accomplished using the `ssl::stream`
template's [link boost_asio.reference.ssl__stream.handshake handshake()] or
[link boost_asio.reference.ssl__stream.async_handshake async_handshake()] member
functions.
Once connected, SSL stream objects are used as synchronous or asynchronous read
and write streams. This means the objects can be used with any of the [link
boost_asio.reference.read read()], [link boost_asio.reference.async_read async_read()],