Skip to content

Honor client_no_context_takeover offer #1194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jhugard wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Honor client_no_context_takeover offer #1194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8e4b6f
Add client_no_context_takeover regression test
jhugard Apr 3, 2026
6ed4712
Honor client_no_context_takeover offer
jhugard Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions test/extension/permessage_deflate.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,18 @@ struct ext_vars {
namespace pmde = websocketpp::extensions::permessage_deflate::error;
namespace pmd_mode = websocketpp::extensions::permessage_deflate::mode;

static std::string make_deterministic_message(size_t size) {
std::string message(size, '\0');
unsigned int state = 0x12345678u;

for (size_t i = 0; i < size; ++i) {
state = state * 1664525u + 1013904223u;
message[i] = static_cast<char>(state >> 24);
}

return message;
}

// Ensure the disabled extension behaves appropriately disabled

BOOST_AUTO_TEST_CASE( disabled_is_disabled ) {
Expand Down Expand Up @@ -703,6 +715,57 @@ BOOST_AUTO_TEST_CASE( compress_data_no_context_takeover ) {
BOOST_CHECK_EQUAL( compress_out1, compress_out2 );
}

BOOST_AUTO_TEST_CASE( compress_data_client_no_context_takeover_offer_without_response_param ) {
ext_vars v;
enabled_type second_message_server;

std::string offer = v.extc.generate_offer();
std::string compress_in = make_deterministic_message(4096);
std::string compress_out1;
std::string compress_out2;
std::string decompress_out1;
std::string decompress_out2;
websocketpp::http::attribute_list response_without_client_no_context_takeover;

BOOST_CHECK( offer.find("client_no_context_takeover") != std::string::npos );

v.ec = v.extc.validate_offer(response_without_client_no_context_takeover);
BOOST_REQUIRE_EQUAL( v.ec, websocketpp::lib::error_code() );

v.ec = v.extc.init(false);
BOOST_REQUIRE_EQUAL( v.ec, websocketpp::lib::error_code() );

v.ec = v.exts.init(true);
BOOST_REQUIRE_EQUAL( v.ec, websocketpp::lib::error_code() );

v.ec = second_message_server.init(true);
BOOST_REQUIRE_EQUAL( v.ec, websocketpp::lib::error_code() );

v.ec = v.extc.compress(compress_in,compress_out1);
BOOST_REQUIRE_EQUAL( v.ec, websocketpp::lib::error_code() );

v.ec = v.extc.compress(compress_in,compress_out2);
BOOST_REQUIRE_EQUAL( v.ec, websocketpp::lib::error_code() );

v.ec = v.exts.decompress(
reinterpret_cast<const uint8_t *>(compress_out1.data()),
compress_out1.size(),
decompress_out1
);
BOOST_REQUIRE_EQUAL( v.ec, websocketpp::lib::error_code() );
BOOST_CHECK( decompress_out1 == compress_in );

v.ec = second_message_server.decompress(
reinterpret_cast<const uint8_t *>(compress_out2.data()),
compress_out2.size(),
decompress_out2
);
BOOST_CHECK_EQUAL( v.ec, websocketpp::lib::error_code() );
if (!v.ec) {
BOOST_CHECK( decompress_out2 == compress_in );
}
}

BOOST_AUTO_TEST_CASE( compress_empty ) {
ext_vars v;

Expand Down
6 changes: 5 additions & 1 deletion websocketpp/extensions/permessage_deflate/enabled.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,7 @@ class enabled {
: m_enabled(false)
, m_server_no_context_takeover(false)
, m_client_no_context_takeover(false)
, m_client_no_context_takeover_offered(false)
, m_server_max_window_bits(15)
, m_client_max_window_bits(15)
, m_server_max_window_bits_mode(mode::accept)
Expand Down Expand Up @@ -307,7 +308,8 @@ class enabled {
m_compress_buffer.reset(new unsigned char[m_compress_buffer_size]);
m_decompress_buffer.reset(new unsigned char[m_compress_buffer_size]);
if ((m_server_no_context_takeover && is_server) ||
(m_client_no_context_takeover && !is_server))
((m_client_no_context_takeover ||
m_client_no_context_takeover_offered) && !is_server))
{
m_flush = Z_FULL_FLUSH;
} else {
Expand Down Expand Up @@ -481,6 +483,7 @@ class enabled {
* @return A WebSocket extension offer string for this extension
*/
std::string generate_offer() const {
m_client_no_context_takeover_offered = true;
// TODO: this should be dynamically generated based on user settings
return "permessage-deflate; client_no_context_takeover; client_max_window_bits";
}
Expand Down Expand Up @@ -796,6 +799,7 @@ class enabled {
bool m_enabled;
bool m_server_no_context_takeover;
bool m_client_no_context_takeover;
mutable bool m_client_no_context_takeover_offered;
uint8_t m_server_max_window_bits;
uint8_t m_client_max_window_bits;
mode::value m_server_max_window_bits_mode;
Expand Down