urldata.h 75 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954
  1. #ifndef HEADER_CURL_URLDATA_H
  2. #define HEADER_CURL_URLDATA_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. /* This file is for lib internal stuff */
  27. #include "curl_setup.h"
  28. #define PORT_FTP 21
  29. #define PORT_FTPS 990
  30. #define PORT_TELNET 23
  31. #define PORT_HTTP 80
  32. #define PORT_HTTPS 443
  33. #define PORT_DICT 2628
  34. #define PORT_LDAP 389
  35. #define PORT_LDAPS 636
  36. #define PORT_TFTP 69
  37. #define PORT_SSH 22
  38. #define PORT_IMAP 143
  39. #define PORT_IMAPS 993
  40. #define PORT_POP3 110
  41. #define PORT_POP3S 995
  42. #define PORT_SMB 445
  43. #define PORT_SMBS 445
  44. #define PORT_SMTP 25
  45. #define PORT_SMTPS 465 /* sometimes called SSMTP */
  46. #define PORT_RTSP 554
  47. #define PORT_RTMP 1935
  48. #define PORT_RTMPT PORT_HTTP
  49. #define PORT_RTMPS PORT_HTTPS
  50. #define PORT_GOPHER 70
  51. #define PORT_MQTT 1883
  52. struct curl_trc_featt;
  53. #ifdef USE_ECH
  54. /* CURLECH_ bits for the tls_ech option */
  55. # define CURLECH_DISABLE (1<<0)
  56. # define CURLECH_GREASE (1<<1)
  57. # define CURLECH_ENABLE (1<<2)
  58. # define CURLECH_HARD (1<<3)
  59. # define CURLECH_CLA_CFG (1<<4)
  60. #endif
  61. #ifndef CURL_DISABLE_WEBSOCKETS
  62. /* CURLPROTO_GOPHERS (29) is the highest publicly used protocol bit number,
  63. * the rest are internal information. If we use higher bits we only do this on
  64. * platforms that have a >= 64-bit type and then we use such a type for the
  65. * protocol fields in the protocol handler.
  66. */
  67. #define CURLPROTO_WS (1<<30)
  68. #define CURLPROTO_WSS ((curl_prot_t)1<<31)
  69. #else
  70. #define CURLPROTO_WS 0
  71. #define CURLPROTO_WSS 0
  72. #endif
  73. /* the default protocols accepting a redirect to */
  74. #define CURLPROTO_REDIR (CURLPROTO_HTTP | CURLPROTO_HTTPS | CURLPROTO_FTP | \
  75. CURLPROTO_FTPS)
  76. /* This should be undefined once we need bit 32 or higher */
  77. #define PROTO_TYPE_SMALL
  78. #ifndef PROTO_TYPE_SMALL
  79. typedef curl_off_t curl_prot_t;
  80. #else
  81. typedef unsigned int curl_prot_t;
  82. #endif
  83. /* This mask is for all the old protocols that are provided and defined in the
  84. public header and shall exclude protocols added since which are not exposed
  85. in the API */
  86. #define CURLPROTO_MASK (0x3ffffff)
  87. #define DICT_MATCH "/MATCH:"
  88. #define DICT_MATCH2 "/M:"
  89. #define DICT_MATCH3 "/FIND:"
  90. #define DICT_DEFINE "/DEFINE:"
  91. #define DICT_DEFINE2 "/D:"
  92. #define DICT_DEFINE3 "/LOOKUP:"
  93. #define CURL_DEFAULT_USER "anonymous"
  94. #define CURL_DEFAULT_PASSWORD "ftp@example.com"
  95. #if !defined(_WIN32) && !defined(MSDOS) && !defined(__EMX__)
  96. /* do FTP line-end CRLF => LF conversions on platforms that prefer LF-only. It
  97. also means: keep CRLF line endings on the CRLF platforms */
  98. #define CURL_PREFER_LF_LINEENDS
  99. #endif
  100. /* Convenience defines for checking protocols or their SSL based version. Each
  101. protocol handler should only ever have a single CURLPROTO_ in its protocol
  102. field. */
  103. #define PROTO_FAMILY_HTTP (CURLPROTO_HTTP|CURLPROTO_HTTPS|CURLPROTO_WS| \
  104. CURLPROTO_WSS)
  105. #define PROTO_FAMILY_FTP (CURLPROTO_FTP|CURLPROTO_FTPS)
  106. #define PROTO_FAMILY_POP3 (CURLPROTO_POP3|CURLPROTO_POP3S)
  107. #define PROTO_FAMILY_SMB (CURLPROTO_SMB|CURLPROTO_SMBS)
  108. #define PROTO_FAMILY_SMTP (CURLPROTO_SMTP|CURLPROTO_SMTPS)
  109. #define PROTO_FAMILY_SSH (CURLPROTO_SCP|CURLPROTO_SFTP)
  110. #if !defined(CURL_DISABLE_FTP) || defined(USE_SSH) || \
  111. !defined(CURL_DISABLE_POP3) || !defined(CURL_DISABLE_FILE)
  112. /* these protocols support CURLOPT_DIRLISTONLY */
  113. #define CURL_LIST_ONLY_PROTOCOL 1
  114. #endif
  115. #define DEFAULT_CONNCACHE_SIZE 5
  116. /* length of longest IPv6 address string including the trailing null */
  117. #define MAX_IPADR_LEN sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255")
  118. /* Default FTP/IMAP etc response timeout in milliseconds */
  119. #define RESP_TIMEOUT (120*1000)
  120. /* Max string input length is a precaution against abuse and to detect junk
  121. input easier and better. */
  122. #define CURL_MAX_INPUT_LENGTH 8000000
  123. #include "cookie.h"
  124. #include "psl.h"
  125. #include "formdata.h"
  126. #ifdef HAVE_NETINET_IN_H
  127. #include <netinet/in.h>
  128. #endif
  129. #ifdef HAVE_NETINET_IN6_H
  130. #include <netinet/in6.h>
  131. #endif
  132. #include "timeval.h"
  133. #include <curl/curl.h>
  134. #include "http_chunks.h" /* for the structs and enum stuff */
  135. #include "hostip.h"
  136. #include "hash.h"
  137. #include "splay.h"
  138. #include "dynbuf.h"
  139. #include "dynhds.h"
  140. #include "request.h"
  141. /* return the count of bytes sent, or -1 on error */
  142. typedef ssize_t (Curl_send)(struct Curl_easy *data, /* transfer */
  143. int sockindex, /* socketindex */
  144. const void *buf, /* data to write */
  145. size_t len, /* max amount to write */
  146. bool eos, /* last chunk */
  147. CURLcode *err); /* error to return */
  148. /* return the count of bytes read, or -1 on error */
  149. typedef ssize_t (Curl_recv)(struct Curl_easy *data, /* transfer */
  150. int sockindex, /* socketindex */
  151. char *buf, /* store data here */
  152. size_t len, /* max amount to read */
  153. CURLcode *err); /* error to return */
  154. #ifdef USE_HYPER
  155. typedef CURLcode (*Curl_datastream)(struct Curl_easy *data,
  156. struct connectdata *conn,
  157. int *didwhat,
  158. int select_res);
  159. #endif
  160. #include "mime.h"
  161. #include "imap.h"
  162. #include "pop3.h"
  163. #include "smtp.h"
  164. #include "ftp.h"
  165. #include "file.h"
  166. #include "vssh/ssh.h"
  167. #include "http.h"
  168. #include "rtsp.h"
  169. #include "smb.h"
  170. #include "mqtt.h"
  171. #include "ftplistparser.h"
  172. #include "multihandle.h"
  173. #include "c-hyper.h"
  174. #include "cf-socket.h"
  175. #ifdef HAVE_GSSAPI
  176. # ifdef HAVE_GSSGNU
  177. # include <gss.h>
  178. # elif defined HAVE_GSSAPI_GSSAPI_H
  179. # include <gssapi/gssapi.h>
  180. # else
  181. # include <gssapi.h>
  182. # endif
  183. # ifdef HAVE_GSSAPI_GSSAPI_GENERIC_H
  184. # include <gssapi/gssapi_generic.h>
  185. # endif
  186. #endif
  187. #ifdef USE_LIBSSH2
  188. #include <libssh2.h>
  189. #include <libssh2_sftp.h>
  190. #endif /* USE_LIBSSH2 */
  191. #define READBUFFER_SIZE CURL_MAX_WRITE_SIZE
  192. #define READBUFFER_MAX CURL_MAX_READ_SIZE
  193. #define READBUFFER_MIN 1024
  194. /* The default upload buffer size, should not be smaller than
  195. CURL_MAX_WRITE_SIZE, as it needs to hold a full buffer as could be sent in
  196. a write callback.
  197. The size was 16KB for many years but was bumped to 64KB because it makes
  198. libcurl able to do significantly faster uploads in some circumstances. Even
  199. larger buffers can help further, but this is deemed a fair memory/speed
  200. compromise. */
  201. #define UPLOADBUFFER_DEFAULT 65536
  202. #define UPLOADBUFFER_MAX (2*1024*1024)
  203. #define UPLOADBUFFER_MIN CURL_MAX_WRITE_SIZE
  204. #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
  205. #ifdef DEBUGBUILD
  206. /* On a debug build, we want to fail hard on easy handles that
  207. * are not NULL, but no longer have the MAGIC touch. This gives
  208. * us early warning on things only discovered by valgrind otherwise. */
  209. #define GOOD_EASY_HANDLE(x) \
  210. (((x) && ((x)->magic == CURLEASY_MAGIC_NUMBER))? TRUE: \
  211. (DEBUGASSERT(!(x)), FALSE))
  212. #else
  213. #define GOOD_EASY_HANDLE(x) \
  214. ((x) && ((x)->magic == CURLEASY_MAGIC_NUMBER))
  215. #endif
  216. #ifdef HAVE_GSSAPI
  217. /* Types needed for krb5-ftp connections */
  218. struct krb5buffer {
  219. struct dynbuf buf;
  220. size_t index;
  221. BIT(eof_flag);
  222. };
  223. enum protection_level {
  224. PROT_NONE, /* first in list */
  225. PROT_CLEAR,
  226. PROT_SAFE,
  227. PROT_CONFIDENTIAL,
  228. PROT_PRIVATE,
  229. PROT_CMD,
  230. PROT_LAST /* last in list */
  231. };
  232. #endif
  233. /* SSL backend-specific data; declared differently by each SSL backend */
  234. struct ssl_backend_data;
  235. typedef enum {
  236. CURL_SSL_PEER_DNS,
  237. CURL_SSL_PEER_IPV4,
  238. CURL_SSL_PEER_IPV6
  239. } ssl_peer_type;
  240. struct ssl_peer {
  241. char *hostname; /* hostname for verification */
  242. char *dispname; /* display version of hostname */
  243. char *sni; /* SNI version of hostname or NULL if not usable */
  244. ssl_peer_type type; /* type of the peer information */
  245. int port; /* port we are talking to */
  246. int transport; /* one of TRNSPRT_* defines */
  247. };
  248. struct ssl_primary_config {
  249. char *CApath; /* certificate dir (does not work on Windows) */
  250. char *CAfile; /* certificate to verify peer against */
  251. char *issuercert; /* optional issuer certificate filename */
  252. char *clientcert;
  253. char *cipher_list; /* list of ciphers to use */
  254. char *cipher_list13; /* list of TLS 1.3 cipher suites to use */
  255. char *pinned_key;
  256. char *CRLfile; /* CRL to check certificate revocation */
  257. struct curl_blob *cert_blob;
  258. struct curl_blob *ca_info_blob;
  259. struct curl_blob *issuercert_blob;
  260. #ifdef USE_TLS_SRP
  261. char *username; /* TLS username (for, e.g., SRP) */
  262. char *password; /* TLS password (for, e.g., SRP) */
  263. #endif
  264. char *curves; /* list of curves to use */
  265. unsigned char ssl_options; /* the CURLOPT_SSL_OPTIONS bitmask */
  266. unsigned int version_max; /* max supported version the client wants to use */
  267. unsigned char version; /* what version the client wants to use */
  268. BIT(verifypeer); /* set TRUE if this is desired */
  269. BIT(verifyhost); /* set TRUE if CN/SAN must match hostname */
  270. BIT(verifystatus); /* set TRUE if certificate status must be checked */
  271. BIT(cache_session); /* cache session or not */
  272. };
  273. struct ssl_config_data {
  274. struct ssl_primary_config primary;
  275. long certverifyresult; /* result from the certificate verification */
  276. curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
  277. void *fsslctxp; /* parameter for call back */
  278. char *cert_type; /* format for certificate (default: PEM)*/
  279. char *key; /* private key filename */
  280. struct curl_blob *key_blob;
  281. char *key_type; /* format for private key (default: PEM) */
  282. char *key_passwd; /* plain text private key password */
  283. BIT(certinfo); /* gather lots of certificate info */
  284. BIT(falsestart);
  285. BIT(enable_beast); /* allow this flaw for interoperability's sake */
  286. BIT(no_revoke); /* disable SSL certificate revocation checks */
  287. BIT(no_partialchain); /* do not accept partial certificate chains */
  288. BIT(revoke_best_effort); /* ignore SSL revocation offline/missing revocation
  289. list errors */
  290. BIT(native_ca_store); /* use the native ca store of operating system */
  291. BIT(auto_client_cert); /* automatically locate and use a client
  292. certificate for authentication (Schannel) */
  293. };
  294. struct ssl_general_config {
  295. size_t max_ssl_sessions; /* SSL session id cache size */
  296. int ca_cache_timeout; /* Certificate store cache timeout (seconds) */
  297. };
  298. typedef void Curl_ssl_sessionid_dtor(void *sessionid, size_t idsize);
  299. /* information stored about one single SSL session */
  300. struct Curl_ssl_session {
  301. char *name; /* hostname for which this ID was used */
  302. char *conn_to_host; /* hostname for the connection (may be NULL) */
  303. const char *scheme; /* protocol scheme used */
  304. void *sessionid; /* as returned from the SSL layer */
  305. size_t idsize; /* if known, otherwise 0 */
  306. Curl_ssl_sessionid_dtor *sessionid_free; /* free `sessionid` callback */
  307. long age; /* just a number, the higher the more recent */
  308. int remote_port; /* remote port */
  309. int conn_to_port; /* remote port for the connection (may be -1) */
  310. int transport; /* TCP or QUIC */
  311. struct ssl_primary_config ssl_config; /* setup for this session */
  312. };
  313. #ifdef USE_WINDOWS_SSPI
  314. #include "curl_sspi.h"
  315. #endif
  316. #ifndef CURL_DISABLE_DIGEST_AUTH
  317. /* Struct used for Digest challenge-response authentication */
  318. struct digestdata {
  319. #if defined(USE_WINDOWS_SSPI)
  320. BYTE *input_token;
  321. size_t input_token_len;
  322. CtxtHandle *http_context;
  323. /* copy of user/passwd used to make the identity for http_context.
  324. either may be NULL. */
  325. char *user;
  326. char *passwd;
  327. #else
  328. char *nonce;
  329. char *cnonce;
  330. char *realm;
  331. char *opaque;
  332. char *qop;
  333. char *algorithm;
  334. int nc; /* nonce count */
  335. unsigned char algo;
  336. BIT(stale); /* set true for re-negotiation */
  337. BIT(userhash);
  338. #endif
  339. };
  340. #endif
  341. typedef enum {
  342. NTLMSTATE_NONE,
  343. NTLMSTATE_TYPE1,
  344. NTLMSTATE_TYPE2,
  345. NTLMSTATE_TYPE3,
  346. NTLMSTATE_LAST
  347. } curlntlm;
  348. typedef enum {
  349. GSS_AUTHNONE,
  350. GSS_AUTHRECV,
  351. GSS_AUTHSENT,
  352. GSS_AUTHDONE,
  353. GSS_AUTHSUCC
  354. } curlnegotiate;
  355. /* Struct used for GSSAPI (Kerberos V5) authentication */
  356. #if defined(USE_KERBEROS5)
  357. struct kerberos5data {
  358. #if defined(USE_WINDOWS_SSPI)
  359. CredHandle *credentials;
  360. CtxtHandle *context;
  361. TCHAR *spn;
  362. SEC_WINNT_AUTH_IDENTITY identity;
  363. SEC_WINNT_AUTH_IDENTITY *p_identity;
  364. size_t token_max;
  365. BYTE *output_token;
  366. #else
  367. gss_ctx_id_t context;
  368. gss_name_t spn;
  369. #endif
  370. };
  371. #endif
  372. /* Struct used for SCRAM-SHA-1 authentication */
  373. #ifdef USE_GSASL
  374. #include <gsasl.h>
  375. struct gsasldata {
  376. Gsasl *ctx;
  377. Gsasl_session *client;
  378. };
  379. #endif
  380. /* Struct used for NTLM challenge-response authentication */
  381. #if defined(USE_NTLM)
  382. struct ntlmdata {
  383. #ifdef USE_WINDOWS_SSPI
  384. /* The sslContext is used for the Schannel bindings. The
  385. * api is available on the Windows 7 SDK and later.
  386. */
  387. #ifdef SECPKG_ATTR_ENDPOINT_BINDINGS
  388. CtxtHandle *sslContext;
  389. #endif
  390. CredHandle *credentials;
  391. CtxtHandle *context;
  392. SEC_WINNT_AUTH_IDENTITY identity;
  393. SEC_WINNT_AUTH_IDENTITY *p_identity;
  394. size_t token_max;
  395. BYTE *output_token;
  396. BYTE *input_token;
  397. size_t input_token_len;
  398. TCHAR *spn;
  399. #else
  400. unsigned int flags;
  401. unsigned char nonce[8];
  402. unsigned int target_info_len;
  403. void *target_info; /* TargetInfo received in the NTLM type-2 message */
  404. #endif
  405. };
  406. #endif
  407. /* Struct used for Negotiate (SPNEGO) authentication */
  408. #ifdef USE_SPNEGO
  409. struct negotiatedata {
  410. #ifdef HAVE_GSSAPI
  411. OM_uint32 status;
  412. gss_ctx_id_t context;
  413. gss_name_t spn;
  414. gss_buffer_desc output_token;
  415. struct dynbuf channel_binding_data;
  416. #else
  417. #ifdef USE_WINDOWS_SSPI
  418. #ifdef SECPKG_ATTR_ENDPOINT_BINDINGS
  419. CtxtHandle *sslContext;
  420. #endif
  421. DWORD status;
  422. CredHandle *credentials;
  423. CtxtHandle *context;
  424. SEC_WINNT_AUTH_IDENTITY identity;
  425. SEC_WINNT_AUTH_IDENTITY *p_identity;
  426. TCHAR *spn;
  427. size_t token_max;
  428. BYTE *output_token;
  429. size_t output_token_length;
  430. #endif
  431. #endif
  432. BIT(noauthpersist);
  433. BIT(havenoauthpersist);
  434. BIT(havenegdata);
  435. BIT(havemultiplerequests);
  436. };
  437. #endif
  438. #ifdef CURL_DISABLE_PROXY
  439. #define CONN_IS_PROXIED(x) 0
  440. #else
  441. #define CONN_IS_PROXIED(x) x->bits.proxy
  442. #endif
  443. /*
  444. * Boolean values that concerns this connection.
  445. */
  446. struct ConnectBits {
  447. #ifndef CURL_DISABLE_PROXY
  448. BIT(httpproxy); /* if set, this transfer is done through an HTTP proxy */
  449. BIT(socksproxy); /* if set, this transfer is done through a socks proxy */
  450. BIT(proxy_user_passwd); /* user+password for the proxy? */
  451. BIT(tunnel_proxy); /* if CONNECT is used to "tunnel" through the proxy.
  452. This is implicit when SSL-protocols are used through
  453. proxies, but can also be enabled explicitly by
  454. apps */
  455. BIT(proxy); /* if set, this transfer is done through a proxy - any type */
  456. #endif
  457. /* always modify bits.close with the connclose() and connkeep() macros! */
  458. BIT(close); /* if set, we close the connection after this request */
  459. BIT(reuse); /* if set, this is a reused connection */
  460. BIT(altused); /* this is an alt-svc "redirect" */
  461. BIT(conn_to_host); /* if set, this connection has a "connect to host"
  462. that overrides the host in the URL */
  463. BIT(conn_to_port); /* if set, this connection has a "connect to port"
  464. that overrides the port in the URL (remote port) */
  465. BIT(ipv6_ip); /* we communicate with a remote site specified with pure IPv6
  466. IP address */
  467. BIT(ipv6); /* we communicate with a site using an IPv6 address */
  468. BIT(do_more); /* this is set TRUE if the ->curl_do_more() function is
  469. supposed to be called, after ->curl_do() */
  470. BIT(protoconnstart);/* the protocol layer has STARTED its operation after
  471. the TCP layer connect */
  472. BIT(retry); /* this connection is about to get closed and then
  473. re-attempted at another connection. */
  474. #ifndef CURL_DISABLE_FTP
  475. BIT(ftp_use_epsv); /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
  476. EPSV does not work we disable it for the forthcoming
  477. requests */
  478. BIT(ftp_use_eprt); /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
  479. EPRT does not work we disable it for the forthcoming
  480. requests */
  481. BIT(ftp_use_data_ssl); /* Enabled SSL for the data connection */
  482. BIT(ftp_use_control_ssl); /* Enabled SSL for the control connection */
  483. #endif
  484. #ifndef CURL_DISABLE_NETRC
  485. BIT(netrc); /* name+password provided by netrc */
  486. #endif
  487. BIT(bound); /* set true if bind() has already been done on this socket/
  488. connection */
  489. BIT(asks_multiplex); /* connection asks for multiplexing, but is not yet */
  490. BIT(multiplex); /* connection is multiplexed */
  491. BIT(tcp_fastopen); /* use TCP Fast Open */
  492. BIT(tls_enable_alpn); /* TLS ALPN extension? */
  493. #ifndef CURL_DISABLE_DOH
  494. BIT(doh);
  495. #endif
  496. #ifdef USE_UNIX_SOCKETS
  497. BIT(abstract_unix_socket);
  498. #endif
  499. BIT(tls_upgraded);
  500. BIT(sock_accepted); /* TRUE if the SECONDARYSOCKET was created with
  501. accept() */
  502. BIT(parallel_connect); /* set TRUE when a parallel connect attempt has
  503. started (happy eyeballs) */
  504. BIT(aborted); /* connection was aborted, e.g. in unclean state */
  505. BIT(shutdown_handler); /* connection shutdown: handler shut down */
  506. BIT(shutdown_filters); /* connection shutdown: filters shut down */
  507. BIT(in_cpool); /* connection is kept in a connection pool */
  508. };
  509. struct hostname {
  510. char *rawalloc; /* allocated "raw" version of the name */
  511. char *encalloc; /* allocated IDN-encoded version of the name */
  512. char *name; /* name to use internally, might be encoded, might be raw */
  513. const char *dispname; /* name to display, as 'name' might be encoded */
  514. };
  515. /*
  516. * Flags on the keepon member of the Curl_transfer_keeper
  517. */
  518. #define KEEP_NONE 0
  519. #define KEEP_RECV (1<<0) /* there is or may be data to read */
  520. #define KEEP_SEND (1<<1) /* there is or may be data to write */
  521. #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
  522. might still be data to read */
  523. #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
  524. might still be data to write */
  525. #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
  526. #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
  527. /* KEEP_SEND_TIMED is set when the transfer should attempt sending
  528. * at timer (or other) events. A transfer waiting on a timer will
  529. * remove KEEP_SEND to suppress POLLOUTs of the connection.
  530. * Adding KEEP_SEND_TIMED will then attempt to send whenever the transfer
  531. * enters the "readwrite" loop, e.g. when a timer fires.
  532. * This is used in HTTP for 'Expect: 100-continue' waiting. */
  533. #define KEEP_SEND_TIMED (1<<6)
  534. #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
  535. #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
  536. /* transfer wants to send is not PAUSE or HOLD */
  537. #define CURL_WANT_SEND(data) \
  538. (((data)->req.keepon & KEEP_SENDBITS) == KEEP_SEND)
  539. /* transfer receive is not on PAUSE or HOLD */
  540. #define CURL_WANT_RECV(data) \
  541. (((data)->req.keepon & KEEP_RECVBITS) == KEEP_RECV)
  542. #if defined(CURLRES_ASYNCH) || !defined(CURL_DISABLE_DOH)
  543. #define USE_CURL_ASYNC
  544. struct Curl_async {
  545. char *hostname;
  546. struct Curl_dns_entry *dns;
  547. struct thread_data *tdata;
  548. void *resolver; /* resolver state, if it is used in the URL state -
  549. ares_channel e.g. */
  550. int port;
  551. int status; /* if done is TRUE, this is the status from the callback */
  552. BIT(done); /* set TRUE when the lookup is complete */
  553. };
  554. #endif
  555. #define FIRSTSOCKET 0
  556. #define SECONDARYSOCKET 1
  557. /* Polling requested by an easy handle.
  558. * `action` is CURL_POLL_IN, CURL_POLL_OUT or CURL_POLL_INOUT.
  559. */
  560. struct easy_pollset {
  561. curl_socket_t sockets[MAX_SOCKSPEREASYHANDLE];
  562. unsigned int num;
  563. unsigned char actions[MAX_SOCKSPEREASYHANDLE];
  564. };
  565. /*
  566. * Specific protocol handler.
  567. */
  568. struct Curl_handler {
  569. const char *scheme; /* URL scheme name in lowercase */
  570. /* Complement to setup_connection_internals(). This is done before the
  571. transfer "owns" the connection. */
  572. CURLcode (*setup_connection)(struct Curl_easy *data,
  573. struct connectdata *conn);
  574. /* These two functions MUST be set to be protocol dependent */
  575. CURLcode (*do_it)(struct Curl_easy *data, bool *done);
  576. CURLcode (*done)(struct Curl_easy *, CURLcode, bool);
  577. /* If the curl_do() function is better made in two halves, this
  578. * curl_do_more() function will be called afterwards, if set. For example
  579. * for doing the FTP stuff after the PASV/PORT command.
  580. */
  581. CURLcode (*do_more)(struct Curl_easy *, int *);
  582. /* This function *MAY* be set to a protocol-dependent function that is run
  583. * after the connect() and everything is done, as a step in the connection.
  584. * The 'done' pointer points to a bool that should be set to TRUE if the
  585. * function completes before return. If it does not complete, the caller
  586. * should call the ->connecting() function until it is.
  587. */
  588. CURLcode (*connect_it)(struct Curl_easy *data, bool *done);
  589. /* See above. */
  590. CURLcode (*connecting)(struct Curl_easy *data, bool *done);
  591. CURLcode (*doing)(struct Curl_easy *data, bool *done);
  592. /* Called from the multi interface during the PROTOCONNECT phase, and it
  593. should then return a proper fd set */
  594. int (*proto_getsock)(struct Curl_easy *data,
  595. struct connectdata *conn, curl_socket_t *socks);
  596. /* Called from the multi interface during the DOING phase, and it should
  597. then return a proper fd set */
  598. int (*doing_getsock)(struct Curl_easy *data,
  599. struct connectdata *conn, curl_socket_t *socks);
  600. /* Called from the multi interface during the DO_MORE phase, and it should
  601. then return a proper fd set */
  602. int (*domore_getsock)(struct Curl_easy *data,
  603. struct connectdata *conn, curl_socket_t *socks);
  604. /* Called from the multi interface during the DO_DONE, PERFORM and
  605. WAITPERFORM phases, and it should then return a proper fd set. Not setting
  606. this will make libcurl use the generic default one. */
  607. int (*perform_getsock)(struct Curl_easy *data,
  608. struct connectdata *conn, curl_socket_t *socks);
  609. /* This function *MAY* be set to a protocol-dependent function that is run
  610. * by the curl_disconnect(), as a step in the disconnection. If the handler
  611. * is called because the connection has been considered dead,
  612. * dead_connection is set to TRUE. The connection is (again) associated with
  613. * the transfer here.
  614. */
  615. CURLcode (*disconnect)(struct Curl_easy *, struct connectdata *,
  616. bool dead_connection);
  617. /* If used, this function gets called from transfer.c to
  618. allow the protocol to do extra handling in writing response to
  619. the client. */
  620. CURLcode (*write_resp)(struct Curl_easy *data, const char *buf, size_t blen,
  621. bool is_eos);
  622. /* If used, this function gets called from transfer.c to
  623. allow the protocol to do extra handling in writing a single response
  624. header line to the client. */
  625. CURLcode (*write_resp_hd)(struct Curl_easy *data,
  626. const char *hd, size_t hdlen, bool is_eos);
  627. /* This function can perform various checks on the connection. See
  628. CONNCHECK_* for more information about the checks that can be performed,
  629. and CONNRESULT_* for the results that can be returned. */
  630. unsigned int (*connection_check)(struct Curl_easy *data,
  631. struct connectdata *conn,
  632. unsigned int checks_to_perform);
  633. /* attach() attaches this transfer to this connection */
  634. void (*attach)(struct Curl_easy *data, struct connectdata *conn);
  635. int defport; /* Default port. */
  636. curl_prot_t protocol; /* See CURLPROTO_* - this needs to be the single
  637. specific protocol bit */
  638. curl_prot_t family; /* single bit for protocol family; basically the
  639. non-TLS name of the protocol this is */
  640. unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
  641. };
  642. #define PROTOPT_NONE 0 /* nothing extra */
  643. #define PROTOPT_SSL (1<<0) /* uses SSL */
  644. #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
  645. #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
  646. /* some protocols will have to call the underlying functions without regard to
  647. what exact state the socket signals. IE even if the socket says "readable",
  648. the send function might need to be called while uploading, or vice versa.
  649. */
  650. #define PROTOPT_DIRLOCK (1<<3)
  651. #define PROTOPT_NONETWORK (1<<4) /* protocol does not use the network! */
  652. #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
  653. gets a default */
  654. #define PROTOPT_NOURLQUERY (1<<6) /* protocol cannot handle
  655. URL query strings (?foo=bar) ! */
  656. #define PROTOPT_CREDSPERREQUEST (1<<7) /* requires login credentials per
  657. request instead of per connection */
  658. #define PROTOPT_ALPN (1<<8) /* set ALPN for this */
  659. /* (1<<9) was PROTOPT_STREAM, now free */
  660. #define PROTOPT_URLOPTIONS (1<<10) /* allow options part in the userinfo field
  661. of the URL */
  662. #define PROTOPT_PROXY_AS_HTTP (1<<11) /* allow this non-HTTP scheme over a
  663. HTTP proxy as HTTP proxies may know
  664. this protocol and act as a gateway */
  665. #define PROTOPT_WILDCARD (1<<12) /* protocol supports wildcard matching */
  666. #define PROTOPT_USERPWDCTRL (1<<13) /* Allow "control bytes" (< 32 ASCII) in
  667. username and password */
  668. #define PROTOPT_NOTCPPROXY (1<<14) /* this protocol cannot proxy over TCP */
  669. #define CONNCHECK_NONE 0 /* No checks */
  670. #define CONNCHECK_ISDEAD (1<<0) /* Check if the connection is dead. */
  671. #define CONNCHECK_KEEPALIVE (1<<1) /* Perform any keepalive function. */
  672. #define CONNRESULT_NONE 0 /* No extra information. */
  673. #define CONNRESULT_DEAD (1<<0) /* The connection is dead. */
  674. struct ip_quadruple {
  675. char remote_ip[MAX_IPADR_LEN];
  676. char local_ip[MAX_IPADR_LEN];
  677. int remote_port;
  678. int local_port;
  679. };
  680. struct proxy_info {
  681. struct hostname host;
  682. int port;
  683. unsigned char proxytype; /* curl_proxytype: what kind of proxy that is in
  684. use */
  685. char *user; /* proxy username string, allocated */
  686. char *passwd; /* proxy password string, allocated */
  687. };
  688. struct ldapconninfo;
  689. #define TRNSPRT_TCP 3
  690. #define TRNSPRT_UDP 4
  691. #define TRNSPRT_QUIC 5
  692. #define TRNSPRT_UNIX 6
  693. /*
  694. * The connectdata struct contains all fields and variables that should be
  695. * unique for an entire connection.
  696. */
  697. struct connectdata {
  698. struct Curl_llist_node cpool_node; /* conncache lists */
  699. curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
  700. void *closesocket_client;
  701. /* This is used by the connection pool logic. If this returns TRUE, this
  702. handle is still used by one or more easy handles and can only used by any
  703. other easy handle without careful consideration (== only for
  704. multiplexing) and it cannot be used by another multi handle! */
  705. #define CONN_INUSE(c) Curl_llist_count(&(c)->easyq)
  706. /**** Fields set when inited and not modified again */
  707. curl_off_t connection_id; /* Contains a unique number to make it easier to
  708. track the connections in the log output */
  709. char *destination; /* string carrying normalized hostname+port+scope */
  710. size_t destination_len; /* strlen(destination) + 1 */
  711. /* 'dns_entry' is the particular host we use. This points to an entry in the
  712. DNS cache and it will not get pruned while locked. It gets unlocked in
  713. multi_done(). This entry will be NULL if the connection is reused as then
  714. there is no name resolve done. */
  715. struct Curl_dns_entry *dns_entry;
  716. /* 'remote_addr' is the particular IP we connected to. it is owned, set
  717. * and NULLed by the connected socket filter (if there is one). */
  718. const struct Curl_sockaddr_ex *remote_addr;
  719. struct hostname host;
  720. char *hostname_resolve; /* hostname to resolve to address, allocated */
  721. char *secondaryhostname; /* secondary socket hostname (ftp) */
  722. struct hostname conn_to_host; /* the host to connect to. valid only if
  723. bits.conn_to_host is set */
  724. #ifndef CURL_DISABLE_PROXY
  725. struct proxy_info socks_proxy;
  726. struct proxy_info http_proxy;
  727. #endif
  728. /* 'primary' and 'secondary' get filled with IP quadruple
  729. (local/remote numerical ip address and port) whenever a connect is
  730. *attempted*.
  731. When more than one address is tried for a connection these will hold data
  732. for the last attempt. When the connection is actually established
  733. these are updated with data which comes directly from the socket. */
  734. struct ip_quadruple primary;
  735. struct ip_quadruple secondary;
  736. char *user; /* username string, allocated */
  737. char *passwd; /* password string, allocated */
  738. char *options; /* options string, allocated */
  739. char *sasl_authzid; /* authorization identity string, allocated */
  740. char *oauth_bearer; /* OAUTH2 bearer, allocated */
  741. struct curltime now; /* "current" time */
  742. struct curltime created; /* creation time */
  743. struct curltime lastused; /* when returned to the connection poolas idle */
  744. curl_socket_t sock[2]; /* two sockets, the second is used for the data
  745. transfer when doing FTP */
  746. Curl_recv *recv[2];
  747. Curl_send *send[2];
  748. struct Curl_cfilter *cfilter[2]; /* connection filters */
  749. struct {
  750. struct curltime start[2]; /* when filter shutdown started */
  751. unsigned int timeout_ms; /* 0 means no timeout */
  752. } shutdown;
  753. /* Last pollset used in connection shutdown. Used to detect changes
  754. * for multi_socket API. */
  755. struct easy_pollset shutdown_poll;
  756. struct ssl_primary_config ssl_config;
  757. #ifndef CURL_DISABLE_PROXY
  758. struct ssl_primary_config proxy_ssl_config;
  759. #endif
  760. struct ConnectBits bits; /* various state-flags for this connection */
  761. const struct Curl_handler *handler; /* Connection's protocol handler */
  762. const struct Curl_handler *given; /* The protocol first given */
  763. /* Protocols can use a custom keepalive mechanism to keep connections alive.
  764. This allows those protocols to track the last time the keepalive mechanism
  765. was used on this connection. */
  766. struct curltime keepalive;
  767. /**** curl_get() phase fields */
  768. curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
  769. curl_socket_t writesockfd; /* socket to write to, it may very
  770. well be the same we read from.
  771. CURL_SOCKET_BAD disables */
  772. #ifdef HAVE_GSSAPI
  773. BIT(sec_complete); /* if Kerberos is enabled for this connection */
  774. unsigned char command_prot; /* enum protection_level */
  775. unsigned char data_prot; /* enum protection_level */
  776. unsigned char request_data_prot; /* enum protection_level */
  777. size_t buffer_size;
  778. struct krb5buffer in_buffer;
  779. void *app_data;
  780. const struct Curl_sec_client_mech *mech;
  781. struct sockaddr_in local_addr;
  782. #endif
  783. #if defined(USE_KERBEROS5) /* Consider moving some of the above GSS-API */
  784. struct kerberos5data krb5; /* variables into the structure definition, */
  785. #endif /* however, some of them are ftp specific. */
  786. struct Curl_llist easyq; /* List of easy handles using this connection */
  787. /*************** Request - specific items ************/
  788. #if defined(USE_WINDOWS_SSPI) && defined(SECPKG_ATTR_ENDPOINT_BINDINGS)
  789. CtxtHandle *sslContext;
  790. #endif
  791. #ifdef USE_GSASL
  792. struct gsasldata gsasl;
  793. #endif
  794. #if defined(USE_NTLM)
  795. curlntlm http_ntlm_state;
  796. curlntlm proxy_ntlm_state;
  797. struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
  798. because it authenticates connections, not
  799. single requests! */
  800. struct ntlmdata proxyntlm; /* NTLM data for proxy */
  801. #endif
  802. #ifdef USE_SPNEGO
  803. curlnegotiate http_negotiate_state;
  804. curlnegotiate proxy_negotiate_state;
  805. struct negotiatedata negotiate; /* state data for host Negotiate auth */
  806. struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
  807. #endif
  808. union {
  809. #ifndef CURL_DISABLE_FTP
  810. struct ftp_conn ftpc;
  811. #endif
  812. #ifdef USE_SSH
  813. struct ssh_conn sshc;
  814. #endif
  815. #ifndef CURL_DISABLE_TFTP
  816. struct tftp_state_data *tftpc;
  817. #endif
  818. #ifndef CURL_DISABLE_IMAP
  819. struct imap_conn imapc;
  820. #endif
  821. #ifndef CURL_DISABLE_POP3
  822. struct pop3_conn pop3c;
  823. #endif
  824. #ifndef CURL_DISABLE_SMTP
  825. struct smtp_conn smtpc;
  826. #endif
  827. #ifndef CURL_DISABLE_RTSP
  828. struct rtsp_conn rtspc;
  829. #endif
  830. #ifndef CURL_DISABLE_SMB
  831. struct smb_conn smbc;
  832. #endif
  833. #ifdef USE_LIBRTMP
  834. void *rtmp;
  835. #endif
  836. #ifdef USE_OPENLDAP
  837. struct ldapconninfo *ldapc;
  838. #endif
  839. #ifndef CURL_DISABLE_MQTT
  840. struct mqtt_conn mqtt;
  841. #endif
  842. #ifndef CURL_DISABLE_WEBSOCKETS
  843. struct websocket *ws;
  844. #endif
  845. unsigned int unused:1; /* avoids empty union */
  846. } proto;
  847. #ifdef USE_UNIX_SOCKETS
  848. char *unix_domain_socket;
  849. #endif
  850. #ifdef USE_HYPER
  851. /* if set, an alternative data transfer function */
  852. Curl_datastream datastream;
  853. #endif
  854. /* When this connection is created, store the conditions for the local end
  855. bind. This is stored before the actual bind and before any connection is
  856. made and will serve the purpose of being used for comparison reasons so
  857. that subsequent bound-requested connections are not accidentally reusing
  858. wrong connections. */
  859. char *localdev;
  860. unsigned short localportrange;
  861. int waitfor; /* current READ/WRITE bits to wait for */
  862. #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
  863. int socks5_gssapi_enctype;
  864. #endif
  865. /* The field below gets set in connect.c:connecthost() */
  866. int remote_port; /* the remote port, not the proxy port! */
  867. int conn_to_port; /* the remote port to connect to. valid only if
  868. bits.conn_to_port is set */
  869. #ifdef USE_IPV6
  870. unsigned int scope_id; /* Scope id for IPv6 */
  871. #endif
  872. unsigned short localport;
  873. unsigned short secondary_port; /* secondary socket remote port to connect to
  874. (ftp) */
  875. unsigned char alpn; /* APLN TLS negotiated protocol, a CURL_HTTP_VERSION*
  876. value */
  877. #ifndef CURL_DISABLE_PROXY
  878. unsigned char proxy_alpn; /* APLN of proxy tunnel, CURL_HTTP_VERSION* */
  879. #endif
  880. unsigned char transport; /* one of the TRNSPRT_* defines */
  881. unsigned char ip_version; /* copied from the Curl_easy at creation time */
  882. unsigned char httpversion; /* the HTTP version*10 reported by the server */
  883. unsigned char connect_only;
  884. unsigned char gssapi_delegation; /* inherited from set.gssapi_delegation */
  885. };
  886. #ifndef CURL_DISABLE_PROXY
  887. #define CURL_CONN_HOST_DISPNAME(c) \
  888. ((c)->bits.socksproxy ? (c)->socks_proxy.host.dispname : \
  889. (c)->bits.httpproxy ? (c)->http_proxy.host.dispname : \
  890. (c)->bits.conn_to_host ? (c)->conn_to_host.dispname : \
  891. (c)->host.dispname)
  892. #else
  893. #define CURL_CONN_HOST_DISPNAME(c) \
  894. (c)->bits.conn_to_host ? (c)->conn_to_host.dispname : \
  895. (c)->host.dispname
  896. #endif
  897. /* The end of connectdata. */
  898. /*
  899. * Struct to keep statistical and informational data.
  900. * All variables in this struct must be initialized/reset in Curl_initinfo().
  901. */
  902. struct PureInfo {
  903. int httpcode; /* Recent HTTP, FTP, RTSP or SMTP response code */
  904. int httpproxycode; /* response code from proxy when received separate */
  905. int httpversion; /* the http version number X.Y = X*10+Y */
  906. time_t filetime; /* If requested, this is might get set. Set to -1 if the
  907. time was unretrievable. */
  908. curl_off_t request_size; /* the amount of bytes sent in the request(s) */
  909. unsigned long proxyauthavail; /* what proxy auth types were announced */
  910. unsigned long httpauthavail; /* what host auth types were announced */
  911. long numconnects; /* how many new connection did libcurl created */
  912. char *contenttype; /* the content type of the object */
  913. char *wouldredirect; /* URL this would have been redirected to if asked to */
  914. curl_off_t retry_after; /* info from Retry-After: header */
  915. unsigned int header_size; /* size of read header(s) in bytes */
  916. /* PureInfo primary ip_quadruple is copied over from the connectdata
  917. struct in order to allow curl_easy_getinfo() to return this information
  918. even when the session handle is no longer associated with a connection,
  919. and also allow curl_easy_reset() to clear this information from the
  920. session handle without disturbing information which is still alive, and
  921. that might be reused, in the connection pool. */
  922. struct ip_quadruple primary;
  923. int conn_remote_port; /* this is the "remote port", which is the port
  924. number of the used URL, independent of proxy or
  925. not */
  926. const char *conn_scheme;
  927. unsigned int conn_protocol;
  928. struct curl_certinfo certs; /* info about the certs. Asked for with
  929. CURLOPT_CERTINFO / CURLINFO_CERTINFO */
  930. CURLproxycode pxcode;
  931. BIT(timecond); /* set to TRUE if the time condition did not match, which
  932. thus made the document NOT get fetched */
  933. BIT(used_proxy); /* the transfer used a proxy */
  934. };
  935. struct pgrs_measure {
  936. struct curltime start; /* when measure started */
  937. curl_off_t start_size; /* the 'cur_size' the measure started at */
  938. };
  939. struct pgrs_dir {
  940. curl_off_t total_size; /* total expected bytes */
  941. curl_off_t cur_size; /* transferred bytes so far */
  942. curl_off_t speed; /* bytes per second transferred */
  943. struct pgrs_measure limit;
  944. };
  945. struct Progress {
  946. time_t lastshow; /* time() of the last displayed progress meter or NULL to
  947. force redraw at next call */
  948. struct pgrs_dir ul;
  949. struct pgrs_dir dl;
  950. curl_off_t current_speed; /* uses the currently fastest transfer */
  951. int width; /* screen width at download start */
  952. int flags; /* see progress.h */
  953. timediff_t timespent;
  954. timediff_t t_postqueue;
  955. timediff_t t_nslookup;
  956. timediff_t t_connect;
  957. timediff_t t_appconnect;
  958. timediff_t t_pretransfer;
  959. timediff_t t_posttransfer;
  960. timediff_t t_starttransfer;
  961. timediff_t t_redirect;
  962. struct curltime start;
  963. struct curltime t_startsingle;
  964. struct curltime t_startop;
  965. struct curltime t_acceptdata;
  966. #define CURR_TIME (5 + 1) /* 6 entries for 5 seconds */
  967. curl_off_t speeder[ CURR_TIME ];
  968. struct curltime speeder_time[ CURR_TIME ];
  969. int speeder_c;
  970. BIT(callback); /* set when progress callback is used */
  971. BIT(is_t_startransfer_set);
  972. };
  973. typedef enum {
  974. RTSPREQ_NONE, /* first in list */
  975. RTSPREQ_OPTIONS,
  976. RTSPREQ_DESCRIBE,
  977. RTSPREQ_ANNOUNCE,
  978. RTSPREQ_SETUP,
  979. RTSPREQ_PLAY,
  980. RTSPREQ_PAUSE,
  981. RTSPREQ_TEARDOWN,
  982. RTSPREQ_GET_PARAMETER,
  983. RTSPREQ_SET_PARAMETER,
  984. RTSPREQ_RECORD,
  985. RTSPREQ_RECEIVE,
  986. RTSPREQ_LAST /* last in list */
  987. } Curl_RtspReq;
  988. struct auth {
  989. unsigned long want; /* Bitmask set to the authentication methods wanted by
  990. app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
  991. unsigned long picked;
  992. unsigned long avail; /* Bitmask for what the server reports to support for
  993. this resource */
  994. BIT(done); /* TRUE when the auth phase is done and ready to do the
  995. actual request */
  996. BIT(multipass); /* TRUE if this is not yet authenticated but within the
  997. auth multipass negotiation */
  998. BIT(iestyle); /* TRUE if digest should be done IE-style or FALSE if it
  999. should be RFC compliant */
  1000. };
  1001. #ifdef USE_NGHTTP2
  1002. struct Curl_data_prio_node {
  1003. struct Curl_data_prio_node *next;
  1004. struct Curl_easy *data;
  1005. };
  1006. #endif
  1007. /**
  1008. * Priority information for an easy handle in relation to others
  1009. * on the same connection.
  1010. * TODO: we need to adapt it to the new priority scheme as defined in RFC 9218
  1011. */
  1012. struct Curl_data_priority {
  1013. #ifdef USE_NGHTTP2
  1014. /* tree like dependencies only implemented in nghttp2 */
  1015. struct Curl_easy *parent;
  1016. struct Curl_data_prio_node *children;
  1017. #endif
  1018. int weight;
  1019. #ifdef USE_NGHTTP2
  1020. BIT(exclusive);
  1021. #endif
  1022. };
  1023. /* Timers */
  1024. typedef enum {
  1025. EXPIRE_100_TIMEOUT,
  1026. EXPIRE_ASYNC_NAME,
  1027. EXPIRE_CONNECTTIMEOUT,
  1028. EXPIRE_DNS_PER_NAME, /* family1 */
  1029. EXPIRE_DNS_PER_NAME2, /* family2 */
  1030. EXPIRE_HAPPY_EYEBALLS_DNS, /* See asyn-ares.c */
  1031. EXPIRE_HAPPY_EYEBALLS,
  1032. EXPIRE_MULTI_PENDING,
  1033. EXPIRE_RUN_NOW,
  1034. EXPIRE_SPEEDCHECK,
  1035. EXPIRE_TIMEOUT,
  1036. EXPIRE_TOOFAST,
  1037. EXPIRE_QUIC,
  1038. EXPIRE_FTP_ACCEPT,
  1039. EXPIRE_ALPN_EYEBALLS,
  1040. EXPIRE_LAST /* not an actual timer, used as a marker only */
  1041. } expire_id;
  1042. typedef enum {
  1043. TRAILERS_NONE,
  1044. TRAILERS_INITIALIZED,
  1045. TRAILERS_SENDING,
  1046. TRAILERS_DONE
  1047. } trailers_state;
  1048. /*
  1049. * One instance for each timeout an easy handle can set.
  1050. */
  1051. struct time_node {
  1052. struct Curl_llist_node list;
  1053. struct curltime time;
  1054. expire_id eid;
  1055. };
  1056. /* individual pieces of the URL */
  1057. struct urlpieces {
  1058. char *scheme;
  1059. char *hostname;
  1060. char *port;
  1061. char *user;
  1062. char *password;
  1063. char *options;
  1064. char *path;
  1065. char *query;
  1066. };
  1067. struct UrlState {
  1068. /* buffers to store authentication data in, as parsed from input options */
  1069. struct curltime keeps_speed; /* for the progress meter really */
  1070. curl_off_t lastconnect_id; /* The last connection, -1 if undefined */
  1071. curl_off_t recent_conn_id; /* The most recent connection used, might no
  1072. * longer exist */
  1073. struct dynbuf headerb; /* buffer to store headers in */
  1074. struct curl_slist *hstslist; /* list of HSTS files set by
  1075. curl_easy_setopt(HSTS) calls */
  1076. curl_off_t current_speed; /* the ProgressShow() function sets this,
  1077. bytes / second */
  1078. /* hostname, port number and protocol of the first (not followed) request.
  1079. if set, this should be the hostname that we will sent authorization to,
  1080. no else. Used to make Location: following not keep sending user+password.
  1081. This is strdup()ed data. */
  1082. char *first_host;
  1083. int first_remote_port;
  1084. curl_prot_t first_remote_protocol;
  1085. int retrycount; /* number of retries on a new connection */
  1086. struct Curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
  1087. long sessionage; /* number of the most recent session */
  1088. int os_errno; /* filled in with errno whenever an error occurs */
  1089. long followlocation; /* redirect counter */
  1090. int requests; /* request counter: redirects + authentication retakes */
  1091. #ifdef HAVE_SIGNAL
  1092. /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
  1093. void (*prev_signal)(int sig);
  1094. #endif
  1095. #ifndef CURL_DISABLE_DIGEST_AUTH
  1096. struct digestdata digest; /* state data for host Digest auth */
  1097. struct digestdata proxydigest; /* state data for proxy Digest auth */
  1098. #endif
  1099. struct auth authhost; /* auth details for host */
  1100. struct auth authproxy; /* auth details for proxy */
  1101. #ifdef USE_CURL_ASYNC
  1102. struct Curl_async async; /* asynchronous name resolver data */
  1103. #endif
  1104. #if defined(USE_OPENSSL)
  1105. /* void instead of ENGINE to avoid bleeding OpenSSL into this header */
  1106. void *engine;
  1107. #endif /* USE_OPENSSL */
  1108. struct curltime expiretime; /* set this with Curl_expire() only */
  1109. struct Curl_tree timenode; /* for the splay stuff */
  1110. struct Curl_llist timeoutlist; /* list of pending timeouts */
  1111. struct time_node expires[EXPIRE_LAST]; /* nodes for each expire type */
  1112. /* a place to store the most recently set (S)FTP entrypath */
  1113. char *most_recent_ftp_entrypath;
  1114. char *range; /* range, if used. See README for detailed specification on
  1115. this syntax. */
  1116. curl_off_t resume_from; /* continue [ftp] transfer from here */
  1117. #ifndef CURL_DISABLE_RTSP
  1118. /* This RTSP state information survives requests and connections */
  1119. long rtsp_next_client_CSeq; /* the session's next client CSeq */
  1120. long rtsp_next_server_CSeq; /* the session's next server CSeq */
  1121. long rtsp_CSeq_recv; /* most recent CSeq received */
  1122. unsigned char rtp_channel_mask[32]; /* for the correctness checking of the
  1123. interleaved data */
  1124. #endif
  1125. curl_off_t infilesize; /* size of file to upload, -1 means unknown.
  1126. Copied from set.filesize at start of operation */
  1127. #if defined(USE_HTTP2) || defined(USE_HTTP3)
  1128. struct Curl_data_priority priority; /* shallow copy of data->set */
  1129. #endif
  1130. curl_read_callback fread_func; /* read callback/function */
  1131. void *in; /* CURLOPT_READDATA */
  1132. CURLU *uh; /* URL handle for the current parsed URL */
  1133. struct urlpieces up;
  1134. char *url; /* work URL, copied from UserDefined */
  1135. char *referer; /* referer string */
  1136. struct curl_slist *resolve; /* set to point to the set.resolve list when
  1137. this should be dealt with in pretransfer */
  1138. #ifndef CURL_DISABLE_HTTP
  1139. curl_mimepart *mimepost;
  1140. #ifndef CURL_DISABLE_FORM_API
  1141. curl_mimepart *formp; /* storage for old API form-posting, allocated on
  1142. demand */
  1143. #endif
  1144. size_t trailers_bytes_sent;
  1145. struct dynbuf trailers_buf; /* a buffer containing the compiled trailing
  1146. headers */
  1147. struct Curl_llist httphdrs; /* received headers */
  1148. struct curl_header headerout[2]; /* for external purposes */
  1149. struct Curl_header_store *prevhead; /* the latest added header */
  1150. trailers_state trailers_state; /* whether we are sending trailers
  1151. and what stage are we at */
  1152. #endif
  1153. #ifndef CURL_DISABLE_COOKIES
  1154. struct curl_slist *cookielist; /* list of cookie files set by
  1155. curl_easy_setopt(COOKIEFILE) calls */
  1156. #endif
  1157. #ifdef USE_HYPER
  1158. bool hconnect; /* set if a CONNECT request */
  1159. CURLcode hresult; /* used to pass return codes back from hyper callbacks */
  1160. #endif
  1161. #ifndef CURL_DISABLE_VERBOSE_STRINGS
  1162. struct curl_trc_feat *feat; /* opt. trace feature transfer is part of */
  1163. #endif
  1164. /* Dynamically allocated strings, MUST be freed before this struct is
  1165. killed. */
  1166. struct dynamically_allocated_data {
  1167. char *uagent;
  1168. char *accept_encoding;
  1169. char *userpwd;
  1170. char *rangeline;
  1171. char *ref;
  1172. char *host;
  1173. #ifndef CURL_DISABLE_COOKIES
  1174. char *cookiehost;
  1175. #endif
  1176. #ifndef CURL_DISABLE_RTSP
  1177. char *rtsp_transport;
  1178. #endif
  1179. char *te; /* TE: request header */
  1180. /* transfer credentials */
  1181. char *user;
  1182. char *passwd;
  1183. #ifndef CURL_DISABLE_PROXY
  1184. char *proxyuserpwd;
  1185. char *proxyuser;
  1186. char *proxypasswd;
  1187. #endif
  1188. } aptr;
  1189. unsigned char httpwant; /* when non-zero, a specific HTTP version requested
  1190. to be used in the library's request(s) */
  1191. unsigned char httpversion; /* the lowest HTTP version*10 reported by any
  1192. server involved in this request */
  1193. unsigned char httpreq; /* Curl_HttpReq; what kind of HTTP request (if any)
  1194. is this */
  1195. unsigned char select_bits; /* != 0 -> bitmask of socket events for this
  1196. transfer overriding anything the socket may
  1197. report */
  1198. /* when curl_easy_perform() is called, the multi handle is "owned" by
  1199. the easy handle so curl_easy_cleanup() on such an easy handle will
  1200. also close the multi handle! */
  1201. BIT(multi_owned_by_easy);
  1202. BIT(this_is_a_follow); /* this is a followed Location: request */
  1203. BIT(refused_stream); /* this was refused, try again */
  1204. BIT(errorbuf); /* Set to TRUE if the error buffer is already filled in.
  1205. This must be set to FALSE every time _easy_perform() is
  1206. called. */
  1207. BIT(allow_port); /* Is set.use_port allowed to take effect or not. This
  1208. is always set TRUE when curl_easy_perform() is called. */
  1209. BIT(authproblem); /* TRUE if there is some problem authenticating */
  1210. /* set after initial USER failure, to prevent an authentication loop */
  1211. BIT(wildcardmatch); /* enable wildcard matching */
  1212. BIT(disableexpect); /* TRUE if Expect: is disabled due to a previous
  1213. 417 response */
  1214. BIT(use_range);
  1215. BIT(rangestringalloc); /* the range string is malloc()'ed */
  1216. BIT(done); /* set to FALSE when Curl_init_do() is called and set to TRUE
  1217. when multi_done() is called, to prevent multi_done() to get
  1218. invoked twice when the multi interface is used. */
  1219. #ifndef CURL_DISABLE_COOKIES
  1220. BIT(cookie_engine);
  1221. #endif
  1222. BIT(prefer_ascii); /* ASCII rather than binary */
  1223. #ifdef CURL_LIST_ONLY_PROTOCOL
  1224. BIT(list_only); /* list directory contents */
  1225. #endif
  1226. BIT(url_alloc); /* URL string is malloc()'ed */
  1227. BIT(referer_alloc); /* referer string is malloc()ed */
  1228. BIT(wildcard_resolve); /* Set to true if any resolve change is a wildcard */
  1229. BIT(upload); /* upload request */
  1230. BIT(internal); /* internal: true if this easy handle was created for
  1231. internal use and the user does not have ownership of the
  1232. handle. */
  1233. };
  1234. /*
  1235. * This 'UserDefined' struct must only contain data that is set once to go
  1236. * for many (perhaps) independent connections. Values that are generated or
  1237. * calculated internally for the "session handle" MUST be defined within the
  1238. * 'struct UrlState' instead. The only exceptions MUST note the changes in
  1239. * the 'DynamicStatic' struct.
  1240. * Character pointer fields point to dynamic storage, unless otherwise stated.
  1241. */
  1242. struct Curl_multi; /* declared in multihandle.c */
  1243. enum dupstring {
  1244. STRING_CERT, /* client certificate filename */
  1245. STRING_CERT_TYPE, /* format for certificate (default: PEM)*/
  1246. STRING_KEY, /* private key filename */
  1247. STRING_KEY_PASSWD, /* plain text private key password */
  1248. STRING_KEY_TYPE, /* format for private key (default: PEM) */
  1249. STRING_SSL_CAPATH, /* CA directory name (does not work on Windows) */
  1250. STRING_SSL_CAFILE, /* certificate file to verify peer against */
  1251. STRING_SSL_PINNEDPUBLICKEY, /* public key file to verify peer against */
  1252. STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
  1253. STRING_SSL_CIPHER13_LIST, /* list of TLS 1.3 ciphers to use */
  1254. STRING_SSL_CRLFILE, /* crl file to check certificate */
  1255. STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */
  1256. STRING_SERVICE_NAME, /* Service name */
  1257. #ifndef CURL_DISABLE_PROXY
  1258. STRING_CERT_PROXY, /* client certificate filename */
  1259. STRING_CERT_TYPE_PROXY, /* format for certificate (default: PEM)*/
  1260. STRING_KEY_PROXY, /* private key filename */
  1261. STRING_KEY_PASSWD_PROXY, /* plain text private key password */
  1262. STRING_KEY_TYPE_PROXY, /* format for private key (default: PEM) */
  1263. STRING_SSL_CAPATH_PROXY, /* CA directory name (does not work on Windows) */
  1264. STRING_SSL_CAFILE_PROXY, /* certificate file to verify peer against */
  1265. STRING_SSL_PINNEDPUBLICKEY_PROXY, /* public key file to verify proxy */
  1266. STRING_SSL_CIPHER_LIST_PROXY, /* list of ciphers to use */
  1267. STRING_SSL_CIPHER13_LIST_PROXY, /* list of TLS 1.3 ciphers to use */
  1268. STRING_SSL_CRLFILE_PROXY, /* crl file to check certificate */
  1269. STRING_SSL_ISSUERCERT_PROXY, /* issuer cert file to check certificate */
  1270. STRING_PROXY_SERVICE_NAME, /* Proxy service name */
  1271. #endif
  1272. #ifndef CURL_DISABLE_COOKIES
  1273. STRING_COOKIE, /* HTTP cookie string to send */
  1274. STRING_COOKIEJAR, /* dump all cookies to this file */
  1275. #endif
  1276. STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
  1277. STRING_DEFAULT_PROTOCOL, /* Protocol to use when the URL does not specify */
  1278. STRING_DEVICE, /* local network interface/address to use */
  1279. STRING_INTERFACE, /* local network interface to use */
  1280. STRING_BINDHOST, /* local address to use */
  1281. STRING_ENCODING, /* Accept-Encoding string */
  1282. #ifndef CURL_DISABLE_FTP
  1283. STRING_FTP_ACCOUNT, /* ftp account data */
  1284. STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
  1285. STRING_FTPPORT, /* port to send with the FTP PORT command */
  1286. #endif
  1287. #if defined(HAVE_GSSAPI)
  1288. STRING_KRB_LEVEL, /* krb security level */
  1289. #endif
  1290. #ifndef CURL_DISABLE_NETRC
  1291. STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
  1292. $HOME/.netrc */
  1293. #endif
  1294. #ifndef CURL_DISABLE_PROXY
  1295. STRING_PROXY, /* proxy to use */
  1296. STRING_PRE_PROXY, /* pre socks proxy to use */
  1297. #endif
  1298. STRING_SET_RANGE, /* range, if used */
  1299. STRING_SET_REFERER, /* custom string for the HTTP referer field */
  1300. STRING_SET_URL, /* what original URL to work on */
  1301. STRING_USERAGENT, /* User-Agent string */
  1302. STRING_SSL_ENGINE, /* name of ssl engine */
  1303. STRING_USERNAME, /* <username>, if used */
  1304. STRING_PASSWORD, /* <password>, if used */
  1305. STRING_OPTIONS, /* <options>, if used */
  1306. #ifndef CURL_DISABLE_PROXY
  1307. STRING_PROXYUSERNAME, /* Proxy <username>, if used */
  1308. STRING_PROXYPASSWORD, /* Proxy <password>, if used */
  1309. STRING_NOPROXY, /* List of hosts which should not use the proxy, if
  1310. used */
  1311. #endif
  1312. #ifndef CURL_DISABLE_RTSP
  1313. STRING_RTSP_SESSION_ID, /* Session ID to use */
  1314. STRING_RTSP_STREAM_URI, /* Stream URI for this request */
  1315. STRING_RTSP_TRANSPORT, /* Transport for this session */
  1316. #endif
  1317. #ifdef USE_SSH
  1318. STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
  1319. STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
  1320. STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ASCII hex */
  1321. STRING_SSH_HOST_PUBLIC_KEY_SHA256, /* sha256 of host public key in base64 */
  1322. STRING_SSH_KNOWNHOSTS, /* filename of knownhosts file */
  1323. #endif
  1324. #ifndef CURL_DISABLE_SMTP
  1325. STRING_MAIL_FROM,
  1326. STRING_MAIL_AUTH,
  1327. #endif
  1328. #ifdef USE_TLS_SRP
  1329. STRING_TLSAUTH_USERNAME, /* TLS auth <username> */
  1330. STRING_TLSAUTH_PASSWORD, /* TLS auth <password> */
  1331. #ifndef CURL_DISABLE_PROXY
  1332. STRING_TLSAUTH_USERNAME_PROXY, /* TLS auth <username> */
  1333. STRING_TLSAUTH_PASSWORD_PROXY, /* TLS auth <password> */
  1334. #endif
  1335. #endif
  1336. STRING_BEARER, /* <bearer>, if used */
  1337. #ifdef USE_UNIX_SOCKETS
  1338. STRING_UNIX_SOCKET_PATH, /* path to Unix socket, if used */
  1339. #endif
  1340. STRING_TARGET, /* CURLOPT_REQUEST_TARGET */
  1341. #ifndef CURL_DISABLE_DOH
  1342. STRING_DOH, /* CURLOPT_DOH_URL */
  1343. #endif
  1344. #ifndef CURL_DISABLE_ALTSVC
  1345. STRING_ALTSVC, /* CURLOPT_ALTSVC */
  1346. #endif
  1347. #ifndef CURL_DISABLE_HSTS
  1348. STRING_HSTS, /* CURLOPT_HSTS */
  1349. #endif
  1350. STRING_SASL_AUTHZID, /* CURLOPT_SASL_AUTHZID */
  1351. #ifdef USE_ARES
  1352. STRING_DNS_SERVERS,
  1353. STRING_DNS_INTERFACE,
  1354. STRING_DNS_LOCAL_IP4,
  1355. STRING_DNS_LOCAL_IP6,
  1356. #endif
  1357. STRING_SSL_EC_CURVES,
  1358. #ifndef CURL_DISABLE_AWS
  1359. STRING_AWS_SIGV4, /* Parameters for V4 signature */
  1360. #endif
  1361. #ifndef CURL_DISABLE_PROXY
  1362. STRING_HAPROXY_CLIENT_IP, /* CURLOPT_HAPROXY_CLIENT_IP */
  1363. #endif
  1364. STRING_ECH_CONFIG, /* CURLOPT_ECH_CONFIG */
  1365. STRING_ECH_PUBLIC, /* CURLOPT_ECH_PUBLIC */
  1366. /* -- end of null-terminated strings -- */
  1367. STRING_LASTZEROTERMINATED,
  1368. /* -- below this are pointers to binary data that cannot be strdup'ed. --- */
  1369. STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
  1370. STRING_LAST /* not used, just an end-of-list marker */
  1371. };
  1372. enum dupblob {
  1373. BLOB_CERT,
  1374. BLOB_KEY,
  1375. BLOB_SSL_ISSUERCERT,
  1376. BLOB_CAINFO,
  1377. #ifndef CURL_DISABLE_PROXY
  1378. BLOB_CERT_PROXY,
  1379. BLOB_KEY_PROXY,
  1380. BLOB_SSL_ISSUERCERT_PROXY,
  1381. BLOB_CAINFO_PROXY,
  1382. #endif
  1383. BLOB_LAST
  1384. };
  1385. /* callback that gets called when this easy handle is completed within a multi
  1386. handle. Only used for internally created transfers, like for example
  1387. DoH. */
  1388. typedef int (*multidone_func)(struct Curl_easy *easy, CURLcode result);
  1389. struct UserDefined {
  1390. FILE *err; /* the stderr user data goes here */
  1391. void *debugdata; /* the data that will be passed to fdebug */
  1392. char *errorbuffer; /* (Static) store failure messages in here */
  1393. void *out; /* CURLOPT_WRITEDATA */
  1394. void *in_set; /* CURLOPT_READDATA */
  1395. void *writeheader; /* write the header to this if non-NULL */
  1396. unsigned short use_port; /* which port to use (when not using default) */
  1397. unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */
  1398. unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */
  1399. long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
  1400. for infinity */
  1401. void *postfields; /* if POST, set the fields' values here */
  1402. curl_seek_callback seek_func; /* function that seeks the input */
  1403. curl_off_t postfieldsize; /* if POST, this might have a size to use instead
  1404. of strlen(), and then the data *may* be binary
  1405. (contain zero bytes) */
  1406. #ifndef CURL_DISABLE_BINDLOCAL
  1407. unsigned short localport; /* local port number to bind to */
  1408. unsigned short localportrange; /* number of additional port numbers to test
  1409. in case the 'localport' one cannot be
  1410. bind()ed */
  1411. #endif
  1412. curl_write_callback fwrite_func; /* function that stores the output */
  1413. curl_write_callback fwrite_header; /* function that stores headers */
  1414. curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
  1415. curl_read_callback fread_func_set; /* function that reads the input */
  1416. curl_progress_callback fprogress; /* OLD and deprecated progress callback */
  1417. curl_xferinfo_callback fxferinfo; /* progress callback */
  1418. curl_debug_callback fdebug; /* function that write informational data */
  1419. curl_ioctl_callback ioctl_func; /* function for I/O control */
  1420. curl_sockopt_callback fsockopt; /* function for setting socket options */
  1421. void *sockopt_client; /* pointer to pass to the socket options callback */
  1422. curl_opensocket_callback fopensocket; /* function for checking/translating
  1423. the address and opening the
  1424. socket */
  1425. void *opensocket_client;
  1426. curl_closesocket_callback fclosesocket; /* function for closing the
  1427. socket */
  1428. void *closesocket_client;
  1429. curl_prereq_callback fprereq; /* pre-initial request callback */
  1430. void *prereq_userp; /* pre-initial request user data */
  1431. void *seek_client; /* pointer to pass to the seek callback */
  1432. #ifndef CURL_DISABLE_HSTS
  1433. curl_hstsread_callback hsts_read;
  1434. void *hsts_read_userp;
  1435. curl_hstswrite_callback hsts_write;
  1436. void *hsts_write_userp;
  1437. #endif
  1438. void *progress_client; /* pointer to pass to the progress callback */
  1439. void *ioctl_client; /* pointer to pass to the ioctl callback */
  1440. unsigned int timeout; /* ms, 0 means no timeout */
  1441. unsigned int connecttimeout; /* ms, 0 means default timeout */
  1442. unsigned int happy_eyeballs_timeout; /* ms, 0 is a valid value */
  1443. unsigned int server_response_timeout; /* ms, 0 means no timeout */
  1444. unsigned int shutdowntimeout; /* ms, 0 means default timeout */
  1445. long maxage_conn; /* in seconds, max idle time to allow a connection that
  1446. is to be reused */
  1447. long maxlifetime_conn; /* in seconds, max time since creation to allow a
  1448. connection that is to be reused */
  1449. #ifndef CURL_DISABLE_TFTP
  1450. long tftp_blksize; /* in bytes, 0 means use default */
  1451. #endif
  1452. curl_off_t filesize; /* size of file to upload, -1 means unknown */
  1453. long low_speed_limit; /* bytes/second */
  1454. long low_speed_time; /* number of seconds */
  1455. curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
  1456. curl_off_t max_recv_speed; /* high speed limit in bytes/second for
  1457. download */
  1458. curl_off_t set_resume_from; /* continue [ftp] transfer from here */
  1459. struct curl_slist *headers; /* linked list of extra headers */
  1460. struct curl_httppost *httppost; /* linked list of old POST data */
  1461. #if !defined(CURL_DISABLE_MIME) || !defined(CURL_DISABLE_FORM_API)
  1462. curl_mimepart mimepost; /* MIME/POST data. */
  1463. #endif
  1464. #ifndef CURL_DISABLE_TELNET
  1465. struct curl_slist *telnet_options; /* linked list of telnet options */
  1466. #endif
  1467. struct curl_slist *resolve; /* list of names to add/remove from
  1468. DNS cache */
  1469. struct curl_slist *connect_to; /* list of host:port mappings to override
  1470. the hostname and port to connect to */
  1471. time_t timevalue; /* what time to compare with */
  1472. unsigned char timecondition; /* kind of time comparison: curl_TimeCond */
  1473. unsigned char method; /* what kind of HTTP request: Curl_HttpReq */
  1474. unsigned char httpwant; /* when non-zero, a specific HTTP version requested
  1475. to be used in the library's request(s) */
  1476. struct ssl_config_data ssl; /* user defined SSL stuff */
  1477. #ifndef CURL_DISABLE_PROXY
  1478. struct ssl_config_data proxy_ssl; /* user defined SSL stuff for proxy */
  1479. struct curl_slist *proxyheaders; /* linked list of extra CONNECT headers */
  1480. unsigned short proxyport; /* If non-zero, use this port number by
  1481. default. If the proxy string features a
  1482. ":[port]" that one will override this. */
  1483. unsigned char proxytype; /* what kind of proxy: curl_proxytype */
  1484. unsigned char socks5auth;/* kind of SOCKS5 authentication to use (bitmask) */
  1485. #endif
  1486. struct ssl_general_config general_ssl; /* general user defined SSL stuff */
  1487. int dns_cache_timeout; /* DNS cache timeout (seconds) */
  1488. unsigned int buffer_size; /* size of receive buffer to use */
  1489. unsigned int upload_buffer_size; /* size of upload buffer to use,
  1490. keep it >= CURL_MAX_WRITE_SIZE */
  1491. void *private_data; /* application-private data */
  1492. #ifndef CURL_DISABLE_HTTP
  1493. struct curl_slist *http200aliases; /* linked list of aliases for http200 */
  1494. #endif
  1495. unsigned char ipver; /* the CURL_IPRESOLVE_* defines in the public header
  1496. file 0 - whatever, 1 - v2, 2 - v6 */
  1497. curl_off_t max_filesize; /* Maximum file size to download */
  1498. #ifndef CURL_DISABLE_FTP
  1499. unsigned char ftp_filemethod; /* how to get to a file: curl_ftpfile */
  1500. unsigned char ftpsslauth; /* what AUTH XXX to try: curl_ftpauth */
  1501. unsigned char ftp_ccc; /* FTP CCC options: curl_ftpccc */
  1502. unsigned int accepttimeout; /* in milliseconds, 0 means no timeout */
  1503. #endif
  1504. #if !defined(CURL_DISABLE_FTP) || defined(USE_SSH)
  1505. struct curl_slist *quote; /* after connection is established */
  1506. struct curl_slist *postquote; /* after the transfer */
  1507. struct curl_slist *prequote; /* before the transfer, after type */
  1508. /* Despite the name, ftp_create_missing_dirs is for FTP(S) and SFTP
  1509. 1 - create directories that do not exist
  1510. 2 - the same but also allow MKD to fail once
  1511. */
  1512. unsigned char ftp_create_missing_dirs;
  1513. #endif
  1514. #ifdef USE_LIBSSH2
  1515. curl_sshhostkeycallback ssh_hostkeyfunc; /* hostkey check callback */
  1516. void *ssh_hostkeyfunc_userp; /* custom pointer to callback */
  1517. #endif
  1518. #ifdef USE_SSH
  1519. curl_sshkeycallback ssh_keyfunc; /* key matching callback */
  1520. void *ssh_keyfunc_userp; /* custom pointer to callback */
  1521. int ssh_auth_types; /* allowed SSH auth types */
  1522. unsigned int new_directory_perms; /* when creating remote dirs */
  1523. #endif
  1524. #ifndef CURL_DISABLE_NETRC
  1525. unsigned char use_netrc; /* enum CURL_NETRC_OPTION values */
  1526. #endif
  1527. unsigned int new_file_perms; /* when creating remote files */
  1528. char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
  1529. struct curl_blob *blobs[BLOB_LAST];
  1530. #ifdef USE_IPV6
  1531. unsigned int scope_id; /* Scope id for IPv6 */
  1532. #endif
  1533. curl_prot_t allowed_protocols;
  1534. curl_prot_t redir_protocols;
  1535. #ifndef CURL_DISABLE_RTSP
  1536. void *rtp_out; /* write RTP to this if non-NULL */
  1537. /* Common RTSP header options */
  1538. Curl_RtspReq rtspreq; /* RTSP request type */
  1539. #endif
  1540. #ifndef CURL_DISABLE_FTP
  1541. curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
  1542. starts */
  1543. curl_chunk_end_callback chunk_end; /* called after part transferring
  1544. stopped */
  1545. curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
  1546. to pattern (e.g. if WILDCARDMATCH is on) */
  1547. void *fnmatch_data;
  1548. void *wildcardptr;
  1549. #endif
  1550. /* GSS-API credential delegation, see the documentation of
  1551. CURLOPT_GSSAPI_DELEGATION */
  1552. unsigned char gssapi_delegation;
  1553. int tcp_keepidle; /* seconds in idle before sending keepalive probe */
  1554. int tcp_keepintvl; /* seconds between TCP keepalive probes */
  1555. int tcp_keepcnt; /* maximum number of keepalive probes */
  1556. long expect_100_timeout; /* in milliseconds */
  1557. #if defined(USE_HTTP2) || defined(USE_HTTP3)
  1558. struct Curl_data_priority priority;
  1559. #endif
  1560. curl_resolver_start_callback resolver_start; /* optional callback called
  1561. before resolver start */
  1562. void *resolver_start_client; /* pointer to pass to resolver start callback */
  1563. long upkeep_interval_ms; /* Time between calls for connection upkeep. */
  1564. multidone_func fmultidone;
  1565. #ifndef CURL_DISABLE_DOH
  1566. curl_off_t dohfor_mid; /* this is a DoH request for that transfer */
  1567. #endif
  1568. CURLU *uh; /* URL handle for the current parsed URL */
  1569. #ifndef CURL_DISABLE_HTTP
  1570. void *trailer_data; /* pointer to pass to trailer data callback */
  1571. curl_trailer_callback trailer_callback; /* trailing data callback */
  1572. #endif
  1573. char keep_post; /* keep POSTs as POSTs after a 30x request; each
  1574. bit represents a request, from 301 to 303 */
  1575. #ifndef CURL_DISABLE_SMTP
  1576. struct curl_slist *mail_rcpt; /* linked list of mail recipients */
  1577. BIT(mail_rcpt_allowfails); /* allow RCPT TO command to fail for some
  1578. recipients */
  1579. #endif
  1580. unsigned int maxconnects; /* Max idle connections in the connection cache */
  1581. unsigned char use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
  1582. IMAP or POP3 or others! (type: curl_usessl)*/
  1583. unsigned char connect_only; /* make connection/request, then let
  1584. application use the socket */
  1585. #ifndef CURL_DISABLE_MIME
  1586. BIT(mime_formescape);
  1587. #endif
  1588. BIT(is_fread_set); /* has read callback been set to non-NULL? */
  1589. #ifndef CURL_DISABLE_TFTP
  1590. BIT(tftp_no_options); /* do not send TFTP options requests */
  1591. #endif
  1592. BIT(sep_headers); /* handle host and proxy headers separately */
  1593. #ifndef CURL_DISABLE_COOKIES
  1594. BIT(cookiesession); /* new cookie session? */
  1595. #endif
  1596. BIT(crlf); /* convert crlf on ftp upload(?) */
  1597. #ifdef USE_SSH
  1598. BIT(ssh_compression); /* enable SSH compression */
  1599. #endif
  1600. /* Here follows boolean settings that define how to behave during
  1601. this session. They are STATIC, set by libcurl users or at least initially
  1602. and they do not change during operations. */
  1603. BIT(quick_exit); /* set 1L when it is okay to leak things (like
  1604. threads), as we are about to exit() anyway and
  1605. do not want lengthy cleanups to delay termination,
  1606. e.g. after a DNS timeout */
  1607. BIT(get_filetime); /* get the time and get of the remote file */
  1608. #ifndef CURL_DISABLE_PROXY
  1609. BIT(tunnel_thru_httpproxy); /* use CONNECT through an HTTP proxy */
  1610. #endif
  1611. BIT(prefer_ascii); /* ASCII rather than binary */
  1612. BIT(remote_append); /* append, not overwrite, on upload */
  1613. #ifdef CURL_LIST_ONLY_PROTOCOL
  1614. BIT(list_only); /* list directory */
  1615. #endif
  1616. #ifndef CURL_DISABLE_FTP
  1617. BIT(ftp_use_port); /* use the FTP PORT command */
  1618. BIT(ftp_use_epsv); /* if EPSV is to be attempted or not */
  1619. BIT(ftp_use_eprt); /* if EPRT is to be attempted or not */
  1620. BIT(ftp_use_pret); /* if PRET is to be used before PASV or not */
  1621. BIT(ftp_skip_ip); /* skip the IP address the FTP server passes on to
  1622. us */
  1623. BIT(wildcard_enabled); /* enable wildcard matching */
  1624. #endif
  1625. BIT(hide_progress); /* do not use the progress meter */
  1626. BIT(http_fail_on_error); /* fail on HTTP error codes >= 400 */
  1627. BIT(http_keep_sending_on_error); /* for HTTP status codes >= 300 */
  1628. BIT(http_follow_location); /* follow HTTP redirects */
  1629. BIT(http_transfer_encoding); /* request compressed HTTP transfer-encoding */
  1630. BIT(allow_auth_to_other_hosts);
  1631. BIT(include_header); /* include received protocol headers in data output */
  1632. BIT(http_set_referer); /* is a custom referer used */
  1633. BIT(http_auto_referer); /* set "correct" referer when following
  1634. location: */
  1635. BIT(opt_no_body); /* as set with CURLOPT_NOBODY */
  1636. BIT(verbose); /* output verbosity */
  1637. #if defined(HAVE_GSSAPI)
  1638. BIT(krb); /* Kerberos connection requested */
  1639. #endif
  1640. BIT(reuse_forbid); /* forbidden to be reused, close after use */
  1641. BIT(reuse_fresh); /* do not reuse an existing connection */
  1642. BIT(no_signal); /* do not use any signal/alarm handler */
  1643. BIT(tcp_nodelay); /* whether to enable TCP_NODELAY or not */
  1644. BIT(ignorecl); /* ignore content length */
  1645. BIT(http_te_skip); /* pass the raw body data to the user, even when
  1646. transfer-encoded (chunked, compressed) */
  1647. BIT(http_ce_skip); /* pass the raw body data to the user, even when
  1648. content-encoded (chunked, compressed) */
  1649. BIT(proxy_transfer_mode); /* set transfer mode (;type=<a|i>) when doing
  1650. FTP via an HTTP proxy */
  1651. #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
  1652. BIT(socks5_gssapi_nec); /* Flag to support NEC SOCKS5 server */
  1653. #endif
  1654. BIT(sasl_ir); /* Enable/disable SASL initial response */
  1655. BIT(tcp_keepalive); /* use TCP keepalives */
  1656. BIT(tcp_fastopen); /* use TCP Fast Open */
  1657. BIT(ssl_enable_alpn);/* TLS ALPN extension? */
  1658. BIT(path_as_is); /* allow dotdots? */
  1659. BIT(pipewait); /* wait for multiplex status before starting a new
  1660. connection */
  1661. BIT(suppress_connect_headers); /* suppress proxy CONNECT response headers
  1662. from user callbacks */
  1663. BIT(dns_shuffle_addresses); /* whether to shuffle addresses before use */
  1664. #ifndef CURL_DISABLE_PROXY
  1665. BIT(haproxyprotocol); /* whether to send HAProxy PROXY protocol v1
  1666. header */
  1667. #endif
  1668. #ifdef USE_UNIX_SOCKETS
  1669. BIT(abstract_unix_socket);
  1670. #endif
  1671. BIT(disallow_username_in_url); /* disallow username in URL */
  1672. #ifndef CURL_DISABLE_DOH
  1673. BIT(doh); /* DNS-over-HTTPS enabled */
  1674. BIT(doh_verifypeer); /* DoH certificate peer verification */
  1675. BIT(doh_verifyhost); /* DoH certificate hostname verification */
  1676. BIT(doh_verifystatus); /* DoH certificate status verification */
  1677. #endif
  1678. BIT(http09_allowed); /* allow HTTP/0.9 responses */
  1679. #ifndef CURL_DISABLE_WEBSOCKETS
  1680. BIT(ws_raw_mode);
  1681. #endif
  1682. #ifdef USE_ECH
  1683. int tls_ech; /* TLS ECH configuration */
  1684. #endif
  1685. };
  1686. #ifndef CURL_DISABLE_MIME
  1687. #define IS_MIME_POST(a) ((a)->set.mimepost.kind != MIMEKIND_NONE)
  1688. #else
  1689. #define IS_MIME_POST(a) FALSE
  1690. #endif
  1691. struct Names {
  1692. struct Curl_hash *hostcache;
  1693. enum {
  1694. HCACHE_NONE, /* not pointing to anything */
  1695. HCACHE_MULTI, /* points to a shared one in the multi handle */
  1696. HCACHE_SHARED /* points to a shared one in a shared object */
  1697. } hostcachetype;
  1698. };
  1699. /*
  1700. * The 'connectdata' struct MUST have all the connection oriented stuff as we
  1701. * may have several simultaneous connections and connection structs in memory.
  1702. *
  1703. * The 'struct UserDefined' must only contain data that is set once to go for
  1704. * many (perhaps) independent connections. Values that are generated or
  1705. * calculated internally for the "session handle" must be defined within the
  1706. * 'struct UrlState' instead.
  1707. */
  1708. struct Curl_easy {
  1709. /* First a simple identifier to easier detect if a user mix up this easy
  1710. handle with a multi handle. Set this to CURLEASY_MAGIC_NUMBER */
  1711. unsigned int magic;
  1712. /* once an easy handle is tied to a connection pool
  1713. a non-negative number to distinguish this transfer from
  1714. other using the same pool. For easier tracking
  1715. in log output.
  1716. This may wrap around after LONG_MAX to 0 again, so it
  1717. has no uniqueness guarantee for very large processings.
  1718. Note: it has no uniqueness either IFF more than one connection pool
  1719. is used by the libcurl application. */
  1720. curl_off_t id;
  1721. /* once an easy handle is added to a multi, either explicitly by the
  1722. * libcurl application or implicitly during `curl_easy_perform()`,
  1723. * a unique identifier inside this one multi instance. */
  1724. curl_off_t mid;
  1725. struct connectdata *conn;
  1726. struct Curl_llist_node multi_queue; /* for multihandle list management */
  1727. struct Curl_llist_node conn_queue; /* list per connectdata */
  1728. CURLMstate mstate; /* the handle's state */
  1729. CURLcode result; /* previous result */
  1730. struct Curl_message msg; /* A single posted message. */
  1731. /* Array with the plain socket numbers this handle takes care of, in no
  1732. particular order. Note that all sockets are added to the sockhash, where
  1733. the state etc are also kept. This array is mostly used to detect when a
  1734. socket is to be removed from the hash. See singlesocket(). */
  1735. struct easy_pollset last_poll;
  1736. struct Names dns;
  1737. struct Curl_multi *multi; /* if non-NULL, points to the multi handle
  1738. struct to which this "belongs" when used by
  1739. the multi interface */
  1740. struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
  1741. struct to which this "belongs" when used
  1742. by the easy interface */
  1743. struct Curl_share *share; /* Share, handles global variable mutexing */
  1744. #ifdef USE_LIBPSL
  1745. struct PslCache *psl; /* The associated PSL cache. */
  1746. #endif
  1747. struct SingleRequest req; /* Request-specific data */
  1748. struct UserDefined set; /* values set by the libcurl user */
  1749. #ifndef CURL_DISABLE_COOKIES
  1750. struct CookieInfo *cookies; /* the cookies, read from files and servers.
  1751. NOTE that the 'cookie' field in the
  1752. UserDefined struct defines if the "engine"
  1753. is to be used or not. */
  1754. #endif
  1755. #ifndef CURL_DISABLE_HSTS
  1756. struct hsts *hsts;
  1757. #endif
  1758. #ifndef CURL_DISABLE_ALTSVC
  1759. struct altsvcinfo *asi; /* the alt-svc cache */
  1760. #endif
  1761. struct Progress progress; /* for all the progress meter data */
  1762. struct UrlState state; /* struct for fields used for state info and
  1763. other dynamic purposes */
  1764. #ifndef CURL_DISABLE_FTP
  1765. struct WildcardData *wildcard; /* wildcard download state info */
  1766. #endif
  1767. struct PureInfo info; /* stats, reports and info data */
  1768. struct curl_tlssessioninfo tsi; /* Information about the TLS session, only
  1769. valid after a client has asked for it */
  1770. #ifdef USE_HYPER
  1771. struct hyptransfer hyp;
  1772. #endif
  1773. };
  1774. #define LIBCURL_NAME "libcurl"
  1775. #endif /* HEADER_CURL_URLDATA_H */