FreeRDP/libfreerdp/core/gateway/http.c

1719 lines
37 KiB
C
Raw Normal View History

2012-04-14 22:19:31 +04:00
/**
2012-10-09 07:02:04 +04:00
* FreeRDP: A Remote Desktop Protocol Implementation
2012-04-14 22:19:31 +04:00
* Hypertext Transfer Protocol (HTTP)
*
* Copyright 2012 Marc-Andre Moreau <marcandre.moreau@gmail.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* 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.
*/
2022-02-16 13:20:38 +03:00
#include <freerdp/config.h>
2017-11-14 18:10:52 +03:00
#include <errno.h>
#include <winpr/crt.h>
#include <winpr/print.h>
2012-12-14 05:23:37 +04:00
#include <winpr/stream.h>
#include <winpr/string.h>
#include <winpr/rpc.h>
#include <winpr/sysinfo.h>
#include <freerdp/log.h>
2023-02-03 13:53:49 +03:00
#include <freerdp/crypto/crypto.h>
2021-01-25 18:20:18 +03:00
/* websocket need sha1 for Sec-Websocket-Accept */
#include <winpr/crypto.h>
#ifdef FREERDP_HAVE_VALGRIND_MEMCHECK_H
#include <valgrind/memcheck.h>
#endif
2012-04-14 22:19:31 +04:00
#include "http.h"
#include "../tcp.h"
2012-04-14 22:19:31 +04:00
#define TAG FREERDP_TAG("core.gateway.http")
#define RESPONSE_SIZE_LIMIT 64 * 1024 * 1024
2021-01-25 18:20:18 +03:00
#define WEBSOCKET_MAGIC_GUID "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
struct s_http_context
{
char* Method;
char* URI;
char* UserAgent;
char* X_MS_UserAgent;
char* Host;
char* Accept;
char* CacheControl;
char* Connection;
char* Pragma;
char* RdgConnectionId;
char* RdgCorrelationId;
char* RdgAuthScheme;
2021-01-25 18:20:18 +03:00
BOOL websocketUpgrade;
char* SecWebsocketKey;
wListDictionary* cookies;
};
struct s_http_request
{
char* Method;
char* URI;
char* AuthScheme;
char* AuthParam;
char* Authorization;
size_t ContentLength;
char* ContentType;
TRANSFER_ENCODING TransferEncoding;
};
struct s_http_response
{
size_t count;
char** lines;
long StatusCode;
const char* ReasonPhrase;
size_t ContentLength;
const char* ContentType;
TRANSFER_ENCODING TransferEncoding;
2021-01-25 18:20:18 +03:00
const char* SecWebsocketVersion;
const char* SecWebsocketAccept;
size_t BodyLength;
BYTE* BodyContent;
wListDictionary* Authenticates;
wListDictionary* SetCookie;
wStream* data;
};
2018-10-18 10:09:30 +03:00
static char* string_strnstr(char* str1, const char* str2, size_t slen)
2015-02-03 01:16:32 +03:00
{
char c = 0;
char sc = 0;
size_t len = 0;
2015-02-03 01:16:32 +03:00
if ((c = *str2++) != '\0')
{
len = strnlen(str2, slen + 1);
2015-02-03 01:16:32 +03:00
do
{
do
{
if (slen-- < 1 || (sc = *str1++) == '\0')
return NULL;
2019-11-06 17:24:51 +03:00
} while (sc != c);
2015-02-03 01:16:32 +03:00
if (len > slen)
return NULL;
2019-11-06 17:24:51 +03:00
} while (strncmp(str1, str2, len) != 0);
2015-02-03 01:16:32 +03:00
str1--;
}
2018-10-18 10:09:30 +03:00
return str1;
2015-02-03 01:16:32 +03:00
}
2018-10-18 10:09:30 +03:00
static BOOL strings_equals_nocase(const void* obj1, const void* obj2)
2015-02-03 01:16:32 +03:00
{
if (!obj1 || !obj2)
return FALSE;
return _stricmp(obj1, obj2) == 0;
}
2018-01-15 14:43:37 +03:00
HttpContext* http_context_new(void)
2012-04-14 22:19:31 +04:00
{
HttpContext* context = (HttpContext*)calloc(1, sizeof(HttpContext));
if (!context)
return NULL;
context->cookies = ListDictionary_New(FALSE);
if (!context->cookies)
goto fail;
wObject* key = ListDictionary_KeyObject(context->cookies);
wObject* value = ListDictionary_ValueObject(context->cookies);
if (!key || !value)
goto fail;
key->fnObjectFree = winpr_ObjectStringFree;
key->fnObjectNew = winpr_ObjectStringClone;
value->fnObjectFree = winpr_ObjectStringFree;
value->fnObjectNew = winpr_ObjectStringClone;
return context;
fail:
WINPR_PRAGMA_DIAG_PUSH
WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
http_context_free(context);
WINPR_PRAGMA_DIAG_POP
return NULL;
2012-04-14 22:19:31 +04:00
}
BOOL http_context_set_method(HttpContext* context, const char* Method)
2012-04-14 22:19:31 +04:00
{
if (!context || !Method)
return FALSE;
free(context->Method);
context->Method = _strdup(Method);
if (!context->Method)
return FALSE;
return TRUE;
2012-04-14 22:19:31 +04:00
}
BOOL http_request_set_content_type(HttpRequest* request, const char* ContentType)
{
if (!request || !ContentType)
return FALSE;
free(request->ContentType);
request->ContentType = _strdup(ContentType);
if (!request->ContentType)
return FALSE;
return TRUE;
}
const char* http_context_get_uri(HttpContext* context)
{
if (!context)
return NULL;
return context->URI;
}
BOOL http_context_set_uri(HttpContext* context, const char* URI)
2012-04-14 22:19:31 +04:00
{
if (!context || !URI)
return FALSE;
free(context->URI);
context->URI = _strdup(URI);
if (!context->URI)
return FALSE;
return TRUE;
2012-04-14 22:19:31 +04:00
}
BOOL http_context_set_user_agent(HttpContext* context, const char* UserAgent)
2012-04-14 22:19:31 +04:00
{
if (!context || !UserAgent)
return FALSE;
free(context->UserAgent);
context->UserAgent = _strdup(UserAgent);
if (!context->UserAgent)
return FALSE;
return TRUE;
2012-04-14 22:19:31 +04:00
}
BOOL http_context_set_x_ms_user_agent(HttpContext* context, const char* X_MS_UserAgent)
{
if (!context || !X_MS_UserAgent)
return FALSE;
free(context->X_MS_UserAgent);
context->X_MS_UserAgent = _strdup(X_MS_UserAgent);
if (!context->X_MS_UserAgent)
return FALSE;
return TRUE;
}
BOOL http_context_set_host(HttpContext* context, const char* Host)
2012-04-14 22:19:31 +04:00
{
if (!context || !Host)
return FALSE;
free(context->Host);
context->Host = _strdup(Host);
if (!context->Host)
return FALSE;
return TRUE;
2012-04-14 22:19:31 +04:00
}
BOOL http_context_set_accept(HttpContext* context, const char* Accept)
2012-04-14 22:19:31 +04:00
{
if (!context || !Accept)
return FALSE;
free(context->Accept);
context->Accept = _strdup(Accept);
if (!context->Accept)
return FALSE;
return TRUE;
2012-04-14 22:19:31 +04:00
}
BOOL http_context_set_cache_control(HttpContext* context, const char* CacheControl)
2012-04-14 22:19:31 +04:00
{
if (!context || !CacheControl)
return FALSE;
free(context->CacheControl);
context->CacheControl = _strdup(CacheControl);
if (!context->CacheControl)
return FALSE;
return TRUE;
2012-04-14 22:19:31 +04:00
}
BOOL http_context_set_connection(HttpContext* context, const char* Connection)
2012-04-14 22:19:31 +04:00
{
if (!context || !Connection)
return FALSE;
free(context->Connection);
context->Connection = _strdup(Connection);
if (!context->Connection)
return FALSE;
return TRUE;
2012-04-14 22:19:31 +04:00
}
WINPR_ATTR_FORMAT_ARG(2, 0)
static BOOL list_append(HttpContext* context, WINPR_FORMAT_ARG const char* str, va_list ap)
{
BOOL rc = FALSE;
va_list vat;
char* Pragma = NULL;
size_t PragmaSize = 0;
va_copy(vat, ap);
const int size = winpr_vasprintf(&Pragma, &PragmaSize, str, ap);
va_end(vat);
if (size <= 0)
goto fail;
char* sstr = NULL;
size_t slen = 0;
if (context->Pragma)
{
winpr_asprintf(&sstr, &slen, "%s, %s", context->Pragma, Pragma);
free(Pragma);
}
else
sstr = Pragma;
2024-04-11 14:08:23 +03:00
Pragma = NULL;
2024-04-11 14:08:23 +03:00
free(context->Pragma);
context->Pragma = sstr;
rc = TRUE;
fail:
va_end(ap);
return rc;
}
WINPR_ATTR_FORMAT_ARG(2, 3)
BOOL http_context_set_pragma(HttpContext* context, WINPR_FORMAT_ARG const char* Pragma, ...)
2012-04-14 22:19:31 +04:00
{
if (!context || !Pragma)
return FALSE;
free(context->Pragma);
context->Pragma = NULL;
va_list ap;
va_start(ap, Pragma);
return list_append(context, Pragma, ap);
}
WINPR_ATTR_FORMAT_ARG(2, 3)
BOOL http_context_append_pragma(HttpContext* context, const char* Pragma, ...)
{
if (!context || !Pragma)
return FALSE;
va_list ap;
va_start(ap, Pragma);
return list_append(context, Pragma, ap);
2012-04-14 22:19:31 +04:00
}
static char* guid2str(const GUID* guid)
{
if (!guid)
return NULL;
char* strguid = NULL;
char bracedGuid[64] = { 0 };
RPC_STATUS rpcStatus = UuidToStringA(guid, &strguid);
if (rpcStatus != RPC_S_OK)
return NULL;
sprintf_s(bracedGuid, sizeof(bracedGuid), "{%s}", strguid);
RpcStringFreeA(&strguid);
return _strdup(bracedGuid);
}
BOOL http_context_set_rdg_connection_id(HttpContext* context, const GUID* RdgConnectionId)
2015-03-17 21:54:16 +03:00
{
if (!context || !RdgConnectionId)
return FALSE;
2015-03-17 21:54:16 +03:00
free(context->RdgConnectionId);
context->RdgConnectionId = guid2str(RdgConnectionId);
2015-03-17 21:54:16 +03:00
if (!context->RdgConnectionId)
return FALSE;
return TRUE;
}
BOOL http_context_set_rdg_correlation_id(HttpContext* context, const GUID* RdgCorrelationId)
{
if (!context || !RdgCorrelationId)
return FALSE;
free(context->RdgCorrelationId);
context->RdgCorrelationId = guid2str(RdgCorrelationId);
if (!context->RdgCorrelationId)
return FALSE;
return TRUE;
}
2021-01-25 18:20:18 +03:00
BOOL http_context_enable_websocket_upgrade(HttpContext* context, BOOL enable)
{
if (!context)
return FALSE;
if (enable)
{
GUID key = { 0 };
if (RPC_S_OK != UuidCreate(&key))
return FALSE;
2023-07-05 09:57:17 +03:00
free(context->SecWebsocketKey);
context->SecWebsocketKey = crypto_base64_encode((BYTE*)&key, sizeof(key));
if (!context->SecWebsocketKey)
return FALSE;
}
2021-01-25 18:20:18 +03:00
context->websocketUpgrade = enable;
return TRUE;
}
BOOL http_context_is_websocket_upgrade_enabled(HttpContext* context)
{
return context->websocketUpgrade;
}
BOOL http_context_set_rdg_auth_scheme(HttpContext* context, const char* RdgAuthScheme)
{
if (!context || !RdgAuthScheme)
return FALSE;
free(context->RdgAuthScheme);
context->RdgAuthScheme = _strdup(RdgAuthScheme);
return context->RdgAuthScheme != NULL;
}
BOOL http_context_set_cookie(HttpContext* context, const char* CookieName, const char* CookieValue)
{
if (!context || !CookieName || !CookieValue)
return FALSE;
if (ListDictionary_Contains(context->cookies, CookieName))
{
if (!ListDictionary_SetItemValue(context->cookies, CookieName, CookieValue))
return FALSE;
}
else
{
if (!ListDictionary_Add(context->cookies, CookieName, CookieValue))
return FALSE;
}
return TRUE;
}
void http_context_free(HttpContext* context)
2012-04-14 22:19:31 +04:00
{
if (context)
2012-04-14 22:19:31 +04:00
{
free(context->SecWebsocketKey);
free(context->UserAgent);
free(context->X_MS_UserAgent);
free(context->Host);
free(context->URI);
free(context->Accept);
free(context->Method);
free(context->CacheControl);
free(context->Connection);
free(context->Pragma);
2015-03-17 21:54:16 +03:00
free(context->RdgConnectionId);
free(context->RdgCorrelationId);
free(context->RdgAuthScheme);
ListDictionary_Free(context->cookies);
free(context);
2012-04-14 22:19:31 +04:00
}
}
BOOL http_request_set_method(HttpRequest* request, const char* Method)
2012-04-14 22:19:31 +04:00
{
if (!request || !Method)
return FALSE;
free(request->Method);
request->Method = _strdup(Method);
if (!request->Method)
return FALSE;
return TRUE;
2012-04-14 22:19:31 +04:00
}
BOOL http_request_set_uri(HttpRequest* request, const char* URI)
2012-04-14 22:19:31 +04:00
{
if (!request || !URI)
return FALSE;
free(request->URI);
request->URI = _strdup(URI);
if (!request->URI)
return FALSE;
return TRUE;
2012-04-14 22:19:31 +04:00
}
BOOL http_request_set_auth_scheme(HttpRequest* request, const char* AuthScheme)
{
if (!request || !AuthScheme)
return FALSE;
free(request->AuthScheme);
request->AuthScheme = _strdup(AuthScheme);
if (!request->AuthScheme)
return FALSE;
return TRUE;
}
BOOL http_request_set_auth_param(HttpRequest* request, const char* AuthParam)
{
if (!request || !AuthParam)
return FALSE;
free(request->AuthParam);
request->AuthParam = _strdup(AuthParam);
if (!request->AuthParam)
return FALSE;
return TRUE;
}
BOOL http_request_set_transfer_encoding(HttpRequest* request, TRANSFER_ENCODING TransferEncoding)
2015-03-17 21:54:16 +03:00
{
if (!request || TransferEncoding == TransferEncodingUnknown)
return FALSE;
request->TransferEncoding = TransferEncoding;
2015-03-17 21:54:16 +03:00
return TRUE;
}
WINPR_ATTR_FORMAT_ARG(2, 3)
static BOOL http_encode_print(wStream* s, WINPR_FORMAT_ARG const char* fmt, ...)
{
char* str = NULL;
va_list ap;
int length = 0;
int used = 0;
if (!s || !fmt)
return FALSE;
va_start(ap, fmt);
length = vsnprintf(NULL, 0, fmt, ap) + 1;
va_end(ap);
2018-10-18 10:09:30 +03:00
if (!Stream_EnsureRemainingCapacity(s, (size_t)length))
return FALSE;
2018-09-27 17:05:14 +03:00
str = (char*)Stream_Pointer(s);
va_start(ap, fmt);
2018-10-18 10:09:30 +03:00
used = vsnprintf(str, (size_t)length, fmt, ap);
va_end(ap);
/* Strip the trailing '\0' from the string. */
if ((used + 1) != length)
return FALSE;
2018-10-18 10:09:30 +03:00
Stream_Seek(s, (size_t)used);
return TRUE;
}
static BOOL http_encode_body_line(wStream* s, const char* param, const char* value)
{
if (!s || !param || !value)
return FALSE;
return http_encode_print(s, "%s: %s\r\n", param, value);
}
static BOOL http_encode_content_length_line(wStream* s, size_t ContentLength)
{
2019-11-06 17:24:51 +03:00
return http_encode_print(s, "Content-Length: %" PRIdz "\r\n", ContentLength);
}
static BOOL http_encode_header_line(wStream* s, const char* Method, const char* URI)
{
if (!s || !Method || !URI)
return FALSE;
return http_encode_print(s, "%s %s HTTP/1.1\r\n", Method, URI);
}
static BOOL http_encode_authorization_line(wStream* s, const char* AuthScheme,
2019-11-06 17:24:51 +03:00
const char* AuthParam)
{
if (!s || !AuthScheme || !AuthParam)
return FALSE;
return http_encode_print(s, "Authorization: %s %s\r\n", AuthScheme, AuthParam);
}
static BOOL http_encode_cookie_line(wStream* s, wListDictionary* cookies)
{
ULONG_PTR* keys = NULL;
BOOL status = TRUE;
if (!s && !cookies)
return FALSE;
ListDictionary_Lock(cookies);
const size_t count = ListDictionary_GetKeys(cookies, &keys);
if (count == 0)
goto unlock;
status = http_encode_print(s, "Cookie: ");
if (!status)
goto unlock;
for (size_t x = 0; status && x < count; x++)
{
char* cur = (char*)ListDictionary_GetItemValue(cookies, (void*)keys[x]);
if (!cur)
{
status = FALSE;
continue;
}
if (x > 0)
{
status = http_encode_print(s, "; ");
if (!status)
continue;
}
status = http_encode_print(s, "%s=%s", (char*)keys[x], cur);
}
status = http_encode_print(s, "\r\n");
unlock:
free(keys);
ListDictionary_Unlock(cookies);
return status;
}
wStream* http_request_write(HttpContext* context, HttpRequest* request)
2012-04-14 22:19:31 +04:00
{
wStream* s = NULL;
if (!context || !request)
return NULL;
s = Stream_New(NULL, 1024);
if (!s)
return NULL;
if (!http_encode_header_line(s, request->Method, request->URI) ||
!http_encode_body_line(s, "Cache-Control", context->CacheControl) ||
!http_encode_body_line(s, "Pragma", context->Pragma) ||
!http_encode_body_line(s, "Accept", context->Accept) ||
!http_encode_body_line(s, "User-Agent", context->UserAgent) ||
!http_encode_body_line(s, "Host", context->Host))
goto fail;
2021-01-25 18:20:18 +03:00
if (!context->websocketUpgrade)
{
if (!http_encode_body_line(s, "Connection", context->Connection))
goto fail;
}
else
{
if (!http_encode_body_line(s, "Connection", "Upgrade") ||
!http_encode_body_line(s, "Upgrade", "websocket") ||
!http_encode_body_line(s, "Sec-Websocket-Version", "13") ||
!http_encode_body_line(s, "Sec-Websocket-Key", context->SecWebsocketKey))
2021-01-25 18:20:18 +03:00
goto fail;
}
2015-03-17 21:54:16 +03:00
if (context->RdgConnectionId)
{
if (!http_encode_body_line(s, "RDG-Connection-Id", context->RdgConnectionId))
goto fail;
}
2015-03-17 21:54:16 +03:00
if (context->RdgCorrelationId)
{
if (!http_encode_body_line(s, "RDG-Correlation-Id", context->RdgCorrelationId))
goto fail;
}
if (context->RdgAuthScheme)
{
if (!http_encode_body_line(s, "RDG-Auth-Scheme", context->RdgAuthScheme))
goto fail;
}
2015-03-17 21:54:16 +03:00
if (request->TransferEncoding != TransferEncodingIdentity)
{
if (request->TransferEncoding == TransferEncodingChunked)
{
if (!http_encode_body_line(s, "Transfer-Encoding", "chunked"))
goto fail;
}
else
goto fail;
}
else
{
if (!http_encode_content_length_line(s, request->ContentLength))
goto fail;
}
2015-03-17 21:54:16 +03:00
if (request->Authorization)
{
if (!http_encode_body_line(s, "Authorization", request->Authorization))
goto fail;
}
else if (request->AuthScheme && request->AuthParam)
{
if (!http_encode_authorization_line(s, request->AuthScheme, request->AuthParam))
goto fail;
2012-04-14 22:19:31 +04:00
}
if (context->cookies)
{
if (!http_encode_cookie_line(s, context->cookies))
goto fail;
}
if (request->ContentType)
{
if (!http_encode_body_line(s, "Content-Type", request->ContentType))
goto fail;
}
if (context->X_MS_UserAgent)
{
if (!http_encode_body_line(s, "X-MS-User-Agent", context->X_MS_UserAgent))
goto fail;
}
if (!http_encode_print(s, "\r\n"))
goto fail;
Stream_SealLength(s);
2012-04-14 22:19:31 +04:00
return s;
fail:
Stream_Free(s, TRUE);
return NULL;
}
2012-04-14 22:19:31 +04:00
2018-01-15 14:43:37 +03:00
HttpRequest* http_request_new(void)
{
HttpRequest* request = (HttpRequest*)calloc(1, sizeof(HttpRequest));
if (!request)
return NULL;
request->TransferEncoding = TransferEncodingIdentity;
return request;
2012-04-14 22:19:31 +04:00
}
void http_request_free(HttpRequest* request)
2012-04-14 22:19:31 +04:00
{
if (!request)
return;
2015-05-11 10:07:39 +03:00
free(request->AuthParam);
free(request->AuthScheme);
free(request->Authorization);
free(request->ContentType);
free(request->Method);
free(request->URI);
free(request);
2012-04-14 22:19:31 +04:00
}
static BOOL http_response_parse_header_status_line(HttpResponse* response, const char* status_line)
{
BOOL rc = FALSE;
2014-11-17 02:00:09 +03:00
char* separator = NULL;
char* status_code = NULL;
char* reason_phrase = NULL;
2014-11-17 02:00:09 +03:00
if (!response)
goto fail;
2014-11-17 02:00:09 +03:00
if (status_line)
separator = strchr(status_line, ' ');
if (!separator)
goto fail;
status_code = separator + 1;
separator = strchr(status_code, ' ');
if (!separator)
goto fail;
reason_phrase = separator + 1;
*separator = '\0';
2017-11-14 18:10:52 +03:00
errno = 0;
{
long val = strtol(status_code, NULL, 0);
if ((errno != 0) || (val < 0) || (val > INT16_MAX))
goto fail;
2017-11-14 18:10:52 +03:00
response->StatusCode = strtol(status_code, NULL, 0);
}
response->ReasonPhrase = reason_phrase;
if (!response->ReasonPhrase)
goto fail;
*separator = ' ';
rc = TRUE;
fail:
if (!rc)
WLog_ERR(TAG, "http_response_parse_header_status_line failed [%s]", status_line);
return rc;
}
static BOOL http_response_parse_header_field(HttpResponse* response, const char* name,
2019-11-06 17:24:51 +03:00
const char* value)
{
BOOL status = TRUE;
WINPR_ASSERT(response);
if (!name)
return FALSE;
if (_stricmp(name, "Content-Length") == 0)
{
unsigned long long val = 0;
2017-11-14 18:10:52 +03:00
errno = 0;
val = _strtoui64(value, NULL, 0);
2017-11-14 18:10:52 +03:00
2018-04-04 11:45:32 +03:00
if ((errno != 0) || (val > INT32_MAX))
2017-11-14 18:10:52 +03:00
return FALSE;
response->ContentLength = val;
}
2015-02-03 01:16:32 +03:00
else if (_stricmp(name, "Content-Type") == 0)
{
response->ContentType = value;
2015-02-03 01:16:32 +03:00
if (!response->ContentType)
return FALSE;
}
else if (_stricmp(name, "Transfer-Encoding") == 0)
{
if (_stricmp(value, "identity") == 0)
response->TransferEncoding = TransferEncodingIdentity;
else if (_stricmp(value, "chunked") == 0)
response->TransferEncoding = TransferEncodingChunked;
else
response->TransferEncoding = TransferEncodingUnknown;
}
2021-01-25 18:20:18 +03:00
else if (_stricmp(name, "Sec-WebSocket-Version") == 0)
{
response->SecWebsocketVersion = value;
if (!response->SecWebsocketVersion)
return FALSE;
}
else if (_stricmp(name, "Sec-WebSocket-Accept") == 0)
{
response->SecWebsocketAccept = value;
if (!response->SecWebsocketAccept)
return FALSE;
}
else if (_stricmp(name, "WWW-Authenticate") == 0)
{
char* separator = NULL;
const char* authScheme = NULL;
2018-10-18 10:09:30 +03:00
char* authValue = NULL;
separator = strchr(value, ' ');
if (separator)
{
/* WWW-Authenticate: Basic realm=""
* WWW-Authenticate: NTLM base64token
* WWW-Authenticate: Digest realm="testrealm@host.com", qop="auth, auth-int",
* nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093",
* opaque="5ccc069c403ebaf9f0171e9517f40e41"
*/
*separator = '\0';
authScheme = value;
authValue = separator + 1;
if (!authScheme || !authValue)
return FALSE;
}
else
{
authScheme = value;
if (!authScheme)
return FALSE;
authValue = NULL;
}
status = ListDictionary_Add(response->Authenticates, authScheme, authValue);
}
else if (_stricmp(name, "Set-Cookie") == 0)
{
char* separator = NULL;
const char* CookieName = NULL;
char* CookieValue = NULL;
separator = strchr(value, '=');
if (separator)
{
/* Set-Cookie: name=value
* Set-Cookie: name=value; Attribute=value
* Set-Cookie: name="value with spaces"; Attribute=value
*/
*separator = '\0';
CookieName = value;
CookieValue = separator + 1;
if (!CookieName || !CookieValue)
return FALSE;
if (*CookieValue == '"')
{
char* p = CookieValue;
while (*p != '"' && *p != '\0')
{
p++;
if (*p == '\\')
p++;
}
*p = '\0';
}
else
{
char* p = CookieValue;
while (*p != ';' && *p != '\0' && *p != ' ')
{
p++;
}
*p = '\0';
}
}
else
{
return FALSE;
}
status = ListDictionary_Add(response->SetCookie, CookieName, CookieValue);
}
return status;
}
2018-01-15 14:43:37 +03:00
static BOOL http_response_parse_header(HttpResponse* response)
{
BOOL rc = FALSE;
char c = 0;
char* line = NULL;
char* name = NULL;
char* colon_pos = NULL;
char* end_of_header = NULL;
char end_of_header_char = 0;
if (!response)
goto fail;
2013-08-29 17:30:22 +04:00
if (!response->lines)
goto fail;
2013-08-29 17:30:22 +04:00
if (!http_response_parse_header_status_line(response, response->lines[0]))
goto fail;
for (size_t count = 1; count < response->count; count++)
{
line = response->lines[count];
2017-11-14 18:10:52 +03:00
/**
* name end_of_header
* | |
* v v
* <header name> : <header value>
* ^ ^
* | |
* colon_pos value
*/
2014-11-17 02:00:09 +03:00
if (line)
colon_pos = strchr(line, ':');
else
colon_pos = NULL;
if ((colon_pos == NULL) || (colon_pos == line))
return FALSE;
/* retrieve the position just after header name */
for (end_of_header = colon_pos; end_of_header != line; end_of_header--)
{
c = end_of_header[-1];
if (c != ' ' && c != '\t' && c != ':')
break;
}
if (end_of_header == line)
goto fail;
end_of_header_char = *end_of_header;
*end_of_header = '\0';
name = line;
/* eat space and tabs before header value */
char* value = colon_pos + 1;
for (; *value; value++)
{
if ((*value != ' ') && (*value != '\t'))
break;
}
if (!http_response_parse_header_field(response, name, value))
goto fail;
*end_of_header = end_of_header_char;
}
rc = TRUE;
fail:
if (!rc)
WLog_ERR(TAG, "parsing failed");
return rc;
}
static void http_response_print(wLog* log, DWORD level, const HttpResponse* response)
{
char buffer[64] = { 0 };
WINPR_ASSERT(log);
WINPR_ASSERT(response);
if (!WLog_IsLevelActive(log, level))
return;
const long status = http_response_get_status_code(response);
WLog_Print(log, level, "HTTP status: %s",
freerdp_http_status_string_format(status, buffer, ARRAYSIZE(buffer)));
for (size_t i = 0; i < response->count; i++)
WLog_Print(log, WLOG_DEBUG, "[%" PRIuz "] %s", i, response->lines[i]);
if (response->ReasonPhrase)
WLog_Print(log, level, "[reason] %s", response->ReasonPhrase);
WLog_Print(log, WLOG_TRACE, "[body][%" PRIuz "] %s", response->BodyLength,
response->BodyContent);
}
static BOOL http_use_content_length(const char* cur)
{
size_t pos = 0;
if (!cur)
return FALSE;
if (_strnicmp(cur, "application/rpc", 15) == 0)
pos = 15;
else if (_strnicmp(cur, "text/plain", 10) == 0)
pos = 10;
else if (_strnicmp(cur, "text/html", 9) == 0)
pos = 9;
else if (_strnicmp(cur, "application/json", 16) == 0)
pos = 16;
if (pos > 0)
{
char end = cur[pos];
switch (end)
{
case ' ':
case ';':
case '\0':
case '\r':
case '\n':
return TRUE;
default:
return FALSE;
}
}
return FALSE;
}
static int print_bio_error(const char* str, size_t len, void* bp)
{
2024-06-27 09:43:29 +03:00
wLog* log = bp;
WINPR_UNUSED(len);
WINPR_UNUSED(bp);
2024-06-27 09:43:29 +03:00
WLog_Print(log, WLOG_ERROR, "%s", str);
return len;
}
int http_chuncked_read(BIO* bio, BYTE* pBuffer, size_t size,
http_encoding_chunked_context* encodingContext)
{
int status = 0;
int effectiveDataLen = 0;
WINPR_ASSERT(bio);
WINPR_ASSERT(pBuffer);
WINPR_ASSERT(encodingContext != NULL);
while (TRUE)
{
switch (encodingContext->state)
{
case ChunkStateData:
{
ERR_clear_error();
status = BIO_read(
bio, pBuffer,
(size > encodingContext->nextOffset ? encodingContext->nextOffset : size));
if (status <= 0)
return (effectiveDataLen > 0 ? effectiveDataLen : status);
encodingContext->nextOffset -= status;
if (encodingContext->nextOffset == 0)
{
encodingContext->state = ChunkStateFooter;
encodingContext->headerFooterPos = 0;
}
effectiveDataLen += status;
if ((size_t)status == size)
return effectiveDataLen;
pBuffer += status;
size -= status;
}
break;
case ChunkStateFooter:
{
char _dummy[2] = { 0 };
WINPR_ASSERT(encodingContext->nextOffset == 0);
WINPR_ASSERT(encodingContext->headerFooterPos < 2);
ERR_clear_error();
status = BIO_read(bio, _dummy, 2 - encodingContext->headerFooterPos);
if (status >= 0)
{
encodingContext->headerFooterPos += status;
if (encodingContext->headerFooterPos == 2)
{
encodingContext->state = ChunkStateLenghHeader;
encodingContext->headerFooterPos = 0;
}
}
else
return (effectiveDataLen > 0 ? effectiveDataLen : status);
}
break;
case ChunkStateLenghHeader:
{
BOOL _haveNewLine = FALSE;
char* dst = &encodingContext->lenBuffer[encodingContext->headerFooterPos];
WINPR_ASSERT(encodingContext->nextOffset == 0);
while (encodingContext->headerFooterPos < 10 && !_haveNewLine)
{
ERR_clear_error();
status = BIO_read(bio, dst, 1);
if (status >= 0)
{
if (*dst == '\n')
_haveNewLine = TRUE;
encodingContext->headerFooterPos += status;
dst += status;
}
else
return (effectiveDataLen > 0 ? effectiveDataLen : status);
}
*dst = '\0';
/* strtoul is tricky, error are reported via errno, we also need
* to ensure the result does not overflow */
errno = 0;
size_t tmp = strtoul(encodingContext->lenBuffer, NULL, 16);
if ((errno != 0) || (tmp > SIZE_MAX))
{
/* denote end of stream if something bad happens */
encodingContext->nextOffset = 0;
encodingContext->state = ChunkStateEnd;
return -1;
}
encodingContext->nextOffset = tmp;
encodingContext->state = ChunkStateData;
if (encodingContext->nextOffset == 0)
{ /* end of stream */
WLog_DBG(TAG, "chunked encoding end of stream received");
encodingContext->headerFooterPos = 0;
encodingContext->state = ChunkStateEnd;
return (effectiveDataLen > 0 ? effectiveDataLen : 0);
}
}
break;
default:
/* invalid state / ChunkStateEnd */
return -1;
}
}
}
#define sleep_or_timeout(tls, startMS, timeoutMS) \
sleep_or_timeout_((tls), (startMS), (timeoutMS), __FILE__, __func__, __LINE__)
static BOOL sleep_or_timeout_(rdpTls* tls, UINT64 startMS, UINT32 timeoutMS, const char* file,
const char* fkt, size_t line)
{
WINPR_ASSERT(tls);
USleep(100);
const UINT64 nowMS = GetTickCount64();
if (nowMS - startMS > timeoutMS)
{
DWORD level = WLOG_ERROR;
wLog* log = WLog_Get(TAG);
if (WLog_IsLevelActive(log, level))
WLog_PrintMessage(log, WLOG_MESSAGE_TEXT, level, line, file, fkt,
"timeout [%" PRIu32 "ms] exceeded", timeoutMS);
return TRUE;
}
if (!BIO_should_retry(tls->bio))
{
2024-06-27 09:43:29 +03:00
DWORD level = WLOG_ERROR;
wLog* log = WLog_Get(TAG);
if (WLog_IsLevelActive(log, level))
{
WLog_PrintMessage(log, WLOG_MESSAGE_TEXT, level, line, file, fkt, "Retries exceeded");
ERR_print_errors_cb(print_bio_error, log);
}
return TRUE;
}
if (freerdp_shall_disconnect_context(tls->context))
return TRUE;
return FALSE;
}
static SSIZE_T http_response_recv_line(rdpTls* tls, HttpResponse* response)
{
WINPR_ASSERT(tls);
WINPR_ASSERT(response);
SSIZE_T payloadOffset = -1;
const UINT32 timeoutMS =
freerdp_settings_get_uint32(tls->context->settings, FreeRDP_TcpConnectTimeout);
const UINT64 startMS = GetTickCount64();
while (payloadOffset <= 0)
{
size_t bodyLength = 0;
size_t position = 0;
int status = -1;
size_t s = 0;
char* end = NULL;
/* Read until we encounter \r\n\r\n */
ERR_clear_error();
status = BIO_read(tls->bio, Stream_Pointer(response->data), 1);
if (status <= 0)
{
if (sleep_or_timeout(tls, startMS, timeoutMS))
goto out_error;
continue;
}
#ifdef FREERDP_HAVE_VALGRIND_MEMCHECK_H
VALGRIND_MAKE_MEM_DEFINED(Stream_Pointer(response->data), status);
#endif
2018-09-27 17:05:14 +03:00
Stream_Seek(response->data, (size_t)status);
if (!Stream_EnsureRemainingCapacity(response->data, 1024))
goto out_error;
position = Stream_GetPosition(response->data);
2015-02-03 01:16:32 +03:00
if (position < 4)
continue;
else if (position > RESPONSE_SIZE_LIMIT)
{
2019-11-06 17:24:51 +03:00
WLog_ERR(TAG, "Request header too large! (%" PRIdz " bytes) Aborting!", bodyLength);
goto out_error;
2015-02-03 01:16:32 +03:00
}
/* Always check at most the lase 8 bytes for occurance of the desired
* sequence of \r\n\r\n */
s = (position > 8) ? 8 : position;
end = (char*)Stream_Pointer(response->data) - s;
if (string_strnstr(end, "\r\n\r\n", s) != NULL)
payloadOffset = Stream_GetPosition(response->data);
}
out_error:
return payloadOffset;
}
static BOOL http_response_recv_body(rdpTls* tls, HttpResponse* response, BOOL readContentLength,
size_t payloadOffset, size_t bodyLength)
{
BOOL rc = FALSE;
WINPR_ASSERT(tls);
WINPR_ASSERT(response);
const UINT64 startMS = GetTickCount64();
const UINT32 timeoutMS =
freerdp_settings_get_uint32(tls->context->settings, FreeRDP_TcpConnectTimeout);
if ((response->TransferEncoding == TransferEncodingChunked) && readContentLength)
{
http_encoding_chunked_context ctx = { 0 };
ctx.state = ChunkStateLenghHeader;
ctx.nextOffset = 0;
ctx.headerFooterPos = 0;
int full_len = 0;
do
{
if (!Stream_EnsureRemainingCapacity(response->data, 2048))
goto out_error;
int status = http_chuncked_read(tls->bio, Stream_Pointer(response->data),
Stream_GetRemainingCapacity(response->data), &ctx);
if (status <= 0)
{
if (sleep_or_timeout(tls, startMS, timeoutMS))
goto out_error;
}
else
{
Stream_Seek(response->data, (size_t)status);
full_len += status;
}
} while (ctx.state != ChunkStateEnd);
response->BodyLength = full_len;
if (response->BodyLength > 0)
response->BodyContent = &(Stream_Buffer(response->data))[payloadOffset];
}
else
{
while (response->BodyLength < bodyLength)
{
int status = 0;
if (!Stream_EnsureRemainingCapacity(response->data, bodyLength - response->BodyLength))
goto out_error;
ERR_clear_error();
status = BIO_read(tls->bio, Stream_Pointer(response->data),
bodyLength - response->BodyLength);
if (status <= 0)
{
if (sleep_or_timeout(tls, startMS, timeoutMS))
goto out_error;
continue;
}
Stream_Seek(response->data, (size_t)status);
response->BodyLength += (unsigned long)status;
if (response->BodyLength > RESPONSE_SIZE_LIMIT)
{
WLog_ERR(TAG, "Request body too large! (%" PRIdz " bytes) Aborting!",
response->BodyLength);
goto out_error;
}
}
if (response->BodyLength > 0)
response->BodyContent = &(Stream_Buffer(response->data))[payloadOffset];
if (bodyLength != response->BodyLength)
{
WLog_WARN(TAG, "%s unexpected body length: actual: %" PRIuz ", expected: %" PRIuz,
response->ContentType, response->BodyLength, bodyLength);
if (bodyLength > 0)
response->BodyLength = MIN(bodyLength, response->BodyLength);
}
/* '\0' terminate the http body */
if (!Stream_EnsureRemainingCapacity(response->data, sizeof(UINT16)))
goto out_error;
Stream_Write_UINT16(response->data, 0);
}
rc = TRUE;
out_error:
return rc;
}
HttpResponse* http_response_recv(rdpTls* tls, BOOL readContentLength)
{
size_t bodyLength = 0;
HttpResponse* response = http_response_new();
if (!response)
return NULL;
response->ContentLength = 0;
const SSIZE_T payloadOffset = http_response_recv_line(tls, response);
if (payloadOffset < 0)
goto out_error;
if (payloadOffset)
{
size_t count = 0;
char* buffer = (char*)Stream_Buffer(response->data);
2019-11-06 17:24:51 +03:00
char* line = (char*)Stream_Buffer(response->data);
2020-05-18 11:35:52 +03:00
char* context = NULL;
2018-10-18 10:09:30 +03:00
while ((line = string_strnstr(line, "\r\n", payloadOffset - (line - buffer) - 2UL)))
{
line += 2;
count++;
}
response->count = count;
if (count)
{
2019-11-06 17:24:51 +03:00
response->lines = (char**)calloc(response->count, sizeof(char*));
2015-02-03 01:16:32 +03:00
if (!response->lines)
2015-02-03 01:16:32 +03:00
goto out_error;
}
2015-02-03 01:16:32 +03:00
buffer[payloadOffset - 1] = '\0';
buffer[payloadOffset - 2] = '\0';
count = 0;
2020-05-18 11:35:52 +03:00
line = strtok_s(buffer, "\r\n", &context);
2018-10-24 15:36:12 +03:00
while (line && (response->count > count))
{
response->lines[count] = line;
2020-05-18 11:35:52 +03:00
line = strtok_s(NULL, "\r\n", &context);
count++;
}
2015-02-03 01:16:32 +03:00
if (!http_response_parse_header(response))
goto out_error;
2015-02-03 01:16:32 +03:00
response->BodyLength = Stream_GetPosition(response->data) - payloadOffset;
WINPR_ASSERT(response->BodyLength == 0);
bodyLength = response->BodyLength; /* expected body length */
if (readContentLength)
{
const char* cur = response->ContentType;
while (cur != NULL)
{
if (http_use_content_length(cur))
{
if (response->ContentLength < RESPONSE_SIZE_LIMIT)
bodyLength = response->ContentLength;
break;
}
else
readContentLength = FALSE; /* prevent chunked read */
cur = strchr(cur, ';');
}
}
if (bodyLength > RESPONSE_SIZE_LIMIT)
{
2019-11-06 17:24:51 +03:00
WLog_ERR(TAG, "Expected request body too large! (%" PRIdz " bytes) Aborting!",
bodyLength);
goto out_error;
}
/* Fetch remaining body! */
if (!http_response_recv_body(tls, response, readContentLength, payloadOffset, bodyLength))
goto out_error;
}
Stream_SealLength(response->data);
/* Ensure '\0' terminated string */
if (!Stream_EnsureRemainingCapacity(response->data, 2))
goto out_error;
Stream_Write_UINT16(response->data, 0);
return response;
out_error:
http_response_free(response);
return NULL;
}
const BYTE* http_response_get_body(const HttpResponse* response)
{
if (!response)
return NULL;
return response->BodyContent;
}
static BOOL set_compare(wListDictionary* dict)
{
WINPR_ASSERT(dict);
wObject* key = ListDictionary_KeyObject(dict);
wObject* value = ListDictionary_KeyObject(dict);
if (!key || !value)
return FALSE;
key->fnObjectEquals = strings_equals_nocase;
value->fnObjectEquals = strings_equals_nocase;
return TRUE;
}
2018-01-15 14:43:37 +03:00
HttpResponse* http_response_new(void)
{
2019-11-06 17:24:51 +03:00
HttpResponse* response = (HttpResponse*)calloc(1, sizeof(HttpResponse));
if (!response)
return NULL;
response->Authenticates = ListDictionary_New(FALSE);
2017-11-14 18:10:52 +03:00
if (!response->Authenticates)
goto fail;
if (!set_compare(response->Authenticates))
goto fail;
response->SetCookie = ListDictionary_New(FALSE);
if (!response->SetCookie)
goto fail;
if (!set_compare(response->SetCookie))
goto fail;
response->data = Stream_New(NULL, 2048);
if (!response->data)
goto fail;
response->TransferEncoding = TransferEncodingIdentity;
return response;
fail:
WINPR_PRAGMA_DIAG_PUSH
WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
http_response_free(response);
WINPR_PRAGMA_DIAG_POP
return NULL;
}
void http_response_free(HttpResponse* response)
{
if (!response)
return;
free(response->lines);
ListDictionary_Free(response->Authenticates);
ListDictionary_Free(response->SetCookie);
Stream_Free(response->data, TRUE);
free(response);
}
const char* http_request_get_uri(HttpRequest* request)
{
if (!request)
return NULL;
return request->URI;
}
SSIZE_T http_request_get_content_length(HttpRequest* request)
{
if (!request)
return -1;
2018-09-27 17:05:14 +03:00
return (SSIZE_T)request->ContentLength;
}
BOOL http_request_set_content_length(HttpRequest* request, size_t length)
{
if (!request)
return FALSE;
request->ContentLength = length;
return TRUE;
}
long http_response_get_status_code(const HttpResponse* response)
{
WINPR_ASSERT(response);
return response->StatusCode;
}
size_t http_response_get_body_length(const HttpResponse* response)
{
WINPR_ASSERT(response);
2018-09-27 17:05:14 +03:00
return (SSIZE_T)response->BodyLength;
}
const char* http_response_get_auth_token(const HttpResponse* response, const char* method)
{
if (!response || !method)
return NULL;
if (!ListDictionary_Contains(response->Authenticates, method))
return NULL;
return ListDictionary_GetItemValue(response->Authenticates, method);
}
const char* http_response_get_setcookie(const HttpResponse* response, const char* cookie)
{
if (!response || !cookie)
return NULL;
if (!ListDictionary_Contains(response->SetCookie, cookie))
return NULL;
return ListDictionary_GetItemValue(response->SetCookie, cookie);
}
TRANSFER_ENCODING http_response_get_transfer_encoding(const HttpResponse* response)
{
if (!response)
return TransferEncodingUnknown;
return response->TransferEncoding;
}
2021-01-25 18:20:18 +03:00
BOOL http_response_is_websocket(const HttpContext* http, const HttpResponse* response)
2021-01-25 18:20:18 +03:00
{
BOOL isWebsocket = FALSE;
WINPR_DIGEST_CTX* sha1 = NULL;
char* base64accept = NULL;
BYTE sha1_digest[WINPR_SHA1_DIGEST_LENGTH];
if (!http || !response)
return FALSE;
if (!http->websocketUpgrade || response->StatusCode != HTTP_STATUS_SWITCH_PROTOCOLS)
return FALSE;
if (response->SecWebsocketVersion && _stricmp(response->SecWebsocketVersion, "13") != 0)
return FALSE;
if (!response->SecWebsocketAccept)
return FALSE;
/* now check if Sec-Websocket-Accept is correct */
sha1 = winpr_Digest_New();
if (!sha1)
goto out;
if (!winpr_Digest_Init(sha1, WINPR_MD_SHA1))
goto out;
if (!winpr_Digest_Update(sha1, (BYTE*)http->SecWebsocketKey, strlen(http->SecWebsocketKey)))
2021-01-25 18:20:18 +03:00
goto out;
if (!winpr_Digest_Update(sha1, (const BYTE*)WEBSOCKET_MAGIC_GUID, strlen(WEBSOCKET_MAGIC_GUID)))
goto out;
if (!winpr_Digest_Final(sha1, sha1_digest, sizeof(sha1_digest)))
goto out;
base64accept = crypto_base64_encode(sha1_digest, WINPR_SHA1_DIGEST_LENGTH);
if (!base64accept)
goto out;
if (_stricmp(response->SecWebsocketAccept, base64accept) != 0)
{
WLog_WARN(TAG, "Webserver gave Websocket Upgrade response but sanity check failed");
goto out;
}
isWebsocket = TRUE;
out:
winpr_Digest_Free(sha1);
free(base64accept);
return isWebsocket;
}
void http_response_log_error_status(wLog* log, DWORD level, const HttpResponse* response)
{
WINPR_ASSERT(log);
WINPR_ASSERT(response);
if (!WLog_IsLevelActive(log, level))
return;
char buffer[64] = { 0 };
const long status = http_response_get_status_code(response);
WLog_Print(log, level, "Unexpected HTTP status: %s",
freerdp_http_status_string_format(status, buffer, ARRAYSIZE(buffer)));
http_response_print(log, level, response);
}