xref: /curl/lib/http.h (revision fc3e1cbc)
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, struct dynbuf *req);
78 CURLcode Curl_add_custom_headers(struct Curl_easy *data, bool is_connect,
79                                  struct dynbuf *req);
80 CURLcode Curl_dynhds_add_custom(struct Curl_easy *data, bool is_connect,
81                                 struct dynhds *hds);
82 
83 void Curl_http_method(struct Curl_easy *data, struct connectdata *conn,
84                       const char **method, Curl_HttpReq *);
85 #ifndef CURL_DISABLE_COOKIES
86 CURLcode Curl_http_cookies(struct Curl_easy *data,
87                            struct connectdata *conn,
88                            struct dynbuf *r);
89 #else
90 #define Curl_http_cookies(a,b,c) CURLE_OK
91 #endif
92 
93 /* protocol-specific functions set up to be called by the main engine */
94 CURLcode Curl_http_setup_conn(struct Curl_easy *data,
95                               struct connectdata *conn);
96 CURLcode Curl_http(struct Curl_easy *data, bool *done);
97 CURLcode Curl_http_done(struct Curl_easy *data, CURLcode, bool premature);
98 CURLcode Curl_http_connect(struct Curl_easy *data, bool *done);
99 int Curl_http_getsock_do(struct Curl_easy *data, struct connectdata *conn,
100                          curl_socket_t *socks);
101 CURLcode Curl_http_write_resp(struct Curl_easy *data,
102                               const char *buf, size_t blen,
103                               bool is_eos);
104 CURLcode Curl_http_write_resp_hd(struct Curl_easy *data,
105                                  const char *hd, size_t hdlen,
106                                  bool is_eos);
107 
108 /* These functions are in http.c */
109 CURLcode Curl_http_input_auth(struct Curl_easy *data, bool proxy,
110                               const char *auth);
111 CURLcode Curl_http_auth_act(struct Curl_easy *data);
112 
113 /* If only the PICKNONE bit is set, there has been a round-trip and we
114    selected to use no auth at all. Ie, we actively select no auth, as opposed
115    to not having one selected. The other CURLAUTH_* defines are present in the
116    public curl/curl.h header. */
117 #define CURLAUTH_PICKNONE (1<<30) /* do not use auth */
118 
119 /* MAX_INITIAL_POST_SIZE indicates the number of bytes that will make the POST
120    data get included in the initial data chunk sent to the server. If the
121    data is larger than this, it will automatically get split up in multiple
122    system calls.
123 
124    This value used to be fairly big (100K), but we must take into account that
125    if the server rejects the POST due for authentication reasons, this data
126    will always be unconditionally sent and thus it may not be larger than can
127    always be afforded to send twice.
128 
129    It must not be greater than 64K to work on VMS.
130 */
131 #ifndef MAX_INITIAL_POST_SIZE
132 #define MAX_INITIAL_POST_SIZE (64*1024)
133 #endif
134 
135 /* EXPECT_100_THRESHOLD is the request body size limit for when libcurl will
136  * automatically add an "Expect: 100-continue" header in HTTP requests. When
137  * the size is unknown, it will always add it.
138  *
139  */
140 #ifndef EXPECT_100_THRESHOLD
141 #define EXPECT_100_THRESHOLD (1024*1024)
142 #endif
143 
144 /* MAX_HTTP_RESP_HEADER_SIZE is the maximum size of all response headers
145    combined that libcurl allows for a single HTTP response, any HTTP
146    version. This count includes CONNECT response headers. */
147 #define MAX_HTTP_RESP_HEADER_SIZE (300*1024)
148 
149 
150 #endif /* CURL_DISABLE_HTTP */
151 
152 /****************************************************************************
153  * HTTP unique setup
154  ***************************************************************************/
155 
156 CURLcode Curl_http_write_resp_hds(struct Curl_easy *data,
157                                   const char *buf, size_t blen,
158                                   size_t *pconsumed);
159 
160 /**
161  * Curl_http_output_auth() setups the authentication headers for the
162  * host/proxy and the correct authentication
163  * method. data->state.authdone is set to TRUE when authentication is
164  * done.
165  *
166  * @param data all information about the current transfer
167  * @param conn all information about the current connection
168  * @param request pointer to the request keyword
169  * @param httpreq is the request type
170  * @param path pointer to the requested path
171  * @param proxytunnel boolean if this is the request setting up a "proxy
172  * tunnel"
173  *
174  * @returns CURLcode
175  */
176 CURLcode
177 Curl_http_output_auth(struct Curl_easy *data,
178                       struct connectdata *conn,
179                       const char *request,
180                       Curl_HttpReq httpreq,
181                       const char *path,
182                       bool proxytunnel); /* TRUE if this is the request setting
183                                             up the proxy tunnel */
184 
185 /* Decode HTTP status code string. */
186 CURLcode Curl_http_decode_status(int *pstatus, const char *s, size_t len);
187 
188 
189 /**
190  * All about a core HTTP request, excluding body and trailers
191  */
192 struct httpreq {
193   char method[24];
194   char *scheme;
195   char *authority;
196   char *path;
197   struct dynhds headers;
198   struct dynhds trailers;
199 };
200 
201 /**
202  * Create an HTTP request struct.
203  */
204 CURLcode Curl_http_req_make(struct httpreq **preq,
205                             const char *method, size_t m_len,
206                             const char *scheme, size_t s_len,
207                             const char *authority, size_t a_len,
208                             const char *path, size_t p_len);
209 
210 CURLcode Curl_http_req_make2(struct httpreq **preq,
211                              const char *method, size_t m_len,
212                              CURLU *url, const char *scheme_default);
213 
214 void Curl_http_req_free(struct httpreq *req);
215 
216 #define HTTP_PSEUDO_METHOD ":method"
217 #define HTTP_PSEUDO_SCHEME ":scheme"
218 #define HTTP_PSEUDO_AUTHORITY ":authority"
219 #define HTTP_PSEUDO_PATH ":path"
220 #define HTTP_PSEUDO_STATUS ":status"
221 
222 /**
223  * Create the list of HTTP/2 headers which represent the request,
224  * using HTTP/2 pseudo headers preceding the `req->headers`.
225  *
226  * Applies the following transformations:
227  * - if `authority` is set, any "Host" header is removed.
228  * - if `authority` is unset and a "Host" header is present, use
229  *   that as `authority` and remove "Host"
230  * - removes and Connection header fields as defined in rfc9113 ch. 8.2.2
231  * - lower-cases the header field names
232  *
233  * @param h2_headers will contain the HTTP/2 headers on success
234  * @param req        the request to transform
235  * @param data       the handle to lookup defaults like ' :scheme' from
236  */
237 CURLcode Curl_http_req_to_h2(struct dynhds *h2_headers,
238                              struct httpreq *req, struct Curl_easy *data);
239 
240 /**
241  * All about a core HTTP response, excluding body and trailers
242  */
243 struct http_resp {
244   int status;
245   char *description;
246   struct dynhds headers;
247   struct dynhds trailers;
248   struct http_resp *prev;
249 };
250 
251 /**
252  * Create an HTTP response struct.
253  */
254 CURLcode Curl_http_resp_make(struct http_resp **presp,
255                              int status,
256                              const char *description);
257 
258 void Curl_http_resp_free(struct http_resp *resp);
259 
260 #endif /* HEADER_CURL_HTTP_H */
261