src/tool_cfgable.h

   1 #ifndef HEADER_CURL_TOOL_CFGABLE_H
   2 #define HEADER_CURL_TOOL_CFGABLE_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 1998 - 2018, 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.haxx.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  ***************************************************************************/
  24 #include "tool_setup.h"
  25
  26 #include "tool_sdecls.h"
  27
  28 #include "tool_metalink.h"
  29
  30 typedef enum {
  31   ERR_NONE,
  32   ERR_BINARY_TERMINAL = 1, /* binary to terminal detected */
  33   ERR_LAST
  34 } curl_error;
  35
  36 struct GlobalConfig;
  37
  38 struct OperationConfig {
  39   CURL *easy;               /* A copy of the handle from GlobalConfig */
  40   bool remote_time;
  41   char *random_file;
  42   char *egd_file;
  43   char *useragent;
  44   char *cookie;             /* single line with specified cookies */
  45   char *cookiejar;          /* write to this file */
  46   char *cookiefile;         /* read from this file */
  47   bool cookiesession;       /* new session? */
  48   bool encoding;            /* Accept-Encoding please */
  49   bool tr_encoding;         /* Transfer-Encoding please */
  50   unsigned long authtype;   /* auth bitmask */
  51   bool use_resume;
  52   bool resume_from_current;
  53   bool disable_epsv;
  54   bool disable_eprt;
  55   bool ftp_pret;
  56   long proto;
  57   bool proto_present;
  58   long proto_redir;
  59   bool proto_redir_present;
  60   char *proto_default;
  61   curl_off_t resume_from;
  62   char *postfields;
  63   curl_off_t postfieldsize;
  64   char *referer;
  65   double timeout;
  66   double connecttimeout;
  67   long maxredirs;
  68   curl_off_t max_filesize;
  69   char *headerfile;
  70   char *ftpport;
  71   char *iface;
  72   int localport;
  73   int localportrange;
  74   unsigned short porttouse;
  75   char *range;
  76   long low_speed_limit;
  77   long low_speed_time;
  78   char *dns_servers;   /* dot notation: 1.1.1.1;2.2.2.2 */
  79   char *dns_interface; /* interface name */
  80   char *dns_ipv4_addr; /* dot notation */
  81   char *dns_ipv6_addr; /* dot notation */
  82   char *userpwd;
  83   char *login_options;
  84   char *tls_username;
  85   char *tls_password;
  86   char *tls_authtype;
  87   char *proxy_tls_username;
  88   char *proxy_tls_password;
  89   char *proxy_tls_authtype;
  90   char *proxyuserpwd;
  91   char *proxy;
  92   int proxyver;             /* set to CURLPROXY_HTTP* define */
  93   char *noproxy;
  94   char *mail_from;
  95   struct curl_slist *mail_rcpt;
  96   char *mail_auth;
  97   bool sasl_ir;             /* Enable/disable SASL initial response */
  98   bool proxytunnel;
  99   bool ftp_append;          /* APPE on ftp */
 100   bool use_ascii;           /* select ascii or text transfer */
 101   bool autoreferer;         /* automatically set referer */
 102   bool failonerror;         /* fail on (HTTP) errors */
 103   bool include_headers;     /* send headers to data output */
 104   bool no_body;             /* don't get the body */
 105   bool dirlistonly;         /* only get the FTP dir list */
 106   bool followlocation;      /* follow http redirects */
 107   bool unrestricted_auth;   /* Continue to send authentication (user+password)
 108                                when following ocations, even when hostname
 109                                changed */
 110   bool netrc_opt;
 111   bool netrc;
 112   char *netrc_file;
 113   struct getout *url_list;  /* point to the first node */
 114   struct getout *url_last;  /* point to the last/current node */
 115   struct getout *url_get;   /* point to the node to fill in URL */
 116   struct getout *url_out;   /* point to the node to fill in outfile */
 117   struct getout *url_ul;    /* point to the node to fill in upload */
 118   char *cipher_list;
 119   char *proxy_cipher_list;
 120   char *cert;
 121   char *proxy_cert;
 122   char *cert_type;
 123   char *proxy_cert_type;
 124   char *cacert;
 125   char *proxy_cacert;
 126   char *capath;
 127   char *proxy_capath;
 128   char *crlfile;
 129   char *proxy_crlfile;
 130   char *pinnedpubkey;
 131   char *proxy_pinnedpubkey;
 132   char *key;
 133   char *proxy_key;
 134   char *key_type;
 135   char *proxy_key_type;
 136   char *key_passwd;
 137   char *proxy_key_passwd;
 138   char *pubkey;
 139   char *hostpubmd5;
 140   char *engine;
 141   bool crlf;
 142   char *customrequest;
 143   char *krblevel;
 144   char *request_target;
 145   long httpversion;
 146   bool nobuffer;
 147   bool readbusy;            /* set when reading input returns EAGAIN */
 148   bool globoff;
 149   bool use_httpget;
 150   bool insecure_ok;         /* set TRUE to allow insecure SSL connects */
 151   bool proxy_insecure_ok;   /* set TRUE to allow insecure SSL connects
 152                                for proxy */
 153   bool terminal_binary_ok;
 154   bool verifystatus;
 155   bool create_dirs;
 156   bool ftp_create_dirs;
 157   bool ftp_skip_ip;
 158   bool proxynegotiate;
 159   bool proxyntlm;
 160   bool proxydigest;
 161   bool proxybasic;
 162   bool proxyanyauth;
 163   char *writeout;           /* %-styled format string to output */
 164   struct curl_slist *quote;
 165   struct curl_slist *postquote;
 166   struct curl_slist *prequote;
 167   long ssl_version;
 168   long ssl_version_max;
 169   long proxy_ssl_version;
 170   long ip_version;
 171   curl_TimeCond timecond;
 172   curl_off_t condtime;
 173   struct curl_slist *headers;
 174   struct curl_slist *proxyheaders;
 175   curl_mime *mimepost;
 176   curl_mime *mimecurrent;
 177   struct curl_slist *telnet_options;
 178   struct curl_slist *resolve;
 179   struct curl_slist *connect_to;
 180   HttpReq httpreq;
 181
 182   /* for bandwidth limiting features: */
 183   curl_off_t sendpersecond; /* send to peer */
 184   curl_off_t recvpersecond; /* receive from peer */
 185
 186   bool ftp_ssl;
 187   bool ftp_ssl_reqd;
 188   bool ftp_ssl_control;
 189   bool ftp_ssl_ccc;
 190   int ftp_ssl_ccc_mode;
 191   char *preproxy;
 192   int socks5_gssapi_nec;    /* The NEC reference server does not protect the
 193                                encryption type exchange */
 194   unsigned long socks5_auth;/* auth bitmask for socks5 proxies */
 195   char *proxy_service_name; /* set authentication service name for HTTP and
 196                                SOCKS5 proxies */
 197   char *service_name;       /* set authentication service name for DIGEST-MD5,
 198                                Kerberos 5 and SPNEGO */
 199
 200   bool tcp_nodelay;
 201   bool tcp_fastopen;
 202   long req_retry;           /* number of retries */
 203   bool retry_connrefused;   /* set connection refused as a transient error */
 204   long retry_delay;         /* delay between retries (in seconds) */
 205   long retry_maxtime;       /* maximum time to keep retrying */
 206
 207   char *ftp_account;        /* for ACCT */
 208   char *ftp_alternative_to_user;  /* send command if USER/PASS fails */
 209   int ftp_filemethod;
 210   long tftp_blksize;        /* TFTP BLKSIZE option */
 211   bool tftp_no_options;     /* do not send TFTP options requests */
 212   bool ignorecl;            /* --ignore-content-length */
 213   bool disable_sessionid;
 214
 215   bool raw;
 216   bool post301;
 217   bool post302;
 218   bool post303;
 219   bool nokeepalive;         /* for keepalive needs */
 220   long alivetime;
 221   bool content_disposition; /* use Content-disposition filename */
 222
 223   int default_node_flags;   /* default flags to search for each 'node', which
 224                                is basically each given URL to transfer */
 225
 226   bool xattr;               /* store metadata in extended attributes */
 227   long gssapi_delegation;
 228   bool ssl_allow_beast;     /* allow this SSL vulnerability */
 229   bool proxy_ssl_allow_beast; /* allow this SSL vulnerability for proxy*/
 230
 231   bool ssl_no_revoke;       /* disable SSL certificate revocation checks */
 232   /*bool proxy_ssl_no_revoke; */
 233
 234   bool use_metalink;        /* process given URLs as metalink XML file */
 235   metalinkfile *metalinkfile_list; /* point to the first node */
 236   metalinkfile *metalinkfile_last; /* point to the last/current node */
 237 #ifdef CURLDEBUG
 238   bool test_event_based;
 239 #endif
 240   char *oauth_bearer;             /* OAuth 2.0 bearer token */
 241   bool nonpn;                     /* enable/disable TLS NPN extension */
 242   bool noalpn;                    /* enable/disable TLS ALPN extension */
 243   char *unix_socket_path;         /* path to Unix domain socket */
 244   bool abstract_unix_socket;      /* path to an abstract Unix domain socket */
 245   bool falsestart;
 246   bool path_as_is;
 247   double expect100timeout;
 248   bool suppress_connect_headers;  /* suppress proxy CONNECT response headers
 249                                      from user callbacks */
 250   curl_error synthetic_error;     /* if non-zero, it overrides any libcurl
 251                                      error */
 252   bool ssh_compression;           /* enable/disable SSH compression */
 253   long happy_eyeballs_timeout_ms; /* happy eyeballs timeout in milliseconds.
 254                                      0 is valid. default: CURL_HET_DEFAULT. */
 255   struct GlobalConfig *global;
 256   struct OperationConfig *prev;
 257   struct OperationConfig *next;   /* Always last in the struct */
 258 };
 259
 260 struct GlobalConfig {
 261   CURL *easy;                     /* Once we have one, we keep it here */
 262   int showerror;                  /* -1 == unset, default => show errors
 263                                       0 => -s is used to NOT show errors
 264                                       1 => -S has been used to show errors */
 265   bool mute;                      /* don't show messages, --silent given */
 266   bool noprogress;                /* don't show progress bar --silent given */
 267   bool isatty;                    /* Updated internally if output is a tty */
 268   FILE *errors;                   /* Error stream, defaults to stderr */
 269   bool errors_fopened;            /* Whether error stream isn't stderr */
 270   char *trace_dump;               /* file to dump the network trace to */
 271   FILE *trace_stream;
 272   bool trace_fopened;
 273   trace tracetype;
 274   bool tracetime;                 /* include timestamp? */
 275   int progressmode;               /* CURL_PROGRESS_BAR / CURL_PROGRESS_STATS */
 276   char *libcurl;                  /* Output libcurl code to this file name */
 277   bool fail_early;                /* exit on first transfer error */
 278   struct OperationConfig *first;
 279   struct OperationConfig *current;
 280   struct OperationConfig *last;   /* Always last in the struct */
 281 };
 282
 283 void config_init(struct OperationConfig *config);
 284 void config_free(struct OperationConfig *config);
 285
 286 #endif /* HEADER_CURL_TOOL_CFGABLE_H */