1 /***************************************************************************
2 * _ _ ____ _
3 * Project ___| | | | _ \| |
4 * / __| | | | |_) | |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
7 *
8 * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
9 *
10 * This software is licensed as described in the file COPYING, which
11 * you should have received as part of this distribution. The terms
12 * are also available at https://curl.haxx.se/docs/copyright.html.
13 *
14 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 * copies of the Software, and permit persons to whom the Software is
16 * furnished to do so, under the terms of the COPYING file.
17 *
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
20 *
21 ***************************************************************************/
22 #include "tool_setup.h"
23
24 #include "tool_panykey.h"
25 #include "tool_help.h"
26 #include "tool_libinfo.h"
27 #include "tool_version.h"
28
29 #include "memdebug.h" /* keep this as LAST include */
30
31 #ifdef MSDOS
32 # define USE_WATT32
33 #endif
34
35 /*
36 * A few of these source lines are >80 columns wide, but that's only because
37 * breaking the strings narrower makes this chunk look even worse!
38 *
39 * Starting with 7.18.0, this list of command line options is sorted based
40 * on the long option name. It is not done automatically, although a command
41 * line like the following can help out:
42 *
43 * curl --help | cut -c5- | grep "^-" | sort
44 */
45
46 static const char *const helptext[] = {
47 "Usage: curl [options...] <url>",
48 "Options: (H) means HTTP/HTTPS only, (F) means FTP only",
49 " --anyauth Pick \"any\" authentication method (H)",
50 " -a, --append Append to target file when uploading (F/SFTP)",
51 " --basic Use HTTP Basic Authentication (H)",
52 " --cacert FILE CA certificate to verify peer against (SSL)",
53 " --capath DIR CA directory to verify peer against (SSL)",
54 " -E, --cert CERT[:PASSWD] Client certificate file and password (SSL)",
55 " --cert-status Verify the status of the server certificate (SSL)",
56 " --cert-type TYPE Certificate file type (DER/PEM/ENG) (SSL)",
57 " --ciphers LIST SSL ciphers to use (SSL)",
58 " --compressed Request compressed response (using deflate or gzip)",
59 " -K, --config FILE Read config from FILE",
60 " --connect-timeout SECONDS Maximum time allowed for connection",
61 " --connect-to HOST1:PORT1:HOST2:PORT2 Connect to host (network level)",
62 " -C, --continue-at OFFSET Resumed transfer OFFSET",
63 " -b, --cookie STRING/FILE Read cookies from STRING/FILE (H)",
64 " -c, --cookie-jar FILE Write cookies to FILE after operation (H)",
65 " --create-dirs Create necessary local directory hierarchy",
66 " --crlf Convert LF to CRLF in upload",
67 " --crlfile FILE Get a CRL list in PEM format from the given file",
68 " -d, --data DATA HTTP POST data (H)",
69 " --data-raw DATA HTTP POST data, '@' allowed (H)",
70 " --data-ascii DATA HTTP POST ASCII data (H)",
71 " --data-binary DATA HTTP POST binary data (H)",
72 " --data-urlencode DATA HTTP POST data url encoded (H)",
73 " --delegation STRING GSS-API delegation permission",
74 " --digest Use HTTP Digest Authentication (H)",
75 " --disable-eprt Inhibit using EPRT or LPRT (F)",
76 " --disable-epsv Inhibit using EPSV (F)",
77 " --dns-servers DNS server addrs to use: 1.1.1.1;2.2.2.2",
78 " --dns-interface Interface to use for DNS requests",
79 " --dns-ipv4-addr IPv4 address to use for DNS requests, dot notation",
80 " --dns-ipv6-addr IPv6 address to use for DNS requests, dot notation",
81 " -D, --dump-header FILE Write the headers to FILE",
82 " --egd-file FILE EGD socket path for random data (SSL)",
83 " --engine ENGINE Crypto engine (use \"--engine list\" for list) (SSL)",
84 #ifdef USE_ENVIRONMENT
85 " --environment Write results to environment variables (RISC OS)",
86 #endif
87 " --expect100-timeout SECONDS How long to wait for 100-continue (H)",
88 " -f, --fail Fail silently (no output at all) on HTTP errors (H)",
89 " --false-start Enable TLS False Start.",
90 " -F, --form CONTENT Specify HTTP multipart POST data (H)",
91 " --form-string STRING Specify HTTP multipart POST data (H)",
92 " --ftp-account DATA Account data string (F)",
93 " --ftp-alternative-to-user COMMAND "
94 "String to replace \"USER [name]\" (F)",
95 " --ftp-create-dirs Create the remote dirs if not present (F)",
96 " --ftp-method [MULTICWD/NOCWD/SINGLECWD] Control CWD usage (F)",
97 " --ftp-pasv Use PASV/EPSV instead of PORT (F)",
98 " -P, --ftp-port ADR Use PORT with given address instead of PASV (F)",
99 " --ftp-skip-pasv-ip Skip the IP address for PASV (F)\n"
100 " --ftp-pret Send PRET before PASV (for drftpd) (F)",
101 " --ftp-ssl-ccc Send CCC after authenticating (F)",
102 " --ftp-ssl-ccc-mode ACTIVE/PASSIVE Set CCC mode (F)",
103 " --ftp-ssl-control Require SSL/TLS for FTP login, "
104 "clear for transfer (F)",
105 " -G, --get Send the -d data with a HTTP GET (H)",
106 " -g, --globoff Disable URL sequences and ranges using {} and []",
107 " -H, --header LINE Pass custom header LINE to server (H)",
108 " -I, --head Show document info only",
109 " -h, --help This help text",
110 " --hostpubmd5 MD5 "
111 "Hex-encoded MD5 string of the host public key. (SSH)",
112 " -0, --http1.0 Use HTTP 1.0 (H)",
113 " --http1.1 Use HTTP 1.1 (H)",
114 " --http2 Use HTTP 2 (H)",
115 " --http2-prior-knowledge Use HTTP 2 without HTTP/1.1 Upgrade (H)",
116 " --ignore-content-length Ignore the HTTP Content-Length header",
117 " -i, --include Include protocol headers in the output (H/F)",
118 " -k, --insecure Allow connections to SSL sites without certs (H)",
119 " --interface INTERFACE Use network INTERFACE (or address)",
120 " -4, --ipv4 Resolve name to IPv4 address",
121 " -6, --ipv6 Resolve name to IPv6 address",
122 " -j, --junk-session-cookies Ignore session cookies read from file (H)",
123 " --keepalive-time SECONDS Wait SECONDS between keepalive probes",
124 " --key KEY Private key file name (SSL/SSH)",
125 " --key-type TYPE Private key file type (DER/PEM/ENG) (SSL)",
126 " --krb LEVEL Enable Kerberos with security LEVEL (F)",
127 #ifndef CURL_DISABLE_LIBCURL_OPTION
128 " --libcurl FILE Dump libcurl equivalent code of this command line",
129 #endif
130 " --limit-rate RATE Limit transfer speed to RATE",
131 " -l, --list-only List only mode (F/POP3)",
132 " --local-port RANGE Force use of RANGE for local port numbers",
133 " -L, --location Follow redirects (H)",
134 " --location-trusted "
135 "Like '--location', and send auth to other hosts (H)",
136 " --login-options OPTIONS Server login options (IMAP, POP3, SMTP)",
137 " -M, --manual Display the full manual",
138 " --mail-from FROM Mail from this address (SMTP)",
139 " --mail-rcpt TO Mail to this/these addresses (SMTP)",
140 " --mail-auth AUTH Originator address of the original email (SMTP)",
141 " --max-filesize BYTES Maximum file size to download (H/F)",
142 " --max-redirs NUM Maximum number of redirects allowed (H)",
143 " -m, --max-time SECONDS Maximum time allowed for the transfer",
144 " --metalink Process given URLs as metalink XML file",
145 " --negotiate Use HTTP Negotiate (SPNEGO) authentication (H)",
146 " -n, --netrc Must read .netrc for user name and password",
147 " --netrc-optional Use either .netrc or URL; overrides -n",
148 " --netrc-file FILE Specify FILE for netrc",
149 " -:, --next "
150 "Allows the following URL to use a separate set of options",
151 " --no-alpn Disable the ALPN TLS extension (H)",
152 " -N, --no-buffer Disable buffering of the output stream",
153 " --no-keepalive Disable keepalive use on the connection",
154 " --no-npn Disable the NPN TLS extension (H)",
155 " --no-sessionid Disable SSL session-ID reusing (SSL)",
156 " --noproxy List of hosts which do not use proxy",
157 " --ntlm Use HTTP NTLM authentication (H)",
158 " --ntlm-wb Use HTTP NTLM authentication with winbind (H)",
159 " --oauth2-bearer TOKEN OAuth 2 Bearer Token (IMAP, POP3, SMTP)",
160 " -o, --output FILE Write to FILE instead of stdout",
161 " --pass PASS Pass phrase for the private key (SSL/SSH)",
162 " --path-as-is Do not squash .. sequences in URL path",
163 " --pinnedpubkey FILE/HASHES Public key to verify peer against (SSL)",
164 " --post301 "
165 "Do not switch to GET after following a 301 redirect (H)",
166 " --post302 "
167 "Do not switch to GET after following a 302 redirect (H)",
168 " --post303 "
169 "Do not switch to GET after following a 303 redirect (H)",
170 " -#, --progress-bar Display transfer progress as a progress bar",
171 " --proto PROTOCOLS Enable/disable PROTOCOLS",
172 " --proto-default PROTOCOL Use PROTOCOL for any URL missing a scheme",
173 " --proto-redir PROTOCOLS Enable/disable PROTOCOLS on redirect",
174 " -x, --proxy [PROTOCOL://]HOST[:PORT] Use proxy on given port",
175 " --proxy-anyauth Pick \"any\" proxy authentication method (H)",
176 " --proxy-basic Use Basic authentication on the proxy (H)",
177 " --proxy-digest Use Digest authentication on the proxy (H)",
178 " --proxy-negotiate "
179 "Use HTTP Negotiate (SPNEGO) authentication on the proxy (H)",
180 " --proxy-ntlm Use NTLM authentication on the proxy (H)",
181 " --proxy-header LINE Pass custom header LINE to proxy (H)",
182 " --proxy-service-name NAME SPNEGO proxy service name",
183 " --service-name NAME SPNEGO service name",
184 " -U, --proxy-user USER[:PASSWORD] Proxy user and password",
185 " --proxy1.0 HOST[:PORT] Use HTTP/1.0 proxy on given port",
186 " -p, --proxytunnel Operate through a HTTP proxy tunnel (using CONNECT)",
187 " --pubkey KEY Public key file name (SSH)",
188 " -Q, --quote CMD Send command(s) to server before transfer (F/SFTP)",
189 " --random-file FILE File for reading random data from (SSL)",
190 " -r, --range RANGE Retrieve only the bytes within RANGE",
191 " --raw Do HTTP \"raw\"; no transfer decoding (H)",
192 " -e, --referer Referer URL (H)",
193 " -J, --remote-header-name Use the header-provided filename (H)",
194 " -O, --remote-name Write output to a file named as the remote file",
195 " --remote-name-all Use the remote file name for all URLs",
196 " -R, --remote-time Set the remote file's time on the local output",
197 " -X, --request COMMAND Specify request command to use",
198 " --resolve HOST:PORT:ADDRESS Force resolve of HOST:PORT to ADDRESS",
199 " --retry NUM "
200 "Retry request NUM times if transient problems occur",
201 " --retry-delay SECONDS Wait SECONDS between retries",
202 " --retry-max-time SECONDS Retry only within this period",
203 " --sasl-ir Enable initial response in SASL authentication",
204 " -S, --show-error "
205 "Show error. With -s, make curl show errors when they occur",
206 " -s, --silent Silent mode (don't output anything)",
207 " --socks4 HOST[:PORT] SOCKS4 proxy on given host + port",
208 " --socks4a HOST[:PORT] SOCKS4a proxy on given host + port",
209 " --socks5 HOST[:PORT] SOCKS5 proxy on given host + port",
210 " --socks5-hostname HOST[:PORT] "
211 "SOCKS5 proxy, pass host name to proxy",
212 " --socks5-gssapi-service NAME SOCKS5 proxy service name for GSS-API",
213 " --socks5-gssapi-nec Compatibility with NEC SOCKS5 server",
214 " -Y, --speed-limit RATE "
215 "Stop transfers below RATE for 'speed-time' secs",
216 " -y, --speed-time SECONDS "
217 "Trigger 'speed-limit' abort after SECONDS (default: 30)",
218 " --ssl Try SSL/TLS (FTP, IMAP, POP3, SMTP)",
219 " --ssl-reqd Require SSL/TLS (FTP, IMAP, POP3, SMTP)",
220 " -2, --sslv2 Use SSLv2 (SSL)",
221 " -3, --sslv3 Use SSLv3 (SSL)",
222 " --ssl-allow-beast Allow security flaw to improve interop (SSL)",
223 " --ssl-no-revoke Disable cert revocation checks (WinSSL)",
224 " --stderr FILE Where to redirect stderr (use \"-\" for stdout)",
225 " --tcp-nodelay Use the TCP_NODELAY option",
226 " --tcp-fastopen Use TCP Fast Open",
227 " -t, --telnet-option OPT=VAL Set telnet option",
228 " --tftp-blksize VALUE Set TFTP BLKSIZE option (must be >512)",
229 " --tftp-no-options Do not send TFTP options requests",
230 " -z, --time-cond TIME Transfer based on a time condition",
231 " -1, --tlsv1 Use >= TLSv1 (SSL)",
232 " --tlsv1.0 Use TLSv1.0 (SSL)",
233 " --tlsv1.1 Use TLSv1.1 (SSL)",
234 " --tlsv1.2 Use TLSv1.2 (SSL)",
235 " --trace FILE Write a debug trace to FILE",
236 " --trace-ascii FILE Like --trace, but without hex output",
237 " --trace-time Add time stamps to trace/verbose output",
238 " --tr-encoding Request compressed transfer encoding (H)",
239 " -T, --upload-file FILE Transfer FILE to destination",
240 " --url URL URL to work with",
241 " -B, --use-ascii Use ASCII/text transfer",
242 " -u, --user USER[:PASSWORD] Server user and password",
243 " --tlsuser USER TLS username",
244 " --tlspassword STRING TLS password",
245 " --tlsauthtype STRING TLS authentication type (default: SRP)",
246 " --unix-socket FILE Connect through this Unix domain socket",
247 " -A, --user-agent STRING Send User-Agent STRING to server (H)",
248 " -v, --verbose Make the operation more talkative",
249 " -V, --version Show version number and quit",
250 #ifdef USE_WATT32
251 " --wdebug Turn on Watt-32 debugging",
252 #endif
253 " -w, --write-out FORMAT Use output FORMAT after completion",
254 " --xattr Store metadata in extended file attributes",
255 " -q, --disable Disable .curlrc (must be first parameter)",
256 NULL
257 };
258
259 #ifdef NETWARE
260 # define PRINT_LINES_PAUSE 23
261 #endif
262
263 #ifdef __SYMBIAN32__
264 # define PRINT_LINES_PAUSE 16
265 #endif
266
267 struct feat {
268 const char *name;
269 int bitmask;
270 };
271
272 static const struct feat feats[] = {
273 {"AsynchDNS", CURL_VERSION_ASYNCHDNS},
274 {"Debug", CURL_VERSION_DEBUG},
275 {"TrackMemory", CURL_VERSION_CURLDEBUG},
276 {"IDN", CURL_VERSION_IDN},
277 {"IPv6", CURL_VERSION_IPV6},
278 {"Largefile", CURL_VERSION_LARGEFILE},
279 {"SSPI", CURL_VERSION_SSPI},
280 {"GSS-API", CURL_VERSION_GSSAPI},
281 {"Kerberos", CURL_VERSION_KERBEROS5},
282 {"SPNEGO", CURL_VERSION_SPNEGO},
283 {"NTLM", CURL_VERSION_NTLM},
284 {"NTLM_WB", CURL_VERSION_NTLM_WB},
285 {"SSL", CURL_VERSION_SSL},
286 {"libz", CURL_VERSION_LIBZ},
287 {"CharConv", CURL_VERSION_CONV},
288 {"TLS-SRP", CURL_VERSION_TLSAUTH_SRP},
289 {"HTTP2", CURL_VERSION_HTTP2},
290 {"UnixSockets", CURL_VERSION_UNIX_SOCKETS},
291 };
292
tool_help(void)293 void tool_help(void)
294 {
295 int i;
296 for(i = 0; helptext[i]; i++) {
297 puts(helptext[i]);
298 #ifdef PRINT_LINES_PAUSE
299 if(i && ((i % PRINT_LINES_PAUSE) == 0))
300 tool_pressanykey();
301 #endif
302 }
303 }
304
tool_version_info(void)305 void tool_version_info(void)
306 {
307 const char *const *proto;
308
309 printf(CURL_ID "%s\n", curl_version());
310 if(curlinfo->protocols) {
311 printf("Protocols: ");
312 for(proto = curlinfo->protocols; *proto; ++proto) {
313 printf("%s ", *proto);
314 }
315 puts(""); /* newline */
316 }
317 if(curlinfo->features) {
318 unsigned int i;
319 printf("Features: ");
320 for(i = 0; i < sizeof(feats)/sizeof(feats[0]); i++) {
321 if(curlinfo->features & feats[i].bitmask)
322 printf("%s ", feats[i].name);
323 }
324 #ifdef USE_METALINK
325 printf("Metalink ");
326 #endif
327 #ifdef USE_LIBPSL
328 printf("PSL ");
329 #endif
330 puts(""); /* newline */
331 }
332 }
333
tool_list_engines(CURL * curl)334 void tool_list_engines(CURL *curl)
335 {
336 struct curl_slist *engines = NULL;
337
338 /* Get the list of engines */
339 curl_easy_getinfo(curl, CURLINFO_SSL_ENGINES, &engines);
340
341 puts("Build-time engines:");
342 if(engines) {
343 for(; engines; engines = engines->next)
344 printf(" %s\n", engines->data);
345 }
346 else {
347 puts(" <none>");
348 }
349
350 /* Cleanup the list of engines */
351 curl_slist_free_all(engines);
352 }
353