Skip to content

Websocket improvement headers #330

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

Merged
fdesbiens merged 2 commits into from
Sep 2, 2025
Merged

Websocket improvement headers #330

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a766a15
websocket client: Sec-WebSocket-Protocol is optional header
joelguittet Jun 18, 2025
5372101
websocket client: Add support for Authorization Bearer header
joelguittet Jun 18, 2025
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
70 changes: 46 additions & 24 deletions addons/websocket/nx_websocket_client.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,8 @@ UINT _nx_websocket_client_delete(NX_WEBSOCKET_CLIENT *client_ptr)
/* uri_path_length Length of uri path */
/* protocol Pointer to protocol */
/* protocol_length Length of protocol */
/* bearer Pointer to bearer */
/* bearer_length Length of bearer */
/* wait_option Wait option */
/* */
/* OUTPUT */
Expand All @@ -351,7 +353,8 @@ UINT _nx_websocket_client_delete(NX_WEBSOCKET_CLIENT *client_ptr)
UINT _nxe_websocket_client_connect(NX_WEBSOCKET_CLIENT *client_ptr, NX_TCP_SOCKET *socket_ptr,
UCHAR *host, UINT host_length,
UCHAR *uri_path, UINT uri_path_length,
UCHAR *protocol, UINT protocol_length,UINT wait_option)
UCHAR *protocol, UINT protocol_length,
UCHAR *bearer, UINT bearer_length, UINT wait_option)
{

UINT status;
Expand All @@ -361,14 +364,13 @@ UINT status;
if ((client_ptr == NX_NULL) || (client_ptr -> nx_websocket_client_id != NX_WEBSOCKET_CLIENT_ID) ||
(socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID) ||
(host == NX_NULL) || (host_length == 0) ||
(uri_path == NX_NULL) || (uri_path_length == 0) ||
(protocol == NX_NULL) || (protocol_length == 0))
(uri_path == NX_NULL) || (uri_path_length == 0))
{
return(NX_PTR_ERROR);
}

/* Call actual connect function. */
status = _nx_websocket_client_connect(client_ptr, socket_ptr, host, host_length, uri_path, uri_path_length, protocol, protocol_length, wait_option);
status = _nx_websocket_client_connect(client_ptr, socket_ptr, host, host_length, uri_path, uri_path_length, protocol, protocol_length, bearer, bearer_length, wait_option);

