为libevent添加websocket支持(上)

时间:2022-02-07 00:01:33

在跨平台网络基础库中,libevent与asio近年来使用比较广泛。asio对boost的依赖太大,个人认为发展前途堪忧,尤其asio对http没有很好的支持也是缺点之一。

libevent对http有天生支持,含有服务与客户两个部分,是做web服务的好特性。

libevent随对http支持很优秀,但并不支持html5标准的websocket,这有些与时代脱轨。如果你熟悉websocket协议,像自己扩展libevent,很遗憾,libevent的http部分并不支持逻辑层扩展。所以我想,还是通过源码级扩展比较好。注:git上有代码级扩展,但不是在http功能上的扩展。

正文:

libevent的http支持核心代码都在http.c中,包含了几个相关头文件,包括http.h、http-internal.h、http_struct.h、http_compat.h。

libevent的主要容器是列表,由一系列宏进行操作。包括http request,callback函数,http connection,输入头信息,输出头信息均被列表容器管理。回调函数的搜索匹配,evkeyxxx相关的头信息搜索,均需要在列表中遍历,会有些许性能损耗。

libevent有两个方法设置http事件回调函数:evhttp_set_cb,evhttp_set_gencb.我本计划用开关的方式来决定是否开启websocket的连接升级(Connection: Upgrade)功能,后来觉得与libevent的原始架构有些不一致,最终决定用类似设置回调函数的方法设置哪些路径接收WebSocket升级:evhttp_set_ws,evhttp_del_ws。

处理头信息:

evhttp_read_header是接管websocket升级的好地方,我在EVHTTP_REQUEST case的地方添加处理代码,根据WebSocket标准文档,先在header中寻找升级Key(Sec-WebSocket-Key),进行Hash(SHA1->BASE64)返回给客户端即可完成升级。至于hash代码,在windows下可方便的用加解密相关函数(Crypt开头)解决,在Linux就要用openssl了。

libevent默认在读完header后会关闭bufferevent的读取事件,这会影响之后我们websocket的通讯,为此我写了一个新的写缓冲函数,不停止读取事件:evhttp_write_buffer_nostop_read。只需要复制evhttp_write_buffer函数,删除设置缓冲cb的代码即可。

libevent http connection有个state枚举,用来只是当前读取状态,我为此枚举添加了一个状态:EVCON_READING_WSDATA,在提升Websocket完成后,将state设置为EVCON_READING_WSDATA,并且为evhttp_read_cb添加一个对应case,处理websocket的数据。

代码

注:代码按照libevent源码风格进行编写,除了大括号后置,基本就是本人的风格了。

先做到协议提升与协议解析,下次再讨论发送的问题以及数据类型的问题。

websocket客户端key处理代码:

Linux需要这些头文件<openssl/sha.h>,<openssl/bio.h>,<openssl/evp.h>,<string.h>,<openssl/buffer.h>,前提你应该有openssl的devel版被安装。

Linux总归会麻烦一些,忍咯!Windows需要引用crypt32.lib,Linu需要引用libcrypto.lib(gcc:lcrypto)。

Windows已测试,Linux只进行了片段代码测试。

 const char*
ws_hash(const char* client_key) {
static char result[];
if (strlen(client_key) > )
return NULL; const char* uuid = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
char src[];
strcpy(src, client_key);
strcat(src, uuid);
size_t src_len = strlen(src); #ifdef _WIN64 or _WIN32
HCRYPTPROV hCryptProv;
if (CryptAcquireContext(&hCryptProv, NULL, NULL, PROV_RSA_FULL, )){
HCRYPTHASH hHash;
if (CryptCreateHash(hCryptProv, CALG_SHA1, , , &hHash)){
if (CryptHashData(hHash, (BYTE*)src, src_len, )){
BYTE hash_result[];
DWORD out_len = sizeof(hash_result);
if (CryptGetHashParam(hHash, HP_HASHVAL, hash_result, &out_len, )){
DWORD crypt_out_len = ;
CryptBinaryToStringA(hash_result, out_len, CRYPT_STRING_BASE64, result, &crypt_out_len);
result[crypt_out_len - ] = ;
return result;
}
}
}
}
#else
unsigned char* value = SHA1((unsigned char*)src, src_len, out);
BIO *bm = NULL, *bio = NULL;
bio = BIO_new(BIO_f_base64());
if (bio) {
bm = BIO_new(BIO_s_mem());
if (bm) {
BIO_push(bio, bm);
BIO_write(bio, value, strlen((const char*)value));
BIO_flush(bio);
BUF_MEM *buf;
BIO_get_mem_ptr(bio, &buf);
strcpy(result, buf->data);
BIO_free_all(bio);
}
}
#endif
return NULL;
}

