/* * This file is part of the MicroPython project, http://micropython.org/ * * The MIT License (MIT) * * Copyright (c) 2022 Scott Shawcroft for Adafruit Industries * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ #include "supervisor/shared/web_workflow/websocket.h" #include "supervisor/shared/title_bar.h" // TODO: Remove ESP specific stuff. For now, it is useful as we refine the server. #include "esp_log.h" typedef struct { socketpool_socket_obj_t socket; uint8_t opcode; uint8_t frame_len; uint8_t payload_len_size; bool masked; bool closed; uint8_t mask[4]; int frame_index; size_t payload_remaining; } _websocket; static _websocket cp_serial; static const char *TAG = "CP websocket"; void websocket_init(void) { cp_serial.socket.num = -1; cp_serial.socket.connected = false; } void websocket_handoff(socketpool_socket_obj_t *socket) { cp_serial.socket = *socket; cp_serial.closed = false; cp_serial.opcode = 0; cp_serial.frame_index = 0; cp_serial.frame_len = 2; // Mark the original socket object as closed without telling the lower level. socket->connected = false; socket->num = -1; // Send the title bar for the new client. supervisor_title_bar_request_update(true); } bool websocket_connected(void) { return !cp_serial.closed && common_hal_socketpool_socket_get_connected(&cp_serial.socket); } static bool _read_byte(uint8_t *c) { int len = socketpool_socket_recv_into(&cp_serial.socket, c, 1); if (len != 1) { if (len != -EAGAIN) { ESP_LOGE(TAG, "recv error %d", len); } return false; } return true; } static void _send_raw(socketpool_socket_obj_t *socket, const uint8_t *buf, int len) { int sent = -EAGAIN; while (sent == -EAGAIN) { sent = socketpool_socket_send(socket, buf, len); } if (sent < len) { ESP_LOGE(TAG, "short send on %d err %d len %d", socket->num, sent, len); } } static void _read_next_frame_header(void) { uint8_t h; if (cp_serial.frame_index == 0 && _read_byte(&h)) { cp_serial.frame_index++; cp_serial.opcode = h & 0xf; } if (cp_serial.frame_index == 1 && _read_byte(&h)) { cp_serial.frame_index++; uint8_t len = h & 0x7f; cp_serial.masked = (h >> 7) == 1; if (len <= 125) { cp_serial.payload_remaining = len; cp_serial.payload_len_size = 0; } else if (len == 126) { // 16 bit length cp_serial.payload_len_size = 2; } else if (len == 127) { // 64 bit length cp_serial.payload_len_size = 8; } cp_serial.frame_len = 2 + cp_serial.payload_len_size; if (cp_serial.masked) { cp_serial.frame_len += 4; } } while (cp_serial.frame_index >= 2 && cp_serial.frame_index < (cp_serial.payload_len_size + 2) && _read_byte(&h)) { cp_serial.frame_index++; cp_serial.payload_remaining = cp_serial.payload_remaining << 8 | h; } int mask_start = cp_serial.payload_len_size + 2; while (cp_serial.frame_index >= mask_start && cp_serial.frame_index < cp_serial.frame_len && _read_byte(&h)) { size_t mask_offset = cp_serial.frame_index - mask_start; cp_serial.mask[mask_offset] = h; cp_serial.frame_index++; } // Reply to PINGs and CLOSE. while ((cp_serial.opcode == 0x8 || cp_serial.opcode == 0x9) && cp_serial.frame_index >= cp_serial.frame_len) { if (cp_serial.frame_index == cp_serial.frame_len) { uint8_t opcode = 0x8; // CLOSE if (cp_serial.opcode == 0x9) { opcode = 0xA; // PONG } else { // Set the TCP socket to send immediately so that we send the payload back before // closing the connection. int nodelay = 1; lwip_setsockopt(cp_serial.socket.num, IPPROTO_TCP, TCP_NODELAY, &nodelay, sizeof(nodelay)); } uint8_t frame_header[2]; frame_header[0] = 1 << 7 | opcode; if (cp_serial.payload_remaining > 125) { ESP_LOGE(TAG, "CLOSE or PING has long payload"); } frame_header[1] = cp_serial.payload_remaining; _send_raw(&cp_serial.socket, (const uint8_t *)frame_header, 2); } if (cp_serial.payload_remaining > 0 && _read_byte(&h)) { // Send the payload back to the client. cp_serial.frame_index++; cp_serial.payload_remaining--; _send_raw(&cp_serial.socket, &h, 1); } if (cp_serial.payload_remaining == 0) { cp_serial.frame_index = 0; if (cp_serial.opcode == 0x8) { cp_serial.closed = true; common_hal_socketpool_socket_close(&cp_serial.socket); } } } } static bool _read_next_payload_byte(uint8_t *c) { _read_next_frame_header(); if (cp_serial.opcode == 0x1 && cp_serial.frame_index >= cp_serial.frame_len && cp_serial.payload_remaining > 0) { if (_read_byte(c)) { uint8_t mask_offset = (cp_serial.frame_index - cp_serial.frame_len) % 4; *c ^= cp_serial.mask[mask_offset]; cp_serial.frame_index++; cp_serial.payload_remaining--; if (cp_serial.payload_remaining == 0) { cp_serial.frame_index = 0; } return true; } } return false; } bool websocket_available(void) { if (!websocket_connected()) { return false; } _read_next_frame_header(); return cp_serial.payload_remaining > 0 && cp_serial.frame_index >= cp_serial.frame_len; } char websocket_read_char(void) { uint8_t c; if (!_read_next_payload_byte(&c)) { c = -1; } return c; } static void _websocket_send(_websocket *ws, const char *text, size_t len) { if (!websocket_connected()) { return; } uint32_t opcode = 1; uint8_t frame_header[2]; frame_header[0] = 1 << 7 | opcode; uint8_t payload_len; if (len <= 125) { payload_len = len; } else if (len < (1 << 16)) { payload_len = 126; } else { payload_len = 127; } frame_header[1] = payload_len; _send_raw(&ws->socket, (const uint8_t *)frame_header, 2); uint8_t extended_len[4]; if (payload_len == 126) { extended_len[0] = (len >> 8) & 0xff; extended_len[1] = len & 0xff; _send_raw(&ws->socket, extended_len, 2); } else if (payload_len == 127) { uint32_t zero = 0; // 64 bits where top four bytes are zero. _send_raw(&ws->socket, (const uint8_t *)&zero, 4); extended_len[0] = (len >> 24) & 0xff; extended_len[1] = (len >> 16) & 0xff; extended_len[2] = (len >> 8) & 0xff; extended_len[3] = len & 0xff; _send_raw(&ws->socket, extended_len, 4); } _send_raw(&ws->socket, (const uint8_t *)text, len); char copy[len]; memcpy(copy, text, len); copy[len] = '\0'; } void websocket_write(const char *text, size_t len) { _websocket_send(&cp_serial, text, len); }