#ifndef HEADER_CURL_URLDATA_H

#define HEADER_CURL_URLDATA_H

/***************************************************************************

 *                                  _   _ ____  _

 *  Project                     ___| | | |  _ \| |

 *                             / __| | | | |_) | |

 *                            | (__| |_| |  _ <| |___

 *                             \___|\___/|_| \_\_____|

 *

 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.

 *

 * This software is licensed as described in the file COPYING, which

 * you should have received as part of this distribution. The terms

 * are also available at https://curl.se/docs/copyright.html.

 *

 * You may opt to use, copy, modify, merge, publish, distribute and/or sell

 * copies of the Software, and permit persons to whom the Software is

 * furnished to do so, under the terms of the COPYING file.

 *

 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY

 * KIND, either express or implied.

 *

 * SPDX-License-Identifier: curl

 *

 ***************************************************************************/

/* This file is for lib internal stuff */

#include "curl_setup.h"

#define PORT_FTP 21

#define PORT_FTPS 990

#define PORT_TELNET 23

#define PORT_HTTP 80

#define PORT_HTTPS 443

#define PORT_DICT 2628

#define PORT_LDAP 389

#define PORT_LDAPS 636

#define PORT_TFTP 69

#define PORT_SSH 22

#define PORT_IMAP 143

#define PORT_IMAPS 993

#define PORT_POP3 110

#define PORT_POP3S 995

#define PORT_SMB 445

#define PORT_SMBS 445

#define PORT_SMTP 25

#define PORT_SMTPS 465 /* sometimes called SSMTP */

#define PORT_RTSP 554

#define PORT_RTMP 1935

#define PORT_RTMPT PORT_HTTP

#define PORT_RTMPS PORT_HTTPS

#define PORT_GOPHER 70

#define PORT_MQTT 1883

struct curl_trc_featt;

#ifdef USE_ECH

/* CURLECH_ bits for the tls_ech option */

# define CURLECH_DISABLE    (1<<0)

# define CURLECH_GREASE     (1<<1)

# define CURLECH_ENABLE     (1<<2)

# define CURLECH_HARD       (1<<3)

# define CURLECH_CLA_CFG    (1<<4)

#endif

#ifndef CURL_DISABLE_WEBSOCKETS

/* CURLPROTO_GOPHERS (29) is the highest publicly used protocol bit number,

 * the rest are internal information. If we use higher bits we only do this on

 * platforms that have a >= 64-bit type and then we use such a type for the

 * protocol fields in the protocol handler.

 */

#define CURLPROTO_WS     (1<<30)

#define CURLPROTO_WSS    ((curl_prot_t)1<<31)

#else

#define CURLPROTO_WS 0

#define CURLPROTO_WSS 0

#endif

/* the default protocols accepting a redirect to */

#define CURLPROTO_REDIR (CURLPROTO_HTTP | CURLPROTO_HTTPS | CURLPROTO_FTP | \

                         CURLPROTO_FTPS)

/* This should be undefined once we need bit 32 or higher */

#define PROTO_TYPE_SMALL

#ifndef PROTO_TYPE_SMALL

typedef curl_off_t curl_prot_t;

#else

typedef unsigned int curl_prot_t;

#endif

/* This mask is for all the old protocols that are provided and defined in the

   public header and shall exclude protocols added since which are not exposed

   in the API */

#define CURLPROTO_MASK   (0x3ffffff)

#define CURL_DEFAULT_USER "anonymous"

#define CURL_DEFAULT_PASSWORD "ftp@example.com"

#if !defined(_WIN32) && !defined(MSDOS)

/* do FTP line-end CRLF => LF conversions on platforms that prefer LF-only. It

   also means: keep CRLF line endings on the CRLF platforms */

#define CURL_PREFER_LF_LINEENDS

#endif

/* Convenience defines for checking protocols or their SSL based version. Each

   protocol handler should only ever have a single CURLPROTO_ in its protocol

   field. */

#define PROTO_FAMILY_HTTP (CURLPROTO_HTTP|CURLPROTO_HTTPS|CURLPROTO_WS| \

                           CURLPROTO_WSS)

#define PROTO_FAMILY_FTP  (CURLPROTO_FTP|CURLPROTO_FTPS)

#define PROTO_FAMILY_POP3 (CURLPROTO_POP3|CURLPROTO_POP3S)

#define PROTO_FAMILY_SMB  (CURLPROTO_SMB|CURLPROTO_SMBS)

#define PROTO_FAMILY_SMTP (CURLPROTO_SMTP|CURLPROTO_SMTPS)

#define PROTO_FAMILY_SSH  (CURLPROTO_SCP|CURLPROTO_SFTP)

#if !defined(CURL_DISABLE_FTP) || defined(USE_SSH) ||   \

  !defined(CURL_DISABLE_POP3) || !defined(CURL_DISABLE_FILE)

/* these protocols support CURLOPT_DIRLISTONLY */

#define CURL_LIST_ONLY_PROTOCOL 1

#endif

#define DEFAULT_CONNCACHE_SIZE 5

/* length of longest IPv6 address string including the trailing null */

#define MAX_IPADR_LEN sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255")

/* Default FTP/IMAP etc response timeout in milliseconds */

#define RESP_TIMEOUT (120*1000)

/* Max string input length is a precaution against abuse and to detect junk

   input easier and better. */

#define CURL_MAX_INPUT_LENGTH 8000000

#include "cookie.h"

#include "psl.h"

#include "formdata.h"

#ifdef HAVE_NETINET_IN_H

#include <netinet/in.h>

#endif

