WebSocket++  0.8.3-dev
C++ websocket client/server library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
none.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_NONE_HPP
29 #define WEBSOCKETPP_TRANSPORT_SECURITY_NONE_HPP
30 
31 #include <websocketpp/uri.hpp>
32 
33 #include <websocketpp/transport/base/connection.hpp>
34 #include <websocketpp/transport/asio/security/base.hpp>
35 
36 #include <websocketpp/common/asio.hpp>
37 #include <websocketpp/common/memory.hpp>
38 
39 #include <sstream>
40 #include <string>
41 
42 namespace websocketpp {
43 namespace transport {
44 namespace asio {
45 /// A socket policy for the asio transport that implements a plain, unencrypted
46 /// socket
47 namespace basic_socket {
48 
49 /// The signature of the socket init handler for this socket policy
50 typedef lib::function<void(connection_hdl,lib::asio::ip::tcp::socket&)>
52 
53 /// Basic Asio connection socket component
54 /**
55  * transport::asio::basic_socket::connection implements a connection socket
56  * component using Asio ip::tcp::socket.
57  */
59 public:
60  /// Type of this connection socket component
61  typedef connection type;
62  /// Type of a shared pointer to this connection socket component
63  typedef lib::shared_ptr<type> ptr;
64 
65  /// Type of a pointer to the Asio io_service being used
67  /// Type of a pointer to the Asio io_service strand being used
69  /// Type of the ASIO socket being used
71  /// Type of a shared pointer to the socket being used.
73 
74  explicit connection() : m_state(UNINITIALIZED) {
75  //std::cout << "transport::asio::basic_socket::connection constructor"
76  // << std::endl;
77  }
78 
79  /// Get a shared pointer to this component
81  return shared_from_this();
82  }
83 
84  /// Check whether or not this connection is secure
85  /**
86  * @return Whether or not this connection is secure
87  */
88  bool is_secure() const {
89  return false;
90  }
91 
92  /// Set the socket initialization handler
93  /**
94  * The socket initialization handler is called after the socket object is
95  * created but before it is used. This gives the application a chance to
96  * set any Asio socket options it needs.
97  *
98  * @param h The new socket_init_handler
99  */
101  m_socket_init_handler = h;
102  }
103 
104  /// Retrieve a pointer to the underlying socket
105  /**
106  * This is used internally. It can also be used to set socket options, etc
107  */
109  return *m_socket;
110  }
111 
112  /// Retrieve a pointer to the underlying socket
113  /**
114  * This is used internally.
115  */
117  return *m_socket;
118  }
119 
120  /// Retrieve a pointer to the underlying socket
121  /**
122  * This is used internally. It can also be used to set socket options, etc
123  */
125  return *m_socket;
126  }
127 
128  /// Get the remote endpoint address
129  /**
130  * The iostream transport has no information about the ultimate remote
131  * endpoint. It will return the string "iostream transport". To indicate
132  * this.
133  *
134  * TODO: allow user settable remote endpoint addresses if this seems useful
135  *
136  * @return A string identifying the address of the remote endpoint
137  */
139  std::stringstream s;
140 
141  lib::asio::error_code aec;
142  lib::asio::ip::tcp::endpoint ep = m_socket->remote_endpoint(aec);
143 
144  if (aec) {
145  ec = error::make_error_code(error::pass_through);
146  s << "Error getting remote endpoint: " << aec
147  << " (" << aec.message() << ")";
148  return s.str();
149  } else {
150  ec = lib::error_code();
151  s << ep;
152  return s.str();
153  }
154  }
155 protected:
156  /// Perform one time initializations
157  /**
158  * init_asio is called once immediately after construction to initialize
159  * Asio components to the io_service
160  *
161  * @param service A pointer to the endpoint's io_service
162  * @param strand A shared pointer to the connection's asio strand
163  * @param is_server Whether or not the endpoint is a server or not.
164  */
166  {
167  if (m_state != UNINITIALIZED) {
168  return socket::make_error_code(socket::error::invalid_state);
169  }
170 
171  m_socket.reset(new lib::asio::ip::tcp::socket(*service));
172 
173  if (m_socket_init_handler) {
174  m_socket_init_handler(m_hdl, *m_socket);
175  }
176 
177  m_state = READY;
178 
179  return lib::error_code();
180  }
181 
182  /// Set uri hook
183  /**
184  * Called by the transport as a connection is being established to provide
185  * the uri being connected to to the security/socket layer.
186  *
187  * This socket policy doesn't use the uri so it is ignored.
188  *
189  * @since 0.6.0
190  *
191  * @param u The uri to set
192  */
193  void set_uri(uri_ptr) {}
194 
195  /// Pre-initialize security policy
196  /**
197  * Called by the transport after a new connection is created to initialize
198  * the socket component of the connection. This method is not allowed to
199  * write any bytes to the wire. This initialization happens before any
200  * proxies or other intermediate wrappers are negotiated.
201  *
202  * @param callback Handler to call back with completion information
203  */
204  void pre_init(init_handler callback) {
205  if (m_state != READY) {
206  callback(socket::make_error_code(socket::error::invalid_state));
207  return;
208  }
209 
210  m_state = READING;
211 
212  callback(lib::error_code());
213  }
214 
215  /// Post-initialize security policy
216  /**
217  * Called by the transport after all intermediate proxies have been
218  * negotiated. This gives the security policy the chance to talk with the
219  * real remote endpoint for a bit before the websocket handshake.
220  *
221  * @param callback Handler to call back with completion information
222  */
223  void post_init(init_handler callback) {
224  callback(lib::error_code());
225  }
226 
227  /// Sets the connection handle
228  /**
229  * The connection handle is passed to any handlers to identify the
230  * connection
231  *
232  * @param hdl The new handle
233  */
234  void set_handle(connection_hdl hdl) {
235  m_hdl = hdl;
236  }
237 
238  /// Cancel all async operations on this socket
239  /**
240  * Attempts to cancel all async operations on this socket and reports any
241  * failures.
242  *
243  * NOTE: Windows XP and earlier do not support socket cancellation.
244  *
245  * @return The error that occurred, if any.
246  */
248  lib::asio::error_code ec;
249  m_socket->cancel(ec);
250  return ec;
251  }
252 
253  void async_shutdown(socket::shutdown_handler h) {
254  lib::asio::error_code ec;
255  m_socket->shutdown(lib::asio::ip::tcp::socket::shutdown_both, ec);
256  h(ec);
257  }
258 
259  lib::error_code get_ec() const {
260  return lib::error_code();
261  }
262 
263 public:
264  /// Translate any security policy specific information about an error code
265  /**
266  * Translate_ec takes an Asio error code and attempts to convert its value
267  * to an appropriate websocketpp error code. In the case that the Asio and
268  * Websocketpp error types are the same (such as using boost::asio and
269  * boost::system_error or using standalone asio and std::system_error the
270  * code will be passed through natively.
271  *
272  * In the case of a mismatch (boost::asio with std::system_error) a
273  * translated code will be returned. The plain socket policy does not have
274  * any additional information so all such errors will be reported as the
275  * generic transport pass_through error.
276  *
277  * @since 0.3.0
278  *
279  * @param ec The error code to translate_ec
280  * @return The translated error code
281  */
282  template <typename ErrorCodeType>
283  static
285  // We don't know any more information about this error so pass through
286  return make_error_code(transport::error::pass_through);
287  }
288 
289  static
290  /// Overload of translate_ec to catch cases where lib::error_code is the
291  /// same type as lib::asio::error_code
293  // We don't know any more information about this error, but the error is
294  // the same type as the one we are translating to, so pass through
295  // untranslated.
296  return ec;
297  }
298 private:
299  enum state {
300  UNINITIALIZED = 0,
301  READY = 1,
302  READING = 2
303  };
304 
305  socket_ptr m_socket;
306  state m_state;
307 
308  connection_hdl m_hdl;
309  socket_init_handler m_socket_init_handler;
310 };
311 
312 /// Basic ASIO endpoint socket component
313 /**
314  * transport::asio::basic_socket::endpoint implements an endpoint socket
315  * component that uses Boost ASIO's ip::tcp::socket.
316  */
317 class endpoint {
318 public:
319  /// The type of this endpoint socket component
320  typedef endpoint type;
321 
322  /// The type of the corresponding connection socket component
324  /// The type of a shared pointer to the corresponding connection socket
325  /// component.
327 
328  explicit endpoint() {}
329 
330  /// Checks whether the endpoint creates secure connections
331  /**
332  * @return Whether or not the endpoint creates secure connections
333  */
334  bool is_secure() const {
335  return false;
336  }
337 
338  /// Set socket init handler
339  /**
340  * The socket init handler is called after a connection's socket is created
341  * but before it is used. This gives the end application an opportunity to
342  * set asio socket specific parameters.
343  *
344  * @param h The new socket_init_handler
345  */
347  m_socket_init_handler = h;
348  }
349 protected:
350  /// Initialize a connection
351  /**
352  * Called by the transport after a new connection is created to initialize
353  * the socket component of the connection.
354  *
355  * @param scon Pointer to the socket component of the connection
356  *
357  * @return Error code (empty on success)
358  */
360  scon->set_socket_init_handler(m_socket_init_handler);
361  return lib::error_code();
362  }
363 private:
364  socket_init_handler m_socket_init_handler;
365 };
366 
367 } // namespace basic_socket
368 } // namespace asio
369 } // namespace transport
370 } // namespace websocketpp
371 
372 #endif // WEBSOCKETPP_TRANSPORT_SECURITY_NONE_HPP
websocketpp::transport::asio::basic_socket::endpoint::socket_con_ptr
socket_con_type::ptr socket_con_ptr
Definition: none.hpp:326
websocketpp::transport::asio::basic_socket::endpoint::init
lib::error_code init(socket_con_ptr scon)
Initialize a connection.
Definition: none.hpp:359
websocketpp::transport::asio::basic_socket::connection::get_next_layer
lib::asio::ip::tcp::socket & get_next_layer()
Retrieve a pointer to the underlying socket.
Definition: none.hpp:116
websocketpp::transport::asio::basic_socket::connection::pre_init
void pre_init(init_handler callback)
Pre-initialize security policy.
Definition: none.hpp:204
websocketpp::transport::asio::basic_socket::connection::translate_ec
static lib::error_code translate_ec(ErrorCodeType)
Translate any security policy specific information about an error code.
Definition: none.hpp:284
websocketpp::transport::asio::basic_socket::endpoint::type
endpoint type
The type of this endpoint socket component.
Definition: none.hpp:320
websocketpp::transport::asio::basic_socket::connection::socket_ptr
lib::shared_ptr< socket_type > socket_ptr
Type of a shared pointer to the socket being used.
Definition: none.hpp:72
websocketpp::transport::asio::basic_socket::connection::is_secure
bool is_secure() const
Check whether or not this connection is secure.
Definition: none.hpp:88
websocketpp::transport::asio::basic_socket::connection::type
connection type
Type of this connection socket component.
Definition: none.hpp:61
websocketpp::transport::asio::basic_socket::connection::get_remote_endpoint
std::string get_remote_endpoint(lib::error_code &ec) const
Get the remote endpoint address.
Definition: none.hpp:138
websocketpp::transport::asio
Transport policy that uses asio.
Definition: base.hpp:46
websocketpp::transport::asio::basic_socket::connection::strand_ptr
lib::shared_ptr< lib::asio::io_service::strand > strand_ptr
Type of a pointer to the Asio io_service strand being used.
Definition: none.hpp:68
websocketpp::transport::asio::basic_socket::endpoint
Basic ASIO endpoint socket component.
Definition: none.hpp:317
websocketpp::transport::asio::basic_socket::connection::get_raw_socket
lib::asio::ip::tcp::socket & get_raw_socket()
Retrieve a pointer to the underlying socket.
Definition: none.hpp:124
websocketpp::transport::asio::basic_socket::connection::set_handle
void set_handle(connection_hdl hdl)
Sets the connection handle.
Definition: none.hpp:234
websocketpp::versions_supported
static std::vector< int > const versions_supported(helper, helper+4)
Container that stores the list of protocol versions supported.
websocketpp::transport::asio::basic_socket::connection::translate_ec
static lib::error_code translate_ec(lib::error_code ec)
Definition: none.hpp:292
websocketpp::transport::dispatch_handler
lib::function< void()> dispatch_handler
The type and signature of the callback passed to the dispatch method.
Definition: connection.hpp:135
websocketpp::transport::asio::basic_socket::connection::get_socket
lib::asio::ip::tcp::socket & get_socket()
Retrieve a pointer to the underlying socket.
Definition: none.hpp:108
websocketpp::transport::asio::basic_socket::connection::post_init
void post_init(init_handler callback)
Post-initialize security policy.
Definition: none.hpp:223
websocketpp::transport::asio::basic_socket::endpoint::set_socket_init_handler
void set_socket_init_handler(socket_init_handler h)
Set socket init handler.
Definition: none.hpp:346
websocketpp::transport::asio::basic_socket::connection::init_asio
lib::error_code init_asio(io_service_ptr service, strand_ptr, bool)
Perform one time initializations.
Definition: none.hpp:165
websocketpp::transport::asio::basic_socket::connection::io_service_ptr
lib::asio::io_service * io_service_ptr
Type of a pointer to the Asio io_service being used.
Definition: none.hpp:66
websocketpp::transport::asio::basic_socket::socket_init_handler
lib::function< void(connection_hdl, lib::asio::ip::tcp::socket &)> socket_init_handler
The signature of the socket init handler for this socket policy.
Definition: none.hpp:51
websocketpp::transport::asio::basic_socket
Definition: none.hpp:47
websocketpp::transport::asio::basic_socket::connection::set_uri
void set_uri(uri_ptr)
Set uri hook.
Definition: none.hpp:193
websocketpp::transport::asio::basic_socket::connection::cancel_socket
lib::asio::error_code cancel_socket()
Cancel all async operations on this socket.
Definition: none.hpp:247
websocketpp::transport::asio::basic_socket::connection::socket_type
lib::asio::ip::tcp::socket socket_type
Type of the ASIO socket being used.
Definition: none.hpp:70
websocketpp::transport::asio::basic_socket::connection::set_socket_init_handler
void set_socket_init_handler(socket_init_handler h)
Set the socket initialization handler.
Definition: none.hpp:100
websocketpp::transport::asio::basic_socket::endpoint::is_secure
bool is_secure() const
Checks whether the endpoint creates secure connections.
Definition: none.hpp:334
websocketpp::transport::asio::basic_socket::connection::get_shared
ptr get_shared()
Get a shared pointer to this component.
Definition: none.hpp:80
websocketpp::transport::asio::basic_socket::endpoint::socket_con_type
connection socket_con_type
The type of the corresponding connection socket component.
Definition: none.hpp:323