websocketpp  0.6.0
C++/Boost Asio based websocket client/server library
tls.hpp
1 /*
2  * Copyright (c) 2015, Peter Thorson. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  * * Redistributions of source code must retain the above copyright
7  * notice, this list of conditions and the following disclaimer.
8  * * Redistributions in binary form must reproduce the above copyright
9  * notice, this list of conditions and the following disclaimer in the
10  * documentation and/or other materials provided with the distribution.
11  * * Neither the name of the WebSocket++ Project nor the
12  * names of its contributors may be used to endorse or promote products
13  * derived from this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
19  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  */
27 
28 #ifndef WEBSOCKETPP_TRANSPORT_SECURITY_TLS_HPP
29 #define WEBSOCKETPP_TRANSPORT_SECURITY_TLS_HPP
30 
31 #include <websocketpp/transport/asio/security/base.hpp>
32 
33 #include <websocketpp/uri.hpp>
34 
35 #include <websocketpp/common/asio.hpp>
36 #include <websocketpp/common/asio_ssl.hpp>
37 #include <websocketpp/common/connection_hdl.hpp>
38 #include <websocketpp/common/functional.hpp>
39 #include <websocketpp/common/memory.hpp>
40 
41 #include <sstream>
42 #include <string>
43 
44 namespace websocketpp {
45 namespace transport {
46 namespace asio {
49 namespace tls_socket {
50 
52 typedef lib::function<void(connection_hdl,lib::asio::ssl::stream<
53  lib::asio::ip::tcp::socket>&)> socket_init_handler;
55 typedef lib::function<lib::shared_ptr<lib::asio::ssl::context>(connection_hdl)>
57 
59 
63 class connection : public lib::enable_shared_from_this<connection> {
64 public:
66  typedef connection type;
68  typedef lib::shared_ptr<type> ptr;
69 
71  typedef lib::asio::ssl::stream<lib::asio::ip::tcp::socket> socket_type;
73  typedef lib::shared_ptr<socket_type> socket_ptr;
75  typedef lib::asio::io_service * io_service_ptr;
77  typedef lib::shared_ptr<lib::asio::io_service::strand> strand_ptr;
79  typedef lib::shared_ptr<lib::asio::ssl::context> context_ptr;
80 
81  explicit connection() {
82  //std::cout << "transport::asio::tls_socket::connection constructor"
83  // << std::endl;
84  }
85 
87  ptr get_shared() {
88  return shared_from_this();
89  }
90 
92 
95  bool is_secure() const {
96  return true;
97  }
98 
100 
103  socket_type::lowest_layer_type & get_raw_socket() {
104  return m_socket->lowest_layer();
105  }
106 
108 
111  socket_type::next_layer_type & get_next_layer() {
112  return m_socket->next_layer();
113  }
114 
116 
119  socket_type & get_socket() {
120  return *m_socket;
121  }
122 
124 
131  void set_socket_init_handler(socket_init_handler h) {
132  m_socket_init_handler = h;
133  }
134 
136 
145  m_tls_init_handler = h;
146  }
147 
149 
158  std::string get_remote_endpoint(lib::error_code & ec) const {
159  std::stringstream s;
160 
161  lib::asio::error_code aec;
162  lib::asio::ip::tcp::endpoint ep = m_socket->lowest_layer().remote_endpoint(aec);
163 
164  if (aec) {
166  s << "Error getting remote endpoint: " << aec
167  << " (" << aec.message() << ")";
168  return s.str();
169  } else {
170  ec = lib::error_code();
171  s << ep;
172  return s.str();
173  }
174  }
175 protected:
177 
185  lib::error_code init_asio (io_service_ptr service, strand_ptr strand,
186  bool is_server)
187  {
188  if (!m_tls_init_handler) {
189  return socket::make_error_code(socket::error::missing_tls_init_handler);
190  }
191  m_context = m_tls_init_handler(m_hdl);
192 
193  if (!m_context) {
194  return socket::make_error_code(socket::error::invalid_tls_context);
195  }
196  m_socket = lib::make_shared<socket_type>(
197  _WEBSOCKETPP_REF(*service),lib::ref(*m_context));
198 
199  m_io_service = service;
200  m_strand = strand;
201  m_is_server = is_server;
202 
203  return lib::error_code();
204  }
205 
207 
218  void set_uri(uri_ptr u) {
219  m_uri = u;
220  }
221 
223 
231  void pre_init(init_handler callback) {
232  // TODO: is this the best way to check whether this function is
233  // available in the version of OpenSSL being used?
234  // TODO: consider case where host is an IP address
235 #if OPENSSL_VERSION_NUMBER >= 0x90812f
236  if (!m_is_server) {
237  // For clients on systems with a suitable OpenSSL version, set the
238  // TLS SNI hostname header so connecting to TLS servers using SNI
239  // will work.
240  long res = SSL_set_tlsext_host_name(
241  get_socket().native_handle(), m_uri->get_host().c_str());
242  if (!(1 == res)) {
243  callback(socket::make_error_code(socket::error::tls_failed_sni_hostname));
244  }
245  }
246 #endif
247 
248  if (m_socket_init_handler) {
249  m_socket_init_handler(m_hdl,get_socket());
250  }
251 
252  callback(lib::error_code());
253  }
254 
256 
263  void post_init(init_handler callback) {
264  m_ec = socket::make_error_code(socket::error::tls_handshake_timeout);
265 
266  // TLS handshake
267  if (m_strand) {
268  m_socket->async_handshake(
269  get_handshake_type(),
270  m_strand->wrap(lib::bind(
271  &type::handle_init, get_shared(),
272  callback,
273  lib::placeholders::_1
274  ))
275  );
276  } else {
277  m_socket->async_handshake(
278  get_handshake_type(),
279  lib::bind(
280  &type::handle_init, get_shared(),
281  callback,
282  lib::placeholders::_1
283  )
284  );
285  }
286  }
287 
289 
296  m_hdl = hdl;
297  }
298 
299  void handle_init(init_handler callback,lib::asio::error_code const & ec) {
300  if (ec) {
301  m_ec = socket::make_error_code(socket::error::tls_handshake_failed);
302  } else {
303  m_ec = lib::error_code();
304  }
305 
306  callback(m_ec);
307  }
308 
309  lib::error_code get_ec() const {
310  return m_ec;
311  }
312 
314  void cancel_socket() {
315  get_raw_socket().cancel();
316  }
317 
318  void async_shutdown(socket_shutdown_handler callback) {
319  m_socket->async_shutdown(callback);
320  }
321 
323 
337  lib::error_code translate_ec(boost::system::error_code ec) {
338  if (ec.category() == lib::asio::error::get_ssl_category()) {
339  if (ERR_GET_REASON(ec.value()) == SSL_R_SHORT_READ) {
340  return make_error_code(transport::error::tls_short_read);
341  } else {
342  // We know it is a TLS related error, but otherwise don't know
343  // more. Pass through as TLS generic.
344  return make_error_code(transport::error::tls_error);
345  }
346  } else {
347  // We don't know any more information about this error so pass
348  // through
349  return make_error_code(transport::error::pass_through);
350  }
351  }
352 private:
353  socket_type::handshake_type get_handshake_type() {
354  if (m_is_server) {
355  return lib::asio::ssl::stream_base::server;
356  } else {
357  return lib::asio::ssl::stream_base::client;
358  }
359  }
360 
361  io_service_ptr m_io_service;
362  strand_ptr m_strand;
363  context_ptr m_context;
364  socket_ptr m_socket;
365  uri_ptr m_uri;
366  bool m_is_server;
367 
368  lib::error_code m_ec;
369 
370  connection_hdl m_hdl;
371  socket_init_handler m_socket_init_handler;
372  tls_init_handler m_tls_init_handler;
373 };
374 
376 
380 class endpoint {
381 public:
383  typedef endpoint type;
384 
390 
391  explicit endpoint() {}
392 
394 
397  bool is_secure() const {
398  return true;
399  }
400 
402 
409  void set_socket_init_handler(socket_init_handler h) {
410  m_socket_init_handler = h;
411  }
412 
414 
423  m_tls_init_handler = h;
424  }
425 protected:
427 
435  lib::error_code init(socket_con_ptr scon) {
436  scon->set_socket_init_handler(m_socket_init_handler);
437  scon->set_tls_init_handler(m_tls_init_handler);
438  return lib::error_code();
439  }
440 
441 private:
442  socket_init_handler m_socket_init_handler;
443  tls_init_handler m_tls_init_handler;
444 };
445 
446 } // namespace tls_socket
447 } // namespace asio
448 } // namespace transport
449 } // namespace websocketpp
450 
451 #endif // WEBSOCKETPP_TRANSPORT_SECURITY_TLS_HPP
TLS enabled Boost ASIO connection socket component.
Definition: tls.hpp:63
socket_type & get_socket()
Retrieve a pointer to the wrapped socket.
Definition: tls.hpp:119
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection socket component.
Definition: tls.hpp:68
lib::error_code make_error_code(error::value e)
Create an error code with the given value and the asio transport category.
Definition: base.hpp:220
bool is_secure() const
Checks whether the endpoint creates secure connections.
Definition: tls.hpp:397
void pre_init(init_handler callback)
Pre-initialize security policy.
Definition: tls.hpp:231
bool is_secure() const
Check whether or not this connection is secure.
Definition: tls.hpp:95
connection type
Type of this connection socket component.
Definition: tls.hpp:66
void set_handle(connection_hdl hdl)
Sets the connection handle.
Definition: tls.hpp:295
lib::weak_ptr< void > connection_hdl
A handle to uniquely identify a connection.
lib::function< lib::shared_ptr< lib::asio::ssl::context >connection_hdl)> tls_init_handler
The signature of the tls_init_handler for this socket policy.
Definition: tls.hpp:56
lib::error_code init(socket_con_ptr scon)
Initialize a connection.
Definition: tls.hpp:435
underlying transport pass through
Definition: connection.hpp:153
socket_type::next_layer_type & get_next_layer()
Retrieve a pointer to the layer below the ssl stream.
Definition: tls.hpp:111
connection socket_con_type
The type of the corresponding connection socket component.
Definition: tls.hpp:386
std::string get_remote_endpoint(lib::error_code &ec) const
Get the remote endpoint address.
Definition: tls.hpp:158
void set_tls_init_handler(tls_init_handler h)
Set TLS init handler.
Definition: tls.hpp:422
lib::shared_ptr< lib::asio::ssl::context > context_ptr
Type of a shared pointer to the ASIO TLS context being used.
Definition: tls.hpp:79
lib::error_code translate_ec(boost::system::error_code ec)
Translate any security policy specific information about an error code.
Definition: tls.hpp:337
void set_uri(uri_ptr u)
Set hostname hook.
Definition: tls.hpp:218
lib::shared_ptr< socket_type > socket_ptr
Type of a shared pointer to the ASIO socket being used.
Definition: tls.hpp:73
void set_socket_init_handler(socket_init_handler h)
Set socket init handler.
Definition: tls.hpp:409
lib::asio::io_service * io_service_ptr
Type of a pointer to the ASIO io_service being used.
Definition: tls.hpp:75
ptr get_shared()
Get a shared pointer to this component.
Definition: tls.hpp:87
there was an error in the underlying transport library
Definition: base.hpp:174
Namespace for the WebSocket++ project.
Definition: base64.hpp:41
lib::function< void(lib::error_code const &)> init_handler
The type and signature of the callback passed to the init hook.
Definition: connection.hpp:117
lib::error_code init_asio(io_service_ptr service, strand_ptr strand, bool is_server)
Perform one time initializations.
Definition: tls.hpp:185
socket_type::lowest_layer_type & get_raw_socket()
Retrieve a pointer to the underlying socket.
Definition: tls.hpp:103
endpoint type
The type of this endpoint socket component.
Definition: tls.hpp:383
lib::function< void(connection_hdl, lib::asio::ssl::stream< lib::asio::ip::tcp::socket > &)> socket_init_handler
The signature of the socket_init_handler for this socket policy.
Definition: tls.hpp:53
void set_tls_init_handler(tls_init_handler h)
Set TLS init handler.
Definition: tls.hpp:144
lib::shared_ptr< uri > uri_ptr
Pointer to a URI.
Definition: uri.hpp:350
void set_socket_init_handler(socket_init_handler h)
Set the socket initialization handler.
Definition: tls.hpp:131
lib::asio::ssl::stream< lib::asio::ip::tcp::socket > socket_type
Type of the ASIO socket being used.
Definition: tls.hpp:71
void post_init(init_handler callback)
Post-initialize security policy.
Definition: tls.hpp:263
TLS enabled Asio endpoint socket component.
Definition: tls.hpp:380
void cancel_socket()
Cancel all async operations on this socket.
Definition: tls.hpp:314
lib::shared_ptr< lib::asio::io_service::strand > strand_ptr
Type of a pointer to the ASIO io_service strand being used.
Definition: tls.hpp:77