#ifdef HAVE_NETINET_IN6_H

#include <netinet/in6.h>

#endif

#include "curlx/timeval.h"

#include <curl/curl.h>

#include "http_chunks.h" /* for the structs and enum stuff */

#include "hostip.h"

#include "hash.h"

#include "splay.h"

#include "curlx/dynbuf.h"

#include "dynhds.h"

#include "request.h"

#include "netrc.h"

/* On error return, the value of `pnwritten` has no meaning */

typedef CURLcode (Curl_send)(struct Curl_easy *data,   /* transfer */

                             int sockindex,            /* socketindex */

                             const void *buf,          /* data to write */

                             size_t len,               /* amount to send */

                             bool eos,                 /* last chunk */

                             size_t *pnwritten);       /* how much sent */

/* On error return, the value of `pnread` has no meaning */

typedef CURLcode (Curl_recv)(struct Curl_easy *data,   /* transfer */

                             int sockindex,            /* socketindex */

                             char *buf,                /* store data here */

                             size_t len,               /* max amount to read */

                             size_t *pnread);          /* how much received */

#include "mime.h"

#include "imap.h"

#include "smtp.h"

#include "ftp.h"

#include "file.h"

#include "vssh/ssh.h"

#include "http.h"

#include "rtsp.h"

#include "smb.h"

#include "mqtt.h"

#include "ftplistparser.h"

#include "multihandle.h"

#include "cf-socket.h"

#ifdef HAVE_GSSAPI

# ifdef HAVE_GSSGNU

#  include <gss.h>

# elif defined HAVE_GSSAPI_GSSAPI_H

#  include <gssapi/gssapi.h>

# else

#  include <gssapi.h>

# endif

# ifdef HAVE_GSSAPI_GSSAPI_GENERIC_H

#  include <gssapi/gssapi_generic.h>

# endif

#endif

#ifdef USE_LIBSSH2

#include <libssh2.h>

#include <libssh2_sftp.h>

#endif /* USE_LIBSSH2 */

#define READBUFFER_SIZE CURL_MAX_WRITE_SIZE

#define READBUFFER_MAX  CURL_MAX_READ_SIZE

#define READBUFFER_MIN  1024

/* The default upload buffer size, should not be smaller than

   CURL_MAX_WRITE_SIZE, as it needs to hold a full buffer as could be sent in

   a write callback.

   The size was 16KB for many years but was bumped to 64KB because it makes

   libcurl able to do significantly faster uploads in some circumstances. Even

   larger buffers can help further, but this is deemed a fair memory/speed

   compromise. */

#define UPLOADBUFFER_DEFAULT 65536

#define UPLOADBUFFER_MAX (2*1024*1024)

#define UPLOADBUFFER_MIN CURL_MAX_WRITE_SIZE

#define CURLEASY_MAGIC_NUMBER 0xc0dedbadU

#ifdef DEBUGBUILD

/* On a debug build, we want to fail hard on easy handles that

 * are not NULL, but no longer have the MAGIC touch. This gives

 * us early warning on things only discovered by valgrind otherwise. */

#define GOOD_EASY_HANDLE(x) \

  (((x) && ((x)->magic == CURLEASY_MAGIC_NUMBER))? TRUE: \

  (DEBUGASSERT(!(x)), FALSE))

#else

#define GOOD_EASY_HANDLE(x) \

  ((x) && ((x)->magic == CURLEASY_MAGIC_NUMBER))

#endif

#ifdef HAVE_GSSAPI

/* Types needed for krb5-ftp connections */

struct krb5buffer {

  struct dynbuf buf;

  size_t index;

  BIT(eof_flag);

};

enum protection_level {

  PROT_NONE, /* first in list */

  PROT_CLEAR,

  PROT_SAFE,

  PROT_CONFIDENTIAL,

  PROT_PRIVATE,

  PROT_CMD,

  PROT_LAST /* last in list */

};

#endif

/* SSL backend-specific data; declared differently by each SSL backend */

struct ssl_backend_data;

struct Curl_ssl_scache_entry;

struct ssl_primary_config {

  char *CApath;          /* certificate dir (does not work on Windows) */

  char *CAfile;          /* certificate to verify peer against */

  char *issuercert;      /* optional issuer certificate filename */

  char *clientcert;

  char *cipher_list;     /* list of ciphers to use */

  char *cipher_list13;   /* list of TLS 1.3 cipher suites to use */

  char *signature_algorithms; /* list of signature algorithms to use */

  char *pinned_key;

  char *CRLfile;         /* CRL to check certificate revocation */

  struct curl_blob *cert_blob;

  struct curl_blob *ca_info_blob;

  struct curl_blob *issuercert_blob;

#ifdef USE_TLS_SRP

  char *username; /* TLS username (for, e.g., SRP) */

  char *password; /* TLS password (for, e.g., SRP) */

#endif

  char *curves;          /* list of curves to use */

  unsigned int version_max; /* max supported version the client wants to use */

  unsigned char ssl_options;  /* the CURLOPT_SSL_OPTIONS bitmask */

  unsigned char version;    /* what version the client wants to use */

  BIT(verifypeer);       /* set TRUE if this is desired */

  BIT(verifyhost);       /* set TRUE if CN/SAN must match hostname */

  BIT(verifystatus);     /* set TRUE if certificate status must be checked */

  BIT(cache_session);    /* cache session or not */

};

struct ssl_config_data {

  struct ssl_primary_config primary;

  long certverifyresult; /* result from the certificate verification */

  curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */

  void *fsslctxp;        /* parameter for call back */

  char *cert_type; /* format for certificate (default: PEM)*/

