http.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. #ifndef HEADER_CURL_HTTP_H
  2. #define HEADER_CURL_HTTP_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
  11. *
  12. * This software is licensed as described in the file COPYING, which
  13. * you should have received as part of this distribution. The terms
  14. * are also available at https://curl.se/docs/copyright.html.
  15. *
  16. * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17. * copies of the Software, and permit persons to whom the Software is
  18. * furnished to do so, under the terms of the COPYING file.
  19. *
  20. * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21. * KIND, either express or implied.
  22. *
  23. * SPDX-License-Identifier: curl
  24. *
  25. ***************************************************************************/
  26. #include "curl_setup.h"
  27. #if defined(USE_MSH3) && !defined(_WIN32)
  28. #include <pthread.h>
  29. #endif
  30. #include "bufq.h"
  31. #include "dynhds.h"
  32. #include "ws.h"
  33. typedef enum {
  34. HTTPREQ_GET,
  35. HTTPREQ_POST,
  36. HTTPREQ_POST_FORM, /* we make a difference internally */
  37. HTTPREQ_POST_MIME, /* we make a difference internally */
  38. HTTPREQ_PUT,
  39. HTTPREQ_HEAD
  40. } Curl_HttpReq;
  41. #ifndef CURL_DISABLE_HTTP
  42. #if defined(ENABLE_QUIC)
  43. #include <stdint.h>
  44. #endif
  45. extern const struct Curl_handler Curl_handler_http;
  46. #ifdef USE_SSL
  47. extern const struct Curl_handler Curl_handler_https;
  48. #endif
  49. #ifdef USE_WEBSOCKETS
  50. extern const struct Curl_handler Curl_handler_ws;
  51. #ifdef USE_SSL
  52. extern const struct Curl_handler Curl_handler_wss;
  53. #endif
  54. #endif /* websockets */
  55. struct dynhds;
  56. CURLcode Curl_bump_headersize(struct Curl_easy *data,
  57. size_t delta,
  58. bool connect_only);
  59. /* Header specific functions */
  60. bool Curl_compareheader(const char *headerline, /* line to check */
  61. const char *header, /* header keyword _with_ colon */
  62. const size_t hlen, /* len of the keyword in bytes */
  63. const char *content, /* content string to find */
  64. const size_t clen); /* len of the content in bytes */
  65. char *Curl_copy_header_value(const char *header);
  66. char *Curl_checkProxyheaders(struct Curl_easy *data,
  67. const struct connectdata *conn,
  68. const char *thisheader,
  69. const size_t thislen);
  70. struct HTTP; /* see below */
  71. CURLcode Curl_buffer_send(struct dynbuf *in,
  72. struct Curl_easy *data,
  73. struct HTTP *http,
  74. curl_off_t *bytes_written,
  75. curl_off_t included_body_bytes,
  76. int socketindex);
  77. CURLcode Curl_add_timecondition(struct Curl_easy *data,
  78. #ifndef USE_HYPER
  79. struct dynbuf *req
  80. #else
  81. void *headers
  82. #endif
  83. );
  84. CURLcode Curl_add_custom_headers(struct Curl_easy *data,
  85. bool is_connect,
  86. #ifndef USE_HYPER
  87. struct dynbuf *req
  88. #else
  89. void *headers
  90. #endif
  91. );
  92. CURLcode Curl_dynhds_add_custom(struct Curl_easy *data,
  93. bool is_connect,
  94. struct dynhds *hds);
  95. CURLcode Curl_http_compile_trailers(struct curl_slist *trailers,
  96. struct dynbuf *buf,
  97. struct Curl_easy *handle);
  98. void Curl_http_method(struct Curl_easy *data, struct connectdata *conn,
  99. const char **method, Curl_HttpReq *);
  100. CURLcode Curl_http_useragent(struct Curl_easy *data);
  101. CURLcode Curl_http_host(struct Curl_easy *data, struct connectdata *conn);
  102. CURLcode Curl_http_target(struct Curl_easy *data, struct connectdata *conn,
  103. struct dynbuf *req);
  104. CURLcode Curl_http_statusline(struct Curl_easy *data,
  105. struct connectdata *conn);
  106. CURLcode Curl_http_header(struct Curl_easy *data, struct connectdata *conn,
  107. char *headp);
  108. CURLcode Curl_transferencode(struct Curl_easy *data);
  109. CURLcode Curl_http_body(struct Curl_easy *data, struct connectdata *conn,
  110. Curl_HttpReq httpreq,
  111. const char **teep);
  112. CURLcode Curl_http_bodysend(struct Curl_easy *data, struct connectdata *conn,
  113. struct dynbuf *r, Curl_HttpReq httpreq);
  114. bool Curl_use_http_1_1plus(const struct Curl_easy *data,
  115. const struct connectdata *conn);
  116. #ifndef CURL_DISABLE_COOKIES
  117. CURLcode Curl_http_cookies(struct Curl_easy *data,
  118. struct connectdata *conn,
  119. struct dynbuf *r);
  120. #else
  121. #define Curl_http_cookies(a,b,c) CURLE_OK
  122. #endif
  123. CURLcode Curl_http_resume(struct Curl_easy *data,
  124. struct connectdata *conn,
  125. Curl_HttpReq httpreq);
  126. CURLcode Curl_http_range(struct Curl_easy *data,
  127. Curl_HttpReq httpreq);
  128. CURLcode Curl_http_firstwrite(struct Curl_easy *data,
  129. struct connectdata *conn,
  130. bool *done);
  131. /* protocol-specific functions set up to be called by the main engine */
  132. CURLcode Curl_http(struct Curl_easy *data, bool *done);
  133. CURLcode Curl_http_done(struct Curl_easy *data, CURLcode, bool premature);
  134. CURLcode Curl_http_connect(struct Curl_easy *data, bool *done);
  135. /* These functions are in http.c */
  136. CURLcode Curl_http_input_auth(struct Curl_easy *data, bool proxy,
  137. const char *auth);
  138. CURLcode Curl_http_auth_act(struct Curl_easy *data);
  139. /* If only the PICKNONE bit is set, there has been a round-trip and we
  140. selected to use no auth at all. Ie, we actively select no auth, as opposed
  141. to not having one selected. The other CURLAUTH_* defines are present in the
  142. public curl/curl.h header. */
  143. #define CURLAUTH_PICKNONE (1<<30) /* don't use auth */
  144. /* MAX_INITIAL_POST_SIZE indicates the number of bytes that will make the POST
  145. data get included in the initial data chunk sent to the server. If the
  146. data is larger than this, it will automatically get split up in multiple
  147. system calls.
  148. This value used to be fairly big (100K), but we must take into account that
  149. if the server rejects the POST due for authentication reasons, this data
  150. will always be unconditionally sent and thus it may not be larger than can
  151. always be afforded to send twice.
  152. It must not be greater than 64K to work on VMS.
  153. */
  154. #ifndef MAX_INITIAL_POST_SIZE
  155. #define MAX_INITIAL_POST_SIZE (64*1024)
  156. #endif
  157. /* EXPECT_100_THRESHOLD is the request body size limit for when libcurl will
  158. * automatically add an "Expect: 100-continue" header in HTTP requests. When
  159. * the size is unknown, it will always add it.
  160. *
  161. */
  162. #ifndef EXPECT_100_THRESHOLD
  163. #define EXPECT_100_THRESHOLD (1024*1024)
  164. #endif
  165. /* MAX_HTTP_RESP_HEADER_SIZE is the maximum size of all response headers
  166. combined that libcurl allows for a single HTTP response, any HTTP
  167. version. This count includes CONNECT response headers. */
  168. #define MAX_HTTP_RESP_HEADER_SIZE (300*1024)
  169. #endif /* CURL_DISABLE_HTTP */
  170. /****************************************************************************
  171. * HTTP unique setup
  172. ***************************************************************************/
  173. struct HTTP {
  174. curl_off_t postsize; /* off_t to handle large file sizes */
  175. const char *postdata;
  176. struct back {
  177. curl_read_callback fread_func; /* backup storage for fread pointer */
  178. void *fread_in; /* backup storage for fread_in pointer */
  179. const char *postdata;
  180. curl_off_t postsize;
  181. struct Curl_easy *data;
  182. } backup;
  183. enum {
  184. HTTPSEND_NADA, /* init */
  185. HTTPSEND_REQUEST, /* sending a request */
  186. HTTPSEND_BODY /* sending body */
  187. } sending;
  188. #ifndef CURL_DISABLE_HTTP
  189. void *h2_ctx; /* HTTP/2 implementation context */
  190. void *h3_ctx; /* HTTP/3 implementation context */
  191. struct dynbuf send_buffer; /* used if the request couldn't be sent in one
  192. chunk, points to an allocated send_buffer
  193. struct */
  194. #endif
  195. };
  196. CURLcode Curl_http_size(struct Curl_easy *data);
  197. CURLcode Curl_http_readwrite_headers(struct Curl_easy *data,
  198. struct connectdata *conn,
  199. const char *buf, size_t blen,
  200. size_t *pconsumed);
  201. /**
  202. * Curl_http_output_auth() setups the authentication headers for the
  203. * host/proxy and the correct authentication
  204. * method. data->state.authdone is set to TRUE when authentication is
  205. * done.
  206. *
  207. * @param data all information about the current transfer
  208. * @param conn all information about the current connection
  209. * @param request pointer to the request keyword
  210. * @param httpreq is the request type
  211. * @param path pointer to the requested path
  212. * @param proxytunnel boolean if this is the request setting up a "proxy
  213. * tunnel"
  214. *
  215. * @returns CURLcode
  216. */
  217. CURLcode
  218. Curl_http_output_auth(struct Curl_easy *data,
  219. struct connectdata *conn,
  220. const char *request,
  221. Curl_HttpReq httpreq,
  222. const char *path,
  223. bool proxytunnel); /* TRUE if this is the request setting
  224. up the proxy tunnel */
  225. /* Decode HTTP status code string. */
  226. CURLcode Curl_http_decode_status(int *pstatus, const char *s, size_t len);
  227. /**
  228. * All about a core HTTP request, excluding body and trailers
  229. */
  230. struct httpreq {
  231. char method[24];
  232. char *scheme;
  233. char *authority;
  234. char *path;
  235. struct dynhds headers;
  236. struct dynhds trailers;
  237. };
  238. /**
  239. * Create a HTTP request struct.
  240. */
  241. CURLcode Curl_http_req_make(struct httpreq **preq,
  242. const char *method, size_t m_len,
  243. const char *scheme, size_t s_len,
  244. const char *authority, size_t a_len,
  245. const char *path, size_t p_len);
  246. CURLcode Curl_http_req_make2(struct httpreq **preq,
  247. const char *method, size_t m_len,
  248. CURLU *url, const char *scheme_default);
  249. void Curl_http_req_free(struct httpreq *req);
  250. #define HTTP_PSEUDO_METHOD ":method"
  251. #define HTTP_PSEUDO_SCHEME ":scheme"
  252. #define HTTP_PSEUDO_AUTHORITY ":authority"
  253. #define HTTP_PSEUDO_PATH ":path"
  254. #define HTTP_PSEUDO_STATUS ":status"
  255. /**
  256. * Create the list of HTTP/2 headers which represent the request,
  257. * using HTTP/2 pseudo headers preceding the `req->headers`.
  258. *
  259. * Applies the following transformations:
  260. * - if `authority` is set, any "Host" header is removed.
  261. * - if `authority` is unset and a "Host" header is present, use
  262. * that as `authority` and remove "Host"
  263. * - removes and Connection header fields as defined in rfc9113 ch. 8.2.2
  264. * - lower-cases the header field names
  265. *
  266. * @param h2_headers will contain the HTTP/2 headers on success
  267. * @param req the request to transform
  268. * @param data the handle to lookup defaults like ' :scheme' from
  269. */
  270. CURLcode Curl_http_req_to_h2(struct dynhds *h2_headers,
  271. struct httpreq *req, struct Curl_easy *data);
  272. /**
  273. * All about a core HTTP response, excluding body and trailers
  274. */
  275. struct http_resp {
  276. int status;
  277. char *description;
  278. struct dynhds headers;
  279. struct dynhds trailers;
  280. struct http_resp *prev;
  281. };
  282. /**
  283. * Create a HTTP response struct.
  284. */
  285. CURLcode Curl_http_resp_make(struct http_resp **presp,
  286. int status,
  287. const char *description);
  288. void Curl_http_resp_free(struct http_resp *resp);
  289. #endif /* HEADER_CURL_HTTP_H */