xref: /curl/src/tool_cfgable.h (revision ce7d0d41)
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) Daniel Stenberg, <daniel@haxx.se>, et al.
11  *
12  * This software is licensed as described in the file COPYING, which
13  * you should have received as part of this distribution. The terms
14  * are also available at https://curl.se/docs/copyright.html.
15  *
16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17  * copies of the Software, and permit persons to whom the Software is
18  * furnished to do so, under the terms of the COPYING file.
19  *
20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21  * KIND, either express or implied.
22  *
23  * SPDX-License-Identifier: curl
24  *
25  ***************************************************************************/
26 #include "tool_setup.h"
27 #include "tool_sdecls.h"
28 #include "tool_urlglob.h"
29 #include "var.h"
30 
31 struct GlobalConfig;
32 
33 struct State {
34   struct getout *urlnode;
35   struct URLGlob *inglob;
36   struct URLGlob *urls;
37   char *outfiles;
38   char *httpgetfields;
39   char *uploadfile;
40   curl_off_t infilenum; /* number of files to upload */
41   curl_off_t up;        /* upload file counter within a single upload glob */
42   curl_off_t urlnum;    /* how many iterations this single URL has with ranges
43                            etc */
44   curl_off_t li;
45 };
46 
47 struct OperationConfig {
48   bool remote_time;
49   char *useragent;
50   struct curl_slist *cookies;  /* cookies to serialize into a single line */
51   char *cookiejar;          /* write to this file */
52   struct curl_slist *cookiefiles;  /* file(s) to load cookies from */
53   char *altsvc;             /* alt-svc cache filename */
54   char *hsts;               /* HSTS cache filename */
55   bool cookiesession;       /* new session? */
56   bool encoding;            /* Accept-Encoding please */
57   bool tr_encoding;         /* Transfer-Encoding please */
58   unsigned long authtype;   /* auth bitmask */
59   bool use_resume;
60   bool resume_from_current;
61   bool disable_epsv;
62   bool disable_eprt;
63   bool ftp_pret;
64   char *proto_str;
65   bool proto_present;
66   char *proto_redir_str;
67   bool proto_redir_present;
68   char *proto_default;
69   curl_off_t resume_from;
70   char *postfields;
71   struct curlx_dynbuf postdata;
72   char *referer;
73   char *query;
74   long timeout_ms;
75   long connecttimeout_ms;
76   long maxredirs;
77   curl_off_t max_filesize;
78   char *output_dir;
79   char *headerfile;
80   char *ftpport;
81   char *iface;
82   long localport;
83   long localportrange;
84   unsigned short porttouse;
85   char *range;
86   long low_speed_limit;
87   long low_speed_time;
88   long ip_tos;         /* IP Type of Service */
89   long vlan_priority;  /* VLAN priority */
90   char *dns_servers;   /* dot notation: 1.1.1.1;2.2.2.2 */
91   char *dns_interface; /* interface name */
92   char *dns_ipv4_addr; /* dot notation */
93   char *dns_ipv6_addr; /* dot notation */
94   char *userpwd;
95   char *login_options;
96   char *tls_username;
97   char *tls_password;
98   char *tls_authtype;
99   char *proxy_tls_username;
100   char *proxy_tls_password;
101   char *proxy_tls_authtype;
102   char *proxyuserpwd;
103   char *proxy;
104   int proxyver;             /* set to CURLPROXY_HTTP* define */
105   char *noproxy;
106   char *mail_from;
107   struct curl_slist *mail_rcpt;
108   char *mail_auth;
109   bool mail_rcpt_allowfails; /* --mail-rcpt-allowfails */
110   char *sasl_authzid;       /* Authorization identity (identity to use) */
111   bool sasl_ir;             /* Enable/disable SASL initial response */
112   bool proxytunnel;
113   bool ftp_append;          /* APPE on ftp */
114   bool use_ascii;           /* select ASCII or text transfer */
115   bool autoreferer;         /* automatically set referer */
116   bool failonerror;         /* fail on (HTTP) errors */
117   bool failwithbody;        /* fail on (HTTP) errors but still store body */
118   bool show_headers;        /* show headers to data output */
119   bool no_body;             /* do not get the body */
120   bool dirlistonly;         /* only get the FTP dir list */
121   bool followlocation;      /* follow http redirects */
122   bool unrestricted_auth;   /* Continue to send authentication (user+password)
123                                when following redirects, even when hostname
124                                changed */
125   bool netrc_opt;
126   bool netrc;
127   char *netrc_file;
128   struct getout *url_list;  /* point to the first node */
129   struct getout *url_last;  /* point to the last/current node */
130   struct getout *url_get;   /* point to the node to fill in URL */
131   struct getout *url_out;   /* point to the node to fill in outfile */
132   struct getout *url_ul;    /* point to the node to fill in upload */
133 #ifndef CURL_DISABLE_IPFS
134   char *ipfs_gateway;
135 #endif /* !CURL_DISABLE_IPFS */
136   char *doh_url;
137   char *cipher_list;
138   char *proxy_cipher_list;
139   char *cipher13_list;
140   char *proxy_cipher13_list;
141   char *cert;
142   char *proxy_cert;
143   char *cert_type;
144   char *proxy_cert_type;
145   char *cacert;
146   char *proxy_cacert;
147   char *capath;
148   char *proxy_capath;
149   char *crlfile;
150   char *proxy_crlfile;
151   char *pinnedpubkey;
152   char *proxy_pinnedpubkey;
153   char *key;
154   char *proxy_key;
155   char *key_type;
156   char *proxy_key_type;
157   char *key_passwd;
158   char *proxy_key_passwd;
159   char *pubkey;
160   char *hostpubmd5;
161   char *hostpubsha256;
162   char *engine;
163   char *etag_save_file;
164   char *etag_compare_file;
165   bool crlf;
166   char *customrequest;
167   char *ssl_ec_curves;
168   char *krblevel;
169   char *request_target;
170   long httpversion;
171   bool http09_allowed;
172   bool nobuffer;
173   bool readbusy;            /* set when reading input returns EAGAIN */
174   bool globoff;
175   bool use_httpget;
176   bool insecure_ok;         /* set TRUE to allow insecure SSL connects */
177   bool doh_insecure_ok;     /* set TRUE to allow insecure SSL connects
178                                for DoH */
179   bool proxy_insecure_ok;   /* set TRUE to allow insecure SSL connects
180                                for proxy */
181   bool terminal_binary_ok;
182   bool verifystatus;
183   bool doh_verifystatus;
184   bool create_dirs;
185   bool ftp_create_dirs;
186   bool ftp_skip_ip;
187   bool proxynegotiate;
188   bool proxyntlm;
189   bool proxydigest;
190   bool proxybasic;
191   bool proxyanyauth;
192   bool jsoned; /* added json content-type */
193   char *writeout;           /* %-styled format string to output */
194   struct curl_slist *quote;
195   struct curl_slist *postquote;
196   struct curl_slist *prequote;
197   long ssl_version;
198   long ssl_version_max;
199   long proxy_ssl_version;
200   long ip_version;
201   long create_file_mode; /* CURLOPT_NEW_FILE_PERMS */
202   curl_TimeCond timecond;
203   curl_off_t condtime;
204   struct curl_slist *headers;
205   struct curl_slist *proxyheaders;
206   struct tool_mime *mimeroot;
207   struct tool_mime *mimecurrent;
208   curl_mime *mimepost;
209   struct curl_slist *telnet_options;
210   struct curl_slist *resolve;
211   struct curl_slist *connect_to;
212   HttpReq httpreq;
213 
214   /* for bandwidth limiting features: */
215   curl_off_t sendpersecond; /* send to peer */
216   curl_off_t recvpersecond; /* receive from peer */
217 
218   bool ftp_ssl;
219   bool ftp_ssl_reqd;
220   bool ftp_ssl_control;
221   bool ftp_ssl_ccc;
222   int ftp_ssl_ccc_mode;
223   char *preproxy;
224   bool socks5_gssapi_nec;   /* The NEC reference server does not protect the
225                                encryption type exchange */
226   unsigned long socks5_auth;/* auth bitmask for socks5 proxies */
227   char *proxy_service_name; /* set authentication service name for HTTP and
228                                SOCKS5 proxies */
229   char *service_name;       /* set authentication service name for DIGEST-MD5,
230                                Kerberos 5 and SPNEGO */
231 
232   bool tcp_nodelay;
233   bool tcp_fastopen;
234   long req_retry;           /* number of retries */
235   bool retry_all_errors;    /* retry on any error */
236   bool retry_connrefused;   /* set connection refused as a transient error */
237   long retry_delay;         /* delay between retries (in seconds) */
238   long retry_maxtime;       /* maximum time to keep retrying */
239 
240   char *ftp_account;        /* for ACCT */
241   char *ftp_alternative_to_user;  /* send command if USER/PASS fails */
242   int ftp_filemethod;
243   long mime_options;        /* Mime option flags. */
244   long tftp_blksize;        /* TFTP BLKSIZE option */
245   bool tftp_no_options;     /* do not send TFTP options requests */
246   bool ignorecl;            /* --ignore-content-length */
247   bool disable_sessionid;
248 
249   bool raw;
250   bool post301;
251   bool post302;
252   bool post303;
253   bool nokeepalive;         /* for keepalive needs */
254   long alivetime;           /* keepalive-time */
255   long alivecnt;            /* keepalive-cnt */
256   bool content_disposition; /* use Content-disposition filename */
257 
258   int default_node_flags;   /* default flags to search for each 'node', which
259                                is basically each given URL to transfer */
260 
261   bool xattr;               /* store metadata in extended attributes */
262   long gssapi_delegation;
263   bool ssl_allow_beast;     /* allow this SSL vulnerability */
264   bool proxy_ssl_allow_beast; /* allow this SSL vulnerability for proxy */
265   bool ssl_no_revoke;       /* disable SSL certificate revocation checks */
266   bool ssl_revoke_best_effort; /* ignore SSL revocation offline/missing
267                                   revocation list errors */
268 
269   bool native_ca_store;        /* use the native OS CA store */
270   bool proxy_native_ca_store;  /* use the native OS CA store for proxy */
271   bool ssl_auto_client_cert;   /* automatically locate and use a client
272                                   certificate for authentication (Schannel) */
273   bool proxy_ssl_auto_client_cert; /* proxy version of ssl_auto_client_cert */
274   char *oauth_bearer;             /* OAuth 2.0 bearer token */
275   bool noalpn;                    /* enable/disable TLS ALPN extension */
276   char *unix_socket_path;         /* path to Unix domain socket */
277   bool abstract_unix_socket;      /* path to an abstract Unix domain socket */
278   bool falsestart;
279   bool path_as_is;
280   long expect100timeout_ms;
281   bool suppress_connect_headers;  /* suppress proxy CONNECT response headers
282                                      from user callbacks */
283   bool synthetic_error;           /* if TRUE, this is tool-internal error */
284   bool ssh_compression;           /* enable/disable SSH compression */
285   long happy_eyeballs_timeout_ms; /* happy eyeballs timeout in milliseconds.
286                                      0 is valid. default: CURL_HET_DEFAULT. */
287   bool haproxy_protocol;          /* whether to send HAProxy protocol v1 */
288   char *haproxy_clientip;         /* client IP for HAProxy protocol */
289   bool disallow_username_in_url;  /* disallow usernames in URLs */
290   char *aws_sigv4;
291   enum {
292     CLOBBER_DEFAULT, /* Provides compatibility with previous versions of curl,
293                         by using the default behavior for -o, -O, and -J.
294                         If those options would have overwritten files, like
295                         -o and -O would, then overwrite them. In the case of
296                         -J, this will not overwrite any files. */
297     CLOBBER_NEVER, /* If the file exists, always fail */
298     CLOBBER_ALWAYS /* If the file exists, always overwrite it */
299   } file_clobber_mode;
300   bool mptcp;                     /* enable MPTCP support */
301   struct GlobalConfig *global;
302   struct OperationConfig *prev;
303   struct OperationConfig *next;   /* Always last in the struct */
304   struct State state;             /* for create_transfer() */
305   bool rm_partial;                /* on error, remove partially written output
306                                      files */
307   bool skip_existing;
308 #ifdef USE_ECH
309   char *ech;                      /* Config set by --ech keywords */
310   char *ech_config;               /* Config set by "--ech esl:" option */
311   char *ech_public;               /* Config set by "--ech pn:" option */
312 #endif
313 
314 };
315 
316 struct GlobalConfig {
317   bool showerror;                 /* show errors when silent */
318   bool silent;                    /* do not show messages, --silent given */
319   bool noprogress;                /* do not show progress bar */
320   bool isatty;                    /* Updated internally if output is a tty */
321   unsigned char verbosity;        /* How verbose we should be */
322   char *trace_dump;               /* file to dump the network trace to */
323   FILE *trace_stream;
324   bool trace_fopened;
325   trace tracetype;
326   bool tracetime;                 /* include timestamp? */
327   bool traceids;                  /* include xfer-/conn-id? */
328   int progressmode;               /* CURL_PROGRESS_BAR / CURL_PROGRESS_STATS */
329   char *libcurl;                  /* Output libcurl code to this filename */
330   bool fail_early;                /* exit on first transfer error */
331   bool styled_output;             /* enable fancy output style detection */
332   long ms_per_transfer;           /* start next transfer after (at least) this
333                                      many milliseconds */
334 #ifdef DEBUGBUILD
335   bool test_event_based;
336 #endif
337   bool parallel;
338   unsigned short parallel_max; /* MAX_PARALLEL is the maximum */
339   bool parallel_connect;
340   char *help_category;            /* The help category, if set */
341   struct var *variables;
342   struct OperationConfig *first;
343   struct OperationConfig *current;
344   struct OperationConfig *last;   /* Always last in the struct */
345 };
346 
347 void config_init(struct OperationConfig *config);
348 void config_free(struct OperationConfig *config);
349 
350 #endif /* HEADER_CURL_TOOL_CFGABLE_H */
351