  char *key; /* private key filename */

  struct curl_blob *key_blob;

  char *key_type; /* format for private key (default: PEM) */

  char *key_passwd; /* plain text private key password */

  BIT(certinfo);     /* gather lots of certificate info */

  BIT(earlydata);    /* use tls1.3 early data */

  BIT(enable_beast); /* allow this flaw for interoperability's sake */

  BIT(no_revoke);    /* disable SSL certificate revocation checks */

  BIT(no_partialchain); /* do not accept partial certificate chains */

  BIT(revoke_best_effort); /* ignore SSL revocation offline/missing revocation

                              list errors */

  BIT(native_ca_store); /* use the native ca store of operating system */

  BIT(auto_client_cert);   /* automatically locate and use a client

                              certificate for authentication (Schannel) */

};

struct ssl_general_config {

  int ca_cache_timeout;  /* Certificate store cache timeout (seconds) */

};

#ifdef USE_WINDOWS_SSPI

#include "curl_sspi.h"

#endif

#ifndef CURL_DISABLE_DIGEST_AUTH

/* Struct used for Digest challenge-response authentication */

struct digestdata {

#if defined(USE_WINDOWS_SSPI)

  BYTE *input_token;

  size_t input_token_len;

  CtxtHandle *http_context;

  /* copy of user/passwd used to make the identity for http_context.

     either may be NULL. */

  char *user;

  char *passwd;

#else

  char *nonce;

  char *cnonce;

  char *realm;

  char *opaque;

  char *qop;

  char *algorithm;

  int nc; /* nonce count */

  unsigned char algo;

  BIT(stale); /* set true for re-negotiation */

  BIT(userhash);

#endif

};

#endif

typedef enum {

  NTLMSTATE_NONE,

  NTLMSTATE_TYPE1,

  NTLMSTATE_TYPE2,

  NTLMSTATE_TYPE3,

  NTLMSTATE_LAST

} curlntlm;

typedef enum {

  GSS_AUTHNONE,

  GSS_AUTHRECV,

  GSS_AUTHSENT,

  GSS_AUTHDONE,

  GSS_AUTHSUCC

} curlnegotiate;

#ifdef CURL_DISABLE_PROXY

#define CONN_IS_PROXIED(x) 0

#else

#define CONN_IS_PROXIED(x) x->bits.proxy

#endif

/*

 * Boolean values that concerns this connection.

 */

struct ConnectBits {

#ifndef CURL_DISABLE_PROXY

  BIT(httpproxy);  /* if set, this transfer is done through an HTTP proxy */

  BIT(socksproxy); /* if set, this transfer is done through a socks proxy */

  BIT(proxy_user_passwd); /* user+password for the proxy? */

  BIT(tunnel_proxy);  /* if CONNECT is used to "tunnel" through the proxy.

                         This is implicit when SSL-protocols are used through

                         proxies, but can also be enabled explicitly by

                         apps */

  BIT(proxy); /* if set, this transfer is done through a proxy - any type */

#endif

  /* always modify bits.close with the connclose() and connkeep() macros! */

  BIT(close); /* if set, we close the connection after this request */

  BIT(reuse); /* if set, this is a reused connection */

  BIT(altused); /* this is an alt-svc "redirect" */

  BIT(conn_to_host); /* if set, this connection has a "connect to host"

                        that overrides the host in the URL */

  BIT(conn_to_port); /* if set, this connection has a "connect to port"

                        that overrides the port in the URL (remote port) */

  BIT(ipv6_ip); /* we communicate with a remote site specified with pure IPv6

                   IP address */

  BIT(ipv6);    /* we communicate with a site using an IPv6 address */

  BIT(do_more); /* this is set TRUE if the ->curl_do_more() function is

                   supposed to be called, after ->curl_do() */

  BIT(protoconnstart);/* the protocol layer has STARTED its operation after

                         the TCP layer connect */

  BIT(retry);         /* this connection is about to get closed and then

                         re-attempted at another connection. */

#ifndef CURL_DISABLE_FTP

  BIT(ftp_use_epsv);  /* As set with CURLOPT_FTP_USE_EPSV, but if we find out

                         EPSV does not work we disable it for the forthcoming

                         requests */

  BIT(ftp_use_eprt);  /* As set with CURLOPT_FTP_USE_EPRT, but if we find out

                         EPRT does not work we disable it for the forthcoming

                         requests */

  BIT(ftp_use_data_ssl); /* Enabled SSL for the data connection */

  BIT(ftp_use_control_ssl); /* Enabled SSL for the control connection */

#endif

#ifndef CURL_DISABLE_NETRC

  BIT(netrc);         /* name+password provided by netrc */

#endif

  BIT(bound); /* set true if bind() has already been done on this socket/

                 connection */

  BIT(asks_multiplex); /* connection asks for multiplexing, but is not yet */

  BIT(multiplex); /* connection is multiplexed */

  BIT(tcp_fastopen); /* use TCP Fast Open */

  BIT(tls_enable_alpn); /* TLS ALPN extension? */

#ifndef CURL_DISABLE_DOH

  BIT(doh);

#endif

#ifdef USE_UNIX_SOCKETS

  BIT(abstract_unix_socket);

#endif

  BIT(sock_accepted); /* TRUE if the SECONDARYSOCKET was created with

                         accept() */

  BIT(parallel_connect); /* set TRUE when a parallel connect attempt has

                            started (happy eyeballs) */

  BIT(aborted); /* connection was aborted, e.g. in unclean state */

  BIT(shutdown_handler); /* connection shutdown: handler shut down */

