• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 file name */
54   char *hsts;               /* HSTS cache file name */
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   char *dns_servers;   /* dot notation: 1.1.1.1;2.2.2.2 */
89   char *dns_interface; /* interface name */
90   char *dns_ipv4_addr; /* dot notation */
91   char *dns_ipv6_addr; /* dot notation */
92   char *userpwd;
93   char *login_options;
94   char *tls_username;
95   char *tls_password;
96   char *tls_authtype;
97   char *proxy_tls_username;
98   char *proxy_tls_password;
99   char *proxy_tls_authtype;
100   char *proxyuserpwd;
101   char *proxy;
102   int proxyver;             /* set to CURLPROXY_HTTP* define */
103   char *noproxy;
104   char *mail_from;
105   struct curl_slist *mail_rcpt;
106   char *mail_auth;
107   bool mail_rcpt_allowfails; /* --mail-rcpt-allowfails */
108   char *sasl_authzid;       /* Authorization identity (identity to use) */
109   bool sasl_ir;             /* Enable/disable SASL initial response */
110   bool proxytunnel;
111   bool ftp_append;          /* APPE on ftp */
112   bool use_ascii;           /* select ascii or text transfer */
113   bool autoreferer;         /* automatically set referer */
114   bool failonerror;         /* fail on (HTTP) errors */
115   bool failwithbody;        /* fail on (HTTP) errors but still store body */
116   bool show_headers;        /* show headers to data output */
117   bool no_body;             /* don't get the body */
118   bool dirlistonly;         /* only get the FTP dir list */
119   bool followlocation;      /* follow http redirects */
120   bool unrestricted_auth;   /* Continue to send authentication (user+password)
121                                when following redirects, even when hostname
122                                changed */
123   bool netrc_opt;
124   bool netrc;
125   char *netrc_file;
126   struct getout *url_list;  /* point to the first node */
127   struct getout *url_last;  /* point to the last/current node */
128   struct getout *url_get;   /* point to the node to fill in URL */
129   struct getout *url_out;   /* point to the node to fill in outfile */
130   struct getout *url_ul;    /* point to the node to fill in upload */
131   char *ipfs_gateway;
132   char *doh_url;
133   char *cipher_list;
134   char *proxy_cipher_list;
135   char *cipher13_list;
136   char *proxy_cipher13_list;
137   char *cert;
138   char *proxy_cert;
139   char *cert_type;
140   char *proxy_cert_type;
141   char *cacert;
142   char *proxy_cacert;
143   char *capath;
144   char *proxy_capath;
145   char *crlfile;
146   char *proxy_crlfile;
147   char *pinnedpubkey;
148   char *proxy_pinnedpubkey;
149   char *key;
150   char *proxy_key;
151   char *key_type;
152   char *proxy_key_type;
153   char *key_passwd;
154   char *proxy_key_passwd;
155   char *pubkey;
156   char *hostpubmd5;
157   char *hostpubsha256;
158   char *engine;
159   char *etag_save_file;
160   char *etag_compare_file;
161   bool crlf;
162   char *customrequest;
163   char *ssl_ec_curves;
164   char *krblevel;
165   char *request_target;
166   long httpversion;
167   bool http09_allowed;
168   bool nobuffer;
169   bool readbusy;            /* set when reading input returns EAGAIN */
170   bool globoff;
171   bool use_httpget;
172   bool insecure_ok;         /* set TRUE to allow insecure SSL connects */
173   bool doh_insecure_ok;     /* set TRUE to allow insecure SSL connects
174                                for DoH */
175   bool proxy_insecure_ok;   /* set TRUE to allow insecure SSL connects
176                                for proxy */
177   bool terminal_binary_ok;
178   bool verifystatus;
179   bool doh_verifystatus;
180   bool create_dirs;
181   bool ftp_create_dirs;
182   bool ftp_skip_ip;
183   bool proxynegotiate;
184   bool proxyntlm;
185   bool proxydigest;
186   bool proxybasic;
187   bool proxyanyauth;
188   bool jsoned; /* added json content-type */
189   char *writeout;           /* %-styled format string to output */
190   struct curl_slist *quote;
191   struct curl_slist *postquote;
192   struct curl_slist *prequote;
193   long ssl_version;
194   long ssl_version_max;
195   long proxy_ssl_version;
196   long ip_version;
197   long create_file_mode; /* CURLOPT_NEW_FILE_PERMS */
198   curl_TimeCond timecond;
199   curl_off_t condtime;
200   struct curl_slist *headers;
201   struct curl_slist *proxyheaders;
202   struct tool_mime *mimeroot;
203   struct tool_mime *mimecurrent;
204   curl_mime *mimepost;
205   struct curl_slist *telnet_options;
206   struct curl_slist *resolve;
207   struct curl_slist *connect_to;
208   HttpReq httpreq;
209 
210   /* for bandwidth limiting features: */
211   curl_off_t sendpersecond; /* send to peer */
212   curl_off_t recvpersecond; /* receive from peer */
213 
214   bool ftp_ssl;
215   bool ftp_ssl_reqd;
216   bool ftp_ssl_control;
217   bool ftp_ssl_ccc;
218   int ftp_ssl_ccc_mode;
219   char *preproxy;
220   bool socks5_gssapi_nec;   /* The NEC reference server does not protect the
221                                encryption type exchange */
222   unsigned long socks5_auth;/* auth bitmask for socks5 proxies */
223   char *proxy_service_name; /* set authentication service name for HTTP and
224                                SOCKS5 proxies */
225   char *service_name;       /* set authentication service name for DIGEST-MD5,
226                                Kerberos 5 and SPNEGO */
227 
228   bool tcp_nodelay;
229   bool tcp_fastopen;
230   long req_retry;           /* number of retries */
231   bool retry_all_errors;    /* retry on any error */
232   bool retry_connrefused;   /* set connection refused as a transient error */
233   long retry_delay;         /* delay between retries (in seconds) */
234   long retry_maxtime;       /* maximum time to keep retrying */
235 
236   char *ftp_account;        /* for ACCT */
237   char *ftp_alternative_to_user;  /* send command if USER/PASS fails */
238   int ftp_filemethod;
239   long mime_options;        /* Mime option flags. */
240   long tftp_blksize;        /* TFTP BLKSIZE option */
241   bool tftp_no_options;     /* do not send TFTP options requests */
242   bool ignorecl;            /* --ignore-content-length */
243   bool disable_sessionid;
244 
245   bool raw;
246   bool post301;
247   bool post302;
248   bool post303;
249   bool nokeepalive;         /* for keepalive needs */
250   long alivetime;
251   bool content_disposition; /* use Content-disposition filename */
252 
253   int default_node_flags;   /* default flags to search for each 'node', which
254                                is basically each given URL to transfer */
255 
256   bool xattr;               /* store metadata in extended attributes */
257   long gssapi_delegation;
258   bool ssl_allow_beast;     /* allow this SSL vulnerability */
259   bool proxy_ssl_allow_beast; /* allow this SSL vulnerability for proxy */
260   bool ssl_no_revoke;       /* disable SSL certificate revocation checks */
261   bool ssl_revoke_best_effort; /* ignore SSL revocation offline/missing
262                                   revocation list errors */
263 
264   bool native_ca_store;        /* use the native OS CA store */
265   bool proxy_native_ca_store;  /* use the native OS CA store for proxy */
266   bool ssl_auto_client_cert;   /* automatically locate and use a client
267                                   certificate for authentication (Schannel) */
268   bool proxy_ssl_auto_client_cert; /* proxy version of ssl_auto_client_cert */
269   char *oauth_bearer;             /* OAuth 2.0 bearer token */
270   bool noalpn;                    /* enable/disable TLS ALPN extension */
271   char *unix_socket_path;         /* path to Unix domain socket */
272   bool abstract_unix_socket;      /* path to an abstract Unix domain socket */
273   bool falsestart;
274   bool path_as_is;
275   long expect100timeout_ms;
276   bool suppress_connect_headers;  /* suppress proxy CONNECT response headers
277                                      from user callbacks */
278   bool synthetic_error;           /* if TRUE, this is tool-internal error */
279   bool ssh_compression;           /* enable/disable SSH compression */
280   long happy_eyeballs_timeout_ms; /* happy eyeballs timeout in milliseconds.
281                                      0 is valid. default: CURL_HET_DEFAULT. */
282   bool haproxy_protocol;          /* whether to send HAProxy protocol v1 */
283   char *haproxy_clientip;         /* client IP for HAProxy protocol */
284   bool disallow_username_in_url;  /* disallow usernames in URLs */
285   char *aws_sigv4;
286   enum {
287     CLOBBER_DEFAULT, /* Provides compatibility with previous versions of curl,
288                         by using the default behavior for -o, -O, and -J.
289                         If those options would have overwritten files, like
290                         -o and -O would, then overwrite them. In the case of
291                         -J, this will not overwrite any files. */
292     CLOBBER_NEVER, /* If the file exists, always fail */
293     CLOBBER_ALWAYS /* If the file exists, always overwrite it */
294   } file_clobber_mode;
295   struct GlobalConfig *global;
296   struct OperationConfig *prev;
297   struct OperationConfig *next;   /* Always last in the struct */
298   struct State state;             /* for create_transfer() */
299   bool rm_partial;                /* on error, remove partially written output
300                                      files */
301 };
302 
303 struct GlobalConfig {
304   bool showerror;                 /* show errors when silent */
305   bool silent;                    /* don't show messages, --silent given */
306   bool noprogress;                /* don't show progress bar */
307   bool isatty;                    /* Updated internally if output is a tty */
308   char *trace_dump;               /* file to dump the network trace to */
309   FILE *trace_stream;
310   bool trace_fopened;
311   trace tracetype;
312   bool tracetime;                 /* include timestamp? */
313   bool traceids;                  /* include xfer-/conn-id? */
314   int progressmode;               /* CURL_PROGRESS_BAR / CURL_PROGRESS_STATS */
315   char *libcurl;                  /* Output libcurl code to this file name */
316   bool fail_early;                /* exit on first transfer error */
317   bool styled_output;             /* enable fancy output style detection */
318   long ms_per_transfer;           /* start next transfer after (at least) this
319                                      many milliseconds */
320 #ifdef CURLDEBUG
321   bool test_event_based;
322 #endif
323   bool parallel;
324   unsigned short parallel_max; /* MAX_PARALLEL is the maximum */
325   bool parallel_connect;
326   char *help_category;            /* The help category, if set */
327   struct var *variables;
328   struct OperationConfig *first;
329   struct OperationConfig *current;
330   struct OperationConfig *last;   /* Always last in the struct */
331 };
332 
333 void config_init(struct OperationConfig *config);
334 void config_free(struct OperationConfig *config);
335 
336 #endif /* HEADER_CURL_TOOL_CFGABLE_H */
337