rpms
/
websocketpp
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix failing tests of websocketpp 0.7.0-6 (#1461069) 

- Add patches to fix zlib test failure (test_permessage_deflate)
- Disable tests test_transport, test_transport_asio_timers

Fix build and test failures with zlib 1.2.11.
Fixes test_permessage_deflate
zaphoyd/websocketpp#653
Upstream patches, backported to websocketpp-0.7.0
zaphoyd/websocketpp@9ddb300
websocketpp-0.7.0-zlib-permessage-deflate.patch
zaphoyd/websocketpp@4cab5e5
websocketpp-0.7.0-minor-adjustments-to-recent-extension-
negotiation.patch
This commit is contained in:
Wolfgang Stöggl 2017-06-27 09:36:49 +02:00
parent 19b12bfdf1
commit 44ef4da118
4 changed files with 775 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
websocketpp-0.7.0-disable-test_transport-test_transport_asio_timers.patch Normal file
View File

@ -0,0 +1,46 @@
--- a/test/transport/CMakeLists.txt
+++ b/test/transport/CMakeLists.txt
@@ -1,24 +1,24 @@
if (OPENSSL_FOUND)
-# Test transport integration
-file (GLOB SOURCE integration.cpp)
-
-init_target (test_transport)
-build_test (${TARGET_NAME} ${SOURCE})
-link_boost ()
-link_openssl()
-final_target ()
-set_target_properties(${TARGET_NAME} PROPERTIES FOLDER "test")
-
-# Test transport asio timers
-file (GLOB SOURCE asio/timers.cpp)
-
-init_target (test_transport_asio_timers)
-build_test (${TARGET_NAME} ${SOURCE})
-link_boost ()
-link_openssl()
-final_target ()
-set_target_properties(${TARGET_NAME} PROPERTIES FOLDER "test")
+## Test transport integration
+#file (GLOB SOURCE integration.cpp)
+#
+#init_target (test_transport)
+#build_test (${TARGET_NAME} ${SOURCE})
+#link_boost ()
+#link_openssl()
+#final_target ()
+#set_target_properties(${TARGET_NAME} PROPERTIES FOLDER "test")
+#
+## Test transport asio timers
+#file (GLOB SOURCE asio/timers.cpp)
+#
+#init_target (test_transport_asio_timers)
+#build_test (${TARGET_NAME} ${SOURCE})
+#link_boost ()
+#link_openssl()
+#final_target ()
+#set_target_properties(${TARGET_NAME} PROPERTIES FOLDER "test")
# Test transport asio security
file (GLOB SOURCE asio/security.cpp)

146
websocketpp-0.7.0-minor-adjustments-to-recent-extension-negotiation.patch Normal file
View File

@ -0,0 +1,146 @@
diff --git a/websocketpp/impl/connection_impl.hpp b/websocketpp/impl/connection_impl.hpp
index 93a5a16..bf88c95 100644
--- a/websocketpp/impl/connection_impl.hpp
+++ b/websocketpp/impl/connection_impl.hpp
@@ -1222,17 +1222,17 @@ lib::error_code connection<config>::process_handshake_request() {
std::pair<lib::error_code,std::string> neg_results;
neg_results = m_processor->negotiate_extensions(m_request);
- if (neg_results.first == error::make_error_code(error::extension_parse_error)) {
+ if (neg_results.first == processor::error::make_error_code(processor::error::extension_parse_error)) {
// There was a fatal error in extension parsing that should result in
// a failed connection attempt.
- m_alog.write(log::alevel::info, "Bad request: " + neg_results.first.message());
+ m_elog.write(log::elevel::info, "Bad request: " + neg_results.first.message());
m_response.set_status(http::status_code::bad_request);
return neg_results.first;
} else if (neg_results.first) {
// There was a fatal error in extension processing that is probably our
// fault. Consider extension negotiation to have failed and continue as
// if extensions were not supported
- m_alog.write(log::alevel::info,
+ m_elog.write(log::elevel::info,
"Extension negotiation failed: " + neg_results.first.message());
} else {
// extension negotiation succeeded, set response header accordingly
diff --git a/websocketpp/processors/hybi13.hpp b/websocketpp/processors/hybi13.hpp
index a95bc64..ca12439 100644
--- a/websocketpp/processors/hybi13.hpp
+++ b/websocketpp/processors/hybi13.hpp
@@ -97,11 +97,6 @@ public:
/**
* This exists mostly because the code for requests and responses is
* identical and I can't have virtual template methods.
- *
- * NOTE: this method makes assumptions that the permessage-deflate
- * extension is the only one supported. If additional extensions are
- * ever supported it should be reviewed carefully. Most cases where
- * that assumption is made are explicitly noted.
*/
template <typename header_type>
err_str_pair negotiate_extensions_helper(header_type const & header) {
@@ -130,55 +125,60 @@ public:
http::parameter_list::const_iterator it;
+ // look through the list of extension requests to find the first
+ // one that we can accept.
if (m_permessage_deflate.is_implemented()) {
err_str_pair neg_ret;
for (it = p.begin(); it != p.end(); ++it) {
- // look through each extension, if the key is permessage-deflate
- if (it->first == "permessage-deflate") {
- // if we have already successfully negotiated this extension
- // then skip any other requests to negotiate the same one
- // with different parameters
- if (m_permessage_deflate.is_enabled()) {
- continue;
- }
-
-
- neg_ret = m_permessage_deflate.negotiate(it->second);
-
- if (neg_ret.first) {
- // Figure out if this is an error that should halt all
- // extension negotiations or simply cause negotiation of
- // this specific extension to fail.
- //std::cout << "permessage-compress negotiation failed: "
- // << neg_ret.first.message() << std::endl;
- } else {
- // Note: this list will need commas if WebSocket++ ever
- // supports more than one extension
-
- // Actually try to initialize the extension before we
- // deem negotiation complete
- ret.first = m_permessage_deflate.init(base::m_server);
- if (!ret.first) {
-
- // TODO: support multiple extensions.
- // right now, because there is only one extension
- // supported, it failing to negotiate means we are
- // done with all negotiating. In the future if more
- // extensions are supported a better solution will
- // be needed here.
- break;
- } else {
- ret.second += neg_ret.second;
+ // not a permessage-deflate extension request, ignore
+ if (it->first != "permessage-deflate") {
+ continue;
+ }
- // continue looking for more extensions
- continue;
- }
-
- }
+ // if we have already successfully negotiated this extension
+ // then skip any other requests to negotiate the same one
+ // with different parameters
+ if (m_permessage_deflate.is_enabled()) {
+ continue;
+ }
+
+ // attempt to negotiate this offer
+ neg_ret = m_permessage_deflate.negotiate(it->second);
+
+ if (neg_ret.first) {
+ // negotiation offer failed. Do nothing. We will continue
+ // searching for a permessage-deflate config that succeeds
+ continue;
+ }
+
+ // Negotiation tentatively succeeded
+
+ // Actually try to initialize the extension before we
+ // deem negotiation complete
+ lib::error_code ec = m_permessage_deflate.init(base::m_server);
+
+ if (ec) {
+ // Negotiation succeeded but initialization failed this is
+ // an error that should stop negotiation of permessage
+ // deflate. Return the reason for the init failure
+
+ ret.first = ec;
+ break;
+ } else {
+ // Successfully initialized, push the negotiated response into
+ // the reply and stop looking for additional permessage-deflate
+ // extensions
+ ret.second += neg_ret.second;
+ break;
}
}
}
+ // support for future extensions would go here. Should check the value of
+ // ret.first before continuing. Might need to consider whether failure of
+ // negotiation of an earlier extension should stop negotiation of subsequent
+ // ones
+
return ret;
}
--
2.13.0

566
websocketpp-0.7.0-zlib-permessage-deflate.patch Normal file
View File

@ -0,0 +1,566 @@
diff --git a/test/extension/permessage_deflate.cpp b/test/extension/permessage_deflate.cpp
index 4cd3e7b..805afcc 100644
--- a/test/extension/permessage_deflate.cpp
+++ b/test/extension/permessage_deflate.cpp
@@ -186,15 +186,22 @@ BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_invalid ) {
BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_valid ) {
ext_vars v;
+
+ // confirm that a request for a value of 8 is interpreted as 9
v.attr["server_max_window_bits"] = "8";
+ v.esp = v.exts.negotiate(v.attr);
+ BOOST_CHECK( v.exts.is_enabled() );
+ BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; server_max_window_bits=9");
+ v.attr["server_max_window_bits"] = "9";
v.esp = v.exts.negotiate(v.attr);
BOOST_CHECK( v.exts.is_enabled() );
BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
- BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; server_max_window_bits=8");
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; server_max_window_bits=9");
- v.attr["server_max_window_bits"] = "15";
+ v.attr["server_max_window_bits"] = "15";
v.esp = v.exts.negotiate(v.attr);
BOOST_CHECK( v.exts.is_enabled() );
BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
@@ -213,7 +220,7 @@ BOOST_AUTO_TEST_CASE( invalid_set_server_max_window_bits ) {
BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_decline ) {
ext_vars v;
- v.attr["server_max_window_bits"] = "8";
+ v.attr["server_max_window_bits"] = "9";
v.ec = v.exts.set_server_max_window_bits(15,pmd_mode::decline);
v.esp = v.exts.negotiate(v.attr);
@@ -223,7 +230,7 @@ BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_decline ) {
BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate");
}
-BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_accept ) {
+BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_accept_8 ) {
ext_vars v;
v.attr["server_max_window_bits"] = "8";
@@ -232,10 +239,22 @@ BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_accept ) {
BOOST_CHECK( v.exts.is_enabled() );
BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
- BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; server_max_window_bits=8");
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; server_max_window_bits=9");
}
-BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_largest ) {
+BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_accept ) {
+ ext_vars v;
+ v.attr["server_max_window_bits"] = "9";
+
+ v.ec = v.exts.set_server_max_window_bits(15,pmd_mode::accept);
+ v.esp = v.exts.negotiate(v.attr);
+ BOOST_CHECK( v.exts.is_enabled() );
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; server_max_window_bits=9");
+}
+
+BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_largest_8 ) {
ext_vars v;
v.attr["server_max_window_bits"] = "8";
@@ -244,10 +263,22 @@ BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_largest ) {
BOOST_CHECK( v.exts.is_enabled() );
BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
- BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; server_max_window_bits=8");
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; server_max_window_bits=9");
}
-BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_smallest ) {
+BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_largest ) {
+ ext_vars v;
+ v.attr["server_max_window_bits"] = "9";
+
+ v.ec = v.exts.set_server_max_window_bits(15,pmd_mode::largest);
+ v.esp = v.exts.negotiate(v.attr);
+ BOOST_CHECK( v.exts.is_enabled() );
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; server_max_window_bits=9");
+}
+
+BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_smallest_8 ) {
ext_vars v;
v.attr["server_max_window_bits"] = "8";
@@ -256,7 +287,19 @@ BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_smallest ) {
BOOST_CHECK( v.exts.is_enabled() );
BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
- BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; server_max_window_bits=8");
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; server_max_window_bits=9");
+}
+
+BOOST_AUTO_TEST_CASE( negotiate_server_max_window_bits_smallest ) {
+ ext_vars v;
+ v.attr["server_max_window_bits"] = "9";
+
+ v.ec = v.exts.set_server_max_window_bits(15,pmd_mode::smallest);
+ v.esp = v.exts.negotiate(v.attr);
+ BOOST_CHECK( v.exts.is_enabled() );
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; server_max_window_bits=9");
}
// Negotiate server_max_window_bits
@@ -292,7 +335,13 @@ BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_valid ) {
v.esp = v.exts.negotiate(v.attr);
BOOST_CHECK( v.exts.is_enabled() );
BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
- BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; client_max_window_bits=8");
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; client_max_window_bits=9");
+
+ v.attr["client_max_window_bits"] = "9";
+ v.esp = v.exts.negotiate(v.attr);
+ BOOST_CHECK( v.exts.is_enabled() );
+ BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; client_max_window_bits=9");
v.attr["client_max_window_bits"] = "15";
v.esp = v.exts.negotiate(v.attr);
@@ -311,7 +360,7 @@ BOOST_AUTO_TEST_CASE( invalid_set_client_max_window_bits ) {
BOOST_CHECK_EQUAL(v.ec,pmde::make_error_code(pmde::invalid_max_window_bits));
}
-BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_decline ) {
+BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_decline_8 ) {
ext_vars v;
v.attr["client_max_window_bits"] = "8";
@@ -323,7 +372,19 @@ BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_decline ) {
BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate");
}
-BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_accept ) {
+BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_decline ) {
+ ext_vars v;
+ v.attr["client_max_window_bits"] = "9";
+
+ v.ec = v.exts.set_client_max_window_bits(9,pmd_mode::decline);
+ v.esp = v.exts.negotiate(v.attr);
+ BOOST_CHECK( v.exts.is_enabled() );
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate");
+}
+
+BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_accept_8 ) {
ext_vars v;
v.attr["client_max_window_bits"] = "8";
@@ -332,10 +393,22 @@ BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_accept ) {
BOOST_CHECK( v.exts.is_enabled() );
BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
- BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; client_max_window_bits=8");
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; client_max_window_bits=9");
}
-BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_largest ) {
+BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_accept ) {
+ ext_vars v;
+ v.attr["client_max_window_bits"] = "9";
+
+ v.ec = v.exts.set_client_max_window_bits(15,pmd_mode::accept);
+ v.esp = v.exts.negotiate(v.attr);
+ BOOST_CHECK( v.exts.is_enabled() );
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; client_max_window_bits=9");
+}
+
+BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_largest_8 ) {
ext_vars v;
v.attr["client_max_window_bits"] = "8";
@@ -344,10 +417,22 @@ BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_largest ) {
BOOST_CHECK( v.exts.is_enabled() );
BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
- BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; client_max_window_bits=8");
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; client_max_window_bits=9");
}
-BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_smallest ) {
+BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_largest ) {
+ ext_vars v;
+ v.attr["client_max_window_bits"] = "9";
+
+ v.ec = v.exts.set_client_max_window_bits(15,pmd_mode::largest);
+ v.esp = v.exts.negotiate(v.attr);
+ BOOST_CHECK( v.exts.is_enabled() );
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; client_max_window_bits=9");
+}
+
+BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_smallest_8 ) {
ext_vars v;
v.attr["client_max_window_bits"] = "8";
@@ -356,7 +441,19 @@ BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_smallest ) {
BOOST_CHECK( v.exts.is_enabled() );
BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
- BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; client_max_window_bits=8");
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; client_max_window_bits=9");
+}
+
+BOOST_AUTO_TEST_CASE( negotiate_client_max_window_bits_smallest ) {
+ ext_vars v;
+ v.attr["client_max_window_bits"] = "9";
+
+ v.ec = v.exts.set_client_max_window_bits(15,pmd_mode::smallest);
+ v.esp = v.exts.negotiate(v.attr);
+ BOOST_CHECK( v.exts.is_enabled() );
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.first, websocketpp::lib::error_code() );
+ BOOST_CHECK_EQUAL( v.esp.second, "permessage-deflate; client_max_window_bits=9");
}
@@ -507,7 +604,8 @@ BOOST_AUTO_TEST_CASE( compress_data ) {
std::string compress_out;
std::string decompress_out;
- v.exts.init(true);
+ v.ec = v.exts.init(true);
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
v.ec = v.exts.compress(compress_in,compress_out);
BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
@@ -520,7 +618,8 @@ BOOST_AUTO_TEST_CASE( compress_data ) {
BOOST_AUTO_TEST_CASE( compress_data_multiple ) {
ext_vars v;
- v.exts.init(true);
+ v.ec = v.exts.init(true);
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
for (int i = 0; i < 2; i++) {
std::string compress_in = "Hello";
@@ -545,11 +644,12 @@ BOOST_AUTO_TEST_CASE( compress_data_large ) {
websocketpp::http::attribute_list alist;
- alist["server_max_window_bits"] = "8";
- v.exts.set_server_max_window_bits(8,websocketpp::extensions::permessage_deflate::mode::smallest);
+ alist["server_max_window_bits"] = "9";
+ v.exts.set_server_max_window_bits(9,websocketpp::extensions::permessage_deflate::mode::smallest);
v.exts.negotiate(alist);
- v.exts.init(true);
+ v.ec = v.exts.init(true);
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
v.ec = v.exts.compress(compress_in,compress_out);
BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
@@ -573,7 +673,8 @@ BOOST_AUTO_TEST_CASE( compress_data_no_context_takeover ) {
v.exts.enable_server_no_context_takeover();
v.exts.negotiate(alist);
- v.exts.init(true);
+ v.ec = v.exts.init(true);
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
v.ec = v.exts.compress(compress_in,compress_out1);
BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
@@ -609,7 +710,8 @@ BOOST_AUTO_TEST_CASE( compress_empty ) {
std::string compress_out;
std::string decompress_out;
- v.exts.init(true);
+ v.ec = v.exts.init(true);
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
v.ec = v.exts.compress(compress_in,compress_out);
BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
@@ -640,7 +742,8 @@ BOOST_AUTO_TEST_CASE( decompress_data ) {
std::string out;
std::string reference = "Hello";
- v.exts.init(true);
+ v.ec = v.exts.init(true);
+ BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
v.ec = v.exts.decompress(in,11,out);
diff --git a/websocketpp/extensions/permessage_deflate/enabled.hpp b/websocketpp/extensions/permessage_deflate/enabled.hpp
index 1581f14..f20a1b1 100644
--- a/websocketpp/extensions/permessage_deflate/enabled.hpp
+++ b/websocketpp/extensions/permessage_deflate/enabled.hpp
@@ -46,7 +46,7 @@
namespace websocketpp {
namespace extensions {
-/// Implementation of the draft permessage-deflate WebSocket extension
+/// Implementation of RFC 7692, the permessage-deflate WebSocket extension
/**
* ### permessage-deflate interface
*
@@ -174,18 +174,30 @@ namespace websocketpp {
namespace extensions {
namespace permessage_deflate {
-/// Default value for server_max_window_bits as defined by draft 17
+/// Default value for server_max_window_bits as defined by RFC 7692
static uint8_t const default_server_max_window_bits = 15;
-/// Minimum value for server_max_window_bits as defined by draft 17
+/// Minimum value for server_max_window_bits as defined by RFC 7692
+/**
+ * NOTE: A value of 8 is not actually supported by zlib, the deflate
+ * library that WebSocket++ uses. To preserve backwards compatibility
+ * with RFC 7692 and previous versions of the library a value of 8
+ * is accepted by the library but will always be negotiated as 9.
+ */
static uint8_t const min_server_max_window_bits = 8;
-/// Maximum value for server_max_window_bits as defined by draft 17
+/// Maximum value for server_max_window_bits as defined by RFC 7692
static uint8_t const max_server_max_window_bits = 15;
-/// Default value for client_max_window_bits as defined by draft 17
+/// Default value for client_max_window_bits as defined by RFC 7692
static uint8_t const default_client_max_window_bits = 15;
-/// Minimum value for client_max_window_bits as defined by draft 17
+/// Minimum value for client_max_window_bits as defined by RFC 7692
+/**
+ * NOTE: A value of 8 is not actually supported by zlib, the deflate
+ * library that WebSocket++ uses. To preserve backwards compatibility
+ * with RFC 7692 and previous versions of the library a value of 8
+ * is accepted by the library but will always be negotiated as 9.
+ */
static uint8_t const min_client_max_window_bits = 8;
-/// Maximum value for client_max_window_bits as defined by draft 17
+/// Maximum value for client_max_window_bits as defined by RFC 7692
static uint8_t const max_client_max_window_bits = 15;
namespace mode {
@@ -372,7 +384,7 @@ public:
/**
* The bits setting is the base 2 logarithm of the maximum window size that
* the server must use to compress outgoing messages. The permitted range
- * is 8 to 15 inclusive. 8 represents a 256 byte window and 15 a 32KiB
+ * is 9 to 15 inclusive. 9 represents a 512 byte window and 15 a 32KiB
* window. The default setting is 15.
*
* Mode Options:
@@ -386,6 +398,14 @@ public:
* adjusted by the server. A server may unilaterally set this value without
* client support.
*
+ * NOTE: The permessage-deflate spec specifies that a value of 8 is allowed.
+ * Prior to version 0.8.0 a value of 8 was also allowed by this library.
+ * zlib, the deflate compression library that WebSocket++ uses has always
+ * silently adjusted a value of 8 to 9. In recent versions of zlib (1.2.9
+ * and greater) a value of 8 is now explicitly rejected. WebSocket++ 0.8.0
+ * continues to perform the 8->9 conversion for backwards compatibility
+ * purposes but this should be considered deprecated functionality.
+ *
* @param bits The size to request for the outgoing window size
* @param mode The mode to use for negotiating this parameter
* @return A status code
@@ -394,6 +414,12 @@ public:
if (bits < min_server_max_window_bits || bits > max_server_max_window_bits) {
return error::make_error_code(error::invalid_max_window_bits);
}
+
+ // See note in doc comment above about what is happening here
+ if (bits == 8) {
+ bits = 9;
+ }
+
m_server_max_window_bits = bits;
m_server_max_window_bits_mode = mode;
@@ -403,8 +429,8 @@ public:
/// Limit client LZ77 sliding window size
/**
* The bits setting is the base 2 logarithm of the window size that the
- * client must use to compress outgoing messages. The permitted range is 8
- * to 15 inclusive. 8 represents a 256 byte window and 15 a 32KiB window.
+ * client must use to compress outgoing messages. The permitted range is 9
+ * to 15 inclusive. 9 represents a 512 byte window and 15 a 32KiB window.
* The default setting is 15.
*
* Mode Options:
@@ -417,6 +443,14 @@ public:
* outgoing window size unilaterally. A server may only limit the client's
* window size if the remote client supports that feature.
*
+ * NOTE: The permessage-deflate spec specifies that a value of 8 is allowed.
+ * Prior to version 0.8.0 a value of 8 was also allowed by this library.
+ * zlib, the deflate compression library that WebSocket++ uses has always
+ * silently adjusted a value of 8 to 9. In recent versions of zlib (1.2.9
+ * and greater) a value of 8 is now explicitly rejected. WebSocket++ 0.8.0
+ * continues to perform the 8->9 conversion for backwards compatibility
+ * purposes but this should be considered deprecated functionality.
+ *
* @param bits The size to request for the outgoing window size
* @param mode The mode to use for negotiating this parameter
* @return A status code
@@ -425,6 +459,12 @@ public:
if (bits < min_client_max_window_bits || bits > max_client_max_window_bits) {
return error::make_error_code(error::invalid_max_window_bits);
}
+
+ // See note in doc comment above about what is happening here
+ if (bits == 8) {
+ bits = 9;
+ }
+
m_client_max_window_bits = bits;
m_client_max_window_bits_mode = mode;
@@ -642,11 +682,17 @@ private:
* client requested that we use.
*
* options:
- * - decline (refuse to use the attribute)
- * - accept (use whatever the client says)
- * - largest (use largest possible value)
+ * - decline (ignore value, offer our default instead)
+ * - accept (use the value requested by the client)
+ * - largest (use largest value acceptable to both)
* - smallest (use smallest possible value)
*
+ * NOTE: As a value of 8 is no longer explicitly supported by zlib but might
+ * be requested for negotiation by an older client/server, if the result of
+ * the negotiation would be to send a value of 8, a value of 9 is offered
+ * instead. This ensures that WebSocket++ will only ever negotiate connections
+ * with compression settings explicitly supported by zlib.
+ *
* @param [in] value The value of the attribute from the offer
* @param [out] ec A reference to the error code to return errors via
*/
@@ -678,6 +724,11 @@ private:
ec = make_error_code(error::invalid_mode);
m_server_max_window_bits = default_server_max_window_bits;
}
+
+ // See note in doc comment
+ if (m_server_max_window_bits == 8) {
+ m_server_max_window_bits = 9;
+ }
}
/// Negotiate client_max_window_bits attribute
@@ -687,11 +738,17 @@ private:
* negotiation mode.
*
* options:
- * - decline (refuse to use the attribute)
- * - accept (use whatever the client says)
- * - largest (use largest possible value)
+ * - decline (ignore value, offer our default instead)
+ * - accept (use the value requested by the client)
+ * - largest (use largest value acceptable to both)
* - smallest (use smallest possible value)
*
+ * NOTE: As a value of 8 is no longer explicitly supported by zlib but might
+ * be requested for negotiation by an older client/server, if the result of
+ * the negotiation would be to send a value of 8, a value of 9 is offered
+ * instead. This ensures that WebSocket++ will only ever negotiate connections
+ * with compression settings explicitly supported by zlib.
+ *
* @param [in] value The value of the attribute from the offer
* @param [out] ec A reference to the error code to return errors via
*/
@@ -727,6 +784,11 @@ private:
ec = make_error_code(error::invalid_mode);
m_client_max_window_bits = default_client_max_window_bits;
}
+
+ // See note in doc comment
+ if (m_client_max_window_bits == 8) {
+ m_client_max_window_bits = 9;
+ }
}
bool m_enabled;
diff --git a/websocketpp/impl/connection_impl.hpp b/websocketpp/impl/connection_impl.hpp
index 105911d..ae55c33 100644
--- a/websocketpp/impl/connection_impl.hpp
+++ b/websocketpp/impl/connection_impl.hpp
@@ -1222,12 +1222,18 @@ lib::error_code connection<config>::process_handshake_request() {
std::pair<lib::error_code,std::string> neg_results;
neg_results = m_processor->negotiate_extensions(m_request);
- if (neg_results.first) {
+ if (neg_results.first == error::make_error_code(error::extension_parse_error)) {
// There was a fatal error in extension parsing that should result in
// a failed connection attempt.
- m_alog.write(log::alevel::devel, "Bad request: " + neg_results.first.message());
+ m_alog.write(log::alevel::info, "Bad request: " + neg_results.first.message());
m_response.set_status(http::status_code::bad_request);
return neg_results.first;
+ } else if (neg_results.first) {
+ // There was a fatal error in extension processing that is probably our
+ // fault. Consider extension negotiation to have failed and continue as
+ // if extensions were not supported
+ m_alog.write(log::alevel::info,
+ "Extension negotiation failed: " + neg_results.first.message());
} else {
// extension negotiation succeeded, set response header accordingly
// we don't send an empty extensions header because it breaks many
diff --git a/websocketpp/processors/hybi13.hpp b/websocketpp/processors/hybi13.hpp
index 7948665..a95bc64 100644
--- a/websocketpp/processors/hybi13.hpp
+++ b/websocketpp/processors/hybi13.hpp
@@ -97,6 +97,11 @@ public:
/**
* This exists mostly because the code for requests and responses is
* identical and I can't have virtual template methods.
+ *
+ * NOTE: this method makes assumptions that the permessage-deflate
+ * extension is the only one supported. If additional extensions are
+ * ever supported it should be reviewed carefully. Most cases where
+ * that assumption is made are explicitly noted.
*/
template <typename header_type>
err_str_pair negotiate_extensions_helper(header_type const & header) {
@@ -149,9 +154,26 @@ public:
} else {
// Note: this list will need commas if WebSocket++ ever
// supports more than one extension
- ret.second += neg_ret.second;
- m_permessage_deflate.init(base::m_server);
- continue;
+
+ // Actually try to initialize the extension before we
+ // deem negotiation complete
+ ret.first = m_permessage_deflate.init(base::m_server);
+ if (!ret.first) {
+
+ // TODO: support multiple extensions.
+ // right now, because there is only one extension
+ // supported, it failing to negotiate means we are
+ // done with all negotiating. In the future if more
+ // extensions are supported a better solution will
+ // be needed here.
+ break;
+ } else {
+ ret.second += neg_ret.second;
+
+ // continue looking for more extensions
+ continue;
+ }
+
}
}
}
--
2.13.0

20
websocketpp.spec
View File

@ -2,7 +2,7 @@
Name: websocketpp
Summary: C++ WebSocket Protocol Library
Version: 0.7.0
Release: 6%{?dist}
Release: 7%{?dist}
License: BSD
Url: http://www.zaphoyd.com/websocketpp
@ -17,6 +17,17 @@ Patch1: websocketpp-0.7.0-cmake_noarch.patch
# https://github.com/zaphoyd/websocketpp/issues/599
Patch2: websocketpp-0.7.0-openssl11.patch
# Fix build and test failures with zlib 1.2.11. Fixes test_permessage_deflate
# https://github.com/zaphoyd/websocketpp/issues/653
# Upstream patches, backported to websocketpp-0.7.0
# https://github.com/zaphoyd/websocketpp/commit/9ddb300d874a30db35e3ad58f188944bef0bf31b
Patch3: websocketpp-0.7.0-zlib-permessage-deflate.patch
# https://github.com/zaphoyd/websocketpp/commit/4cab5e5c0c5f19fcee7d37b4a38b156d63a150d4
Patch4: websocketpp-0.7.0-minor-adjustments-to-recent-extension-negotiation.patch
# Disable the following tests, which fail occasionally: test_transport, test_transport_asio_timers
Patch5: websocketpp-0.7.0-disable-test_transport-test_transport_asio_timers.patch
BuildRequires: boost-devel
BuildRequires: cmake
# needed for tests mostly
@ -63,8 +74,7 @@ rm -rfv %{buildroot}%{_includedir}/test_connection/
%check
# tests non-fatal (for now)
make test -C %{_target_platform} ||:
make test -C %{_target_platform}
%files devel
@ -76,6 +86,10 @@ make test -C %{_target_platform} ||:
%changelog
* Tue Jun 13 2017 Wolfgang Stöggl <c72578@yahoo.de> - 0.7.0-7
- Add patches to fix zlib test failure (test_permessage_deflate)
- Disable tests test_transport, test_transport_asio_timers
* Fri May 26 2017 Rex Dieter <rdieter@fedoraproject.org> - 0.7.0-6
- explicitly use openssl-devel (instead of generic 'pkgconfig(openssl)'