  BIT(shutdown_filters); /* connection shutdown: filters shut down */

  BIT(in_cpool);     /* connection is kept in a connection pool */

};

struct hostname {

  char *rawalloc; /* allocated "raw" version of the name */

  char *encalloc; /* allocated IDN-encoded version of the name */

  char *name;     /* name to use internally, might be encoded, might be raw */

  const char *dispname; /* name to display, as 'name' might be encoded */

};

/*

 * Flags on the keepon member of the Curl_transfer_keeper

 */

#define KEEP_NONE  0

#define KEEP_RECV  (1<<0)     /* there is or may be data to read */

#define KEEP_SEND (1<<1)     /* there is or may be data to write */

#define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there

                                 might still be data to read */

#define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there

                                  might still be data to write */

#define KEEP_RECV_PAUSE (1<<4) /* reading is paused */

#define KEEP_SEND_PAUSE (1<<5) /* writing is paused */

/* KEEP_SEND_TIMED is set when the transfer should attempt sending

 * at timer (or other) events. A transfer waiting on a timer will

  * remove KEEP_SEND to suppress POLLOUTs of the connection.

  * Adding KEEP_SEND_TIMED will then attempt to send whenever the transfer

  * enters the "readwrite" loop, e.g. when a timer fires.

  * This is used in HTTP for 'Expect: 100-continue' waiting. */

#define KEEP_SEND_TIMED (1<<6)

#define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)

#define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)

/* transfer wants to send is not PAUSE or HOLD */

#define CURL_WANT_SEND(data) \

  (((data)->req.keepon & KEEP_SENDBITS) == KEEP_SEND)

/* transfer receive is not on PAUSE or HOLD */

#define CURL_WANT_RECV(data) \

  (((data)->req.keepon & KEEP_RECVBITS) == KEEP_RECV)

#define FIRSTSOCKET     0

#define SECONDARYSOCKET 1

/* Polling requested by an easy handle.

 * `action` is CURL_POLL_IN, CURL_POLL_OUT or CURL_POLL_INOUT.

 */

struct easy_pollset {

  curl_socket_t sockets[MAX_SOCKSPEREASYHANDLE];

  unsigned int num;

  unsigned char actions[MAX_SOCKSPEREASYHANDLE];

};

/*

 * Specific protocol handler.

 */

struct Curl_handler {

  const char *scheme;        /* URL scheme name in lowercase */

  /* Complement to setup_connection_internals(). This is done before the

     transfer "owns" the connection. */

  CURLcode (*setup_connection)(struct Curl_easy *data,

                               struct connectdata *conn);

  /* These two functions MUST be set to be protocol dependent */

  CURLcode (*do_it)(struct Curl_easy *data, bool *done);

  CURLcode (*done)(struct Curl_easy *, CURLcode, bool);

  /* If the curl_do() function is better made in two halves, this

   * curl_do_more() function will be called afterwards, if set. For example

   * for doing the FTP stuff after the PASV/PORT command.

   */

  CURLcode (*do_more)(struct Curl_easy *, int *);

  /* This function *MAY* be set to a protocol-dependent function that is run

   * after the connect() and everything is done, as a step in the connection.

   * The 'done' pointer points to a bool that should be set to TRUE if the

   * function completes before return. If it does not complete, the caller

   * should call the ->connecting() function until it is.

   */

  CURLcode (*connect_it)(struct Curl_easy *data, bool *done);

  /* See above. */

  CURLcode (*connecting)(struct Curl_easy *data, bool *done);

  CURLcode (*doing)(struct Curl_easy *data, bool *done);

  /* Called from the multi interface during the PROTOCONNECT phase, and it

     should then return a proper fd set */

  int (*proto_getsock)(struct Curl_easy *data,

                       struct connectdata *conn, curl_socket_t *socks);

  /* Called from the multi interface during the DOING phase, and it should

     then return a proper fd set */

  int (*doing_getsock)(struct Curl_easy *data,

                       struct connectdata *conn, curl_socket_t *socks);

  /* Called from the multi interface during the DO_MORE phase, and it should

     then return a proper fd set */

  int (*domore_getsock)(struct Curl_easy *data,

                        struct connectdata *conn, curl_socket_t *socks);

  /* Called from the multi interface during the DO_DONE, PERFORM and

     WAITPERFORM phases, and it should then return a proper fd set. Not setting

     this will make libcurl use the generic default one. */

  int (*perform_getsock)(struct Curl_easy *data,

                         struct connectdata *conn, curl_socket_t *socks);

  /* This function *MAY* be set to a protocol-dependent function that is run

   * by the curl_disconnect(), as a step in the disconnection. If the handler

   * is called because the connection has been considered dead,

   * dead_connection is set to TRUE. The connection is (again) associated with

   * the transfer here.

   */

  CURLcode (*disconnect)(struct Curl_easy *, struct connectdata *,

                         bool dead_connection);

  /* If used, this function gets called from transfer.c to

     allow the protocol to do extra handling in writing response to

     the client. */

  CURLcode (*write_resp)(struct Curl_easy *data, const char *buf, size_t blen,

                         bool is_eos);

  /* If used, this function gets called from transfer.c to

     allow the protocol to do extra handling in writing a single response

     header line to the client. */

  CURLcode (*write_resp_hd)(struct Curl_easy *data,

                            const char *hd, size_t hdlen, bool is_eos);

  /* This function can perform various checks on the connection. See

     CONNCHECK_* for more information about the checks that can be performed,

     and CONNRESULT_* for the results that can be returned. */

