FreeRDP
Loading...
Searching...
No Matches
libfreerdp/core/gateway/http.h
1
20#ifndef FREERDP_LIB_CORE_GATEWAY_HTTP_H
21#define FREERDP_LIB_CORE_GATEWAY_HTTP_H
22
23#include <winpr/stream.h>
24
25#include <freerdp/api.h>
26#include <freerdp/utils/http.h>
27
28#include "../../crypto/tls.h"
29
30typedef enum
31{
32 TransferEncodingUnknown,
33 TransferEncodingIdentity,
34 TransferEncodingChunked
35} TRANSFER_ENCODING;
36
37typedef enum
38{
39 ChunkStateLenghHeader,
40 ChunkStateData,
41 ChunkStateFooter,
42 ChunkStateEnd
43} CHUNK_STATE;
44
45typedef struct
46{
47 size_t nextOffset;
48 size_t headerFooterPos;
49 CHUNK_STATE state;
50 char lenBuffer[11];
51} http_encoding_chunked_context;
52
53/* HTTP context */
54typedef struct s_http_context HttpContext;
55
56FREERDP_LOCAL void http_context_free(HttpContext* context);
57
58WINPR_ATTR_MALLOC(http_context_free, 1)
59WINPR_ATTR_NODISCARD
60FREERDP_LOCAL HttpContext* http_context_new(void);
61
62WINPR_ATTR_NODISCARD
63FREERDP_LOCAL BOOL http_context_set_method(HttpContext* context, const char* Method);
64
65WINPR_ATTR_NODISCARD
66FREERDP_LOCAL const char* http_context_get_uri(HttpContext* context);
67
68WINPR_ATTR_NODISCARD
69FREERDP_LOCAL BOOL http_context_set_uri(HttpContext* context, const char* URI);
70
71WINPR_ATTR_NODISCARD
72FREERDP_LOCAL BOOL http_context_set_user_agent(HttpContext* context, const char* UserAgent);
73
74WINPR_ATTR_NODISCARD
75FREERDP_LOCAL BOOL http_context_set_x_ms_user_agent(HttpContext* context, const char* UserAgent);
76
77WINPR_ATTR_NODISCARD
78FREERDP_LOCAL BOOL http_context_set_host(HttpContext* context, const char* Host);
79
80WINPR_ATTR_NODISCARD
81FREERDP_LOCAL BOOL http_context_set_accept(HttpContext* context, const char* Accept);
82
83WINPR_ATTR_NODISCARD
84FREERDP_LOCAL BOOL http_context_set_cache_control(HttpContext* context, const char* CacheControl);
85
86WINPR_ATTR_NODISCARD
87FREERDP_LOCAL BOOL http_context_set_connection(HttpContext* context, const char* Connection);
88
89WINPR_ATTR_NODISCARD
90FREERDP_LOCAL BOOL http_context_set_pragma(HttpContext* context,
91 WINPR_FORMAT_ARG const char* Pragma, ...);
92
93WINPR_ATTR_NODISCARD
94FREERDP_LOCAL BOOL http_context_append_pragma(HttpContext* context,
95 WINPR_FORMAT_ARG const char* Pragma, ...);
96
97WINPR_ATTR_NODISCARD
98FREERDP_LOCAL BOOL http_context_set_cookie(HttpContext* context, const char* CookieName,
99 const char* CookieValue);
100
101WINPR_ATTR_NODISCARD
102FREERDP_LOCAL BOOL http_context_set_rdg_connection_id(HttpContext* context);
103
104WINPR_ATTR_NODISCARD
105FREERDP_LOCAL BOOL http_context_set_rdg_correlation_id(HttpContext* context,
106 const GUID* RdgCorrelationId);
107
108WINPR_ATTR_NODISCARD
109WINPR_ATTR_FORMAT_ARG(3, 4)
110FREERDP_LOCAL BOOL http_context_set_header(HttpContext* context, const char* key,
111 WINPR_FORMAT_ARG const char* value, ...);
112
113WINPR_ATTR_NODISCARD
114WINPR_ATTR_FORMAT_ARG(3, 0)
115FREERDP_LOCAL BOOL http_context_set_header_va(HttpContext* context, const char* key,
116 WINPR_FORMAT_ARG const char* value, va_list ap);
117
118WINPR_ATTR_NODISCARD
119FREERDP_LOCAL BOOL http_context_set_rdg_auth_scheme(HttpContext* context,
120 const char* RdgAuthScheme);
121
122FREERDP_LOCAL BOOL http_context_enable_websocket_upgrade(HttpContext* context, BOOL enable);
123
124WINPR_ATTR_NODISCARD
125FREERDP_LOCAL BOOL http_context_is_websocket_upgrade_enabled(HttpContext* context);
126
127/* HTTP request */
128typedef struct s_http_request HttpRequest;
129
130FREERDP_LOCAL void http_request_free(HttpRequest* request);
131
132WINPR_ATTR_MALLOC(http_request_free, 1)
133WINPR_ATTR_NODISCARD
134FREERDP_LOCAL HttpRequest* http_request_new(void);
135
136WINPR_ATTR_NODISCARD
137FREERDP_LOCAL BOOL http_request_set_method(HttpRequest* request, const char* Method);
138
139WINPR_ATTR_NODISCARD
140FREERDP_LOCAL BOOL http_request_set_content_type(HttpRequest* request, const char* ContentType);
141
142WINPR_ATTR_NODISCARD
143FREERDP_LOCAL SSIZE_T http_request_get_content_length(HttpRequest* request);
144
145WINPR_ATTR_NODISCARD
146FREERDP_LOCAL BOOL http_request_set_content_length(HttpRequest* request, size_t length);
147
148WINPR_ATTR_NODISCARD
149FREERDP_LOCAL const char* http_request_get_uri(HttpRequest* request);
150
151WINPR_ATTR_NODISCARD
152FREERDP_LOCAL BOOL http_request_set_uri(HttpRequest* request, const char* URI);
153
154WINPR_ATTR_NODISCARD
155FREERDP_LOCAL BOOL http_request_set_auth_scheme(HttpRequest* request, const char* AuthScheme);
156
157WINPR_ATTR_NODISCARD
158FREERDP_LOCAL BOOL http_request_set_auth_param(HttpRequest* request, const char* AuthParam);
159
160WINPR_ATTR_NODISCARD
161FREERDP_LOCAL BOOL http_request_set_transfer_encoding(HttpRequest* request,
162 TRANSFER_ENCODING TransferEncoding);
163
164WINPR_ATTR_NODISCARD
165WINPR_ATTR_FORMAT_ARG(3, 4)
166FREERDP_LOCAL BOOL http_request_set_header(HttpRequest* request, const char* key,
167 WINPR_FORMAT_ARG const char* value, ...);
168
169WINPR_ATTR_MALLOC(Stream_Free, 1)
170WINPR_ATTR_NODISCARD
171FREERDP_LOCAL wStream* http_request_write(HttpContext* context, HttpRequest* request);
172
173/* HTTP response */
174typedef struct s_http_response HttpResponse;
175
176FREERDP_LOCAL void http_response_free(HttpResponse* response);
177
178WINPR_ATTR_MALLOC(http_response_free, 1)
179WINPR_ATTR_NODISCARD
180FREERDP_LOCAL HttpResponse* http_response_new(void);
181
182WINPR_ATTR_MALLOC(http_response_free, 1)
183WINPR_ATTR_NODISCARD
184FREERDP_LOCAL HttpResponse* http_response_recv(rdpTls* tls, BOOL readContentLength);
185
186WINPR_ATTR_NODISCARD
187FREERDP_LOCAL UINT16 http_response_get_status_code(const HttpResponse* response);
188
189WINPR_ATTR_NODISCARD
190FREERDP_LOCAL size_t http_response_get_body_length(const HttpResponse* response);
191
192WINPR_ATTR_NODISCARD
193FREERDP_LOCAL const char* http_response_get_body(const HttpResponse* response);
194
195WINPR_ATTR_NODISCARD
196FREERDP_LOCAL const char* http_response_get_auth_token(const HttpResponse* response,
197 const char* method);
198
199WINPR_ATTR_NODISCARD
200FREERDP_LOCAL const char* http_response_get_setcookie(const HttpResponse* response,
201 const char* cookie);
202
203FREERDP_LOCAL BOOL http_response_extract_cookies(const HttpResponse* response,
204 HttpContext* context);
205
206WINPR_ATTR_NODISCARD
207FREERDP_LOCAL TRANSFER_ENCODING http_response_get_transfer_encoding(const HttpResponse* response);
208
209WINPR_ATTR_NODISCARD
210FREERDP_LOCAL BOOL http_response_is_websocket(const HttpContext* http,
211 const HttpResponse* response);
212
213#define http_response_log_error_status(log, level, response) \
214 http_response_log_error_status_((log), (level), (response), __FILE__, __LINE__, __func__)
215FREERDP_LOCAL void http_response_log_error_status_(wLog* log, DWORD level,
216 const HttpResponse* response, const char* file,
217 size_t line, const char* fkt);
218
219/* chunked read helper */
220WINPR_ATTR_NODISCARD
221FREERDP_LOCAL int http_chuncked_read(BIO* bio, BYTE* pBuffer, size_t size,
222 http_encoding_chunked_context* encodingContext);
223
224#endif /* FREERDP_LIB_CORE_GATEWAY_HTTP_H */
http_encoding_chunked_context
Definition libfreerdp/core/gateway/http.h:46