• 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 - 2020, 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 #include "tool_sdecls.h"
26 #include "tool_metalink.h"
27 #include "tool_urlglob.h"
28 #include "tool_formparse.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 State {
39   struct getout *urlnode;
40   struct URLGlob *inglob;
41   struct URLGlob *urls;
42   char *outfiles;
43   char *httpgetfields;
44   char *uploadfile;
45   unsigned long infilenum; /* number of files to upload */
46   unsigned long up;  /* upload file counter within a single upload glob */
47   unsigned long urlnum; /* how many iterations this single URL has with ranges
48                            etc */
49   unsigned long li;
50 };
51 
52 struct OperationConfig {
53   bool remote_time;
54   char *random_file;
55   char *egd_file;
56   char *useragent;
57   char *cookie;             /* single line with specified cookies */
58   char *cookiejar;          /* write to this file */
59   char *cookiefile;         /* read from this file */
60   char *altsvc;             /* alt-svc 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 show_headers;        /* show headers to data output */
121   bool no_body;             /* don't get the body */
122   bool dirlistonly;         /* only get the FTP dir list */
123   bool followlocation;      /* follow http redirects */
124   bool unrestricted_auth;   /* Continue to send authentication (user+password)
125                                when following ocations, even when hostname
126                                changed */
127   bool netrc_opt;
128   bool netrc;
129   char *netrc_file;
130   struct getout *url_list;  /* point to the first node */
131   struct getout *url_last;  /* point to the last/current node */
132   struct getout *url_get;   /* point to the node to fill in URL */
133   struct getout *url_out;   /* point to the node to fill in outfile */
134   struct getout *url_ul;    /* point to the node to fill in upload */
135   char *doh_url;
136   char *cipher_list;
137   char *proxy_cipher_list;
138   char *cipher13_list;
139   char *proxy_cipher13_list;
140   char *cert;
141   char *proxy_cert;
142   char *cert_type;
143   char *proxy_cert_type;
144   char *cacert;
145   char *proxy_cacert;
146   char *capath;
147   char *proxy_capath;
148   char *crlfile;
149   char *proxy_crlfile;
150   char *pinnedpubkey;
151   char *proxy_pinnedpubkey;
152   char *key;
153   char *proxy_key;
154   char *key_type;
155   char *proxy_key_type;
156   char *key_passwd;
157   char *proxy_key_passwd;
158   char *pubkey;
159   char *hostpubmd5;
160   char *engine;
161   char *etag_save_file;
162   char *etag_compare_file;
163   bool crlf;
164   char *customrequest;
165   char *ssl_ec_curves;
166   char *krblevel;
167   char *request_target;
168   long httpversion;
169   bool http09_allowed;
170   bool nobuffer;
171   bool readbusy;            /* set when reading input returns EAGAIN */
172   bool globoff;
173   bool use_httpget;
174   bool insecure_ok;         /* set TRUE to allow insecure SSL connects */
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 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   char *writeout;           /* %-styled format string to output */
188   struct curl_slist *quote;
189   struct curl_slist *postquote;
190   struct curl_slist *prequote;
191   long ssl_version;
192   long ssl_version_max;
193   long proxy_ssl_version;
194   long ip_version;
195   curl_TimeCond timecond;
196   curl_off_t condtime;
197   struct curl_slist *headers;
198   struct curl_slist *proxyheaders;
199   struct tool_mime *mimeroot;
200   struct tool_mime *mimecurrent;
201   curl_mime *mimepost;
202   struct curl_slist *telnet_options;
203   struct curl_slist *resolve;
204   struct curl_slist *connect_to;
205   HttpReq httpreq;
206 
207   /* for bandwidth limiting features: */
208   curl_off_t sendpersecond; /* send to peer */
209   curl_off_t recvpersecond; /* receive from peer */
210 
211   bool ftp_ssl;
212   bool ftp_ssl_reqd;
213   bool ftp_ssl_control;
214   bool ftp_ssl_ccc;
215   int ftp_ssl_ccc_mode;
216   char *preproxy;
217   int socks5_gssapi_nec;    /* The NEC reference server does not protect the
218                                encryption type exchange */
219   unsigned long socks5_auth;/* auth bitmask for socks5 proxies */
220   char *proxy_service_name; /* set authentication service name for HTTP and
221                                SOCKS5 proxies */
222   char *service_name;       /* set authentication service name for DIGEST-MD5,
223                                Kerberos 5 and SPNEGO */
224 
225   bool tcp_nodelay;
226   bool tcp_fastopen;
227   long req_retry;           /* number of retries */
228   bool retry_all_errors;    /* retry on any error */
229   bool retry_connrefused;   /* set connection refused as a transient error */
230   long retry_delay;         /* delay between retries (in seconds) */
231   long retry_maxtime;       /* maximum time to keep retrying */
232 
233   char *ftp_account;        /* for ACCT */
234   char *ftp_alternative_to_user;  /* send command if USER/PASS fails */
235   int ftp_filemethod;
236   long tftp_blksize;        /* TFTP BLKSIZE option */
237   bool tftp_no_options;     /* do not send TFTP options requests */
238   bool ignorecl;            /* --ignore-content-length */
239   bool disable_sessionid;
240 
241   bool raw;
242   bool post301;
243   bool post302;
244   bool post303;
245   bool nokeepalive;         /* for keepalive needs */
246   long alivetime;
247   bool content_disposition; /* use Content-disposition filename */
248 
249   int default_node_flags;   /* default flags to search for each 'node', which
250                                is basically each given URL to transfer */
251 
252   bool xattr;               /* store metadata in extended attributes */
253   long gssapi_delegation;
254   bool ssl_allow_beast;     /* allow this SSL vulnerability */
255   bool proxy_ssl_allow_beast; /* allow this SSL vulnerability for proxy*/
256 
257   bool ssl_no_revoke;       /* disable SSL certificate revocation checks */
258   /*bool proxy_ssl_no_revoke; */
259 
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 
265   bool use_metalink;        /* process given URLs as metalink XML file */
266   struct metalinkfile *metalinkfile_list; /* point to the first node */
267   struct metalinkfile *metalinkfile_last; /* point to the last/current node */
268   char *oauth_bearer;             /* OAuth 2.0 bearer token */
269   bool nonpn;                     /* enable/disable TLS NPN extension */
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   double expect100timeout;
276   bool suppress_connect_headers;  /* suppress proxy CONNECT response headers
277                                      from user callbacks */
278   curl_error synthetic_error;     /* if non-zero, it overrides any libcurl
279                                      error */
280   bool ssh_compression;           /* enable/disable SSH compression */
281   long happy_eyeballs_timeout_ms; /* happy eyeballs timeout in milliseconds.
282                                      0 is valid. default: CURL_HET_DEFAULT. */
283   bool haproxy_protocol;          /* whether to send HAProxy protocol v1 */
284   bool disallow_username_in_url;  /* disallow usernames in URLs */
285   struct GlobalConfig *global;
286   struct OperationConfig *prev;
287   struct OperationConfig *next;   /* Always last in the struct */
288   struct State state;             /* for create_transfer() */
289 };
290 
291 struct GlobalConfig {
292   int showerror;                  /* -1 == unset, default => show errors
293                                       0 => -s is used to NOT show errors
294                                       1 => -S has been used to show errors */
295   bool mute;                      /* don't show messages, --silent given */
296   bool noprogress;                /* don't show progress bar --silent given */
297   bool isatty;                    /* Updated internally if output is a tty */
298   FILE *errors;                   /* Error stream, defaults to stderr */
299   bool errors_fopened;            /* Whether error stream isn't stderr */
300   char *trace_dump;               /* file to dump the network trace to */
301   FILE *trace_stream;
302   bool trace_fopened;
303   trace tracetype;
304   bool tracetime;                 /* include timestamp? */
305   int progressmode;               /* CURL_PROGRESS_BAR / CURL_PROGRESS_STATS */
306   char *libcurl;                  /* Output libcurl code to this file name */
307   bool fail_early;                /* exit on first transfer error */
308   bool styled_output;             /* enable fancy output style detection */
309 #ifdef CURLDEBUG
310   bool test_event_based;
311 #endif
312   bool parallel;
313   long parallel_max;
314   bool parallel_connect;
315   char *help_category;            /* The help category, if set */
316   struct OperationConfig *first;
317   struct OperationConfig *current;
318   struct OperationConfig *last;   /* Always last in the struct */
319 };
320 
321 void config_init(struct OperationConfig *config);
322 void config_free(struct OperationConfig *config);
323 
324 #endif /* HEADER_CURL_TOOL_CFGABLE_H */
325