Skip to content

Allow omitting default WS headers by setting an empty extra header #622

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
roberthedwardsIV wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow omitting default WS headers by setting an empty extra header #622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,8 @@ headers["foo"] = "bar";
webSocket.setExtraHeaders(headers);
```

You may also prevent header fields from being sent - like User-Agent or Origin - by setting the corresponding HTTP header fields to "".

### Subprotocols

You can specify subprotocols to be set during the WebSocket handshake. For more info you can refer to [this doc](https://hpbn.co/websocket/#subprotocol-negotiation).
Expand Down
1 change: 1 addition & 0 deletions ixwebsocket/IXWebSocketHandshake.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ namespace ix

for (auto& it : extraHeaders)
{
if (it.second.empty()) continue;
ss << it.first << ": " << it.second << "\r\n";
}

Expand Down
21 changes: 17 additions & 4 deletions test/IXWebSocketHostTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@

using namespace ix;

bool startServer(ix::WebSocketServer& server, std::string& subProtocols)
bool startServer(ix::WebSocketServer& server, std::string& subProtocols,
WebSocketHttpHeaders& receivedHeaders)
{
server.setOnClientMessageCallback(
[&server, &subProtocols](std::shared_ptr<ConnectionState> connectionState,
[&server, &subProtocols, &receivedHeaders](std::shared_ptr<ConnectionState> connectionState,
WebSocket& webSocket,
const ix::WebSocketMessagePtr& msg) {
auto remoteIp = connectionState->getRemoteIp();
Expand All @@ -34,6 +35,7 @@ bool startServer(ix::WebSocketServer& server, std::string& subProtocols)
}

subProtocols = msg->openInfo.headers["Sec-WebSocket-Protocol"];
receivedHeaders = msg->openInfo.headers;
}
else if (msg->type == ix::WebSocketMessageType::Close)
{
Expand Down Expand Up @@ -62,12 +64,14 @@ bool startServer(ix::WebSocketServer& server, std::string& subProtocols)
return true;
}

void runTest(int port, const ix::WebSocketHttpHeaders & headers)
WebSocketHttpHeaders runTest(int port, const ix::WebSocketHttpHeaders & headers)
{
ix::WebSocketServer server(port);

std::string subProtocols;
startServer(server, subProtocols);
WebSocketHttpHeaders receivedHeaders;

startServer(server, subProtocols, receivedHeaders);

std::atomic<bool> connected(false);
ix::WebSocket webSocket;
Expand Down Expand Up @@ -107,6 +111,7 @@ void runTest(int port, const ix::WebSocketHttpHeaders & headers)
server.stop();

REQUIRE(subProtocols == "json,msgpack");
return receivedHeaders;
}


Expand Down Expand Up @@ -141,4 +146,12 @@ TEST_CASE("host", "[websocket_host]")
int port = getFreePort();
runTest(port, {{"Host", "localhost"}});
}

SECTION("Connect with User-Agent and Origin header removed")
{
int port = getFreePort();
WebSocketHttpHeaders received = runTest(port, {{"User-Agent", ""}, {"Origin", ""}});
CHECK(received.count("User-Agent") == 0);
CHECK(received.count("Origin") == 0);
}
}