• 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) 1998 - 2021, 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  ***************************************************************************/
24 #include "tool_setup.h"
25 #include "tool_sdecls.h"
26 #include "tool_urlglob.h"
27 #include "tool_formparse.h"
28 
29 typedef enum {
30   ERR_NONE,
31   ERR_BINARY_TERMINAL = 1, /* binary to terminal detected */
32   ERR_LAST
33 } curl_error;
34 
35 struct GlobalConfig;
36 
37 struct State {
38   struct getout *urlnode;
39   struct URLGlob *inglob;
40   struct URLGlob *urls;
41   char *outfiles;
42   char *httpgetfields;
43   char *uploadfile;
44   unsigned long infilenum; /* number of files to upload */
45   unsigned long up;  /* upload file counter within a single upload glob */
46   unsigned long urlnum; /* how many iterations this single URL has with ranges
47                            etc */
48   unsigned long li;
49 };
50 
51 struct OperationConfig {
52   bool remote_time;
53   char *random_file;
54   char *egd_file;
55   char *useragent;
56   struct curl_slist *cookies;  /* cookies to serialize into a single line */
57   char *cookiejar;          /* write to this file */
58   struct curl_slist *cookiefiles;  /* file(s) to load cookies from */
59   char *altsvc;             /* alt-svc cache file name */
60   char *hsts;               /* HSTS cache file name */
61   bool cookiesession;       /* new session? */
62   bool encoding;            /* Accept-Encoding please */
63   bool tr_encoding;         /* Transfer-Encoding please */
64   unsigned long authtype;   /* auth bitmask */
65   bool use_resume;
66   bool resume_from_current;
67   bool disable_epsv;
68   bool disable_eprt;
69   bool ftp_pret;
70   long proto;
71   bool proto_present;
72   long proto_redir;
73   bool proto_redir_present;
74   char *proto_default;
75   curl_off_t resume_from;
76   char *postfields;
77   curl_off_t postfieldsize;
78   char *referer;
79   double timeout;
80   double connecttimeout;
81   long maxredirs;
82   curl_off_t max_filesize;
83   char *output_dir;
84   char *headerfile;
85   char *ftpport;
86   char *iface;
87   long localport;
88   long localportrange;
89   unsigned short porttouse;
90   char *range;
91   long low_speed_limit;
92   long low_speed_time;
93   char *dns_servers;   /* dot notation: 1.1.1.1;2.2.2.2 */
94   char *dns_interface; /* interface name */
95   char *dns_ipv4_addr; /* dot notation */
96   char *dns_ipv6_addr; /* dot notation */
97   char *userpwd;
98   char *login_options;
99   char *tls_username;
100   char *tls_password;
101   char *tls_authtype;
102   char *proxy_tls_username;
103   char *proxy_tls_password;
104   char *proxy_tls_authtype;
105   char *proxyuserpwd;
106   char *proxy;
107   int proxyver;             /* set to CURLPROXY_HTTP* define */
108   char *noproxy;
109   char *mail_from;
110   struct curl_slist *mail_rcpt;
111   char *mail_auth;
112   bool mail_rcpt_allowfails; /* --mail-rcpt-allowfails */
113   char *sasl_authzid;       /* Authorisation identity (identity to use) */
114   bool sasl_ir;             /* Enable/disable SASL initial response */
115   bool proxytunnel;
116   bool ftp_append;          /* APPE on ftp */
117   bool use_ascii;           /* select ascii or text transfer */
118   bool autoreferer;         /* automatically set referer */
119   bool failonerror;         /* fail on (HTTP) errors */
120   bool failwithbody;        /* fail on (HTTP) errors but still store body */
121   bool show_headers;        /* show headers to data output */
122   bool no_body;             /* don't get the body */
123   bool dirlistonly;         /* only get the FTP dir list */
124   bool followlocation;      /* follow http redirects */
125   bool unrestricted_auth;   /* Continue to send authentication (user+password)
126                                when following ocations, even when hostname
127                                changed */
128   bool netrc_opt;
129   bool netrc;
130   char *netrc_file;
131   struct getout *url_list;  /* point to the first node */
132   struct getout *url_last;  /* point to the last/current node */
133   struct getout *url_get;   /* point to the node to fill in URL */
134   struct getout *url_out;   /* point to the node to fill in outfile */
135   struct getout *url_ul;    /* point to the node to fill in upload */
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 *engine;
162   char *etag_save_file;
163   char *etag_compare_file;
164   bool crlf;
165   char *customrequest;
166   char *ssl_ec_curves;
167   char *krblevel;
168   char *request_target;
169   long httpversion;
170   bool http09_allowed;
171   bool nobuffer;
172   bool readbusy;            /* set when reading input returns EAGAIN */
173   bool globoff;
174   bool use_httpget;
175   bool insecure_ok;         /* set TRUE to allow insecure SSL connects */
176   bool doh_insecure_ok;     /* set TRUE to allow insecure SSL connects
177                                for DoH */
178   bool proxy_insecure_ok;   /* set TRUE to allow insecure SSL connects
179                                for proxy */
180   bool terminal_binary_ok;
181   bool verifystatus;
182   bool doh_verifystatus;
183   bool create_dirs;
184   bool ftp_create_dirs;
185   bool ftp_skip_ip;
186   bool proxynegotiate;
187   bool proxyntlm;
188   bool proxydigest;
189   bool proxybasic;
190   bool proxyanyauth;
191   char *writeout;           /* %-styled format string to output */
192   struct curl_slist *quote;
193   struct curl_slist *postquote;
194   struct curl_slist *prequote;
195   long ssl_version;
196   long ssl_version_max;
197   long proxy_ssl_version;
198   long ip_version;
199   long create_file_mode; /* CURLOPT_NEW_FILE_PERMS */
200   curl_TimeCond timecond;
201   curl_off_t condtime;
202   struct curl_slist *headers;
203   struct curl_slist *proxyheaders;
204   struct tool_mime *mimeroot;
205   struct tool_mime *mimecurrent;
206   curl_mime *mimepost;
207   struct curl_slist *telnet_options;
208   struct curl_slist *resolve;
209   struct curl_slist *connect_to;
210   HttpReq httpreq;
211 
212   /* for bandwidth limiting features: */
213   curl_off_t sendpersecond; /* send to peer */
214   curl_off_t recvpersecond; /* receive from peer */
215 
216   bool ftp_ssl;
217   bool ftp_ssl_reqd;
218   bool ftp_ssl_control;
219   bool ftp_ssl_ccc;
220   int ftp_ssl_ccc_mode;
221   char *preproxy;
222   int socks5_gssapi_nec;    /* The NEC reference server does not protect the
223                                encryption type exchange */
224   unsigned long socks5_auth;/* auth bitmask for socks5 proxies */
225   char *proxy_service_name; /* set authentication service name for HTTP and
226                                SOCKS5 proxies */
227   char *service_name;       /* set authentication service name for DIGEST-MD5,
228                                Kerberos 5 and SPNEGO */
229 
230   bool tcp_nodelay;
231   bool tcp_fastopen;
232   long req_retry;           /* number of retries */
233   bool retry_all_errors;    /* retry on any error */
234   bool retry_connrefused;   /* set connection refused as a transient error */
235   long retry_delay;         /* delay between retries (in seconds) */
236   long retry_maxtime;       /* maximum time to keep retrying */
237 
238   char *ftp_account;        /* for ACCT */
239   char *ftp_alternative_to_user;  /* send command if USER/PASS fails */
240   int ftp_filemethod;
241   long tftp_blksize;        /* TFTP BLKSIZE option */
242   bool tftp_no_options;     /* do not send TFTP options requests */
243   bool ignorecl;            /* --ignore-content-length */
244   bool disable_sessionid;
245 
246   bool raw;
247   bool post301;
248   bool post302;
249   bool post303;
250   bool nokeepalive;         /* for keepalive needs */
251   long alivetime;
252   bool content_disposition; /* use Content-disposition filename */
253 
254   int default_node_flags;   /* default flags to search for each 'node', which
255                                is basically each given URL to transfer */
256 
257   bool xattr;               /* store metadata in extended attributes */
258   long gssapi_delegation;
259   bool ssl_allow_beast;     /* allow this SSL vulnerability */
260   bool proxy_ssl_allow_beast; /* allow this SSL vulnerability for proxy*/
261 
262   bool ssl_no_revoke;       /* disable SSL certificate revocation checks */
263   /*bool proxy_ssl_no_revoke; */
264 
265   bool ssl_revoke_best_effort; /* ignore SSL revocation offline/missing
266                                   revocation list errors */
267 
268   bool native_ca_store;        /* use the native os ca store */
269   bool ssl_auto_client_cert;   /* automatically locate and use a client
270                                   certificate for authentication (Schannel) */
271   bool proxy_ssl_auto_client_cert; /* proxy version of ssl_auto_client_cert */
272   char *oauth_bearer;             /* OAuth 2.0 bearer token */
273   bool nonpn;                     /* enable/disable TLS NPN extension */
274   bool noalpn;                    /* enable/disable TLS ALPN extension */
275   char *unix_socket_path;         /* path to Unix domain socket */
276   bool abstract_unix_socket;      /* path to an abstract Unix domain socket */
277   bool falsestart;
278   bool path_as_is;
279   double expect100timeout;
280   bool suppress_connect_headers;  /* suppress proxy CONNECT response headers
281                                      from user callbacks */
282   curl_error synthetic_error;     /* if non-zero, it overrides any libcurl
283                                      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   bool disallow_username_in_url;  /* disallow usernames in URLs */
289   char *aws_sigv4;
290   struct GlobalConfig *global;
291   struct OperationConfig *prev;
292   struct OperationConfig *next;   /* Always last in the struct */
293   struct State state;             /* for create_transfer() */
294 };
295 
296 struct GlobalConfig {
297   int showerror;                  /* -1 == unset, default => show errors
298                                       0 => -s is used to NOT show errors
299                                       1 => -S has been used to show errors */
300   bool mute;                      /* don't show messages, --silent given */
301   bool noprogress;                /* don't show progress bar --silent given */
302   bool isatty;                    /* Updated internally if output is a tty */
303   FILE *errors;                   /* Error stream, defaults to stderr */
304   bool errors_fopened;            /* Whether error stream isn't stderr */
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 #ifdef CURLDEBUG
315   bool test_event_based;
316 #endif
317   bool parallel;
318   long parallel_max;
319   bool parallel_connect;
320   char *help_category;            /* The help category, if set */
321   struct OperationConfig *first;
322   struct OperationConfig *current;
323   struct OperationConfig *last;   /* Always last in the struct */
324 };
325 
326 void config_init(struct OperationConfig *config);
327 void config_free(struct OperationConfig *config);
328 
329 #endif /* HEADER_CURL_TOOL_CFGABLE_H */
330