• 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 "tool_formparse.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   unsigned long infilenum; /* number of files to upload */
41   unsigned long up;  /* upload file counter within a single upload glob */
42   unsigned long urlnum; /* how many iterations this single URL has with ranges
43                            etc */
44   unsigned long 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   curl_off_t postfieldsize;
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 ocations, 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 *doh_url;
132   char *cipher_list;
133   char *proxy_cipher_list;
134   char *cipher13_list;
135   char *proxy_cipher13_list;
136   char *cert;
137   char *proxy_cert;
138   char *cert_type;
139   char *proxy_cert_type;
140   char *cacert;
141   char *proxy_cacert;
142   char *capath;
143   char *proxy_capath;
144   char *crlfile;
145   char *proxy_crlfile;
146   char *pinnedpubkey;
147   char *proxy_pinnedpubkey;
148   char *key;
149   char *proxy_key;
150   char *key_type;
151   char *proxy_key_type;
152   char *key_passwd;
153   char *proxy_key_passwd;
154   char *pubkey;
155   char *hostpubmd5;
156   char *hostpubsha256;
157   char *engine;
158   char *etag_save_file;
159   char *etag_compare_file;
160   bool crlf;
161   char *customrequest;
162   char *ssl_ec_curves;
163   char *krblevel;
164   char *request_target;
165   long httpversion;
166   bool http09_allowed;
167   bool nobuffer;
168   bool readbusy;            /* set when reading input returns EAGAIN */
169   bool globoff;
170   bool use_httpget;
171   bool insecure_ok;         /* set TRUE to allow insecure SSL connects */
172   bool doh_insecure_ok;     /* set TRUE to allow insecure SSL connects
173                                for DoH */
174   bool proxy_insecure_ok;   /* set TRUE to allow insecure SSL connects
175                                for proxy */
176   bool terminal_binary_ok;
177   bool verifystatus;
178   bool doh_verifystatus;
179   bool create_dirs;
180   bool ftp_create_dirs;
181   bool ftp_skip_ip;
182   bool proxynegotiate;
183   bool proxyntlm;
184   bool proxydigest;
185   bool proxybasic;
186   bool proxyanyauth;
187   bool jsoned; /* added json content-type */
188   char *writeout;           /* %-styled format string to output */
189   struct curl_slist *quote;
190   struct curl_slist *postquote;
191   struct curl_slist *prequote;
192   long ssl_version;
193   long ssl_version_max;
194   long proxy_ssl_version;
195   long ip_version;
196   long create_file_mode; /* CURLOPT_NEW_FILE_PERMS */
197   curl_TimeCond timecond;
198   curl_off_t condtime;
199   struct curl_slist *headers;
200   struct curl_slist *proxyheaders;
201   struct tool_mime *mimeroot;
202   struct tool_mime *mimecurrent;
203   curl_mime *mimepost;
204   struct curl_slist *telnet_options;
205   struct curl_slist *resolve;
206   struct curl_slist *connect_to;
207   HttpReq httpreq;
208 
209   /* for bandwidth limiting features: */
210   curl_off_t sendpersecond; /* send to peer */
211   curl_off_t recvpersecond; /* receive from peer */
212 
213   bool ftp_ssl;
214   bool ftp_ssl_reqd;
215   bool ftp_ssl_control;
216   bool ftp_ssl_ccc;
217   int ftp_ssl_ccc_mode;
218   char *preproxy;
219   bool socks5_gssapi_nec;   /* The NEC reference server does not protect the
220                                encryption type exchange */
221   unsigned long socks5_auth;/* auth bitmask for socks5 proxies */
222   char *proxy_service_name; /* set authentication service name for HTTP and
223                                SOCKS5 proxies */
224   char *service_name;       /* set authentication service name for DIGEST-MD5,
225                                Kerberos 5 and SPNEGO */
226 
227   bool tcp_nodelay;
228   bool tcp_fastopen;
229   long req_retry;           /* number of retries */
230   bool retry_all_errors;    /* retry on any error */
231   bool retry_connrefused;   /* set connection refused as a transient error */
232   long retry_delay;         /* delay between retries (in seconds) */
233   long retry_maxtime;       /* maximum time to keep retrying */
234 
235   char *ftp_account;        /* for ACCT */
236   char *ftp_alternative_to_user;  /* send command if USER/PASS fails */
237   int ftp_filemethod;
238   long mime_options;        /* Mime option flags. */
239   long tftp_blksize;        /* TFTP BLKSIZE option */
240   bool tftp_no_options;     /* do not send TFTP options requests */
241   bool ignorecl;            /* --ignore-content-length */
242   bool disable_sessionid;
243 
244   bool raw;
245   bool post301;
246   bool post302;
247   bool post303;
248   bool nokeepalive;         /* for keepalive needs */
249   long alivetime;
250   bool content_disposition; /* use Content-disposition filename */
251 
252   int default_node_flags;   /* default flags to search for each 'node', which
253                                is basically each given URL to transfer */
254 
255   bool xattr;               /* store metadata in extended attributes */
256   long gssapi_delegation;
257   bool ssl_allow_beast;     /* allow this SSL vulnerability */
258   bool proxy_ssl_allow_beast; /* allow this SSL vulnerability for proxy */
259   bool ssl_no_revoke;       /* disable SSL certificate revocation checks */
260   bool ssl_revoke_best_effort; /* ignore SSL revocation offline/missing
261                                   revocation list errors */
262 
263   bool native_ca_store;        /* use the native os ca store */
264   bool ssl_auto_client_cert;   /* automatically locate and use a client
265                                   certificate for authentication (Schannel) */
266   bool proxy_ssl_auto_client_cert; /* proxy version of ssl_auto_client_cert */
267   char *oauth_bearer;             /* OAuth 2.0 bearer token */
268   bool noalpn;                    /* enable/disable TLS ALPN extension */
269   char *unix_socket_path;         /* path to Unix domain socket */
270   bool abstract_unix_socket;      /* path to an abstract Unix domain socket */
271   bool falsestart;
272   bool path_as_is;
273   long expect100timeout_ms;
274   bool suppress_connect_headers;  /* suppress proxy CONNECT response headers
275                                      from user callbacks */
276   bool synthetic_error;           /* if TRUE, this is tool-internal error */
277   bool ssh_compression;           /* enable/disable SSH compression */
278   long happy_eyeballs_timeout_ms; /* happy eyeballs timeout in milliseconds.
279                                      0 is valid. default: CURL_HET_DEFAULT. */
280   bool haproxy_protocol;          /* whether to send HAProxy protocol v1 */
281   bool disallow_username_in_url;  /* disallow usernames in URLs */
282   char *aws_sigv4;
283   enum {
284     CLOBBER_DEFAULT, /* Provides compatibility with previous versions of curl,
285                         by using the default behavior for -o, -O, and -J.
286                         If those options would have overwritten files, like
287                         -o and -O would, then overwrite them. In the case of
288                         -J, this will not overwrite any files. */
289     CLOBBER_NEVER, /* If the file exists, always fail */
290     CLOBBER_ALWAYS /* If the file exists, always overwrite it */
291   } file_clobber_mode;
292   struct GlobalConfig *global;
293   struct OperationConfig *prev;
294   struct OperationConfig *next;   /* Always last in the struct */
295   struct State state;             /* for create_transfer() */
296   bool rm_partial;                /* on error, remove partially written output
297                                      files */
298 };
299 
300 struct GlobalConfig {
301   bool showerror;                 /* show errors when silent */
302   bool silent;                    /* don't show messages, --silent given */
303   bool noprogress;                /* don't show progress bar */
304   bool isatty;                    /* Updated internally if output is a tty */
305   char *trace_dump;               /* file to dump the network trace to */
306   FILE *trace_stream;
307   bool trace_fopened;
308   trace tracetype;
309   bool tracetime;                 /* include timestamp? */
310   int progressmode;               /* CURL_PROGRESS_BAR / CURL_PROGRESS_STATS */
311   char *libcurl;                  /* Output libcurl code to this file name */
312   bool fail_early;                /* exit on first transfer error */
313   bool styled_output;             /* enable fancy output style detection */
314   long ms_per_transfer;           /* start next transfer after (at least) this
315                                      many milliseconds */
316 #ifdef CURLDEBUG
317   bool test_event_based;
318 #endif
319   bool parallel;
320   long parallel_max;
321   bool parallel_connect;
322   char *help_category;            /* The help category, if set */
323   struct OperationConfig *first;
324   struct OperationConfig *current;
325   struct OperationConfig *last;   /* Always last in the struct */
326 };
327 
328 void config_init(struct OperationConfig *config);
329 void config_free(struct OperationConfig *config);
330 
331 #endif /* HEADER_CURL_TOOL_CFGABLE_H */
332