alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

tcp_transport: Fix Websocket transport initialization

Browse Source 
In case of a failure in alocation of WS transport handle, parent leaks.
This commit is contained in:
Euripedes Rocha 2021-12-06 13:15:55 -03:00
parent 120b0ba2af
commit ae8eeaade9
2 changed files with 39 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
components/tcp_transport/transport_ws.c
View File

@ -1,16 +1,8 @@
// Copyright 2015-2021 Espressif Systems (Shanghai) PTE LTD /*
// * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD
// Licensed under the Apache License, Version 2.0 (the "License"); *
// you may not use this file except in compliance with the License. * SPDX-License-Identifier: Apache-2.0
// You may obtain a copy of the License at */
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <stdlib.h> #include <stdlib.h>
#include <string.h> #include <string.h>
@ -109,7 +101,9 @@ static char *trimwhitespace(const char *str)
char *end; char *end;
// Trim leading space // Trim leading space
while (isspace((unsigned char)*str)) str++; while (isspace((unsigned char)*str)) {
str++;
}
if (*str == 0) { if (*str == 0) {
return (char *)str; return (char *)str;
@ -117,7 +111,9 @@ static char *trimwhitespace(const char *str)
// Trim trailing space // Trim trailing space
end = (char *)(str + strlen(str) - 1); end = (char *)(str + strlen(str) - 1);
while (end > str && isspace((unsigned char)*end)) end--; while (end > str && isspace((unsigned char)*end)) {
end--;
}
// Write new null terminator // Write new null terminator
*(end + 1) = 0; *(end + 1) = 0;
@ -154,21 +150,21 @@ static int ws_connect(esp_transport_handle_t t, const char *host, int port, int
// Size of base64 coded string is equal '((input_size * 4) / 3) + (input_size / 96) + 6' including Z-term // Size of base64 coded string is equal '((input_size * 4) / 3) + (input_size / 96) + 6' including Z-term
unsigned char client_key[28] = {0}; unsigned char client_key[28] = {0};
const char *user_agent_ptr = (ws->user_agent)?(ws->user_agent):"ESP32 Websocket Client"; const char *user_agent_ptr = (ws->user_agent) ? (ws->user_agent) : "ESP32 Websocket Client";
size_t outlen = 0; size_t outlen = 0;
esp_crypto_base64_encode(client_key, sizeof(client_key), &outlen, random_key, sizeof(random_key)); esp_crypto_base64_encode(client_key, sizeof(client_key), &outlen, random_key, sizeof(random_key));
int len = snprintf(ws->buffer, WS_BUFFER_SIZE, int len = snprintf(ws->buffer, WS_BUFFER_SIZE,
"GET %s HTTP/1.1\r\n" "GET %s HTTP/1.1\r\n"
"Connection: Upgrade\r\n" "Connection: Upgrade\r\n"
"Host: %s:%d\r\n" "Host: %s:%d\r\n"
"User-Agent: %s\r\n" "User-Agent: %s\r\n"
"Upgrade: websocket\r\n" "Upgrade: websocket\r\n"
"Sec-WebSocket-Version: 13\r\n" "Sec-WebSocket-Version: 13\r\n"
"Sec-WebSocket-Key: %s\r\n", "Sec-WebSocket-Key: %s\r\n",
ws->path, ws->path,
host, port, user_agent_ptr, host, port, user_agent_ptr,
client_key); client_key);
if (len <= 0 || len >= WS_BUFFER_SIZE) { if (len <= 0 || len >= WS_BUFFER_SIZE) {
ESP_LOGE(TAG, "Error in request generation, desired request len: %d, buffer size: %d", len, WS_BUFFER_SIZE); ESP_LOGE(TAG, "Error in request generation, desired request len: %d, buffer size: %d", len, WS_BUFFER_SIZE);
return -1; return -1;
@ -179,7 +175,7 @@ static int ws_connect(esp_transport_handle_t t, const char *host, int port, int
len += r; len += r;
if (r <= 0 || len >= WS_BUFFER_SIZE) { if (r <= 0 || len >= WS_BUFFER_SIZE) {
ESP_LOGE(TAG, "Error in request generation" ESP_LOGE(TAG, "Error in request generation"
"(snprintf of subprotocol returned %d, desired request len: %d, buffer size: %d", r, len, WS_BUFFER_SIZE); "(snprintf of subprotocol returned %d, desired request len: %d, buffer size: %d", r, len, WS_BUFFER_SIZE);
return -1; return -1;
} }
} }
@ -189,7 +185,7 @@ static int ws_connect(esp_transport_handle_t t, const char *host, int port, int
len += r; len += r;
if (r <= 0 || len >= WS_BUFFER_SIZE) { if (r <= 0 || len >= WS_BUFFER_SIZE) {
ESP_LOGE(TAG, "Error in request generation" ESP_LOGE(TAG, "Error in request generation"
"(strncpy of headers returned %d, desired request len: %d, buffer size: %d", r, len, WS_BUFFER_SIZE); "(strncpy of headers returned %d, desired request len: %d, buffer size: %d", r, len, WS_BUFFER_SIZE);
return -1; return -1;
} }
} }
@ -197,7 +193,7 @@ static int ws_connect(esp_transport_handle_t t, const char *host, int port, int
len += r; len += r;
if (r <= 0 || len >= WS_BUFFER_SIZE) { if (r <= 0 || len >= WS_BUFFER_SIZE) {
ESP_LOGE(TAG, "Error in request generation" ESP_LOGE(TAG, "Error in request generation"
"(snprintf of header terminal returned %d, desired request len: %d, buffer size: %d", r, len, WS_BUFFER_SIZE); "(snprintf of header terminal returned %d, desired request len: %d, buffer size: %d", r, len, WS_BUFFER_SIZE);
return -1; return -1;
} }
ESP_LOGD(TAG, "Write upgrade request\r\n%s", ws->buffer); ESP_LOGD(TAG, "Write upgrade request\r\n%s", ws->buffer);
@ -229,15 +225,15 @@ static int ws_connect(esp_transport_handle_t t, const char *host, int port, int
// If you are interested, see https://tools.ietf.org/html/rfc6455 // If you are interested, see https://tools.ietf.org/html/rfc6455
const char expected_server_magic[] = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; const char expected_server_magic[] = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
unsigned char expected_server_text[sizeof(client_key) + sizeof(expected_server_magic) + 1]; unsigned char expected_server_text[sizeof(client_key) + sizeof(expected_server_magic) + 1];
strcpy((char*)expected_server_text, (char*)client_key); strcpy((char *)expected_server_text, (char *)client_key);
strcat((char*)expected_server_text, expected_server_magic); strcat((char *)expected_server_text, expected_server_magic);
size_t key_len = strlen((char*)expected_server_text); size_t key_len = strlen((char *)expected_server_text);
esp_crypto_sha1(expected_server_text, key_len, expected_server_sha1); esp_crypto_sha1(expected_server_text, key_len, expected_server_sha1);
esp_crypto_base64_encode(expected_server_key, sizeof(expected_server_key), &outlen, expected_server_sha1, sizeof(expected_server_sha1)); esp_crypto_base64_encode(expected_server_key, sizeof(expected_server_key), &outlen, expected_server_sha1, sizeof(expected_server_sha1));
expected_server_key[ (outlen < sizeof(expected_server_key)) ? outlen : (sizeof(expected_server_key) - 1) ] = 0; expected_server_key[ (outlen < sizeof(expected_server_key)) ? outlen : (sizeof(expected_server_key) - 1) ] = 0;
ESP_LOGD(TAG, "server key=%s, send_key=%s, expected_server_key=%s", (char *)server_key, (char*)client_key, expected_server_key); ESP_LOGD(TAG, "server key=%s, send_key=%s, expected_server_key=%s", (char *)server_key, (char *)client_key, expected_server_key);
if (strcmp((char*)expected_server_key, (char*)server_key) != 0) { if (strcmp((char *)expected_server_key, (char *)server_key) != 0) {
ESP_LOGE(TAG, "Invalid websocket key"); ESP_LOGE(TAG, "Invalid websocket key");
return -1; return -1;
} }
@ -300,7 +296,7 @@ static int _ws_write(esp_transport_handle_t t, int opcode, int mask_flag, const
// in case of masked transport we have to revert back to the original data, as ws layer // in case of masked transport we have to revert back to the original data, as ws layer
// does not create its own copy of data to be sent // does not create its own copy of data to be sent
if (mask_flag) { if (mask_flag) {
mask = &ws_header[header_len-4]; mask = &ws_header[header_len - 4];
for (i = 0; i < len; ++i) { for (i = 0; i < len; ++i) {
buffer[i] = (buffer[i] ^ mask[i % 4]); buffer[i] = (buffer[i] ^ mask[i % 4]);
} }
@ -443,7 +439,7 @@ static int ws_handle_control_frame_internal(esp_transport_handle_t t, int timeou
// If no new header reception in progress, or not a control frame // If no new header reception in progress, or not a control frame
// just pass 0 -> no need to handle control frames // just pass 0 -> no need to handle control frames
if (ws->frame_state.header_received == false || if (ws->frame_state.header_received == false ||
!(ws->frame_state.opcode & WS_OPCODE_CONTROL_FRAME)) { !(ws->frame_state.opcode & WS_OPCODE_CONTROL_FRAME)) {
return 0; return 0;
} }
@ -499,7 +495,7 @@ static int ws_read(esp_transport_handle_t t, char *buffer, int len, int timeout_
// If the new opcode is a control frame and we don't pass it to the app // If the new opcode is a control frame and we don't pass it to the app
// - try to handle it internally using the application buffer // - try to handle it internally using the application buffer
if (ws->frame_state.header_received && (ws->frame_state.opcode & WS_OPCODE_CONTROL_FRAME) && if (ws->frame_state.header_received && (ws->frame_state.opcode & WS_OPCODE_CONTROL_FRAME) &&
ws->propagate_control_frames == false) { ws->propagate_control_frames == false) {
// automatically handle only 0 payload frames and make the transport read to return 0 on success // automatically handle only 0 payload frames and make the transport read to return 0 on success
// which might be interpreted as timeouts // which might be interpreted as timeouts
return ws_handle_control_frame_internal(t, timeout_ms); return ws_handle_control_frame_internal(t, timeout_ms);
@ -598,7 +594,10 @@ esp_transport_handle_t esp_transport_ws_init(esp_transport_handle_t parent_handl
return NULL; return NULL;
} }
transport_ws_t *ws = calloc(1, sizeof(transport_ws_t)); transport_ws_t *ws = calloc(1, sizeof(transport_ws_t));
ESP_TRANSPORT_MEM_CHECK(TAG, ws, return NULL); ESP_TRANSPORT_MEM_CHECK(TAG, ws, {
esp_transport_destroy(t);
return NULL;
});
ws->parent = parent_handle; ws->parent = parent_handle;
ws->path = strdup("/"); ws->path = strdup("/");
@ -735,7 +734,7 @@ static int esp_transport_ws_handle_control_frames(esp_transport_handle_t t, char
// If no new header reception in progress, or not a control frame // If no new header reception in progress, or not a control frame
// just pass 0 -> no need to handle control frames // just pass 0 -> no need to handle control frames
if (ws->frame_state.header_received == false || if (ws->frame_state.header_received == false ||
!(ws->frame_state.opcode & WS_OPCODE_CONTROL_FRAME)) { !(ws->frame_state.opcode & WS_OPCODE_CONTROL_FRAME)) {
return 0; return 0;
} }
int actual_len; int actual_len;
@ -771,7 +770,7 @@ static int esp_transport_ws_handle_control_frames(esp_transport_handle_t t, char
if (client_closed == false) { if (client_closed == false) {
// Only echo the closing frame if not initiated by the client // Only echo the closing frame if not initiated by the client
if (_ws_write(t, WS_OPCODE_CLOSE | WS_FIN, WS_MASK, NULL,0, timeout_ms) < 0) { if (_ws_write(t, WS_OPCODE_CLOSE | WS_FIN, WS_MASK, NULL, 0, timeout_ms) < 0) {
ESP_LOGE(TAG, "Sending CLOSE frame with 0 payload failed"); ESP_LOGE(TAG, "Sending CLOSE frame with 0 payload failed");
return -1; return -1;
} }

1
tools/ci/check_copyright_ignore.txt
View File

@ -2294,7 +2294,6 @@ components/tcp_transport/test/test_transport_fixtures.c
components/tcp_transport/transport.c components/tcp_transport/transport.c
components/tcp_transport/transport_ssl.c components/tcp_transport/transport_ssl.c
components/tcp_transport/transport_utils.c components/tcp_transport/transport_utils.c
components/tcp_transport/transport_ws.c
components/tcpip_adapter/include/tcpip_adapter.h components/tcpip_adapter/include/tcpip_adapter.h
components/tcpip_adapter/include/tcpip_adapter_compatible/tcpip_adapter_compat.h components/tcpip_adapter/include/tcpip_adapter_compatible/tcpip_adapter_compat.h
components/tcpip_adapter/include/tcpip_adapter_types.h components/tcpip_adapter/include/tcpip_adapter_types.h