websocket提升代码:

主要处理头信息并写回客户端与状态。

     case EVHTTP_REQUEST: {
/* handle the websocket upgrade key */
const char* seckey = evhttp_find_header(req->input_headers, "Sec-WebSocket-Key");
if (seckey) {
struct evhttp_wsup* wsup;
char* translated;
/* Test for different URLs */
const char* path = evhttp_uri_get_path(req->uri_elems);
size_t offset = strlen(path);
if ((translated = mm_malloc(offset + )) == NULL)
return;
evhttp_decode_uri_internal(path, offset, translated,
/* decode_plus */);
TAILQ_FOREACH(wsup, &evcon->http_server->websocket_upgrades, next) {
if (!stricmp(wsup->what, translated)) {
evhttp_add_header(req->output_headers, "Connection", "Upgrade");
evhttp_add_header(req->output_headers, "Upgrade", "WebSocket");
evhttp_add_header(req->output_headers, "Sec-WebSocket-Accept", ws_hash(seckey));
req->websocket = ;
evhttp_response_code(req, , "SwitchProtocol");
evhttp_make_header(req->evcon, req);
evhttp_write_buffer_nostop_read(req->evcon, NULL, NULL);
evcon->state = EVCON_READING_WSDATA;
bufferevent_enable(evcon->bufev, EV_READ);
break;
}
}
mm_free(translated);
return;
}

处理websocket协议的代码:

 int
process_buffer(unsigned char* buff, size_t data_len)
{
if (data_len < )
return ;
switch (buff[] & 0xF){
case :
return ;
case :
case :{
auto len = buff[] & 0x7F;
auto mask = (buff[] & 0x80) > ;
if (len > )
return -; if (mask)
return ;
else
return ;
break;
}
case :{
auto len = buff[] & 0x7F;
auto mask = (buff[] & 0x80) > ;
int head_len = ;
if (len == )
head_len = mask ? : ;
else if (len == )
head_len = mask ? : ;
else
head_len = mask ? : ;
if (data_len < head_len)
return ; int tail_len = ;
if (len == )
tail_len = (int)ntohll((unsigned long long)(buff + ));
else if (len == )
tail_len = ntohs((u_short)(buff + ));
else
tail_len = len; if (data_len < head_len + tail_len)
return ; if (mask)
for (int i = head_len, j = ; j < tail_len; i++, j++)
buff[i] = buff[i] ^ buff[head_len - + j % ]; char* utf8_text = buff + head_len; return head_len + tail_len;
}
}
return ;
} static void
evhttp_read_wsdata(struct evhttp_connection *evcon, struct evhttp_request *req)
{
struct evbuffer *buf = bufferevent_get_input(evcon->bufev); size_t buflen = evbuffer_get_length(buf);
if (buflen == )
return; size_t drain_len = ;
unsigned char* data = evbuffer_pullup(buf, buflen);
while (buflen>) {
int result = process_buffer(data, buflen);
if (result < ) {
evhttp_connection_free(evcon);
return;
}
else if (result > ) {
if (result > buflen) {
evhttp_connection_free(evcon);
return;
}
drain_len += result;
data += result;
buflen -= result;
}
else
break;
}
if(drain_len>)evbuffer_drain(buf, drain_len); /* Read more! */
bufferevent_enable(evcon->bufev, EV_READ);
}