/* Return completion status. */
return(status);
Expand Down Expand Up @@ -400,6 +402,8 @@ UINT status;
/* uri_path_length Length of uri path */
/* protocol Pointer to protocol */
/* protocol_length Length of protocol */
/* bearer Pointer to bearer */
/* bearer_length Length of bearer */
/* wait_option Wait option */
/* */
/* OUTPUT */
Expand All @@ -424,7 +428,8 @@ UINT status;
UINT _nx_websocket_client_connect(NX_WEBSOCKET_CLIENT *client_ptr, NX_TCP_SOCKET *socket_ptr,
UCHAR *host, UINT host_length,
UCHAR *resource, UINT resource_length,
UCHAR *protocol, UINT protocol_length,UINT wait_option)
UCHAR *protocol, UINT protocol_length,
UCHAR *bearer, UINT bearer_length, UINT wait_option)
{

UINT status;
Expand Down Expand Up @@ -463,7 +468,7 @@ UINT status;
client_ptr -> nx_websocket_client_use_tls = NX_FALSE;
#endif /* NX_SECURE_ENABLE */

status = _nx_websocket_client_connect_internal(client_ptr, host, host_length, resource, resource_length, protocol, protocol_length, wait_option);
status = _nx_websocket_client_connect_internal(client_ptr, host, host_length, resource, resource_length, protocol, protocol_length, bearer, bearer_length, wait_option);

/* Release the mutex and return */
tx_mutex_put(&(client_ptr -> nx_websocket_client_mutex));
Expand Down Expand Up @@ -494,6 +499,8 @@ UINT status;
/* uri_path_length Length of uri path */
/* protocol Pointer to protocol */
/* protocol_length Length of protocol */
/* bearer Pointer to bearer */
/* bearer_length Length of bearer */
/* wait_option Wait option */
/* */
/* OUTPUT */
Expand Down Expand Up @@ -529,7 +536,8 @@ UINT status;
UINT _nx_websocket_client_connect_internal(NX_WEBSOCKET_CLIENT *client_ptr,
UCHAR *host, UINT host_length,
UCHAR *uri_path, UINT uri_path_length,
UCHAR *protocol, UINT protocol_length,UINT wait_option)
UCHAR *protocol, UINT protocol_length,
UCHAR *bearer, UINT bearer_length, UINT wait_option)
{

UINT i;
Expand Down Expand Up @@ -630,15 +638,26 @@ NX_PACKET *packet_ptr;
status += nx_packet_data_append(packet_ptr, client_ptr -> nx_websocket_client_key, client_ptr -> nx_websocket_client_key_size, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);
status += nx_packet_data_append(packet_ptr, NX_WEBSOCKET_CRLF, NX_WEBSOCKET_CRLF_SIZE, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);

/* Place the connection in the header. */
status += nx_packet_data_append(packet_ptr, "Sec-WebSocket-Protocol: ", sizeof("Sec-WebSocket-Protocol: ") - 1, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);
status += nx_packet_data_append(packet_ptr, protocol, protocol_length, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);
status += nx_packet_data_append(packet_ptr, NX_WEBSOCKET_CRLF, NX_WEBSOCKET_CRLF_SIZE, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);
/* Place the Sec-WebSocket-Protocol in the header. */
if ((protocol != NX_NULL) && (protocol_length != 0))
{
status += nx_packet_data_append(packet_ptr, "Sec-WebSocket-Protocol: ", sizeof("Sec-WebSocket-Protocol: ") - 1, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);
status += nx_packet_data_append(packet_ptr, protocol, protocol_length, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);
status += nx_packet_data_append(packet_ptr, NX_WEBSOCKET_CRLF, NX_WEBSOCKET_CRLF_SIZE, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);
}

/* Place the connection in the header. */
/* Place the Sec-WebSocket-Version in the header. */
status += nx_packet_data_append(packet_ptr, "Sec-WebSocket-Version: 13", sizeof("Sec-WebSocket-Version: 13") - 1, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);
status += nx_packet_data_append(packet_ptr, NX_WEBSOCKET_CRLF, NX_WEBSOCKET_CRLF_SIZE, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);

/* Place the Bearer in the header. */
if ((bearer != NX_NULL) && (bearer_length != 0))
{
status += nx_packet_data_append(packet_ptr, "Authorization: Bearer ", sizeof("Authorization: Bearer ") - 1, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);
status += nx_packet_data_append(packet_ptr, bearer, bearer_length, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);
status += nx_packet_data_append(packet_ptr, NX_WEBSOCKET_CRLF, NX_WEBSOCKET_CRLF_SIZE, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);
}

/* Fill the last \r\n. */
status += nx_packet_data_append(packet_ptr, NX_WEBSOCKET_CRLF, NX_WEBSOCKET_CRLF_SIZE, client_ptr -> nx_websocket_client_packet_pool_ptr, wait_option);

Expand Down Expand Up @@ -732,6 +751,8 @@ NX_PACKET *packet_ptr;
/* uri_path_length Length of uri path */
/* protocol Pointer to protocol */
/* protocol_length Length of protocol */
/* bearer Pointer to bearer */
/* bearer_length Length of bearer */
/* wait_option Wait option */
/* */
/* OUTPUT */
Expand All @@ -756,7 +777,8 @@ NX_PACKET *packet_ptr;
UINT _nxe_websocket_client_secure_connect(NX_WEBSOCKET_CLIENT *client_ptr, NX_SECURE_TLS_SESSION *tls_session,
UCHAR *host, UINT host_length,
UCHAR *uri_path, UINT uri_path_length,
UCHAR *protocol, UINT protocol_length,UINT wait_option)
UCHAR *protocol, UINT protocol_length,
UCHAR *bearer, UINT bearer_length, UINT wait_option)
{

UINT status;
Expand All @@ -766,14 +788,13 @@ UINT status;
if ((client_ptr == NX_NULL) || (client_ptr -> nx_websocket_client_id != NX_WEBSOCKET_CLIENT_ID) ||
(tls_session == NX_NULL) ||
(host == NX_NULL) || (host_length == 0) ||
(uri_path == NX_NULL) || (uri_path_length == 0) ||
(protocol == NX_NULL) || (protocol_length == 0))
(uri_path == NX_NULL) || (uri_path_length == 0))
{
return(NX_PTR_ERROR);
}