  unsigned int (*connection_check)(struct Curl_easy *data,

                                   struct connectdata *conn,

                                   unsigned int checks_to_perform);

  /* attach() attaches this transfer to this connection */

  void (*attach)(struct Curl_easy *data, struct connectdata *conn);

  /* return CURLE_OK if a redirect to `newurl` should be followed,

     CURLE_TOO_MANY_REDIRECTS otherwise. May alter `data` to change

     the way the follow request is performed. */

  CURLcode (*follow)(struct Curl_easy *data, const char *newurl,

                     followtype type);

  int defport;            /* Default port. */

  curl_prot_t protocol;  /* See CURLPROTO_* - this needs to be the single

                            specific protocol bit */

  curl_prot_t family;    /* single bit for protocol family; basically the

                            non-TLS name of the protocol this is */

  unsigned int flags;     /* Extra particular characteristics, see PROTOPT_* */

};

#define PROTOPT_NONE 0             /* nothing extra */

#define PROTOPT_SSL (1<<0)         /* uses SSL */

#define PROTOPT_DUAL (1<<1)        /* this protocol uses two connections */

#define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */

/* some protocols will have to call the underlying functions without regard to

   what exact state the socket signals. IE even if the socket says "readable",

   the send function might need to be called while uploading, or vice versa.

*/

#define PROTOPT_DIRLOCK (1<<3)

#define PROTOPT_NONETWORK (1<<4)   /* protocol does not use the network! */

#define PROTOPT_NEEDSPWD (1<<5)    /* needs a password, and if none is set it

                                      gets a default */

#define PROTOPT_NOURLQUERY (1<<6)   /* protocol cannot handle

                                       URL query strings (?foo=bar) ! */

#define PROTOPT_CREDSPERREQUEST (1<<7) /* requires login credentials per

                                          request instead of per connection */

#define PROTOPT_ALPN (1<<8) /* set ALPN for this */

/* (1<<9) was PROTOPT_STREAM, now free */

#define PROTOPT_URLOPTIONS (1<<10) /* allow options part in the userinfo field

                                      of the URL */

#define PROTOPT_PROXY_AS_HTTP (1<<11) /* allow this non-HTTP scheme over a

                                         HTTP proxy as HTTP proxies may know

                                         this protocol and act as a gateway */

#define PROTOPT_WILDCARD (1<<12) /* protocol supports wildcard matching */

#define PROTOPT_USERPWDCTRL (1<<13) /* Allow "control bytes" (< 32 ASCII) in

                                       username and password */

#define PROTOPT_NOTCPPROXY (1<<14) /* this protocol cannot proxy over TCP */

#define CONNCHECK_NONE 0                 /* No checks */

#define CONNCHECK_ISDEAD (1<<0)          /* Check if the connection is dead. */

#define CONNCHECK_KEEPALIVE (1<<1)       /* Perform any keepalive function. */

#define CONNRESULT_NONE 0                /* No extra information. */

#define CONNRESULT_DEAD (1<<0)           /* The connection is dead. */

struct ip_quadruple {

  char remote_ip[MAX_IPADR_LEN];

  char local_ip[MAX_IPADR_LEN];

  int remote_port;

  int local_port;

};

struct proxy_info {

  struct hostname host;

  int port;

  unsigned char proxytype; /* curl_proxytype: what kind of proxy that is in

                              use */

  char *user;    /* proxy username string, allocated */

  char *passwd;  /* proxy password string, allocated */

};

#define TRNSPRT_TCP 3

#define TRNSPRT_UDP 4

#define TRNSPRT_QUIC 5

#define TRNSPRT_UNIX 6

/*

 * The connectdata struct contains all fields and variables that should be

 * unique for an entire connection.

 */

struct connectdata {

  struct Curl_llist_node cpool_node; /* conncache lists */

  struct Curl_llist_node cshutdn_node; /* cshutdn list */

  curl_closesocket_callback fclosesocket; /* function closing the socket(s) */

  void *closesocket_client;

  /* This is used by the connection pool logic. If this returns TRUE, this

     handle is still used by one or more easy handles and can only used by any

     other easy handle without careful consideration (== only for

     multiplexing) and it cannot be used by another multi handle! */

#define CONN_INUSE(c) (!Curl_uint_spbset_empty(&(c)->xfers_attached))

#define CONN_ATTACHED(c) Curl_uint_spbset_count(&(c)->xfers_attached)

  /**** Fields set when inited and not modified again */

  curl_off_t connection_id; /* Contains a unique number to make it easier to

                               track the connections in the log output */

  char *destination; /* string carrying normalized hostname+port+scope */

  /* `meta_hash` is a general key-value store for implementations

   * with the lifetime of the connection.

   * Elements need to be added with their own destructor to be invoked when

   * the connection is cleaned up (see Curl_hash_add2()).*/

  struct Curl_hash meta_hash;

  struct hostname host;

  char *hostname_resolve; /* hostname to resolve to address, allocated */

  char *secondaryhostname; /* secondary socket hostname (ftp) */

  struct hostname conn_to_host; /* the host to connect to. valid only if

                                   bits.conn_to_host is set */

#ifndef CURL_DISABLE_PROXY

  struct proxy_info socks_proxy;

  struct proxy_info http_proxy;

#endif

  /* 'primary' and 'secondary' get filled with IP quadruple

     (local/remote numerical ip address and port) whenever a connect is

     *attempted*.

     When more than one address is tried for a connection these will hold data

     for the last attempt. When the connection is actually established

     these are updated with data which comes directly from the socket. */

  struct ip_quadruple primary;

  struct ip_quadruple secondary;

  char *user;    /* username string, allocated */

