xref: /curl/lib/http.h (revision c074ba64)
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 
28 #if defined(USE_MSH3) && !defined(_WIN32)
29 #include <pthread.h>
30 #endif
31 
32 #include "bufq.h"
33 #include "dynhds.h"
34 #include "ws.h"
35 
36 typedef enum {
37   HTTPREQ_GET,
38   HTTPREQ_POST,
39   HTTPREQ_POST_FORM, /* we make a difference internally */
40   HTTPREQ_POST_MIME, /* we make a difference internally */
41   HTTPREQ_PUT,
42   HTTPREQ_HEAD
43 } Curl_HttpReq;
44 
45 #ifndef CURL_DISABLE_HTTP
46 
47 #if defined(USE_HTTP3)
48 #include <stdint.h>
49 #endif
50 
51 extern const struct Curl_handler Curl_handler_http;
52 
53 #ifdef USE_SSL
54 extern const struct Curl_handler Curl_handler_https;
55 #endif
56 
57 struct dynhds;
58 
59 CURLcode Curl_bump_headersize(struct Curl_easy *data,
60                               size_t delta,
61                               bool connect_only);
62 
63 /* Header specific functions */
64 bool Curl_compareheader(const char *headerline,  /* line to check */
65                         const char *header,   /* header keyword _with_ colon */
66                         const size_t hlen,   /* len of the keyword in bytes */
67                         const char *content, /* content string to find */
68                         const size_t clen);   /* len of the content in bytes */
69 
70 char *Curl_copy_header_value(const char *header);
71 
72 char *Curl_checkProxyheaders(struct Curl_easy *data,
73                              const struct connectdata *conn,
74                              const char *thisheader,
75                              const size_t thislen);
76 
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 
96 void Curl_http_method(struct Curl_easy *data, struct connectdata *conn,
97                       const char **method, Curl_HttpReq *);
98 CURLcode Curl_http_useragent(struct Curl_easy *data);
99 CURLcode Curl_http_host(struct Curl_easy *data, struct connectdata *conn);
100 CURLcode Curl_http_target(struct Curl_easy *data, struct connectdata *conn,
101                           struct dynbuf *req);
102 CURLcode Curl_http_statusline(struct Curl_easy *data,
103                               struct connectdata *conn);
104 CURLcode Curl_http_header(struct Curl_easy *data,
105                           const char *hd, size_t hdlen);
106 CURLcode Curl_transferencode(struct Curl_easy *data);
107 CURLcode Curl_http_req_set_reader(struct Curl_easy *data,
108                                   Curl_HttpReq httpreq,
109                                   const char **tep);
110 CURLcode Curl_http_req_complete(struct Curl_easy *data,
111                                 struct dynbuf *r, Curl_HttpReq httpreq);
112 bool Curl_use_http_1_1plus(const struct Curl_easy *data,
113                            const struct connectdata *conn);
114 #ifndef CURL_DISABLE_COOKIES
115 CURLcode Curl_http_cookies(struct Curl_easy *data,
116                            struct connectdata *conn,
117                            struct dynbuf *r);
118 #else
119 #define Curl_http_cookies(a,b,c) CURLE_OK
120 #endif
121 CURLcode Curl_http_range(struct Curl_easy *data,
122                          Curl_HttpReq httpreq);
123 CURLcode Curl_http_firstwrite(struct Curl_easy *data);
124 
125 /* protocol-specific functions set up to be called by the main engine */
126 CURLcode Curl_http_setup_conn(struct Curl_easy *data,
127                               struct connectdata *conn);
128 CURLcode Curl_http(struct Curl_easy *data, bool *done);
129 CURLcode Curl_http_done(struct Curl_easy *data, CURLcode, bool premature);
130 CURLcode Curl_http_connect(struct Curl_easy *data, bool *done);
131 int Curl_http_getsock_do(struct Curl_easy *data, struct connectdata *conn,
132                          curl_socket_t *socks);
133 CURLcode Curl_http_write_resp(struct Curl_easy *data,
134                               const char *buf, size_t blen,
135                               bool is_eos);
136 CURLcode Curl_http_write_resp_hd(struct Curl_easy *data,
137                                  const char *hd, size_t hdlen,
138                                  bool is_eos);
139 
140 /* These functions are in http.c */
141 CURLcode Curl_http_input_auth(struct Curl_easy *data, bool proxy,
142                               const char *auth);
143 CURLcode Curl_http_auth_act(struct Curl_easy *data);
144 
145 /* If only the PICKNONE bit is set, there has been a round-trip and we
146    selected to use no auth at all. Ie, we actively select no auth, as opposed
147    to not having one selected. The other CURLAUTH_* defines are present in the
148    public curl/curl.h header. */
149 #define CURLAUTH_PICKNONE (1<<30) /* do not use auth */
150 
151 /* MAX_INITIAL_POST_SIZE indicates the number of bytes that will make the POST
152    data get included in the initial data chunk sent to the server. If the
153    data is larger than this, it will automatically get split up in multiple
154    system calls.
155 
156    This value used to be fairly big (100K), but we must take into account that
157    if the server rejects the POST due for authentication reasons, this data
158    will always be unconditionally sent and thus it may not be larger than can
159    always be afforded to send twice.
160 
161    It must not be greater than 64K to work on VMS.
162 */
163 #ifndef MAX_INITIAL_POST_SIZE
164 #define MAX_INITIAL_POST_SIZE (64*1024)
165 #endif
166 
167 /* EXPECT_100_THRESHOLD is the request body size limit for when libcurl will
168  * automatically add an "Expect: 100-continue" header in HTTP requests. When
169  * the size is unknown, it will always add it.
170  *
171  */
172 #ifndef EXPECT_100_THRESHOLD
173 #define EXPECT_100_THRESHOLD (1024*1024)
174 #endif
175 
176 /* MAX_HTTP_RESP_HEADER_SIZE is the maximum size of all response headers
177    combined that libcurl allows for a single HTTP response, any HTTP
178    version. This count includes CONNECT response headers. */
179 #define MAX_HTTP_RESP_HEADER_SIZE (300*1024)
180 
181 bool Curl_http_exp100_is_selected(struct Curl_easy *data);
182 void Curl_http_exp100_got100(struct Curl_easy *data);
183 
184 #endif /* CURL_DISABLE_HTTP */
185 
186 /****************************************************************************
187  * HTTP unique setup
188  ***************************************************************************/
189 
190 CURLcode Curl_http_size(struct Curl_easy *data);
191 
192 CURLcode Curl_http_write_resp_hds(struct Curl_easy *data,
193                                   const char *buf, size_t blen,
194                                   size_t *pconsumed);
195 
196 /**
197  * Curl_http_output_auth() setups the authentication headers for the
198  * host/proxy and the correct authentication
199  * method. data->state.authdone is set to TRUE when authentication is
200  * done.
201  *
202  * @param data all information about the current transfer
203  * @param conn all information about the current connection
204  * @param request pointer to the request keyword
205  * @param httpreq is the request type
206  * @param path pointer to the requested path
207  * @param proxytunnel boolean if this is the request setting up a "proxy
208  * tunnel"
209  *
210  * @returns CURLcode
211  */
212 CURLcode
213 Curl_http_output_auth(struct Curl_easy *data,
214                       struct connectdata *conn,
215                       const char *request,
216                       Curl_HttpReq httpreq,
217                       const char *path,
218                       bool proxytunnel); /* TRUE if this is the request setting
219                                             up the proxy tunnel */
220 
221 /* Decode HTTP status code string. */
222 CURLcode Curl_http_decode_status(int *pstatus, const char *s, size_t len);
223 
224 
225 /**
226  * All about a core HTTP request, excluding body and trailers
227  */
228 struct httpreq {
229   char method[24];
230   char *scheme;
231   char *authority;
232   char *path;
233   struct dynhds headers;
234   struct dynhds trailers;
235 };
236 
237 /**
238  * Create an HTTP request struct.
239  */
240 CURLcode Curl_http_req_make(struct httpreq **preq,
241                             const char *method, size_t m_len,
242                             const char *scheme, size_t s_len,
243                             const char *authority, size_t a_len,
244                             const char *path, size_t p_len);
245 
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 
250 void Curl_http_req_free(struct httpreq *req);
251 
252 #define HTTP_PSEUDO_METHOD ":method"
253 #define HTTP_PSEUDO_SCHEME ":scheme"
254 #define HTTP_PSEUDO_AUTHORITY ":authority"
255 #define HTTP_PSEUDO_PATH ":path"
256 #define HTTP_PSEUDO_STATUS ":status"
257 
258 /**
259  * Create the list of HTTP/2 headers which represent the request,
260  * using HTTP/2 pseudo headers preceding the `req->headers`.
261  *
262  * Applies the following transformations:
263  * - if `authority` is set, any "Host" header is removed.
264  * - if `authority` is unset and a "Host" header is present, use
265  *   that as `authority` and remove "Host"
266  * - removes and Connection header fields as defined in rfc9113 ch. 8.2.2
267  * - lower-cases the header field names
268  *
269  * @param h2_headers will contain the HTTP/2 headers on success
270  * @param req        the request to transform
271  * @param data       the handle to lookup defaults like ' :scheme' from
272  */
273 CURLcode Curl_http_req_to_h2(struct dynhds *h2_headers,
274                              struct httpreq *req, struct Curl_easy *data);
275 
276 /**
277  * All about a core HTTP response, excluding body and trailers
278  */
279 struct http_resp {
280   int status;
281   char *description;
282   struct dynhds headers;
283   struct dynhds trailers;
284   struct http_resp *prev;
285 };
286 
287 /**
288  * Create an HTTP response struct.
289  */
290 CURLcode Curl_http_resp_make(struct http_resp **presp,
291                              int status,
292                              const char *description);
293 
294 void Curl_http_resp_free(struct http_resp *resp);
295 
296 #endif /* HEADER_CURL_HTTP_H */
297