/* Call actual secure connect function. */
status = _nx_websocket_client_secure_connect(client_ptr, tls_session, host, host_length, uri_path, uri_path_length, protocol, protocol_length, wait_option);
status = _nx_websocket_client_secure_connect(client_ptr, tls_session, host, host_length, uri_path, uri_path_length, protocol, protocol_length, bearer, bearer_length, wait_option);

/* Return completion status. */
return(status);
Expand Down Expand Up @@ -805,6 +826,8 @@ UINT status;
/* uri_path_length Length of uri path */
/* protocol Pointer to protocol */
/* protocol_length Length of protocol */
/* bearer Pointer to bearer */
/* bearer_length Length of bearer */
/* wait_option Wait option */
/* */
/* OUTPUT */
Expand All @@ -829,7 +852,8 @@ UINT status;
UINT _nx_websocket_client_secure_connect(NX_WEBSOCKET_CLIENT *client_ptr, NX_SECURE_TLS_SESSION *tls_session,
UCHAR *host, UINT host_length,
UCHAR *uri_path, UINT uri_path_length,
UCHAR *protocol, UINT protocol_length,UINT wait_option)
UCHAR *protocol, UINT protocol_length,
UCHAR *bearer, UINT bearer_length, UINT wait_option)
{

UINT status;
Expand Down Expand Up @@ -865,7 +889,7 @@ UINT status;
client_ptr -> nx_websocket_client_tls_session_ptr = tls_session;
client_ptr -> nx_websocket_client_use_tls = NX_TRUE;

status = _nx_websocket_client_connect_internal(client_ptr, host, host_length, uri_path, uri_path_length, protocol, protocol_length, wait_option);
status = _nx_websocket_client_connect_internal(client_ptr, host, host_length, uri_path, uri_path_length, protocol, protocol_length, bearer, bearer_length, wait_option);

/* Release the mutex and return */
tx_mutex_put(&(client_ptr -> nx_websocket_client_mutex));
Expand Down Expand Up @@ -919,7 +943,8 @@ UINT _nx_websocket_client_name_compare(UCHAR *src, ULONG src_length, UCHAR *des
UCHAR ch;

/* Compare the length. */
if(src_length != dest_length)
if((src_length != dest_length) ||
(src == NX_NULL) || (dest == NX_NULL))
{
return(NX_WEBSOCKET_ERROR);
}
Expand Down Expand Up @@ -1009,7 +1034,6 @@ UCHAR key[NX_WEBSOCKET_ACCEPT_KEY_SIZE + 1];
UINT key_size = 0;
UCHAR upgrade_flag = NX_FALSE;
UCHAR connection_flag = NX_FALSE;
UCHAR protocol_cnt = 0;
UCHAR accept_cnt = 0;

NX_PARAMETER_NOT_USED(client_ptr);
Expand Down Expand Up @@ -1135,8 +1159,6 @@ UCHAR accept_cnt = 0;
{
return(NX_WEBSOCKET_INVALID_PACKET);
}

protocol_cnt++;
}
else if (_nx_websocket_client_name_compare((UCHAR *)field_name, field_name_length, (UCHAR *)"Sec-WebSocket-Accept", sizeof("Sec-WebSocket-Accept") - 1) == NX_SUCCESS)
{
Expand All @@ -1162,8 +1184,8 @@ UCHAR accept_cnt = 0;
/* Check if the all fields are processed and found as required. */
if ((offset != packet_ptr -> nx_packet_length) ||
(upgrade_flag != NX_TRUE) || (connection_flag != NX_TRUE) ||
(protocol_cnt != 1) || (accept_cnt != 1)) /* Both sec-websocket-protocol field and sec-websocket-accept field are allowed occur once only.
Reference in RFC 6455, Section 11.3.3 and 11.3.4, Page 59-60 */
(accept_cnt != 1)) /* Sec-WebSocket-Accept field is allowed occur once only.
Reference in RFC 6455, Section 11.3.3 and 11.3.4, Page 59-60 */
{
return(NX_WEBSOCKET_INVALID_PACKET);
}
Expand Down
Loading