  char *passwd;  /* password string, allocated */

  char *options; /* options string, allocated */

  char *sasl_authzid;     /* authorization identity string, allocated */

  char *oauth_bearer; /* OAUTH2 bearer, allocated */

  struct curltime created; /* creation time */

  struct curltime lastused; /* when returned to the connection poolas idle */

  curl_socket_t sock[2]; /* two sockets, the second is used for the data

                            transfer when doing FTP */

  Curl_recv *recv[2];

  Curl_send *send[2];

  struct Curl_cfilter *cfilter[2]; /* connection filters */

  struct {

    struct curltime start[2]; /* when filter shutdown started */

    timediff_t timeout_ms; /* 0 means no timeout */

  } shutdown;

  struct ssl_primary_config ssl_config;

#ifndef CURL_DISABLE_PROXY

  struct ssl_primary_config proxy_ssl_config;

#endif

  struct ConnectBits bits;    /* various state-flags for this connection */

  const struct Curl_handler *handler; /* Connection's protocol handler */

  const struct Curl_handler *given;   /* The protocol first given */

  /* Protocols can use a custom keepalive mechanism to keep connections alive.

     This allows those protocols to track the last time the keepalive mechanism

     was used on this connection. */

  struct curltime keepalive;

  /**** curl_get() phase fields */

  curl_socket_t sockfd;   /* socket to read from or CURL_SOCKET_BAD */

  curl_socket_t writesockfd; /* socket to write to, it may be the same we read

                                from. CURL_SOCKET_BAD disables */

#ifdef HAVE_GSSAPI

  BIT(sec_complete); /* if Kerberos is enabled for this connection */

  unsigned char command_prot; /* enum protection_level */

  unsigned char data_prot; /* enum protection_level */

  unsigned char request_data_prot; /* enum protection_level */

  size_t buffer_size;

  struct krb5buffer in_buffer;

  void *app_data;

  const struct Curl_sec_client_mech *mech;

  struct sockaddr_in local_addr;

#endif

  struct uint_spbset xfers_attached; /* mids of attached transfers */

  /* A connection cache from a SHARE might be used in several multi handles.

   * We MUST not reuse connections that are running in another multi,

   * for concurrency reasons. That multi might run in another thread.

   * `attached_multi` is set by the first transfer attached and cleared

   * when the last one is detached.

   * NEVER call anything on this multi, just check for equality. */

  struct Curl_multi *attached_multi;

  /*************** Request - specific items ************/

#if defined(USE_WINDOWS_SSPI) && defined(SECPKG_ATTR_ENDPOINT_BINDINGS)

  CtxtHandle *sslContext;

#endif

#if defined(USE_NTLM)

  curlntlm http_ntlm_state;

  curlntlm proxy_ntlm_state;

#endif

#ifdef USE_SPNEGO

  curlnegotiate http_negotiate_state;

  curlnegotiate proxy_negotiate_state;

#endif

#ifdef USE_UNIX_SOCKETS

  char *unix_domain_socket;

#endif

  /* When this connection is created, store the conditions for the local end

     bind. This is stored before the actual bind and before any connection is

     made and will serve the purpose of being used for comparison reasons so

     that subsequent bound-requested connections are not accidentally reusing

     wrong connections. */

  char *localdev;

  unsigned short localportrange;

  int waitfor;      /* current READ/WRITE bits to wait for */

#if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)

  int socks5_gssapi_enctype;

#endif

  /* The field below gets set in connect.c:connecthost() */

  int remote_port; /* the remote port, not the proxy port! */

  int conn_to_port; /* the remote port to connect to. valid only if

                       bits.conn_to_port is set */

#ifdef USE_IPV6

  unsigned int scope_id;  /* Scope id for IPv6 */

#endif

  unsigned short localport;

  unsigned short secondary_port; /* secondary socket remote port to connect to

                                    (ftp) */

  unsigned char alpn; /* APLN TLS negotiated protocol, a CURL_HTTP_VERSION*

                         value */

#ifndef CURL_DISABLE_PROXY

  unsigned char proxy_alpn; /* APLN of proxy tunnel, CURL_HTTP_VERSION* */

#endif

  unsigned char transport; /* one of the TRNSPRT_* defines */

  unsigned char ip_version; /* copied from the Curl_easy at creation time */

  /* HTTP version last responded with by the server.

   * 0 at start, then one of 09, 10, 11, etc. */

  unsigned char httpversion_seen;

  unsigned char connect_only;

  unsigned char gssapi_delegation; /* inherited from set.gssapi_delegation */

};

#ifndef CURL_DISABLE_PROXY

#define CURL_CONN_HOST_DISPNAME(c) \

          ((c)->bits.socksproxy ? (c)->socks_proxy.host.dispname : \

            (c)->bits.httpproxy ? (c)->http_proxy.host.dispname : \

              (c)->bits.conn_to_host ? (c)->conn_to_host.dispname : \

                (c)->host.dispname)

#else

#define CURL_CONN_HOST_DISPNAME(c) \

          (c)->bits.conn_to_host ? (c)->conn_to_host.dispname : \

            (c)->host.dispname

#endif

/* The end of connectdata. */

/*

 * Struct to keep statistical and informational data.

 * All variables in this struct must be initialized/reset in Curl_initinfo().

 */

struct PureInfo {

  int httpcode;  /* Recent HTTP, FTP, RTSP or SMTP response code */

  int httpproxycode; /* response code from proxy when received separate */

  int httpversion; /* the http version number X.Y = X*10+Y */

  time_t filetime; /* If requested, this is might get set. Set to -1 if the

                      time was unretrievable. */

