2022-09-09 16:11:14 +03:00
|
|
|
/***************************************************************************
|
|
|
|
* _ _ ____ _
|
|
|
|
* Project ___| | | | _ \| |
|
|
|
|
* / __| | | | |_) | |
|
|
|
|
* | (__| |_| | _ <| |___
|
|
|
|
* \___|\___/|_| \_\_____|
|
|
|
|
*
|
|
|
|
* Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
|
|
*
|
|
|
|
* This software is licensed as described in the file COPYING, which
|
|
|
|
* you should have received as part of this distribution. The terms
|
|
|
|
* are also available at https://curl.se/docs/copyright.html.
|
|
|
|
*
|
|
|
|
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
|
|
* copies of the Software, and permit persons to whom the Software is
|
|
|
|
* furnished to do so, under the terms of the COPYING file.
|
|
|
|
*
|
|
|
|
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
|
|
* KIND, either express or implied.
|
|
|
|
*
|
|
|
|
* SPDX-License-Identifier: curl
|
|
|
|
*
|
|
|
|
***************************************************************************/
|
|
|
|
#include "curl_setup.h"
|
2022-09-12 11:22:42 +03:00
|
|
|
#include <curl/curl.h>
|
2022-09-09 16:11:14 +03:00
|
|
|
|
|
|
|
#ifdef USE_WEBSOCKETS
|
|
|
|
|
|
|
|
#include "urldata.h"
|
|
|
|
#include "dynbuf.h"
|
|
|
|
#include "rand.h"
|
|
|
|
#include "curl_base64.h"
|
|
|
|
#include "sendf.h"
|
|
|
|
#include "multiif.h"
|
|
|
|
#include "ws.h"
|
|
|
|
#include "easyif.h"
|
|
|
|
#include "transfer.h"
|
|
|
|
#include "nonblock.h"
|
|
|
|
|
|
|
|
/* The last 3 #include files should be in this order */
|
|
|
|
#include "curl_printf.h"
|
|
|
|
#include "curl_memory.h"
|
|
|
|
#include "memdebug.h"
|
|
|
|
|
|
|
|
struct wsfield {
|
|
|
|
const char *name;
|
|
|
|
const char *val;
|
|
|
|
};
|
|
|
|
|
|
|
|
CURLcode Curl_ws_request(struct Curl_easy *data, REQTYPE *req)
|
|
|
|
{
|
|
|
|
unsigned int i;
|
|
|
|
CURLcode result = CURLE_OK;
|
|
|
|
unsigned char rand[16];
|
|
|
|
char *randstr;
|
|
|
|
size_t randlen;
|
|
|
|
char keyval[40];
|
|
|
|
struct SingleRequest *k = &data->req;
|
2022-09-20 11:54:22 +03:00
|
|
|
struct wsfield heads[]= {
|
2022-09-09 16:11:14 +03:00
|
|
|
{
|
|
|
|
/* The request MUST contain an |Upgrade| header field whose value
|
|
|
|
MUST include the "websocket" keyword. */
|
|
|
|
"Upgrade:", "websocket"
|
|
|
|
},
|
|
|
|
{
|
|
|
|
/* The request MUST contain a |Connection| header field whose value
|
|
|
|
MUST include the "Upgrade" token. */
|
|
|
|
"Connection:", "Upgrade",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
/* The request MUST include a header field with the name
|
|
|
|
|Sec-WebSocket-Version|. The value of this header field MUST be
|
|
|
|
13. */
|
|
|
|
"Sec-WebSocket-Version:", "13",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
/* The request MUST include a header field with the name
|
|
|
|
|Sec-WebSocket-Key|. The value of this header field MUST be a nonce
|
|
|
|
consisting of a randomly selected 16-byte value that has been
|
|
|
|
base64-encoded (see Section 4 of [RFC4648]). The nonce MUST be
|
|
|
|
selected randomly for each connection. */
|
2022-09-20 11:54:22 +03:00
|
|
|
"Sec-WebSocket-Key:", NULL,
|
2022-09-09 16:11:14 +03:00
|
|
|
}
|
|
|
|
};
|
2022-09-20 11:54:22 +03:00
|
|
|
heads[3].val = &keyval[0];
|
2022-09-09 16:11:14 +03:00
|
|
|
|
|
|
|
/* 16 bytes random */
|
|
|
|
result = Curl_rand(data, (unsigned char *)rand, sizeof(rand));
|
|
|
|
if(result)
|
|
|
|
return result;
|
|
|
|
result = Curl_base64_encode((char *)rand, sizeof(rand), &randstr, &randlen);
|
|
|
|
if(result)
|
|
|
|
return result;
|
|
|
|
DEBUGASSERT(randlen < sizeof(keyval));
|
|
|
|
if(randlen >= sizeof(keyval))
|
|
|
|
return CURLE_FAILED_INIT;
|
|
|
|
strcpy(keyval, randstr);
|
|
|
|
free(randstr);
|
|
|
|
for(i = 0; !result && (i < sizeof(heads)/sizeof(heads[0])); i++) {
|
|
|
|
if(!Curl_checkheaders(data, STRCONST(heads[i].name))) {
|
|
|
|
#ifdef USE_HYPER
|
|
|
|
char field[128];
|
|
|
|
msnprintf(field, sizeof(field), "%s %s", heads[i].name,
|
|
|
|
heads[i].val);
|
|
|
|
result = Curl_hyper_header(data, req, field);
|
|
|
|
#else
|
|
|
|
(void)data;
|
|
|
|
result = Curl_dyn_addf(req, "%s %s\r\n", heads[i].name,
|
|
|
|
heads[i].val);
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
}
|
|
|
|
k->upgr101 = UPGR101_WS;
|
|
|
|
Curl_dyn_init(&data->req.p.http->ws.buf, MAX_WS_SIZE * 2);
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
|
|
|
CURLcode Curl_ws_accept(struct Curl_easy *data)
|
|
|
|
{
|
|
|
|
struct SingleRequest *k = &data->req;
|
|
|
|
struct HTTP *ws = data->req.p.http;
|
|
|
|
struct connectdata *conn = data->conn;
|
2022-10-03 18:40:02 +03:00
|
|
|
struct websocket *wsp = &data->req.p.http->ws;
|
2022-09-09 16:11:14 +03:00
|
|
|
CURLcode result;
|
|
|
|
|
|
|
|
/* Verify the Sec-WebSocket-Accept response.
|
|
|
|
|
|
|
|
The sent value is the base64 encoded version of a SHA-1 hash done on the
|
|
|
|
|Sec-WebSocket-Key| header field concatenated with
|
|
|
|
the string "258EAFA5-E914-47DA-95CA-C5AB0DC85B11".
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* If the response includes a |Sec-WebSocket-Extensions| header field and
|
|
|
|
this header field indicates the use of an extension that was not present
|
|
|
|
in the client's handshake (the server has indicated an extension not
|
|
|
|
requested by the client), the client MUST Fail the WebSocket Connection.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* If the response includes a |Sec-WebSocket-Protocol| header field
|
|
|
|
and this header field indicates the use of a subprotocol that was
|
|
|
|
not present in the client's handshake (the server has indicated a
|
|
|
|
subprotocol not requested by the client), the client MUST Fail
|
|
|
|
the WebSocket Connection. */
|
|
|
|
|
|
|
|
/* 4 bytes random */
|
|
|
|
result = Curl_rand(data, (unsigned char *)&ws->ws.mask, sizeof(ws->ws.mask));
|
|
|
|
if(result)
|
|
|
|
return result;
|
|
|
|
|
2022-10-03 18:40:02 +03:00
|
|
|
infof(data, "Received 101, switch to WebSocket; mask %02x%02x%02x%02x",
|
2022-09-09 16:11:14 +03:00
|
|
|
ws->ws.mask[0], ws->ws.mask[1], ws->ws.mask[2], ws->ws.mask[3]);
|
|
|
|
k->upgr101 = UPGR101_RECEIVED;
|
|
|
|
|
|
|
|
if(data->set.connect_only)
|
|
|
|
/* switch off non-blocking sockets */
|
|
|
|
(void)curlx_nonblock(conn->sock[FIRSTSOCKET], FALSE);
|
|
|
|
|
2022-10-03 18:40:02 +03:00
|
|
|
wsp->oleft = 0;
|
2022-09-09 16:11:14 +03:00
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
|
|
|
#define WSBIT_FIN 0x80
|
|
|
|
#define WSBIT_OPCODE_CONT 0
|
|
|
|
#define WSBIT_OPCODE_TEXT (1)
|
|
|
|
#define WSBIT_OPCODE_BIN (2)
|
|
|
|
#define WSBIT_OPCODE_CLOSE (8)
|
|
|
|
#define WSBIT_OPCODE_PING (9)
|
|
|
|
#define WSBIT_OPCODE_PONG (0xa)
|
|
|
|
#define WSBIT_OPCODE_MASK (0xf)
|
|
|
|
|
|
|
|
#define WSBIT_MASK 0x80
|
|
|
|
|
|
|
|
/* remove the spent bytes from the beginning of the buffer as that part has
|
|
|
|
now been delivered to the application */
|
2022-11-11 17:15:37 +03:00
|
|
|
static void ws_decode_shift(struct Curl_easy *data, size_t spent)
|
2022-09-09 16:11:14 +03:00
|
|
|
{
|
2022-10-03 18:40:02 +03:00
|
|
|
struct websocket *wsp = &data->req.p.http->ws;
|
2022-09-09 16:11:14 +03:00
|
|
|
size_t len = Curl_dyn_len(&wsp->buf);
|
|
|
|
size_t keep = len - spent;
|
|
|
|
DEBUGASSERT(len >= spent);
|
|
|
|
Curl_dyn_tail(&wsp->buf, keep);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* ws_decode() decodes a binary frame into structured WebSocket data,
|
|
|
|
|
|
|
|
wpkt - the incoming raw data. If NULL, work on the already buffered data.
|
|
|
|
ilen - the size of the provided data, perhaps too little, perhaps too much
|
|
|
|
out - stored pointed to extracted data
|
|
|
|
olen - stored length of the extracted data
|
2022-10-03 18:40:02 +03:00
|
|
|
oleft - number of unread bytes pending to that belongs to this frame
|
2022-10-10 00:35:21 +03:00
|
|
|
more - if there is more data in there
|
2022-09-09 16:11:14 +03:00
|
|
|
flags - stored bitmask about the frame
|
|
|
|
|
|
|
|
Returns CURLE_AGAIN if there is only a partial frame in the buffer. Then it
|
|
|
|
stores the first part in the ->extra buffer to be used in the next call
|
|
|
|
when more data is provided.
|
|
|
|
*/
|
|
|
|
|
|
|
|
static CURLcode ws_decode(struct Curl_easy *data,
|
2022-11-11 17:15:37 +03:00
|
|
|
unsigned char *inbuf, size_t inlen,
|
|
|
|
size_t *headlen, size_t *olen,
|
2022-10-03 18:40:02 +03:00
|
|
|
curl_off_t *oleft,
|
2022-09-09 16:11:14 +03:00
|
|
|
unsigned int *flags)
|
|
|
|
{
|
|
|
|
bool fin;
|
|
|
|
unsigned char opcode;
|
2022-10-03 18:40:02 +03:00
|
|
|
curl_off_t total;
|
2022-09-09 16:11:14 +03:00
|
|
|
size_t dataindex = 2;
|
2022-10-03 18:40:02 +03:00
|
|
|
curl_off_t payloadsize;
|
2022-09-09 16:11:14 +03:00
|
|
|
|
2022-11-11 17:15:37 +03:00
|
|
|
*olen = *headlen = 0;
|
2022-09-09 16:11:14 +03:00
|
|
|
|
2022-11-11 17:15:37 +03:00
|
|
|
if(inlen < 2) {
|
2022-09-09 16:11:14 +03:00
|
|
|
/* the smallest possible frame is two bytes */
|
2022-11-11 17:15:37 +03:00
|
|
|
infof(data, "WS: plen == %u, EAGAIN", (int)inlen);
|
2022-09-09 16:11:14 +03:00
|
|
|
return CURLE_AGAIN;
|
|
|
|
}
|
|
|
|
|
2022-11-11 17:15:37 +03:00
|
|
|
fin = inbuf[0] & WSBIT_FIN;
|
|
|
|
opcode = inbuf[0] & WSBIT_OPCODE_MASK;
|
2022-09-09 16:11:14 +03:00
|
|
|
infof(data, "WS:%d received FIN bit %u", __LINE__, (int)fin);
|
|
|
|
*flags = 0;
|
|
|
|
switch(opcode) {
|
|
|
|
case WSBIT_OPCODE_CONT:
|
|
|
|
if(!fin)
|
|
|
|
*flags |= CURLWS_CONT;
|
|
|
|
infof(data, "WS: received OPCODE CONT");
|
|
|
|
break;
|
|
|
|
case WSBIT_OPCODE_TEXT:
|
|
|
|
infof(data, "WS: received OPCODE TEXT");
|
|
|
|
*flags |= CURLWS_TEXT;
|
|
|
|
break;
|
|
|
|
case WSBIT_OPCODE_BIN:
|
|
|
|
infof(data, "WS: received OPCODE BINARY");
|
|
|
|
*flags |= CURLWS_BINARY;
|
|
|
|
break;
|
|
|
|
case WSBIT_OPCODE_CLOSE:
|
|
|
|
infof(data, "WS: received OPCODE CLOSE");
|
|
|
|
*flags |= CURLWS_CLOSE;
|
|
|
|
break;
|
|
|
|
case WSBIT_OPCODE_PING:
|
|
|
|
infof(data, "WS: received OPCODE PING");
|
|
|
|
*flags |= CURLWS_PING;
|
|
|
|
break;
|
|
|
|
case WSBIT_OPCODE_PONG:
|
|
|
|
infof(data, "WS: received OPCODE PONG");
|
|
|
|
*flags |= CURLWS_PONG;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
2022-11-11 17:15:37 +03:00
|
|
|
if(inbuf[1] & WSBIT_MASK) {
|
2022-09-09 16:11:14 +03:00
|
|
|
/* A client MUST close a connection if it detects a masked frame. */
|
|
|
|
failf(data, "WS: masked input frame");
|
|
|
|
return CURLE_RECV_ERROR;
|
|
|
|
}
|
2022-11-11 17:15:37 +03:00
|
|
|
payloadsize = inbuf[1];
|
2022-10-03 18:40:02 +03:00
|
|
|
if(payloadsize == 126) {
|
2022-11-11 17:15:37 +03:00
|
|
|
if(inlen < 4) {
|
|
|
|
infof(data, "WS:%d plen == %u, EAGAIN", __LINE__, (int)inlen);
|
2022-09-09 16:11:14 +03:00
|
|
|
return CURLE_AGAIN; /* not enough data available */
|
|
|
|
}
|
2022-11-11 17:15:37 +03:00
|
|
|
payloadsize = (inbuf[2] << 8) | inbuf[3];
|
2022-09-09 16:11:14 +03:00
|
|
|
dataindex += 2;
|
|
|
|
}
|
2022-10-03 18:40:02 +03:00
|
|
|
else if(payloadsize == 127) {
|
|
|
|
/* 64 bit payload size */
|
2022-11-11 17:15:37 +03:00
|
|
|
if(inlen < 10)
|
2022-10-03 18:40:02 +03:00
|
|
|
return CURLE_AGAIN;
|
2022-11-11 17:15:37 +03:00
|
|
|
if(inbuf[2] & 80) {
|
2022-10-03 18:40:02 +03:00
|
|
|
failf(data, "WS: too large frame");
|
|
|
|
return CURLE_RECV_ERROR;
|
|
|
|
}
|
|
|
|
dataindex += 8;
|
2022-11-11 17:15:37 +03:00
|
|
|
payloadsize = ((curl_off_t)inbuf[2] << 56) |
|
|
|
|
(curl_off_t)inbuf[3] << 48 |
|
|
|
|
(curl_off_t)inbuf[4] << 40 |
|
|
|
|
(curl_off_t)inbuf[5] << 32 |
|
|
|
|
(curl_off_t)inbuf[6] << 24 |
|
|
|
|
(curl_off_t)inbuf[7] << 16 |
|
|
|
|
(curl_off_t)inbuf[8] << 8 |
|
|
|
|
inbuf[9];
|
2022-09-09 16:11:14 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
/* point to the payload */
|
2022-11-11 17:15:37 +03:00
|
|
|
*headlen = dataindex;
|
|
|
|
total = dataindex + payloadsize;
|
|
|
|
if(total > (curl_off_t)inlen) {
|
|
|
|
/* buffer contains partial frame */
|
|
|
|
*olen = inlen - dataindex; /* bytes to write out */
|
|
|
|
*oleft = total - inlen; /* bytes yet to come (for this frame) */
|
|
|
|
payloadsize = total - dataindex;
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
/* we have the complete frame (`total` bytes) in buffer */
|
|
|
|
*olen = payloadsize; /* bytes to write out */
|
|
|
|
*oleft = 0; /* bytes yet to come (for this frame) */
|
|
|
|
}
|
|
|
|
|
|
|
|
infof(data, "WS: received %zu bytes payload (%zu left, buflen was %zu)",
|
|
|
|
payloadsize, *oleft, inlen);
|
2022-09-09 16:11:14 +03:00
|
|
|
return CURLE_OK;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Curl_ws_writecb() is the write callback for websocket traffic. The
|
|
|
|
websocket data is provided to this raw, in chunks. This function should
|
|
|
|
handle/decode the data and call the "real" underlying callback accordingly.
|
|
|
|
*/
|
|
|
|
size_t Curl_ws_writecb(char *buffer, size_t size /* 1 */,
|
|
|
|
size_t nitems, void *userp)
|
|
|
|
{
|
|
|
|
struct HTTP *ws = (struct HTTP *)userp;
|
|
|
|
struct Curl_easy *data = ws->ws.data;
|
2022-11-11 17:15:37 +03:00
|
|
|
struct websocket *wsp = &data->req.p.http->ws;
|
2022-09-09 16:11:14 +03:00
|
|
|
void *writebody_ptr = data->set.out;
|
|
|
|
if(data->set.ws_raw_mode)
|
|
|
|
return data->set.fwrite_func(buffer, size, nitems, writebody_ptr);
|
|
|
|
else if(nitems) {
|
2022-11-11 17:15:37 +03:00
|
|
|
size_t wrote = 0, headlen;
|
2022-09-09 16:11:14 +03:00
|
|
|
CURLcode result;
|
2022-11-11 17:15:37 +03:00
|
|
|
|
|
|
|
if(buffer) {
|
|
|
|
result = Curl_dyn_addn(&wsp->buf, buffer, nitems);
|
|
|
|
if(result) {
|
|
|
|
infof(data, "WS: error adding data to buffer %d", (int)result);
|
2022-10-03 18:40:02 +03:00
|
|
|
return nitems - 1;
|
|
|
|
}
|
2022-11-11 17:15:37 +03:00
|
|
|
buffer = NULL;
|
2022-10-03 18:40:02 +03:00
|
|
|
}
|
2022-11-11 17:15:37 +03:00
|
|
|
|
|
|
|
while(Curl_dyn_len(&wsp->buf)) {
|
|
|
|
unsigned char *wsbuf = Curl_dyn_uptr(&wsp->buf);
|
|
|
|
size_t buflen = Curl_dyn_len(&wsp->buf);
|
|
|
|
size_t write_len = 0;
|
|
|
|
size_t consumed = 0;
|
|
|
|
|
|
|
|
if(!ws->ws.frame.bytesleft) {
|
|
|
|
unsigned int recvflags;
|
|
|
|
curl_off_t fb_left;
|
|
|
|
|
|
|
|
result = ws_decode(data, wsbuf, buflen,
|
|
|
|
&headlen, &write_len, &fb_left, &recvflags);
|
|
|
|
consumed += headlen;
|
|
|
|
wsbuf += headlen;
|
|
|
|
buflen -= headlen;
|
|
|
|
if(result == CURLE_AGAIN)
|
|
|
|
/* insufficient amount of data, keep it for later.
|
|
|
|
* we pretend to have written all since we have a copy */
|
|
|
|
return nitems;
|
|
|
|
else if(result) {
|
|
|
|
infof(data, "WS: decode error %d", (int)result);
|
|
|
|
return nitems - 1;
|
|
|
|
}
|
|
|
|
/* New frame. store details about the frame to be reachable with
|
|
|
|
curl_ws_meta() from within the write callback */
|
|
|
|
ws->ws.frame.age = 0;
|
|
|
|
ws->ws.frame.offset = 0;
|
|
|
|
ws->ws.frame.flags = recvflags;
|
|
|
|
ws->ws.frame.bytesleft = fb_left;
|
2022-10-07 15:07:46 +03:00
|
|
|
}
|
2022-11-11 17:15:37 +03:00
|
|
|
else {
|
|
|
|
/* continuing frame */
|
|
|
|
write_len = (size_t)ws->ws.frame.bytesleft;
|
|
|
|
if(write_len > buflen)
|
|
|
|
write_len = buflen;
|
|
|
|
ws->ws.frame.offset += write_len;
|
|
|
|
ws->ws.frame.bytesleft -= write_len;
|
|
|
|
}
|
|
|
|
if((ws->ws.frame.flags & CURLWS_PING) && !ws->ws.frame.bytesleft) {
|
|
|
|
/* auto-respond to PINGs, only works for single-frame payloads atm */
|
|
|
|
size_t bytes;
|
|
|
|
infof(data, "WS: auto-respond to PING with a PONG");
|
|
|
|
/* send back the exact same content as a PONG */
|
|
|
|
result = curl_ws_send(data, wsbuf, write_len,
|
|
|
|
&bytes, 0, CURLWS_PONG);
|
|
|
|
if(result)
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
else if(write_len || !wsp->frame.bytesleft) {
|
|
|
|
/* deliver the decoded frame to the user callback */
|
|
|
|
Curl_set_in_callback(data, true);
|
|
|
|
wrote = data->set.fwrite_func((char *)wsbuf, 1,
|
|
|
|
write_len, writebody_ptr);
|
|
|
|
Curl_set_in_callback(data, false);
|
|
|
|
if(wrote != write_len)
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
/* get rid of the buffered data consumed */
|
|
|
|
consumed += write_len;
|
|
|
|
ws_decode_shift(data, consumed);
|
2022-09-09 16:11:14 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return nitems;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2022-09-09 16:11:14 +03:00
|
|
|
CURL_EXTERN CURLcode curl_ws_recv(struct Curl_easy *data, void *buffer,
|
2022-10-03 18:40:02 +03:00
|
|
|
size_t buflen, size_t *nread,
|
|
|
|
struct curl_ws_frame **metap)
|
2022-09-09 16:11:14 +03:00
|
|
|
{
|
|
|
|
CURLcode result;
|
2022-10-03 18:40:02 +03:00
|
|
|
struct websocket *wsp = &data->req.p.http->ws;
|
2022-11-11 17:15:37 +03:00
|
|
|
bool done = FALSE; /* not filled passed buffer yet */
|
2022-09-09 16:11:14 +03:00
|
|
|
|
|
|
|
*nread = 0;
|
2022-10-03 18:40:02 +03:00
|
|
|
*metap = NULL;
|
2022-09-09 16:11:14 +03:00
|
|
|
/* get a download buffer */
|
|
|
|
result = Curl_preconnect(data);
|
|
|
|
if(result)
|
|
|
|
return result;
|
|
|
|
|
2022-11-11 17:15:37 +03:00
|
|
|
while(!done) {
|
|
|
|
size_t write_len;
|
|
|
|
unsigned int recvflags;
|
|
|
|
|
|
|
|
if(!wsp->stillblen) {
|
|
|
|
/* try to get more data */
|
|
|
|
size_t n;
|
2022-10-03 18:40:02 +03:00
|
|
|
result = curl_easy_recv(data, data->state.buffer,
|
2022-11-11 17:15:37 +03:00
|
|
|
data->set.buffer_size, &n);
|
2022-10-03 18:40:02 +03:00
|
|
|
if(result)
|
|
|
|
return result;
|
2022-11-11 17:15:37 +03:00
|
|
|
if(!n)
|
|
|
|
/* still have nothing */
|
|
|
|
goto out;
|
|
|
|
wsp->stillb = data->state.buffer;
|
|
|
|
wsp->stillblen = n;
|
|
|
|
}
|
|
|
|
|
|
|
|
infof(data, "WS: got %u websocket bytes to decode",
|
|
|
|
(int)wsp->stillblen);
|
|
|
|
if(!wsp->frame.bytesleft) {
|
|
|
|
size_t headlen;
|
|
|
|
curl_off_t oleft;
|
|
|
|
/* detect new frame */
|
|
|
|
result = ws_decode(data, (unsigned char *)wsp->stillb, wsp->stillblen,
|
|
|
|
&headlen, &write_len, &oleft, &recvflags);
|
|
|
|
if(result == CURLE_AGAIN)
|
|
|
|
/* a packet fragment only */
|
|
|
|
break;
|
|
|
|
else if(result)
|
|
|
|
return result;
|
|
|
|
wsp->stillb += headlen;
|
|
|
|
wsp->stillblen -= headlen;
|
|
|
|
wsp->frame.offset = 0;
|
|
|
|
wsp->frame.bytesleft = oleft;
|
|
|
|
wsp->frame.flags = recvflags;
|
2022-10-03 18:40:02 +03:00
|
|
|
}
|
|
|
|
else {
|
2022-11-11 17:15:37 +03:00
|
|
|
/* existing frame, remaining payload handling */
|
|
|
|
write_len = wsp->frame.bytesleft;
|
|
|
|
if(write_len > wsp->stillblen)
|
|
|
|
write_len = wsp->stillblen;
|
2022-10-03 18:40:02 +03:00
|
|
|
}
|
2022-09-09 16:11:14 +03:00
|
|
|
|
2022-11-11 17:15:37 +03:00
|
|
|
/* auto-respond to PINGs */
|
|
|
|
if((wsp->frame.flags & CURLWS_PING) && !wsp->frame.bytesleft) {
|
|
|
|
infof(data, "WS: auto-respond to PING with a PONG");
|
|
|
|
/* send back the exact same content as a PONG */
|
|
|
|
result = curl_ws_send(data, wsp->stillb, write_len,
|
|
|
|
&write_len, 0, CURLWS_PONG);
|
|
|
|
if(result)
|
|
|
|
return result;
|
2022-09-09 16:11:14 +03:00
|
|
|
}
|
2022-11-11 17:15:37 +03:00
|
|
|
else if(write_len || !wsp->frame.bytesleft) {
|
|
|
|
if(write_len > buflen)
|
|
|
|
write_len = buflen;
|
|
|
|
/* copy the payload to the user buffer */
|
|
|
|
memcpy(buffer, wsp->stillb, write_len);
|
|
|
|
*nread = write_len;
|
|
|
|
done = TRUE;
|
|
|
|
}
|
|
|
|
if(write_len) {
|
|
|
|
/* update buffer and frame info */
|
|
|
|
wsp->frame.offset += write_len;
|
|
|
|
DEBUGASSERT(wsp->frame.bytesleft >= (curl_off_t)write_len);
|
|
|
|
if(wsp->frame.bytesleft)
|
|
|
|
wsp->frame.bytesleft -= write_len;
|
|
|
|
DEBUGASSERT(write_len <= wsp->stillblen);
|
|
|
|
wsp->stillblen -= write_len;
|
|
|
|
if(wsp->stillblen)
|
|
|
|
wsp->stillb += write_len;
|
|
|
|
else
|
|
|
|
wsp->stillb = NULL;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
out:
|
2022-10-03 18:40:02 +03:00
|
|
|
*metap = &wsp->frame;
|
2022-09-09 16:11:14 +03:00
|
|
|
return CURLE_OK;
|
|
|
|
}
|
|
|
|
|
2022-10-03 18:40:02 +03:00
|
|
|
static void ws_xor(struct Curl_easy *data,
|
|
|
|
const unsigned char *source,
|
|
|
|
unsigned char *dest,
|
|
|
|
size_t len)
|
|
|
|
{
|
|
|
|
struct websocket *wsp = &data->req.p.http->ws;
|
|
|
|
size_t i;
|
|
|
|
/* append payload after the mask, XOR appropriately */
|
|
|
|
for(i = 0; i < len; i++) {
|
|
|
|
dest[i] = source[i] ^ wsp->mask[wsp->xori];
|
|
|
|
wsp->xori++;
|
|
|
|
wsp->xori &= 3;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-09 16:11:14 +03:00
|
|
|
/***
|
|
|
|
RFC 6455 Section 5.2
|
|
|
|
|
|
|
|
0 1 2 3
|
|
|
|
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
|
|
|
|
+-+-+-+-+-------+-+-------------+-------------------------------+
|
|
|
|
|F|R|R|R| opcode|M| Payload len | Extended payload length |
|
|
|
|
|I|S|S|S| (4) |A| (7) | (16/64) |
|
|
|
|
|N|V|V|V| |S| | (if payload len==126/127) |
|
|
|
|
| |1|2|3| |K| | |
|
|
|
|
+-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
|
|
|
|
| Extended payload length continued, if payload len == 127 |
|
|
|
|
+ - - - - - - - - - - - - - - - +-------------------------------+
|
|
|
|
| |Masking-key, if MASK set to 1 |
|
|
|
|
+-------------------------------+-------------------------------+
|
|
|
|
| Masking-key (continued) | Payload Data |
|
|
|
|
+-------------------------------- - - - - - - - - - - - - - - - +
|
|
|
|
: Payload Data continued ... :
|
|
|
|
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
|
|
|
|
| Payload Data continued ... |
|
|
|
|
+---------------------------------------------------------------+
|
|
|
|
*/
|
|
|
|
|
2022-10-03 18:40:02 +03:00
|
|
|
static size_t ws_packethead(struct Curl_easy *data,
|
|
|
|
size_t len, unsigned int flags)
|
2022-09-09 16:11:14 +03:00
|
|
|
{
|
|
|
|
struct HTTP *ws = data->req.p.http;
|
|
|
|
unsigned char *out = (unsigned char *)data->state.ulbuf;
|
|
|
|
unsigned char firstbyte = 0;
|
|
|
|
int outi;
|
|
|
|
unsigned char opcode;
|
|
|
|
if(flags & CURLWS_TEXT) {
|
|
|
|
opcode = WSBIT_OPCODE_TEXT;
|
|
|
|
infof(data, "WS: send OPCODE TEXT");
|
|
|
|
}
|
|
|
|
else if(flags & CURLWS_CLOSE) {
|
|
|
|
opcode = WSBIT_OPCODE_CLOSE;
|
|
|
|
infof(data, "WS: send OPCODE CLOSE");
|
|
|
|
}
|
|
|
|
else if(flags & CURLWS_PING) {
|
|
|
|
opcode = WSBIT_OPCODE_PING;
|
|
|
|
infof(data, "WS: send OPCODE PING");
|
|
|
|
}
|
|
|
|
else if(flags & CURLWS_PONG) {
|
|
|
|
opcode = WSBIT_OPCODE_PONG;
|
|
|
|
infof(data, "WS: send OPCODE PONG");
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
opcode = WSBIT_OPCODE_BIN;
|
|
|
|
infof(data, "WS: send OPCODE BINARY");
|
|
|
|
}
|
|
|
|
|
|
|
|
if(!(flags & CURLWS_CONT)) {
|
|
|
|
/* if not marked as continuing, assume this is the final fragment */
|
|
|
|
firstbyte |= WSBIT_FIN | opcode;
|
|
|
|
ws->ws.contfragment = FALSE;
|
|
|
|
}
|
|
|
|
else if(ws->ws.contfragment) {
|
|
|
|
/* the previous fragment was not a final one and this isn't either, keep a
|
|
|
|
CONT opcode and no FIN bit */
|
|
|
|
firstbyte |= WSBIT_OPCODE_CONT;
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
ws->ws.contfragment = TRUE;
|
|
|
|
}
|
|
|
|
out[0] = firstbyte;
|
2022-10-03 18:40:02 +03:00
|
|
|
if(len > 65535) {
|
|
|
|
out[1] = 127 | WSBIT_MASK;
|
|
|
|
out[2] = (len >> 8) & 0xff;
|
|
|
|
out[3] = len & 0xff;
|
|
|
|
outi = 10;
|
|
|
|
}
|
2022-10-07 15:07:46 +03:00
|
|
|
else if(len > 126) {
|
2022-09-09 16:11:14 +03:00
|
|
|
out[1] = 126 | WSBIT_MASK;
|
|
|
|
out[2] = (len >> 8) & 0xff;
|
|
|
|
out[3] = len & 0xff;
|
|
|
|
outi = 4;
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
out[1] = (unsigned char)len | WSBIT_MASK;
|
|
|
|
outi = 2;
|
|
|
|
}
|
|
|
|
|
|
|
|
infof(data, "WS: send FIN bit %u (byte %02x)",
|
|
|
|
firstbyte & WSBIT_FIN ? 1 : 0,
|
|
|
|
firstbyte);
|
|
|
|
infof(data, "WS: send payload len %u", (int)len);
|
|
|
|
|
|
|
|
/* 4 bytes mask */
|
|
|
|
memcpy(&out[outi], &ws->ws.mask, 4);
|
|
|
|
|
|
|
|
if(data->set.upload_buffer_size < (len + 10))
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
/* pass over the mask */
|
|
|
|
outi += 4;
|
|
|
|
|
2022-10-03 18:40:02 +03:00
|
|
|
ws->ws.xori = 0;
|
2022-09-09 16:11:14 +03:00
|
|
|
/* return packet size */
|
|
|
|
return outi;
|
|
|
|
}
|
|
|
|
|
2022-09-09 16:11:14 +03:00
|
|
|
CURL_EXTERN CURLcode curl_ws_send(struct Curl_easy *data, const void *buffer,
|
|
|
|
size_t buflen, size_t *sent,
|
2022-10-03 18:40:02 +03:00
|
|
|
curl_off_t totalsize,
|
2022-09-09 16:11:14 +03:00
|
|
|
unsigned int sendflags)
|
2022-09-09 16:11:14 +03:00
|
|
|
{
|
|
|
|
CURLcode result;
|
2022-10-03 18:40:02 +03:00
|
|
|
size_t headlen;
|
2022-09-09 16:11:14 +03:00
|
|
|
char *out;
|
2022-10-03 18:40:02 +03:00
|
|
|
ssize_t written;
|
|
|
|
struct websocket *wsp = &data->req.p.http->ws;
|
2022-09-09 16:11:14 +03:00
|
|
|
|
|
|
|
if(!data->set.ws_raw_mode) {
|
|
|
|
result = Curl_get_upload_buffer(data);
|
|
|
|
if(result)
|
|
|
|
return result;
|
|
|
|
}
|
2022-10-03 18:40:02 +03:00
|
|
|
else {
|
|
|
|
if(totalsize || sendflags)
|
|
|
|
return CURLE_BAD_FUNCTION_ARGUMENT;
|
|
|
|
}
|
2022-09-09 16:11:14 +03:00
|
|
|
|
2022-10-03 18:40:02 +03:00
|
|
|
if(data->set.ws_raw_mode) {
|
|
|
|
if(!buflen)
|
|
|
|
/* nothing to do */
|
|
|
|
return CURLE_OK;
|
|
|
|
/* raw mode sends exactly what was requested, and this is from within
|
|
|
|
the write callback */
|
|
|
|
if(Curl_is_in_callback(data))
|
2022-09-09 16:11:14 +03:00
|
|
|
result = Curl_write(data, data->conn->writesockfd, buffer, buflen,
|
|
|
|
&written);
|
2022-10-03 18:40:02 +03:00
|
|
|
else
|
|
|
|
result = Curl_senddata(data, buffer, buflen, &written);
|
|
|
|
|
|
|
|
infof(data, "WS: wanted to send %zu bytes, sent %zu bytes",
|
|
|
|
buflen, written);
|
|
|
|
*sent = written;
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
|
|
|
if(buflen > (data->set.upload_buffer_size - 10))
|
|
|
|
/* don't do more than this in one go */
|
|
|
|
buflen = data->set.upload_buffer_size - 10;
|
|
|
|
|
|
|
|
if(sendflags & CURLWS_OFFSET) {
|
|
|
|
if(totalsize) {
|
|
|
|
/* a frame series 'totalsize' bytes big, this is the first */
|
|
|
|
headlen = ws_packethead(data, totalsize, sendflags);
|
|
|
|
wsp->sleft = totalsize - buflen;
|
2022-09-09 16:11:14 +03:00
|
|
|
}
|
|
|
|
else {
|
2022-10-03 18:40:02 +03:00
|
|
|
headlen = 0;
|
|
|
|
if((curl_off_t)buflen > wsp->sleft) {
|
|
|
|
infof(data, "WS: unaligned frame size (sending %zu instead of %zu)",
|
|
|
|
buflen, wsp->sleft);
|
|
|
|
wsp->sleft = 0;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
wsp->sleft -= buflen;
|
2022-09-09 16:11:14 +03:00
|
|
|
}
|
|
|
|
}
|
2022-10-03 18:40:02 +03:00
|
|
|
else
|
|
|
|
headlen = ws_packethead(data, buflen, sendflags);
|
|
|
|
|
|
|
|
/* headlen is the size of the frame header */
|
|
|
|
out = data->state.ulbuf;
|
|
|
|
if(buflen)
|
|
|
|
/* for PING and PONG etc there might not be a payload */
|
2022-10-07 14:52:31 +03:00
|
|
|
ws_xor(data, buffer, (unsigned char *)out + headlen, buflen);
|
|
|
|
|
|
|
|
if(data->set.connect_only)
|
|
|
|
result = Curl_senddata(data, out, buflen + headlen, &written);
|
|
|
|
else
|
2022-10-03 18:40:02 +03:00
|
|
|
result = Curl_write(data, data->conn->writesockfd, out,
|
|
|
|
buflen + headlen, &written);
|
|
|
|
|
|
|
|
infof(data, "WS: wanted to send %zu bytes, sent %zu bytes",
|
|
|
|
headlen + buflen, written);
|
|
|
|
*sent = written;
|
2022-09-09 16:11:14 +03:00
|
|
|
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
|
|
|
void Curl_ws_done(struct Curl_easy *data)
|
|
|
|
{
|
2022-10-03 18:40:02 +03:00
|
|
|
struct websocket *wsp = &data->req.p.http->ws;
|
2022-09-09 16:11:14 +03:00
|
|
|
DEBUGASSERT(wsp);
|
|
|
|
Curl_dyn_free(&wsp->buf);
|
|
|
|
}
|
|
|
|
|
2022-10-03 18:40:02 +03:00
|
|
|
CURL_EXTERN struct curl_ws_frame *curl_ws_meta(struct Curl_easy *data)
|
2022-09-09 16:11:14 +03:00
|
|
|
{
|
2022-10-03 18:40:02 +03:00
|
|
|
/* we only return something for websocket, called from within the callback
|
2022-09-09 16:11:14 +03:00
|
|
|
when not using raw mode */
|
|
|
|
if(GOOD_EASY_HANDLE(data) && Curl_is_in_callback(data) && data->req.p.http &&
|
|
|
|
!data->set.ws_raw_mode)
|
2022-10-03 18:40:02 +03:00
|
|
|
return &data->req.p.http->ws.frame;
|
2022-09-09 16:11:14 +03:00
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2022-09-09 16:11:14 +03:00
|
|
|
#else
|
|
|
|
|
|
|
|
CURL_EXTERN CURLcode curl_ws_recv(CURL *curl, void *buffer, size_t buflen,
|
2022-10-03 18:40:02 +03:00
|
|
|
size_t *nread,
|
|
|
|
struct curl_ws_frame **metap)
|
2022-09-09 16:11:14 +03:00
|
|
|
{
|
|
|
|
(void)curl;
|
|
|
|
(void)buffer;
|
|
|
|
(void)buflen;
|
|
|
|
(void)nread;
|
2022-10-03 18:40:02 +03:00
|
|
|
(void)metap;
|
2022-11-03 22:52:34 +03:00
|
|
|
return CURLE_NOT_BUILT_IN;
|
2022-09-09 16:11:14 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
CURL_EXTERN CURLcode curl_ws_send(CURL *curl, const void *buffer,
|
|
|
|
size_t buflen, size_t *sent,
|
2022-10-03 18:40:02 +03:00
|
|
|
curl_off_t framesize,
|
2022-09-09 16:11:14 +03:00
|
|
|
unsigned int sendflags)
|
|
|
|
{
|
|
|
|
(void)curl;
|
|
|
|
(void)buffer;
|
|
|
|
(void)buflen;
|
|
|
|
(void)sent;
|
2022-10-03 18:40:02 +03:00
|
|
|
(void)framesize;
|
2022-09-09 16:11:14 +03:00
|
|
|
(void)sendflags;
|
2022-11-03 22:52:34 +03:00
|
|
|
return CURLE_NOT_BUILT_IN;
|
2022-09-09 16:11:14 +03:00
|
|
|
}
|
|
|
|
|
2022-10-03 18:40:02 +03:00
|
|
|
CURL_EXTERN struct curl_ws_frame *curl_ws_meta(struct Curl_easy *data)
|
2022-09-09 16:11:14 +03:00
|
|
|
{
|
|
|
|
(void)data;
|
|
|
|
return NULL;
|
|
|
|
}
|
2022-09-09 16:11:14 +03:00
|
|
|
#endif /* USE_WEBSOCKETS */
|