Added client mode support to HTTP::Websocket, added websockettest binary, added ws/wss protocol support to HTTP::URL, added support for websockets and socket overriding to HTTP::Downloader, fixed HTTP parser not handling response codes 1XX, 204 and 304 correctly.

This commit is contained in:
Thulinma 2020-09-01 12:42:25 +02:00
parent 57b930020b
commit 37af199a1c
9 changed files with 214 additions and 42 deletions

View file

@ -824,4 +824,6 @@ target_link_libraries(bitwritertest mist)
add_test(BitWriterTest COMMAND bitwritertest) add_test(BitWriterTest COMMAND bitwritertest)
add_executable(streamstatustest test/status.cpp ${BINARY_DIR}/mist/.headers) add_executable(streamstatustest test/status.cpp ${BINARY_DIR}/mist/.headers)
target_link_libraries(streamstatustest mist) target_link_libraries(streamstatustest mist)
add_executable(websockettest test/websocket.cpp ${BINARY_DIR}/mist/.headers)
target_link_libraries(websockettest mist)

View file

@ -12,6 +12,7 @@ namespace HTTP{
retryCount = 5; retryCount = 5;
ssl = false; ssl = false;
proxied = false; proxied = false;
sPtr = 0;
char *p = getenv("http_proxy"); char *p = getenv("http_proxy");
if (p){ if (p){
proxyUrl = HTTP::URL(p); proxyUrl = HTTP::URL(p);
@ -59,16 +60,28 @@ namespace HTTP{
/// Returns a reference to the internal HTTP class instance. /// Returns a reference to the internal HTTP class instance.
Parser &Downloader::getHTTP(){return H;} Parser &Downloader::getHTTP(){return H;}
/// Returns a reference to the internal Socket::Connection class instance. /// Returns a reference to the internal Socket::Connection class instance, or the override, if in use.
Socket::Connection &Downloader::getSocket(){return S;} Socket::Connection &Downloader::getSocket(){
const Socket::Connection &Downloader::getSocket() const{return S;} if (sPtr){return *sPtr;}
return S;
}
const Socket::Connection &Downloader::getSocket() const{
if (sPtr){return *sPtr;}
return S;
}
///Sets an override to use the given socket
void Downloader::setSocket(Socket::Connection * socketPtr){
sPtr = socketPtr;
}
Downloader::~Downloader(){S.close();} Downloader::~Downloader(){S.close();}
/// Prepares a request for the given URL, does not send anything /// Prepares a request for the given URL, does not send anything
void Downloader::prepareRequest(const HTTP::URL &link, const std::string &method){ void Downloader::prepareRequest(const HTTP::URL &link, const std::string &method){
if (!canRequest(link)){return;} if (!canRequest(link)){return;}
bool needSSL = (link.protocol == "https"); bool needSSL = (link.protocol == "https" || link.protocol == "wss");
H.Clean(); H.Clean();
// Reconnect if needed // Reconnect if needed
if (!proxied || needSSL){ if (!proxied || needSSL){
@ -78,12 +91,12 @@ namespace HTTP{
connectedPort = link.getPort(); connectedPort = link.getPort();
#ifdef SSL #ifdef SSL
if (needSSL){ if (needSSL){
S.open(connectedHost, connectedPort, true, true); getSocket().open(connectedHost, connectedPort, true, true);
}else{ }else{
S.open(connectedHost, connectedPort, true); getSocket().open(connectedHost, connectedPort, true);
} }
#else #else
S.open(connectedHost, connectedPort, true); getSocket().open(connectedHost, connectedPort, true);
#endif #endif
} }
}else{ }else{
@ -91,12 +104,12 @@ namespace HTTP{
getSocket().close(); getSocket().close();
connectedHost = proxyUrl.host; connectedHost = proxyUrl.host;
connectedPort = proxyUrl.getPort(); connectedPort = proxyUrl.getPort();
S.open(connectedHost, connectedPort, true); getSocket().open(connectedHost, connectedPort, true);
} }
} }
ssl = needSSL; ssl = needSSL;
if (!getSocket()){ if (!getSocket()){
H.method = S.getError(); H.method = getSocket().getError();
return; // socket is closed return; // socket is closed
} }
if (proxied && !ssl){ if (proxied && !ssl){
@ -440,12 +453,12 @@ namespace HTTP{
bool Downloader::canRequest(const HTTP::URL &link){ bool Downloader::canRequest(const HTTP::URL &link){
if (!link.host.size()){return false;} if (!link.host.size()){return false;}
if (link.protocol != "http" && link.protocol != "https"){ if (link.protocol != "http" && link.protocol != "https" && link.protocol != "ws" && link.protocol != "wss"){
FAIL_MSG("Protocol not supported: %s", link.protocol.c_str()); FAIL_MSG("Protocol not supported: %s", link.protocol.c_str());
return false; return false;
} }
#ifndef SSL #ifndef SSL
if (link.protocol == "https"){ if (link.protocol == "https" || link.protocol == "wss"){
FAIL_MSG("Protocol not supported: %s", link.protocol.c_str()); FAIL_MSG("Protocol not supported: %s", link.protocol.c_str());
return false; return false;
} }

View file

@ -45,6 +45,7 @@ namespace HTTP{
Parser &getHTTP(); Parser &getHTTP();
Socket::Connection &getSocket(); Socket::Connection &getSocket();
const Socket::Connection &getSocket() const; const Socket::Connection &getSocket() const;
void setSocket(Socket::Connection * socketPtr);
uint32_t retryCount, dataTimeout; uint32_t retryCount, dataTimeout;
bool isProxied() const; bool isProxied() const;
const HTTP::URL &lastURL(); const HTTP::URL &lastURL();
@ -56,6 +57,7 @@ namespace HTTP{
uint32_t connectedPort; ///< Currently connected port number uint32_t connectedPort; ///< Currently connected port number
Parser H; ///< HTTP parser for downloader Parser H; ///< HTTP parser for downloader
Socket::Connection S; ///< TCP socket for downloader Socket::Connection S; ///< TCP socket for downloader
Socket::Connection * sPtr; ///< TCP socket override, when wanting to use an external socket
bool ssl; ///< True if ssl is currently in use. bool ssl; ///< True if ssl is currently in use.
std::string authStr; ///< Most recently seen WWW-Authenticate request std::string authStr; ///< Most recently seen WWW-Authenticate request
std::string proxyAuthStr; ///< Most recently seen Proxy-Authenticate request std::string proxyAuthStr; ///< Most recently seen Proxy-Authenticate request

View file

@ -629,6 +629,11 @@ bool HTTP::Parser::parse(std::string &HTTPbuffer, Util::DataCallback &cb){
} }
if (seenHeaders){ if (seenHeaders){
if (headerOnly){return true;} if (headerOnly){return true;}
//Check if we have a response code that may never have a body
if (url.size() && url[0] >= '0' && url[0] <= '9'){
unsigned int code = atoi(url.data());
if ((code >= 100 && code < 200) || code == 204 || code == 304){return true;}
}
if (length > 0 && !getChunks){ if (length > 0 && !getChunks){
unsigned int toappend = length - body.length(); unsigned int toappend = length - body.length();

View file

@ -795,15 +795,19 @@ void Socket::Connection::open(std::string host, int port, bool nonblock, bool wi
int ret = 0; int ret = 0;
if ((ret = mbedtls_net_connect(server_fd, host.c_str(), JSON::Value(port).asString().c_str(), if ((ret = mbedtls_net_connect(server_fd, host.c_str(), JSON::Value(port).asString().c_str(),
MBEDTLS_NET_PROTO_TCP)) != 0){ MBEDTLS_NET_PROTO_TCP)) != 0){
lastErr = "mbedtls_net_connect failed"; char estr[200];
FAIL_MSG(" failed\n ! mbedtls_net_connect returned %d\n\n", ret); mbedtls_strerror(ret, estr, 200);
lastErr = estr;
FAIL_MSG("SSL connect failed: %d: %s", ret, lastErr.c_str());
close(); close();
return; return;
} }
if ((ret = mbedtls_ssl_config_defaults(conf, MBEDTLS_SSL_IS_CLIENT, MBEDTLS_SSL_TRANSPORT_STREAM, if ((ret = mbedtls_ssl_config_defaults(conf, MBEDTLS_SSL_IS_CLIENT, MBEDTLS_SSL_TRANSPORT_STREAM,
MBEDTLS_SSL_PRESET_DEFAULT)) != 0){ MBEDTLS_SSL_PRESET_DEFAULT)) != 0){
lastErr = "mbedtls_ssl_config_defaults failed"; char estr[200];
FAIL_MSG(" failed\n ! mbedtls_ssl_config_defaults returned %d\n\n", ret); mbedtls_strerror(ret, estr, 200);
lastErr = estr;
FAIL_MSG("SSL config failed: %d: %s", ret, lastErr.c_str());
close(); close();
return; return;
} }
@ -819,7 +823,10 @@ void Socket::Connection::open(std::string host, int port, bool nonblock, bool wi
return; return;
} }
if ((ret = mbedtls_ssl_set_hostname(ssl, host.c_str())) != 0){ if ((ret = mbedtls_ssl_set_hostname(ssl, host.c_str())) != 0){
FAIL_MSG(" failed\n ! mbedtls_ssl_set_hostname returned %d\n\n", ret); char estr[200];
mbedtls_strerror(ret, estr, 200);
lastErr = estr;
FAIL_MSG("SSL setup error %d: %s", ret, lastErr.c_str());
close(); close();
return; return;
} }

View file

@ -147,10 +147,13 @@ uint32_t HTTP::URL::getPort() const{
uint32_t HTTP::URL::getDefaultPort() const{ uint32_t HTTP::URL::getDefaultPort() const{
if (protocol == "http"){return 80;} if (protocol == "http"){return 80;}
if (protocol == "https"){return 443;} if (protocol == "https"){return 443;}
if (protocol == "ws"){return 80;}
if (protocol == "wss"){return 443;}
if (protocol == "rtmp"){return 1935;} if (protocol == "rtmp"){return 1935;}
if (protocol == "rtmps"){return 443;} if (protocol == "rtmps"){return 443;}
if (protocol == "dtsc"){return 4200;} if (protocol == "dtsc"){return 4200;}
if (protocol == "rtsp"){return 554;} if (protocol == "rtsp"){return 554;}
if (protocol == "srt"){return 8889;}
return 0; return 0;
} }

View file

@ -3,56 +3,117 @@
#include "encode.h" #include "encode.h"
#include "timing.h" #include "timing.h"
#include "websocket.h" #include "websocket.h"
#include "downloader.h"
#ifdef SSL #ifdef SSL
#include "mbedtls/sha1.h" #include "mbedtls/sha1.h"
#endif #endif
// Takes the data from a Sec-WebSocket-Key header, and returns the corresponding data for a Sec-WebSocket-Accept header
static std::string calculateKeyAccept(std::string client_key){
client_key += "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
mbedtls_sha1_context ctx;
unsigned char outdata[20];
mbedtls_sha1_starts(&ctx);
mbedtls_sha1_update(&ctx, (const unsigned char *)client_key.data(), client_key.size());
mbedtls_sha1_finish(&ctx, outdata);
return Encodings::Base64::encode(std::string((const char *)outdata, 20));
}
namespace HTTP{ namespace HTTP{
Websocket::Websocket(Socket::Connection &c, HTTP::Parser &h) : C(c), H(h){ /// Uses the referenced Socket::Connection to make use of an already connected Websocket.
Websocket::Websocket(Socket::Connection &c, bool client) : C(c){
maskOut = client;
}
/// Uses the referenced Socket::Connection to make a new Websocket by connecting to the given URL.
Websocket::Websocket(Socket::Connection &c, const HTTP::URL & url, std::map<std::string, std::string> * headers) : C(c){
HTTP::Downloader d;
//Ensure our passed socket gets used by the downloader class
d.setSocket(&C);
//Generate a random nonce based on the current process ID
//Note: This is not cryptographically secure, nor intended to be.
//It does make it possible to trace which stream came from which PID, if needed.
char nonce[16];
unsigned int state = getpid();
for (size_t i = 0; i < 16; ++i){nonce[i] = rand_r(&state) % 255;}
std::string handshakeKey = Encodings::Base64::encode(std::string(nonce, 16));
//Prepare the headers
d.setHeader("Connection", "Upgrade");
d.setHeader("Upgrade", "websocket");
d.setHeader("Sec-WebSocket-Version", "13");
d.setHeader("Sec-WebSocket-Key", handshakeKey);
if (headers && headers->size()){
for (std::map<std::string, std::string>::iterator it = headers->begin(); it != headers->end(); ++it){
d.setHeader(it->first, it->second);
}
}
if (!d.get(url) || d.getStatusCode() != 101 || !d.getHeader("Sec-WebSocket-Accept").size()){
FAIL_MSG("Could not connect websocket to %s", url.getUrl().c_str());
d.getSocket().close();
C = d.getSocket();
return;
}
#ifdef SSL
std::string handshakeAccept = calculateKeyAccept(handshakeKey);
if (d.getHeader("Sec-WebSocket-Accept") != handshakeAccept){
FAIL_MSG("WebSocket handshake failure: expected accept parameter %s but received %s", handshakeAccept.c_str(), d.getHeader("Sec-WebSocket-Accept").c_str());
d.getSocket().close();
C = d.getSocket();
return;
}
#endif
MEDIUM_MSG("Connected to websocket %s", url.getUrl().c_str());
maskOut = true;
}
/// Takes an incoming HTTP::Parser request for a Websocket, and turns it into one.
Websocket::Websocket(Socket::Connection &c, HTTP::Parser &h) : C(c){
frameType = 0; frameType = 0;
std::string connHeader = H.GetHeader("Connection"); maskOut = false;
std::string connHeader = h.GetHeader("Connection");
Util::stringToLower(connHeader); Util::stringToLower(connHeader);
if (connHeader.find("upgrade") == std::string::npos){ if (connHeader.find("upgrade") == std::string::npos){
FAIL_MSG("Could not negotiate websocket, connection header incorrect (%s).", connHeader.c_str()); FAIL_MSG("Could not negotiate websocket, connection header incorrect (%s).", connHeader.c_str());
C.close(); C.close();
return; return;
} }
std::string upgradeHeader = H.GetHeader("Upgrade"); std::string upgradeHeader = h.GetHeader("Upgrade");
Util::stringToLower(upgradeHeader); Util::stringToLower(upgradeHeader);
if (upgradeHeader != "websocket"){ if (upgradeHeader != "websocket"){
FAIL_MSG("Could not negotiate websocket, upgrade header incorrect (%s).", upgradeHeader.c_str()); FAIL_MSG("Could not negotiate websocket, upgrade header incorrect (%s).", upgradeHeader.c_str());
C.close(); C.close();
return; return;
} }
if (H.GetHeader("Sec-WebSocket-Version") != "13"){ if (h.GetHeader("Sec-WebSocket-Version") != "13"){
FAIL_MSG("Could not negotiate websocket, version incorrect (%s).", FAIL_MSG("Could not negotiate websocket, version incorrect (%s).",
H.GetHeader("Sec-WebSocket-Version").c_str()); h.GetHeader("Sec-WebSocket-Version").c_str());
C.close(); C.close();
return; return;
} }
std::string client_key = H.GetHeader("Sec-WebSocket-Key"); #ifdef SSL
std::string client_key = h.GetHeader("Sec-WebSocket-Key");
if (!client_key.size()){ if (!client_key.size()){
FAIL_MSG("Could not negotiate websocket, missing key!"); FAIL_MSG("Could not negotiate websocket, missing key!");
C.close(); C.close();
return; return;
} }
client_key += "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; #endif
H.Clean(); h.Clean();
H.setCORSHeaders(); h.setCORSHeaders();
H.SetHeader("Upgrade", "websocket"); h.SetHeader("Upgrade", "websocket");
H.SetHeader("Connection", "Upgrade"); h.SetHeader("Connection", "Upgrade");
#ifdef SSL #ifdef SSL
mbedtls_sha1_context ctx; h.SetHeader("Sec-WebSocket-Accept", calculateKeyAccept(client_key));
unsigned char outdata[20];
mbedtls_sha1_starts(&ctx);
mbedtls_sha1_update(&ctx, (const unsigned char *)client_key.data(), client_key.size());
mbedtls_sha1_finish(&ctx, outdata);
H.SetHeader("Sec-WebSocket-Accept", Encodings::Base64::encode(std::string((const char *)outdata, 20)));
#endif #endif
// H.SetHeader("Sec-WebSocket-Protocol", "json"); // H.SetHeader("Sec-WebSocket-Protocol", "json");
H.SendResponse("101", "Websocket away!", C); h.SendResponse("101", "Websocket away!", C);
} }
/// Loops calling readFrame until the connection is closed, sleeping in between reads if needed. /// Loops calling readFrame until the connection is closed, sleeping in between reads if needed.
@ -138,27 +199,47 @@ namespace HTTP{
} }
} }
void Websocket::sendFrame(const char *data, unsigned int len, unsigned int frameType){ void Websocket::sendFrameHead(unsigned int len, unsigned int frameType){
char header[10];
header[0] = 0x80 + frameType; // FIN + frameType header[0] = 0x80 + frameType; // FIN + frameType
headLen = 2;
if (len < 126){ if (len < 126){
header[1] = len; header[1] = len;
C.SendNow(header, 2);
}else{ }else{
if (len <= 0xFFFF){ if (len <= 0xFFFF){
header[1] = 126; header[1] = 126;
Bit::htobs(header + 2, len); Bit::htobs(header + 2, len);
C.SendNow(header, 4); headLen = 4;
}else{ }else{
header[1] = 127; header[1] = 127;
Bit::htobll(header + 2, len); Bit::htobll(header + 2, len);
C.SendNow(header, 10); headLen = 10;
} }
} }
C.SendNow(data, len); if (maskOut){
header[1] |= 128;
header[headLen++] = 0;
header[headLen++] = 0;
header[headLen++] = 0;
header[headLen++] = 0;
}
C.SendNow(header, headLen);
dataCtr = 0;
} }
void Websocket::sendFrame(const std::string &data){sendFrame(data.data(), data.size());} void Websocket::sendFrameData(const char *data, unsigned int len){
C.SendNow(data, len);
dataCtr += len;
}
void Websocket::sendFrame(const char *data, unsigned int len, unsigned int frameType){
sendFrameHead(len, frameType);
sendFrameData(data, len);
}
void Websocket::sendFrame(const std::string &data){
sendFrameHead(data.size());
sendFrameData(data.data(), data.size());
}
Websocket::operator bool() const{return C;} Websocket::operator bool() const{return C;}

View file

@ -1,5 +1,6 @@
#pragma once #pragma once
#include "http_parser.h" #include "http_parser.h"
#include "url.h"
#include "socket.h" #include "socket.h"
#include "util.h" #include "util.h"
@ -7,16 +8,23 @@ namespace HTTP{
class Websocket{ class Websocket{
public: public:
Websocket(Socket::Connection &c, HTTP::Parser &h); Websocket(Socket::Connection &c, HTTP::Parser &h);
Websocket(Socket::Connection &c, const HTTP::URL & url, std::map<std::string, std::string> * headers = 0);
Websocket(Socket::Connection &c, bool client);
operator bool() const; operator bool() const;
bool readFrame(); bool readFrame();
bool readLoop(); bool readLoop();
void sendFrame(const char *data, unsigned int len, unsigned int frameType = 1); void sendFrame(const char *data, unsigned int len, unsigned int frameType = 1);
void sendFrameHead(unsigned int len, unsigned int frameType = 1);
void sendFrameData(const char *data, unsigned int len);
void sendFrame(const std::string &data); void sendFrame(const std::string &data);
Util::ResizeablePointer data; Util::ResizeablePointer data;
uint8_t frameType; uint8_t frameType;
private: private:
char header[14];///< Header used for currently sending frame, if any
size_t headLen; ///< Length of header used for currently sending frame
size_t dataCtr; ///< Tracks payload bytes sent since frame start
bool maskOut; ///< True if masking is used for output
Socket::Connection &C; Socket::Connection &C;
HTTP::Parser &H;
}; };
}// namespace HTTP }// namespace HTTP

51
test/websocket.cpp Normal file
View file

@ -0,0 +1,51 @@
#include <iomanip>
#include <iostream>
#include <mist/config.h>
#include <mist/timing.h>
#include <mist/websocket.h>
int main(int argc, char **argv){
Util::Config c(argv[0]);
JSON::Value option;
option["arg_num"] = 1;
option["arg"] = "string";
option["help"] = "URL to retrieve";
c.addOption("url", option);
if (!(c.parseArgs(argc, argv))){return 1;}
Util::redirectLogsIfNeeded();
Socket::Connection C;
HTTP::Websocket ws(C, HTTP::URL(c.getString("url")));
if (!ws){return 1;}
while (ws){
if (!ws.readFrame()){
Util::sleep(100);
continue;
}
switch (ws.frameType){
case 1:
std::cout << "Text frame (" << ws.data.size() << "b):" << std::endl
<< std::string(ws.data, ws.data.size()) << std::endl;
break;
case 2:{
std::cout << "Binary frame (" << ws.data.size() << "b):" << std::endl;
size_t counter = 0;
for (size_t i = 0; i < ws.data.size(); ++i){
std::cout << std::hex << std::setw(2) << std::setfill('0') << (int)(ws.data[i] & 0xff) << " ";
if ((counter) % 32 == 31){std::cout << std::endl;}
counter++;
}
std::cout << std::endl;
}break;
case 8:
std::cout << "Connection close frame" << std::endl;
C.close();
break;
case 9: std::cout << "Ping frame" << std::endl; break;
case 10: std::cout << "Pong frame" << std::endl; break;
default: std::cout << "Unknown frame (" << (int)ws.frameType << ")" << std::endl; break;
}
}
return 0;
}