  curl_off_t request_size; /* the amount of bytes sent in the request(s) */

  unsigned long proxyauthavail; /* what proxy auth types were announced */

  unsigned long httpauthavail;  /* what host auth types were announced */

  unsigned long proxyauthpicked; /* selected proxy auth type */

  unsigned long httpauthpicked;  /* selected host auth type */

  long numconnects; /* how many new connection did libcurl created */

  char *contenttype; /* the content type of the object */

  char *wouldredirect; /* URL this would have been redirected to if asked to */

  curl_off_t retry_after; /* info from Retry-After: header */

  unsigned int header_size;  /* size of read header(s) in bytes */

  /* PureInfo primary ip_quadruple is copied over from the connectdata

     struct in order to allow curl_easy_getinfo() to return this information

     even when the session handle is no longer associated with a connection,

     and also allow curl_easy_reset() to clear this information from the

     session handle without disturbing information which is still alive, and

     that might be reused, in the connection pool. */

  struct ip_quadruple primary;

  int conn_remote_port;  /* this is the "remote port", which is the port

                            number of the used URL, independent of proxy or

                            not */

  const char *conn_scheme;

  unsigned int conn_protocol;

  struct curl_certinfo certs; /* info about the certs. Asked for with

                                 CURLOPT_CERTINFO / CURLINFO_CERTINFO */

  CURLproxycode pxcode;

  BIT(timecond);  /* set to TRUE if the time condition did not match, which

                     thus made the document NOT get fetched */

  BIT(used_proxy); /* the transfer used a proxy */

};

struct pgrs_measure {

  struct curltime start; /* when measure started */

  curl_off_t start_size; /* the 'cur_size' the measure started at */

};

struct pgrs_dir {

  curl_off_t total_size; /* total expected bytes */

  curl_off_t cur_size; /* transferred bytes so far */

  curl_off_t speed; /* bytes per second transferred */

  struct pgrs_measure limit;

};

struct Progress {

  time_t lastshow; /* time() of the last displayed progress meter or NULL to

                      force redraw at next call */

  struct pgrs_dir ul;

  struct pgrs_dir dl;

  curl_off_t current_speed; /* uses the currently fastest transfer */

  curl_off_t earlydata_sent;

  timediff_t timespent;

  timediff_t t_postqueue;

  timediff_t t_nslookup;

  timediff_t t_connect;

  timediff_t t_appconnect;

  timediff_t t_pretransfer;

  timediff_t t_posttransfer;

  timediff_t t_starttransfer;

  timediff_t t_redirect;

  struct curltime start;

  struct curltime t_startsingle;

  struct curltime t_startop;

  struct curltime t_startqueue;

  struct curltime t_acceptdata;

#define CURR_TIME (5 + 1) /* 6 entries for 5 seconds */

  curl_off_t speeder[ CURR_TIME ];

  struct curltime speeder_time[ CURR_TIME ];

  unsigned char speeder_c;

  BIT(hide);

  BIT(ul_size_known);

  BIT(dl_size_known);

  BIT(headers_out); /* when the headers have been written */

  BIT(callback);  /* set when progress callback is used */

  BIT(is_t_startransfer_set);

};

typedef enum {

    RTSPREQ_NONE, /* first in list */

    RTSPREQ_OPTIONS,

    RTSPREQ_DESCRIBE,

    RTSPREQ_ANNOUNCE,

    RTSPREQ_SETUP,

    RTSPREQ_PLAY,

    RTSPREQ_PAUSE,

    RTSPREQ_TEARDOWN,

    RTSPREQ_GET_PARAMETER,

    RTSPREQ_SET_PARAMETER,

    RTSPREQ_RECORD,

    RTSPREQ_RECEIVE,

    RTSPREQ_LAST /* last in list */

} Curl_RtspReq;

struct auth {

  unsigned long want;  /* Bitmask set to the authentication methods wanted by

                          app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */

  unsigned long picked;

  unsigned long avail; /* Bitmask for what the server reports to support for

                          this resource */

  BIT(done);  /* TRUE when the auth phase is done and ready to do the

                 actual request */

  BIT(multipass); /* TRUE if this is not yet authenticated but within the

                     auth multipass negotiation */

  BIT(iestyle); /* TRUE if digest should be done IE-style or FALSE if it

                   should be RFC compliant */

};

#ifdef USE_NGHTTP2

struct Curl_data_prio_node {

  struct Curl_data_prio_node *next;

  struct Curl_easy *data;

};

#endif

/**

 * Priority information for an easy handle in relation to others

 * on the same connection.

 */

struct Curl_data_priority {

#ifdef USE_NGHTTP2

  /* tree like dependencies only implemented in nghttp2 */

  struct Curl_easy *parent;

  struct Curl_data_prio_node *children;

#endif

  int weight;

#ifdef USE_NGHTTP2

  BIT(exclusive);

#endif

};

/* Timers */

typedef enum {

  EXPIRE_100_TIMEOUT,

  EXPIRE_ASYNC_NAME,

  EXPIRE_CONNECTTIMEOUT,

  EXPIRE_DNS_PER_NAME, /* family1 */

  EXPIRE_DNS_PER_NAME2, /* family2 */

  EXPIRE_HAPPY_EYEBALLS_DNS, /* See asyn-ares.c */

  EXPIRE_HAPPY_EYEBALLS,

  EXPIRE_MULTI_PENDING,

  EXPIRE_RUN_NOW,

  EXPIRE_SPEEDCHECK,

  EXPIRE_TIMEOUT,

  EXPIRE_TOOFAST,

  EXPIRE_QUIC,

  EXPIRE_FTP_ACCEPT,

  EXPIRE_ALPN_EYEBALLS,

  EXPIRE_SHUTDOWN,

  EXPIRE_LAST /* not an actual timer, used as a marker only */

} expire_id;

typedef enum {

  TRAILERS_NONE,

  TRAILERS_INITIALIZED,

  TRAILERS_SENDING,

  TRAILERS_DONE

} trailers_state;

/*

 * One instance for each timeout an easy handle can set.

 */

struct time_node {

  struct Curl_llist_node list;

  struct curltime time;

  expire_id eid;

};

/* individual pieces of the URL */

struct urlpieces {

  char *scheme;

  char *hostname;

  char *port;

  char *user;

  char *password;

  char *options;

  char *path;

  char *query;

};

#define CREDS_NONE   0

#define CREDS_URL    1 /* from URL */

#define CREDS_OPTION 2 /* set with a CURLOPT_ */

#define CREDS_NETRC  3 /* found in netrc */

struct UrlState {

  /* buffers to store authentication data in, as parsed from input options */

  struct curltime keeps_speed; /* for the progress meter really */

  curl_off_t lastconnect_id; /* The last connection, -1 if undefined */

  curl_off_t recent_conn_id; /* The most recent connection used, might no

                              * longer exist */

  struct dynbuf headerb; /* buffer to store headers in */

  struct curl_slist *hstslist; /* list of HSTS files set by

                                  curl_easy_setopt(HSTS) calls */

  curl_off_t current_speed;  /* the ProgressShow() function sets this,

                                bytes / second */

  /* hostname, port number and protocol of the first (not followed) request.

     if set, this should be the hostname that we will sent authorization to,

     no else. Used to make Location: following not keep sending user+password.

     This is strdup()ed data. */

  char *first_host;

  int first_remote_port;

  curl_prot_t first_remote_protocol;

  int retrycount; /* number of retries on a new connection */

  int os_errno;  /* filled in with errno whenever an error occurs */

  long followlocation; /* redirect counter */

  int requests; /* request counter: redirects + authentication retakes */

#ifdef HAVE_SIGNAL

  /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */

  void (*prev_signal)(int sig);

#endif

#ifndef CURL_DISABLE_DIGEST_AUTH

  struct digestdata digest;      /* state data for host Digest auth */

  struct digestdata proxydigest; /* state data for proxy Digest auth */

#endif

  struct auth authhost;  /* auth details for host */

  struct auth authproxy; /* auth details for proxy */

  struct Curl_dns_entry *dns[2]; /* DNS to connect FIRST/SECONDARY */

#ifdef USE_CURL_ASYNC

  struct Curl_async async;  /* asynchronous name resolver data */

#endif

#if defined(USE_OPENSSL)

  /* void instead of ENGINE to avoid bleeding OpenSSL into this header */

  void *engine;

  /* void instead of OSSL_PROVIDER */

  void *provider;

  void *baseprov;

  void *libctx;

  char *propq; /* for a provider */

  BIT(provider_loaded);

#endif /* USE_OPENSSL */

  struct curltime expiretime; /* set this with Curl_expire() only */

  struct Curl_tree timenode; /* for the splay stuff */

  struct Curl_llist timeoutlist; /* list of pending timeouts */

  struct time_node expires[EXPIRE_LAST]; /* nodes for each expire type */

  /* a place to store the most recently set (S)FTP entrypath */

  char *most_recent_ftp_entrypath;

  char *range; /* range, if used. See README for detailed specification on

                  this syntax. */

  curl_off_t resume_from; /* continue [ftp] transfer from here */

#ifndef CURL_DISABLE_RTSP

  /* This RTSP state information survives requests and connections */

  long rtsp_next_client_CSeq; /* the session's next client CSeq */

  long rtsp_next_server_CSeq; /* the session's next server CSeq */

  long rtsp_CSeq_recv; /* most recent CSeq received */

  unsigned char rtp_channel_mask[32]; /* for the correctness checking of the

                                         interleaved data */

#endif

  curl_off_t infilesize; /* size of file to upload, -1 means unknown.

                            Copied from set.filesize at start of operation */

#if defined(USE_HTTP2) || defined(USE_HTTP3)

  struct Curl_data_priority priority; /* shallow copy of data->set */

#endif

  curl_read_callback fread_func; /* read callback/function */

  void *in;                      /* CURLOPT_READDATA */

  CURLU *uh; /* URL handle for the current parsed URL */

  struct urlpieces up;

  char *url;        /* work URL, copied from UserDefined */

  char *referer;    /* referer string */

  struct curl_slist *resolve; /* set to point to the set.resolve list when

                                 this should be dealt with in pretransfer */

#ifndef CURL_DISABLE_HTTP

  curl_mimepart *mimepost;

#ifndef CURL_DISABLE_FORM_API

  curl_mimepart *formp; /* storage for old API form-posting, allocated on

                           demand */

#endif

  size_t trailers_bytes_sent;

  struct dynbuf trailers_buf; /* a buffer containing the compiled trailing

                                 headers */

  struct Curl_llist httphdrs; /* received headers */

  struct curl_header headerout[2]; /* for external purposes */

  struct Curl_header_store *prevhead; /* the latest added header */

  trailers_state trailers_state; /* whether we are sending trailers

                                    and what stage are we at */

#endif

#ifndef CURL_DISABLE_COOKIES

  struct curl_slist *cookielist; /* list of cookie files set by

                                    curl_easy_setopt(COOKIEFILE) calls */

#endif