blob: 5b981063711f704ab7845e3bba50ead1520bc6e3 [file] [log] [blame]
Daniel Stenbergeea22872004-03-16 07:56:51 +00001 _ _ ____ _
2 ___| | | | _ \| |
3 / __| | | | |_) | |
4 | (__| |_| | _ <| |___
Daniel Stenberg7c37c6a2000-05-22 17:35:35 +00005 \___|\___/|_| \_\_____|
6
7FAQ
8
Daniel Stenbergc3318b42000-08-17 14:06:42 +00009 1. Philosophy
10 1.1 What is cURL?
11 1.2 What is libcurl?
Daniel Stenbergc3688002004-10-04 12:54:58 +000012 1.3 What is curl not?
Daniel Stenbergc3318b42000-08-17 14:06:42 +000013 1.4 When will you make curl do XXXX ?
Daniel Stenbergc3688002004-10-04 12:54:58 +000014 1.5 Who makes curl?
15 1.6 What do you get for making curl?
Daniel Stenbergc528dc52001-08-07 11:17:37 +000016 1.7 What about CURL from curl.com?
Daniel Stenberg8eaa7fe2002-04-27 18:12:26 +000017 1.8 I have a problem who do I mail?
Daniel Stenberg9a44fa82005-11-02 09:34:53 +000018 1.9 Where do I buy commercial support for curl?
19 1.10 How many are using curl?
Daniel Stenberg15bf1682008-02-07 15:43:36 +000020 1.11 Why don't you update ca-bundle.crt
Daniel Stenberg8740d142009-06-09 09:02:39 +000021 1.12 I have a problem who can I chat with?
Daniel Stenberg59842d42010-08-18 16:54:11 +020022 1.13 curl's ECCN number?
Daniel Stenberga5f96b42010-10-06 20:03:13 +020023 1.14 How do I submit my patch?
Daniel Stenbergf81d3562015-05-26 19:13:09 +020024 1.15 How do I port libcurl to my OS?
Daniel Stenberg7c37c6a2000-05-22 17:35:35 +000025
Daniel Stenbergc3318b42000-08-17 14:06:42 +000026 2. Install Related Problems
27 2.1 configure doesn't find OpenSSL even when it is installed
Daniel Stenberg811edcd2004-08-10 08:41:41 +000028 2.1.1 native linker doesn't find OpenSSL
29 2.1.2 only the libssl lib is missing
Daniel Stenbergc3318b42000-08-17 14:06:42 +000030 2.2 Does curl work/build with other SSL libraries?
31 2.3 Where can I find a copy of LIBEAY32.DLL?
Dan Fandrich5c9fff92009-01-30 18:28:29 +000032 2.4 Does curl support SOCKS (RFC 1928) ?
Daniel Stenberg7c37c6a2000-05-22 17:35:35 +000033
Daniel Stenbergc3318b42000-08-17 14:06:42 +000034 3. Usage Problems
35 3.1 curl: (1) SSL is disabled, https: not supported
36 3.2 How do I tell curl to resume a transfer?
37 3.3 Why doesn't my posting using -F work?
38 3.4 How do I tell curl to run custom FTP commands?
Dan Fandrichb3740f02011-06-02 18:41:57 -070039 3.5 How can I disable the Accept: */* header?
Daniel Stenberg48bc73c2002-05-21 13:53:32 +000040 3.6 Does curl support ASP, XML, XHTML or HTML version Y?
Daniel Stenbergc3318b42000-08-17 14:06:42 +000041 3.7 Can I use curl to delete/rename a file through FTP?
42 3.8 How do I tell curl to follow HTTP redirects?
Daniel Stenberg98871d12002-05-22 22:14:03 +000043 3.9 How do I use curl in my favorite programming language?
Daniel Stenberg147a6732001-03-08 09:25:09 +000044 3.10 What about SOAP, WebDAV, XML-RPC or similar protocols over HTTP?
Daniel Stenberg88d14e92001-05-29 14:02:20 +000045 3.11 How do I POST with a different Content-Type?
Daniel Stenberg6513dce2001-11-27 13:34:59 +000046 3.12 Why do FTP specific features over HTTP proxy fail?
Daniel Stenberg6b1a1a62002-03-11 08:29:26 +000047 3.13 Why does my single/double quotes fail?
Dan Fandrich5c9fff92009-01-30 18:28:29 +000048 3.14 Does curl support Javascript or PAC (automated proxy config)?
Daniel Stenbergf3e5d4a2003-12-22 17:24:21 +000049 3.15 Can I do recursive fetches with curl?
Daniel Stenbergedd16d92004-08-12 11:39:00 +000050 3.16 What certificates do I need when I use SSL?
Daniel Stenberg951fdeb2004-12-21 09:37:55 +000051 3.17 How do I list the root dir of an FTP server?
Daniel Stenberge9eb5232005-04-05 14:36:37 +000052 3.18 Can I use curl to send a POST/PUT and not wait for a response?
Daniel Stenberg64f12a32010-09-07 19:05:07 +020053 3.19 How do I get HTTP from a host using a specific IP address?
Daniel Stenberg3f7b7de2011-03-07 22:27:26 +010054 3.20 How to SFTP from my user's home directory?
Daniel Stenberg0d0f8082011-03-08 11:15:59 +010055 3.21 Protocol xxx not supported or disabled in libcurl
Daniel Stenberg0ed4a092013-01-21 14:33:12 +010056 3.22 curl -X gives me HTTP problems
Daniel Stenberg7c37c6a2000-05-22 17:35:35 +000057
Daniel Stenbergc3318b42000-08-17 14:06:42 +000058 4. Running Problems
59 4.1 Problems connecting to SSL servers.
Daniel Stenberge26ee092001-01-15 10:26:37 +000060 4.2 Why do I get problems when I use & or % in the URL?
Daniel Stenbergc3318b42000-08-17 14:06:42 +000061 4.3 How can I use {, }, [ or ] to specify multiple URLs?
62 4.4 Why do I get downloaded data even though the web page doesn't exist?
63 4.5 Why do I get return code XXX from a HTTP server?
64 4.5.1 "400 Bad Request"
65 4.5.2 "401 Unauthorized"
66 4.5.3 "403 Forbidden"
67 4.5.4 "404 Not Found"
68 4.5.5 "405 Method Not Allowed"
Daniel Stenbergd60029d2001-12-19 23:25:04 +000069 4.5.6 "301 Moved Permanently"
Daniel Stenbergc3318b42000-08-17 14:06:42 +000070 4.6 Can you tell me what error code 142 means?
Daniel Stenberg4c485992001-04-22 15:45:27 +000071 4.7 How do I keep user names and passwords secret in Curl command lines?
Daniel Stenberg09ba8562000-10-27 12:25:00 +000072 4.8 I found a bug!
Daniel Stenberg2c100372000-12-19 07:30:51 +000073 4.9 Curl can't authenticate to the server that requires NTLM?
Daniel Stenbergbc743752002-05-15 21:40:29 +000074 4.10 My HTTP request using HEAD, PUT or DELETE doesn't work!
Daniel Stenberg522b85a2002-11-12 20:00:02 +000075 4.11 Why does my HTTP range requests return the full document?
Daniel Stenberg16077112002-11-20 19:17:43 +000076 4.12 Why do I get "certificate verify failed" ?
Daniel Stenberg1dc0ce92005-06-13 18:33:40 +000077 4.13 Why is curl -R on Windows one hour off?
Daniel Stenberg09cb9c72005-08-26 13:22:39 +000078 4.14 Redirects work in browser but not with curl!
Daniel Stenberg844cbc72007-07-29 22:17:39 +000079 4.15 FTPS doesn't work
Daniel Stenberg95df5d02008-09-24 07:50:46 +000080 4.16 My HTTP POST or PUT requests are slow!
Daniel Stenberg2afb88e2009-02-23 21:21:00 +000081 4.17 Non-functional connect timeouts on Windows
Daniel Stenbergb8012ea2009-11-07 21:52:41 +000082 4.18 file:// URLs containing drive letters (Windows, NetWare)
Daniel Stenberg0f199632016-10-18 13:59:54 +020083 4.19 Why doesn't curl return an error when the network cable is unplugged?
Daniel Stenberg889de6b2014-08-28 11:39:39 +020084 4.20 curl doesn't return error for HTTP non-200 responses!
Daniel Stenbergae823552015-03-04 18:24:46 +010085 4.21 Why is there a HTTP/1.1 in my HTTP/2 request?
Daniel Stenberg7c37c6a2000-05-22 17:35:35 +000086
Daniel Stenbergc3318b42000-08-17 14:06:42 +000087 5. libcurl Issues
Daniel Stenberg7d09e512001-01-11 12:52:07 +000088 5.1 Is libcurl thread-safe?
Daniel Stenberga40b55d2000-11-22 07:27:26 +000089 5.2 How can I receive all data into a large memory chunk?
Daniel Stenberg2c100372000-12-19 07:30:51 +000090 5.3 How do I fetch multiple files with libcurl?
Daniel Stenberg910fc852000-12-30 11:48:51 +000091 5.4 Does libcurl do Winsock initing on win32 systems?
Daniel Stenberg7e3cd822003-12-08 13:59:35 +000092 5.5 Does CURLOPT_WRITEDATA and CURLOPT_READDATA work on win32 ?
Daniel Stenberg4c485992001-04-22 15:45:27 +000093 5.6 What about Keep-Alive or persistent connections?
Daniel Stenbergdd82d692002-10-08 07:16:17 +000094 5.7 Link errors when building libcurl on Windows!
Daniel Stenberg9754b202010-08-11 09:15:43 +020095 5.8 libcurl.so.X: open failed: No such file or directory
Daniel Stenberg1d323362004-08-12 14:09:10 +000096 5.9 How does libcurl resolve host names?
Daniel Stenberge9eb5232005-04-05 14:36:37 +000097 5.10 How do I prevent libcurl from writing the response to stdout?
Daniel Stenberg6e8e0412005-04-05 14:38:38 +000098 5.11 How do I make libcurl not receive the whole HTTP response?
Daniel Stenbergb5d50e92005-04-11 13:39:55 +000099 5.12 Can I make libcurl fake or hide my real IP address?
Daniel Stenberg24602ed2007-12-10 10:28:56 +0000100 5.13 How do I stop an ongoing transfer?
Daniel Stenberg22059852008-09-24 07:39:42 +0000101 5.14 Using C++ non-static functions for callbacks?
Yang Tsea07bc792010-02-14 19:40:18 +0000102 5.15 How do I get an FTP directory listing?
Daniel Stenberge8ab9a02012-09-28 15:50:18 +0200103 5.16 I want a different time-out!
Daniel Stenbergdbf93a82013-01-03 10:15:02 +0100104 5.17 Can I write a server with libcurl?
Daniel Stenberg1495f422014-05-08 09:30:35 +0200105 5.18 Does libcurl use threads?
Daniel Stenberg7c37c6a2000-05-22 17:35:35 +0000106
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000107 6. License Issues
108 6.1 I have a GPL program, can I use the libcurl library?
109 6.2 I have a closed-source program, can I use the libcurl library?
Daniel Stenberg31b8eea2000-08-23 07:27:00 +0000110 6.3 I have a BSD licensed program, can I use the libcurl library?
111 6.4 I have a program that uses LGPL libraries, can I use libcurl?
112 6.5 Can I modify curl/libcurl for my program and keep the changes secret?
113 6.6 Can you please change the curl/libcurl license to XXXX?
Dan Fandrich5c9fff92009-01-30 18:28:29 +0000114 6.7 What are my obligations when using libcurl in my commercial apps?
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000115
Daniel Stenberg9ac76292004-08-18 11:18:36 +0000116 7. PHP/CURL Issues
117 7.1 What is PHP/CURL?
Daniel Stenberge38a7882011-03-17 11:30:29 +0100118 7.2 Who wrote PHP/CURL?
Daniel Stenberg9ac76292004-08-18 11:18:36 +0000119 7.3 Can I perform multiple requests using the same handle?
Daniel Stenberg6d496952017-05-12 19:58:06 +0200120 7.4 Does PHP/CURL have dependencies?
Daniel Stenberg9ac76292004-08-18 11:18:36 +0000121
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000122==============================================================================
123
1241. Philosophy
125
126 1.1 What is cURL?
127
Daniel Stenbergc3688002004-10-04 12:54:58 +0000128 cURL is the name of the project. The name is a play on 'Client for URLs',
129 originally with URL spelled in uppercase to make it obvious it deals with
130 URLs. The fact it can also be pronounced 'see URL' also helped, it works as
Dan Fandrichec2ad572005-04-13 19:31:00 +0000131 an abbreviation for "Client URL Request Library" or why not the recursive
Daniel Stenbergeea22872004-03-16 07:56:51 +0000132 version: "Curl URL Request Library".
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000133
Daniel Stenbergc3688002004-10-04 12:54:58 +0000134 The cURL project produces two products:
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000135
Daniel Stenbergc3688002004-10-04 12:54:58 +0000136 libcurl
137
Daniel Stenberg8d121b62010-08-27 23:15:45 +0200138 A free and easy-to-use client-side URL transfer library, supporting DICT,
139 FILE, FTP, FTPS, GOPHER, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, POP3,
Bill Nagel96c3b1a2014-11-30 16:51:26 -0500140 POP3S, RTMP, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS, TELNET and TFTP.
Daniel Stenbergac20f522010-08-18 19:43:06 +0200141
Daniel Stenberg7ac16812009-01-14 22:52:18 +0000142 libcurl supports HTTPS certificates, HTTP POST, HTTP PUT, FTP uploading,
Michael Osipov37f0e8a2014-08-02 13:51:18 +0100143 Kerberos, SPNEGO, HTTP form based upload, proxies, cookies, user+password
Daniel Stenberg7ac16812009-01-14 22:52:18 +0000144 authentication, file transfer resume, http proxy tunneling and more!
Daniel Stenbergc3688002004-10-04 12:54:58 +0000145
146 libcurl is highly portable, it builds and works identically on numerous
Michael Osipov37f0e8a2014-08-02 13:51:18 +0100147 platforms, including Solaris, NetBSD, FreeBSD, OpenBSD, Darwin, HP-UX,
Dan Fandrichcb787b72012-07-20 21:02:58 +0200148 IRIX, AIX, Tru64, Linux, UnixWare, HURD, Windows, Amiga, OS/2, BeOS, Mac
Dan Fandrichea1f30e2009-11-03 19:07:19 +0000149 OS X, Ultrix, QNX, OpenVMS, RISC OS, Novell NetWare, DOS, Symbian, OSF,
150 Android, Minix, IBM TPF and more...
Daniel Stenbergc3688002004-10-04 12:54:58 +0000151
152 libcurl is free, thread-safe, IPv6 compatible, feature rich, well
153 supported and fast.
Gisle Vanem51a87fa2004-11-24 15:14:42 +0000154
Daniel Stenbergc3688002004-10-04 12:54:58 +0000155 curl
156
157 A command line tool for getting or sending files using URL syntax.
158
Daniel Stenbergac20f522010-08-18 19:43:06 +0200159 Since curl uses libcurl, curl supports the same wide range of common
160 Internet protocols that libcurl does.
Daniel Stenbergc3688002004-10-04 12:54:58 +0000161
Daniel Stenberg17932a82014-09-19 10:01:45 +0200162 We pronounce curl with an initial k sound. It rhymes with words like girl
163 and earl. This is a short WAV file to help you:
164
Viktor Szakats13ef6232017-08-08 19:22:34 +0000165 https://media.merriam-webster.com/soundc11/c/curl0001.wav
Daniel Stenberg887e7282001-01-03 09:13:07 +0000166
Daniel Stenbergf83be112005-05-18 10:12:08 +0000167 There are numerous sub-projects and related projects that also use the word
168 curl in the project names in various combinations, but you should take
Daniel Stenberg073ef0b2003-05-09 07:07:13 +0000169 notice that this FAQ is directed at the command-line tool named curl (and
Daniel Stenbergeea22872004-03-16 07:56:51 +0000170 libcurl the library), and may therefore not be valid for other curl-related
Daniel Stenbergf83be112005-05-18 10:12:08 +0000171 projects. (There is however a small section for the PHP/CURL in this FAQ.)
Daniel Stenberg073ef0b2003-05-09 07:07:13 +0000172
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000173 1.2 What is libcurl?
174
Daniel Stenbergbc5954f2001-03-23 08:16:24 +0000175 libcurl is a reliable and portable library which provides you with an easy
Daniel Stenberg4c485992001-04-22 15:45:27 +0000176 interface to a range of common Internet protocols.
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000177
Daniel Stenbergeea22872004-03-16 07:56:51 +0000178 You can use libcurl for free in your application, be it open source,
179 commercial or closed-source.
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000180
Daniel Stenberg9a44fa82005-11-02 09:34:53 +0000181 libcurl is most probably the most portable, most powerful and most often
182 used C-based multi-platform file transfer library on this planet - be it
183 open source or commercial.
184
Daniel Stenbergc3688002004-10-04 12:54:58 +0000185 1.3 What is curl not?
Daniel Stenbergef34ad22000-06-02 12:45:23 +0000186
Daniel Stenberg890b34d2007-02-11 09:55:17 +0000187 Curl is not a wget clone. That is a common misconception. Never, during
Daniel Stenbergeea22872004-03-16 07:56:51 +0000188 curl's development, have we intended curl to replace wget or compete on its
189 market. Curl is targeted at single-shot file transfers.
190
191 Curl is not a web site mirroring program. If you want to use curl to mirror
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000192 something: fine, go ahead and write a script that wraps around curl to make
193 it reality (like curlmirror.pl does).
Daniel Stenbergef34ad22000-06-02 12:45:23 +0000194
Daniel Stenberg4c485992001-04-22 15:45:27 +0000195 Curl is not an FTP site mirroring program. Sure, get and send FTP with curl
196 but if you want systematic and sequential behavior you should write a
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000197 script (or write a new program that interfaces libcurl) and do it.
198
199 Curl is not a PHP tool, even though it works perfectly well when used from
Daniel Stenbergc3688002004-10-04 12:54:58 +0000200 or with PHP (when using the PHP/CURL module).
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000201
Daniel Stenberg890b34d2007-02-11 09:55:17 +0000202 Curl is not a program for a single operating system. Curl exists, compiles,
203 builds and runs under a wide range of operating systems, including all
204 modern Unixes (and a bunch of older ones too), Windows, Amiga, BeOS, OS/2,
205 OS X, QNX etc.
Daniel Stenberg31b8eea2000-08-23 07:27:00 +0000206
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000207 1.4 When will you make curl do XXXX ?
208
Daniel Stenberg11d718b2001-03-13 11:47:30 +0000209 We love suggestions of what to change in order to make curl and libcurl
210 better. We do however believe in a few rules when it comes to the future of
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000211 curl:
212
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200213 Curl -- the command line tool -- is to remain a non-graphical command line
214 tool. If you want GUIs or fancy scripting capabilities, you should look for
215 another tool that uses libcurl.
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000216
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200217 We do not add things to curl that other small and available tools already do
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600218 very well at the side. Curl's output can be piped into another program or
219 redirected to another file for the next program to interpret.
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000220
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200221 We focus on protocol related issues and improvements. If you wanna do more
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600222 magic with the supported protocols than curl currently does, chances are good
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200223 we will agree. If you wanna add more protocols, we may very well agree.
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000224
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600225 If you want someone else to do all the work while you wait for us to
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200226 implement it for you, that is not a very friendly attitude. We spend a
227 considerable time already on maintaining and developing curl. In order to
228 get more out of us, you should consider trading in some of your time and
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600229 effort in return. Simply go to the GitHub repo which resides at
Viktor Szakats20dcd192016-02-03 18:34:16 +0100230 https://github.com/curl/curl, fork the project, and create pull requests
paulehoffman53d1e422016-01-24 14:27:08 -0800231 with your proposed changes.
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000232
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600233 If you write the code, chances are better that it will get into curl faster.
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000234
Daniel Stenbergc3688002004-10-04 12:54:58 +0000235 1.5 Who makes curl?
Daniel Stenberga0eb52b2001-03-23 15:28:13 +0000236
Daniel Stenbergf83be112005-05-18 10:12:08 +0000237 curl and libcurl are not made by any single individual. Daniel Stenberg is
238 project leader and main developer, but other persons' submissions are
Daniel Stenbergd16c7572002-08-08 11:54:11 +0000239 important and crucial. Anyone can contribute and post their changes and
240 improvements and have them inserted in the main sources (of course on the
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600241 condition that developers agree that the fixes are good).
Daniel Stenberga0eb52b2001-03-23 15:28:13 +0000242
Daniel Stenbergdb2d52a2007-12-10 11:33:46 +0000243 The full list of all contributors is found in the docs/THANKS file.
Daniel Stenberga0eb52b2001-03-23 15:28:13 +0000244
245 curl is developed by a community, with Daniel at the wheel.
246
Daniel Stenbergc3688002004-10-04 12:54:58 +0000247 1.6 What do you get for making curl?
Daniel Stenberga0eb52b2001-03-23 15:28:13 +0000248
Daniel Stenbergd16c7572002-08-08 11:54:11 +0000249 Project cURL is entirely free and open. No person gets paid for developing
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600250 curl full time. We do this voluntarily, mostly in our spare time.
Daniel Stenbergb1341b32014-08-18 08:38:34 +0200251 Occasionally companies pay individual developers to work on curl, but that's
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600252 up to each company and developer. This is not controlled by nor supervised in
Daniel Stenbergb1341b32014-08-18 08:38:34 +0200253 any way by the project.
Daniel Stenberga0eb52b2001-03-23 15:28:13 +0000254
Daniel Stenberg72acffc2009-10-22 07:56:10 +0000255 We still get help from companies. Haxx provides web site, bandwidth, mailing
Daniel Stenberg07f97802013-02-08 09:58:23 +0100256 lists etc, sourceforge.net hosts project services we take advantage from,
paulehoffman53d1e422016-01-24 14:27:08 -0800257 like the bug tracker, and GitHub hosts the primary git repository at
Viktor Szakats20dcd192016-02-03 18:34:16 +0100258 https://github.com/curl/curl. Also again, some companies have sponsored
paulehoffman53d1e422016-01-24 14:27:08 -0800259 certain parts of the development in the past and I hope some will continue to
260 do so in the future.
Daniel Stenberga0eb52b2001-03-23 15:28:13 +0000261
Daniel Stenbergf83be112005-05-18 10:12:08 +0000262 If you want to support our project, consider a donation or a banner-program
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600263 or even better: by helping us with coding, documenting or testing etc.
Daniel Stenbergc528dc52001-08-07 11:17:37 +0000264
265 1.7 What about CURL from curl.com?
266
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600267 During the summer of 2001, curl.com was busy advertising their client-side
Daniel Stenbergc528dc52001-08-07 11:17:37 +0000268 programming language for the web, named CURL.
269
Daniel Stenberg81b6ebc2001-08-07 18:02:37 +0000270 We are in no way associated with curl.com or their CURL programming
Daniel Stenbergeea22872004-03-16 07:56:51 +0000271 language.
Daniel Stenbergc528dc52001-08-07 11:17:37 +0000272
Daniel Stenberg81b6ebc2001-08-07 18:02:37 +0000273 Our project name curl has been in effective use since 1998. We were not the
Daniel Stenberg4045cd52001-08-07 21:21:24 +0000274 first computer related project to use the name "curl" and do not claim any
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200275 rights to the name.
Daniel Stenbergc528dc52001-08-07 11:17:37 +0000276
Daniel Stenberg81b6ebc2001-08-07 18:02:37 +0000277 We recognize that we will be living in parallel with curl.com and wish them
278 every success.
Daniel Stenbergc528dc52001-08-07 11:17:37 +0000279
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600280 1.8 I have a problem whom do I mail?
Daniel Stenberg8eaa7fe2002-04-27 18:12:26 +0000281
Daniel Stenbergdb5c9cd2003-02-25 08:52:32 +0000282 Please do not mail any single individual unless you really need to. Keep
283 curl-related questions on a suitable mailing list. All available mailing
284 lists are listed in the MANUAL document and online at
Daniel Stenberg6b485c72016-02-02 00:24:30 +0100285 https://curl.haxx.se/mail/
Daniel Stenberg8eaa7fe2002-04-27 18:12:26 +0000286
Daniel Stenbergdb5c9cd2003-02-25 08:52:32 +0000287 Keeping curl-related questions and discussions on mailing lists allows
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600288 others to join in and help, to share their ideas, to contribute their
289 suggestions and to spread their wisdom. Keeping discussions on public mailing
Daniel Stenbergdb5c9cd2003-02-25 08:52:32 +0000290 lists also allows for others to learn from this (both current and future
291 users thanks to the web based archives of the mailing lists), thus saving us
292 from having to repeat ourselves even more. Thanks for respecting this.
Daniel Stenberg8eaa7fe2002-04-27 18:12:26 +0000293
Daniel Stenberg0b8f57b2005-08-07 14:36:55 +0000294 If you have found or simply suspect a security problem in curl or libcurl,
295 mail curl-security at haxx.se (closed list of receivers, mails are not
296 disclosed) and tell. Then we can produce a fix in a timely manner before the
297 flaw is announced to the world, thus lessen the impact the problem will have
298 on existing users.
299
Daniel Stenberg9a44fa82005-11-02 09:34:53 +0000300 1.9 Where do I buy commercial support for curl?
301
302 curl is fully open source. It means you can hire any skilled engineer to fix
303 your curl-related problems.
304
305 We list available alternatives on the curl web site:
Daniel Stenberg6b485c72016-02-02 00:24:30 +0100306 https://curl.haxx.se/support.html
Daniel Stenberg9a44fa82005-11-02 09:34:53 +0000307
308 1.10 How many are using curl?
309
310 It is impossible to tell.
311
312 We don't know how many users that knowingly have installed and use curl.
313
314 We don't know how many users that use curl without knowing that they are in
315 fact using it.
316
317 We don't know how many users that downloaded or installed curl and then
318 never use it.
319
Daniel Stenbergfec096f2012-05-16 23:17:47 +0200320 In May 2012 Daniel did a counting game and came up with a number that may
Daniel Stenberg07f97802013-02-08 09:58:23 +0100321 be completely wrong or somewhat accurate. Over 500 million!
Daniel Stenberg9a44fa82005-11-02 09:34:53 +0000322
Dan Fandrich093f9cd2016-02-03 01:45:21 +0100323 See https://daniel.haxx.se/blog/2012/05/16/300m-users/
Daniel Stenberg9a44fa82005-11-02 09:34:53 +0000324
Daniel Stenberg15bf1682008-02-07 15:43:36 +0000325 1.11 Why don't you update ca-bundle.crt
326
Daniel Stenberg6d496952017-05-12 19:58:06 +0200327 The ca cert bundle that used to be shipped with curl was very outdated and
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600328 must be replaced with an up-to-date version by anyone who wants to verify
329 peers. It is no longer provided by curl. The last curl release that ever
Daniel Stenberg07f97802013-02-08 09:58:23 +0100330 shipped a ca cert bundle was curl 7.18.0.
Daniel Stenberg15bf1682008-02-07 15:43:36 +0000331
332 In the cURL project we've decided not to attempt to keep this file updated
Daniel Stenberg074bd2a2008-02-18 11:39:11 +0000333 (or even present anymore) since deciding what to add to a ca cert bundle is
334 an undertaking we've not been ready to accept, and the one we can get from
335 Mozilla is perfectly fine so there's no need to duplicate that work.
Daniel Stenberg15bf1682008-02-07 15:43:36 +0000336
337 Today, with many services performed over HTTPS, every operating system
338 should come with a default ca cert bundle that can be deemed somewhat
339 trustworthy and that collection (if reasonably updated) should be deemed to
Daniel Stenberg074bd2a2008-02-18 11:39:11 +0000340 be a lot better than a private curl version.
Daniel Stenberg15bf1682008-02-07 15:43:36 +0000341
Daniel Stenberg074bd2a2008-02-18 11:39:11 +0000342 If you want the most recent collection of ca certs that Mozilla Firefox
343 uses, we recommend that you extract the collection yourself from Mozilla
344 Firefox (by running 'make ca-bundle), or by using our online service setup
Daniel Stenberg6b485c72016-02-02 00:24:30 +0100345 for this purpose: https://curl.haxx.se/docs/caextract.html
Daniel Stenberg15bf1682008-02-07 15:43:36 +0000346
Daniel Stenberg8740d142009-06-09 09:02:39 +0000347 1.12 I have a problem who can I chat with?
348
349 There's a bunch of friendly people hanging out in the #curl channel on the
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600350 IRC network irc.freenode.net. If you're polite and nice, chances are good
Daniel Stenberg8740d142009-06-09 09:02:39 +0000351 that you can get -- or provide -- help instantly.
352
Daniel Stenberg59842d42010-08-18 16:54:11 +0200353 1.13 curl's ECCN number?
354
355 The US government restricts exports of software that contains or uses
356 cryptography. When doing so, the Export Control Classification Number (ECCN)
357 is used to identify the level of export control etc.
358
Daniel Stenbergb8235962016-01-04 18:59:29 +0100359 Apache Software Foundation gives a good explanation of ECCNs at
360 https://www.apache.org/dev/crypto.html
Daniel Stenberg59842d42010-08-18 16:54:11 +0200361
362 We believe curl's number might be ECCN 5D002, another possibility is
Daniel Stenbergb8235962016-01-04 18:59:29 +0100363 5D992. It seems necessary to write them (the authority that administers ECCN
364 numbers), asking to confirm.
Daniel Stenberg59842d42010-08-18 16:54:11 +0200365
Daniel Stenbergb8235962016-01-04 18:59:29 +0100366 Comprehensible explanations of the meaning of such numbers and how to obtain
367 them (resp.) are here
Daniel Stenberg59842d42010-08-18 16:54:11 +0200368
Viktor Szakats13ef6232017-08-08 19:22:34 +0000369 https://www.bis.doc.gov/licensing/exportingbasics.htm
370 https://www.bis.doc.gov/licensing/do_i_needaneccn.html
Daniel Stenberg59842d42010-08-18 16:54:11 +0200371
372 An incomprehensible description of the two numbers above is here
373 http://www.access.gpo.gov/bis/ear/pdf/ccl5-pt2.pdf
374
Daniel Stenberga5f96b42010-10-06 20:03:13 +0200375 1.14 How do I submit my patch?
376
377 When you have made a patch or a change of whatever sort, and want to submit
378 that to the project, there are a few different ways we prefer:
379
380 o send a patch to the curl-library mailing list. We're many subscribers
381 there and there are lots of people who can review patches, comment on them
382 and "receive" them properly.
383
384 o if your patch changes or fixes a bug, you can also opt to submit a bug
385 report in the bug tracker and attach your patch there. There are less
386 people involved there.
387
388 Lots of more details are found in the CONTRIBUTE and INTERNALS docs.
389
Daniel Stenbergf81d3562015-05-26 19:13:09 +0200390 1.15 How do I port libcurl to my OS?
391
392 Here's a rough step-by-step:
393
394 1. copy a suitable lib/config-*.h file as a start to lib/config-[youros].h
395
396 2. edit lib/config-[youros].h to match your OS and setup
397
398 3. edit lib/curl_setup.h to include config-[youros].h when your OS is
399 detected by the preprocessor, in the style others already exist
400
401 4. compile lib/*.c and make them into a library
402
Daniel Stenberg8eaa7fe2002-04-27 18:12:26 +0000403
Daniel Stenbergc3318b42000-08-17 14:06:42 +00004042. Install Related Problems
405
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000406 2.1 configure doesn't find OpenSSL even when it is installed
Daniel Stenberg7c37c6a2000-05-22 17:35:35 +0000407
Daniel Stenbergef34ad22000-06-02 12:45:23 +0000408 This may be because of several reasons.
Daniel Stenberg7c37c6a2000-05-22 17:35:35 +0000409
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000410 2.1.1 native linker doesn't find openssl
Daniel Stenberg7c37c6a2000-05-22 17:35:35 +0000411
Daniel Stenbergbfb16902000-08-17 11:42:59 +0000412 Affected platforms:
413 Solaris (native cc compiler)
414 HPUX (native cc compiler)
415 SGI IRIX (native cc compiler)
Daniel Stenberg13962ad2000-09-28 10:26:44 +0000416 SCO UNIX (native cc compiler)
Daniel Stenberg7c37c6a2000-05-22 17:35:35 +0000417
Daniel Stenbergef34ad22000-06-02 12:45:23 +0000418 When configuring curl, I specify --with-ssl. OpenSSL is installed in
419 /usr/local/ssl Configure reports SSL in /usr/local/ssl, but fails to find
420 CRYPTO_lock in -lcrypto
Daniel Stenberg7c37c6a2000-05-22 17:35:35 +0000421
Daniel Stenbergef34ad22000-06-02 12:45:23 +0000422 Cause: The cc for this test places the -L/usr/local/ssl/lib AFTER
423 -lcrypto, so ld can't find the library. This is due to a bug in the GNU
424 autoconf tool.
425
426 Workaround: Specifying "LDFLAGS=-L/usr/local/ssl/lib" in front of
427 ./configure places the -L/usr/local/ssl/lib early enough in the command
428 line to make things work
429
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000430 2.1.2 only the libssl lib is missing
Daniel Stenbergef34ad22000-06-02 12:45:23 +0000431
432 If all include files and the libcrypto lib is present, with only the
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600433 libssl being missing according to configure, this is most likely because
Daniel Stenbergef34ad22000-06-02 12:45:23 +0000434 a few functions are left out from the libssl.
435
436 If the function names missing include RSA or RSAREF you can be certain
Daniel Stenberg4c485992001-04-22 15:45:27 +0000437 that this is because libssl requires the RSA and RSAREF libs to build.
Daniel Stenbergef34ad22000-06-02 12:45:23 +0000438
439 See the INSTALL file section that explains how to add those libs to
440 configure. Make sure that you remove the config.cache file before you
441 rerun configure with the new flags.
442
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000443 2.2 Does curl work/build with other SSL libraries?
Daniel Stenberge9640b62000-08-02 07:17:56 +0000444
Daniel Stenberg045c7342013-01-23 13:17:36 +0100445 Curl has been written to use a generic SSL function layer internally, and
446 that SSL functionality can then be provided by one out of many different SSL
447 backends.
448
449 curl can be built to use one of the following SSL alternatives: OpenSSL,
Nick Zitzmann23a47ef2013-01-23 17:41:23 -0700450 GnuTLS, yassl, NSS, PolarSSL, axTLS, Secure Transport (native iOS/OS X),
Patrick Monnerat265b9a22014-10-13 16:33:47 +0200451 WinSSL (native Windows) or GSKit (native IBM i). They all have their pros
Nick Zitzmann23a47ef2013-01-23 17:41:23 -0700452 and cons, and we try to maintain a comparison of them here:
Daniel Stenberg6b485c72016-02-02 00:24:30 +0100453 https://curl.haxx.se/docs/ssl-compared.html
Daniel Stenberge9640b62000-08-02 07:17:56 +0000454
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000455 2.3 Where can I find a copy of LIBEAY32.DLL?
Daniel Stenberge9640b62000-08-02 07:17:56 +0000456
457 That is an OpenSSL binary built for Windows.
458
Daniel Stenberg07f97802013-02-08 09:58:23 +0100459 Curl can be built with OpenSSL to do the SSL stuff. The LIBEAY32.DLL is then
460 what curl needs on a windows machine to do https:// etc. Check out the curl
461 web site to find accurate and up-to-date pointers to recent OpenSSL DLLs and
462 other binary packages.
Daniel Stenberge9640b62000-08-02 07:17:56 +0000463
Dan Fandrich5c9fff92009-01-30 18:28:29 +0000464 2.4 Does curl support SOCKS (RFC 1928) ?
Daniel Stenberge9640b62000-08-02 07:17:56 +0000465
Daniel Stenberg844cbc72007-07-29 22:17:39 +0000466 Yes, SOCKS 4 and 5 are supported.
Daniel Stenberge9640b62000-08-02 07:17:56 +0000467
468
Daniel Stenbergc3318b42000-08-17 14:06:42 +00004693. Usage problems
Daniel Stenberge9640b62000-08-02 07:17:56 +0000470
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000471 3.1 curl: (1) SSL is disabled, https: not supported
Daniel Stenberge9640b62000-08-02 07:17:56 +0000472
473 If you get this output when trying to get anything from a https:// server,
Daniel Stenberg0d0f8082011-03-08 11:15:59 +0100474 it means that the instance of curl/libcurl that you're using was built
475 without support for this protocol.
476
477 This could've happened if the configure script that was run at build time
478 couldn't find all libs and include files curl requires for SSL to work. If
479 the configure script fails to find them, curl is simply built without SSL
480 support.
Daniel Stenberge9640b62000-08-02 07:17:56 +0000481
482 To get the https:// support into a curl that was previously built but that
483 reports that https:// is not supported, you should dig through the document
484 and logs and check out why the configure script doesn't find the SSL libs
485 and/or include files.
486
Dan Fandrichea1f30e2009-11-03 19:07:19 +0000487 Also, check out the other paragraph in this FAQ labelled "configure doesn't
Daniel Stenberge9640b62000-08-02 07:17:56 +0000488 find OpenSSL even when it is installed".
489
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000490 3.2 How do I tell curl to resume a transfer?
Daniel Stenberge9640b62000-08-02 07:17:56 +0000491
Daniel Stenberg11d718b2001-03-13 11:47:30 +0000492 Curl supports resumed transfers both ways on both FTP and HTTP.
Daniel Stenberg887e7282001-01-03 09:13:07 +0000493 Try the -C option.
Daniel Stenberge9640b62000-08-02 07:17:56 +0000494
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000495 3.3 Why doesn't my posting using -F work?
Daniel Stenberge9640b62000-08-02 07:17:56 +0000496
Daniel Stenberg6d496952017-05-12 19:58:06 +0200497 You can't arbitrarily use -F or -d, the choice between -F or -d depends on the
498 HTTP operation you need curl to do and what the web server that will receive
499 your post expects.
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600500
Daniel Stenberg6d496952017-05-12 19:58:06 +0200501 If the form you're trying to submit uses the type 'multipart/form-data', then
502 and only then you must use the -F type. In all the most common cases, you
503 should use -d which then causes a posting with the type
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600504 'application/x-www-form-urlencoded'.
Daniel Stenberge9640b62000-08-02 07:17:56 +0000505
Daniel Stenberg4c485992001-04-22 15:45:27 +0000506 This is described in some detail in the MANUAL and TheArtOfHttpScripting
507 documents, and if you don't understand it the first time, read it again
508 before you post questions about this to the mailing list. Also, try reading
509 through the mailing list archives for old postings and questions regarding
510 this.
Daniel Stenberge9640b62000-08-02 07:17:56 +0000511
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000512 3.4 How do I tell curl to run custom FTP commands?
Daniel Stenberge9640b62000-08-02 07:17:56 +0000513
514 You can tell curl to perform optional commands both before and/or after a
515 file transfer. Study the -Q/--quote option.
516
Daniel Stenberg68e2c9a2012-11-25 19:44:49 +0100517 Since curl is used for file transfers, you don't normally use curl to
518 perform FTP commands without transferring anything. Therefore you must
519 always specify a URL to transfer to/from even when doing custom FTP
520 commands, or use -I which implies the "no body" option sent to libcurl.
Daniel Stenberge9640b62000-08-02 07:17:56 +0000521
Dan Fandrichb3740f02011-06-02 18:41:57 -0700522 3.5 How can I disable the Accept: */* header?
Daniel Stenberge9640b62000-08-02 07:17:56 +0000523
524 You can change all internally generated headers by adding a replacement with
525 the -H/--header option. By adding a header with empty contents you safely
Dan Fandrichb3740f02011-06-02 18:41:57 -0700526 disable that one. Use -H "Accept:" to disable that specific header.
Daniel Stenberge9640b62000-08-02 07:17:56 +0000527
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000528 3.6 Does curl support ASP, XML, XHTML or HTML version Y?
Daniel Stenberge9640b62000-08-02 07:17:56 +0000529
530 To curl, all contents are alike. It doesn't matter how the page was
Daniel Stenberg07f97802013-02-08 09:58:23 +0100531 generated. It may be ASP, PHP, Perl, shell-script, SSI or plain HTML
532 files. There's no difference to curl and it doesn't even know what kind of
533 language that generated the page.
Daniel Stenberge9640b62000-08-02 07:17:56 +0000534
Daniel Stenberg20807382002-05-21 14:00:55 +0000535 See also item 3.14 regarding javascript.
Daniel Stenberge9640b62000-08-02 07:17:56 +0000536
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000537 3.7 Can I use curl to delete/rename a file through FTP?
Daniel Stenberge9640b62000-08-02 07:17:56 +0000538
Daniel Stenberg4c485992001-04-22 15:45:27 +0000539 Yes. You specify custom FTP commands with -Q/--quote.
Daniel Stenberge9640b62000-08-02 07:17:56 +0000540
541 One example would be to delete a file after you have downloaded it:
542
543 curl -O ftp://download.com/coolfile -Q '-DELE coolfile'
544
Daniel Stenberg33b9daa2007-06-26 21:53:46 +0000545 or rename a file after upload:
546
547 curl -T infile ftp://upload.com/dir/ -Q "-RNFR infile" -Q "-RNTO newname"
548
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000549 3.8 How do I tell curl to follow HTTP redirects?
Daniel Stenberge9640b62000-08-02 07:17:56 +0000550
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000551 Curl does not follow so-called redirects by default. The Location: header
552 that informs the client about this is only interpreted if you're using the
553 -L/--location option. As in:
Daniel Stenberge9640b62000-08-02 07:17:56 +0000554
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000555 curl -L http://redirector.com
556
Daniel Stenberg09cb9c72005-08-26 13:22:39 +0000557 Not all redirects are HTTP ones, see 4.14
558
Daniel Stenberg98871d12002-05-22 22:14:03 +0000559 3.9 How do I use curl in my favorite programming language?
Daniel Stenberg368e3522001-01-29 10:16:21 +0000560
Daniel Stenbergdfdf4912001-12-21 09:20:04 +0000561 There exist many language interfaces/bindings for curl that integrates it
562 better with various languages. If you are fluid in a script language, you
563 may very well opt to use such an interface instead of using the command line
564 tool.
Daniel Stenberg4c485992001-04-22 15:45:27 +0000565
Daniel Stenberg4c485992001-04-22 15:45:27 +0000566 Find out more about which languages that support curl directly, and how to
567 install and use them, in the libcurl section of the curl web site:
Daniel Stenberg6b485c72016-02-02 00:24:30 +0100568 https://curl.haxx.se/libcurl/
Daniel Stenberg368e3522001-01-29 10:16:21 +0000569
Daniel Stenberg832e8272011-06-13 19:02:38 +0200570 All the various bindings to libcurl are made by other projects and people,
571 outside of the cURL project. The cURL project itself only produces libcurl
572 with its plain C API. If you don't find anywhere else to ask you can ask
573 about bindings on the curl-library list too, but be prepared that people on
574 that list may not know anything about bindings.
575
Dan Fandrichea1f30e2009-11-03 19:07:19 +0000576 In October 2009, there were interfaces available for the following
577 languages: Ada95, Basic, C, C++, Ch, Cocoa, D, Dylan, Eiffel, Euphoria,
578 Ferite, Gambas, glib/GTK+, Haskell, ILE/RPG, Java, Lisp, Lua, Mono, .NET,
Sylvestre Ledru658b9a22017-03-04 15:50:33 +0100579 Object-Pascal, OCaml, Pascal, Perl, PHP, PostgreSQL, Python, R, Rexx, Ruby,
Dan Fandrichea1f30e2009-11-03 19:07:19 +0000580 Scheme, S-Lang, Smalltalk, SP-Forth, SPL, Tcl, Visual Basic, Visual FoxPro,
581 Q, wxwidgets and XBLite. By the time you read this, additional ones may have
582 appeared!
Daniel Stenberg368e3522001-01-29 10:16:21 +0000583
Daniel Stenberg147a6732001-03-08 09:25:09 +0000584 3.10 What about SOAP, WebDAV, XML-RPC or similar protocols over HTTP?
Daniel Stenbergc59baa02001-02-12 10:05:09 +0000585
586 Curl adheres to the HTTP spec, which basically means you can play with *any*
Daniel Stenberg4c485992001-04-22 15:45:27 +0000587 protocol that is built on top of HTTP. Protocols such as SOAP, WEBDAV and
Daniel Stenbergc59baa02001-02-12 10:05:09 +0000588 XML-RPC are all such ones. You can use -X to set custom requests and -H to
589 set custom headers (or replace internally generated ones).
590
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600591 Using libcurl is of course just as good and you'd just use the proper
Daniel Stenbergdb5c9cd2003-02-25 08:52:32 +0000592 library options to do the same.
Daniel Stenbergc59baa02001-02-12 10:05:09 +0000593
Daniel Stenberg88d14e92001-05-29 14:02:20 +0000594 3.11 How do I POST with a different Content-Type?
595
596 You can always replace the internally generated headers with -H/--header.
597 To make a simple HTTP POST with text/xml as content-type, do something like:
598
599 curl -d "datatopost" -H "Content-Type: text/xml" [URL]
600
Daniel Stenberg50e9f8f2001-10-23 10:12:28 +0000601 3.12 Why do FTP specific features over HTTP proxy fail?
Daniel Stenberg7d3daa52001-10-23 10:12:00 +0000602
603 Because when you use a HTTP proxy, the protocol spoken on the network will
604 be HTTP, even if you specify a FTP URL. This effectively means that you
Daniel Stenberg98871d12002-05-22 22:14:03 +0000605 normally can't use FTP specific features such as FTP upload and FTP quote
Daniel Stenberg7d3daa52001-10-23 10:12:00 +0000606 etc.
607
608 There is one exception to this rule, and that is if you can "tunnel through"
Daniel Stenberg271f96f2001-11-20 08:03:01 +0000609 the given HTTP proxy. Proxy tunneling is enabled with a special option (-p)
Daniel Stenberg97a8c982001-12-21 08:10:34 +0000610 and is generally not available as proxy admins usually disable tunneling to
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600611 ports other than 443 (which is used for HTTPS access through proxies).
Daniel Stenberg7d3daa52001-10-23 10:12:00 +0000612
Daniel Stenberg6b1a1a62002-03-11 08:29:26 +0000613 3.13 Why does my single/double quotes fail?
614
615 To specify a command line option that includes spaces, you might need to
616 put the entire option within quotes. Like in:
617
618 curl -d " with spaces " url.com
Daniel Stenbergeea22872004-03-16 07:56:51 +0000619
Daniel Stenberg6b1a1a62002-03-11 08:29:26 +0000620 or perhaps
621
622 curl -d ' with spaces ' url.com
623
624 Exactly what kind of quotes and how to do this is entirely up to the shell
Daniel Stenberg98871d12002-05-22 22:14:03 +0000625 or command line interpreter that you are using. For most unix shells, you
Daniel Stenberg6b1a1a62002-03-11 08:29:26 +0000626 can more or less pick either single (') or double (") quotes. For
627 Windows/DOS prompts I believe you're forced to use double (") quotes.
628
Daniel Stenberg98871d12002-05-22 22:14:03 +0000629 Please study the documentation for your particular environment. Examples in
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600630 the curl docs will use a mix of both of these as shown above. You must
Daniel Stenberg6b1a1a62002-03-11 08:29:26 +0000631 adjust them to work in your environment.
632
Daniel Stenberg61f62842002-03-11 08:39:00 +0000633 Remember that curl works and runs on more operating systems than most single
Daniel Stenberg6b1a1a62002-03-11 08:29:26 +0000634 individuals have ever tried.
635
Dan Fandrich5c9fff92009-01-30 18:28:29 +0000636 3.14 Does curl support Javascript or PAC (automated proxy config)?
Daniel Stenberg48bc73c2002-05-21 13:53:32 +0000637
Dan Fandrich5c9fff92009-01-30 18:28:29 +0000638 Many web pages do magic stuff using embedded Javascript. Curl and libcurl
Daniel Stenberg48bc73c2002-05-21 13:53:32 +0000639 have no built-in support for that, so it will be treated just like any other
640 contents.
641
642 .pac files are a netscape invention and are sometimes used by organizations
643 to allow them to differentiate which proxies to use. The .pac contents is
Dan Fandrich5c9fff92009-01-30 18:28:29 +0000644 just a Javascript program that gets invoked by the browser and that returns
645 the name of the proxy to connect to. Since curl doesn't support Javascript,
Daniel Stenberg48bc73c2002-05-21 13:53:32 +0000646 it can't support .pac proxy configuration either.
647
Dan Fandrichea1f30e2009-11-03 19:07:19 +0000648 Some workarounds usually suggested to overcome this Javascript dependency:
Daniel Stenberg48bc73c2002-05-21 13:53:32 +0000649
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200650 Depending on the Javascript complexity, write up a script that translates it
651 to another language and execute that.
Daniel Stenberg48bc73c2002-05-21 13:53:32 +0000652
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200653 Read the Javascript code and rewrite the same logic in another language.
Daniel Stenberg48bc73c2002-05-21 13:53:32 +0000654
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200655 Implement a Javascript interpreter, people have successfully used the
656 Mozilla Javascript engine in the past.
Daniel Stenberg48bc73c2002-05-21 13:53:32 +0000657
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200658 Ask your admins to stop this, for a static proxy setup or similar.
Daniel Stenberg48bc73c2002-05-21 13:53:32 +0000659
Daniel Stenbergf3e5d4a2003-12-22 17:24:21 +0000660 3.15 Can I do recursive fetches with curl?
661
662 No. curl itself has no code that performs recursive operations, such as
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000663 those performed by wget and similar tools.
Daniel Stenbergf3e5d4a2003-12-22 17:24:21 +0000664
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600665 There exists wrapper scripts with that functionality (for example the
Daniel Stenbergf3e5d4a2003-12-22 17:24:21 +0000666 curlmirror perl script), and you can write programs based on libcurl to do
667 it, but the command line tool curl itself cannot.
Daniel Stenberg6b1a1a62002-03-11 08:29:26 +0000668
Daniel Stenbergedd16d92004-08-12 11:39:00 +0000669 3.16 What certificates do I need when I use SSL?
Daniel Stenberg43563562004-08-12 11:02:01 +0000670
671 There are three different kinds of "certificates" to keep track of when we
672 talk about using SSL-based protocols (HTTPS or FTPS) using curl or libcurl.
673
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200674 CLIENT CERTIFICATE
Daniel Stenberg43563562004-08-12 11:02:01 +0000675
Daniel Stenberg6d496952017-05-12 19:58:06 +0200676 The server you communicate with may require that you can provide this in
677 order to prove that you actually are who you claim to be. If the server
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600678 doesn't require this, you don't need a client certificate.
Daniel Stenberg64f12a32010-09-07 19:05:07 +0200679
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200680 A client certificate is always used together with a private key, and the
681 private key has a pass phrase that protects it.
Daniel Stenberg43563562004-08-12 11:02:01 +0000682
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200683 SERVER CERTIFICATE
Daniel Stenberg43563562004-08-12 11:02:01 +0000684
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200685 The server you communicate with has a server certificate. You can and should
686 verify this certificate to make sure that you are truly talking to the real
687 server and not a server impersonating it.
688
689 CERTIFICATE AUTHORITY CERTIFICATE ("CA cert")
690
691 You often have several CA certs in a CA cert bundle that can be used to
692 verify a server certificate that was signed by one of the authorities in the
693 bundle. curl does not come with a CA cert bundle but most curl installs
694 provide one. You can also override the default.
695
696 The server certificate verification process is made by using a Certificate
697 Authority certificate ("CA cert") that was used to sign the server
698 certificate. Server certificate verification is enabled by default in curl
699 and libcurl and is often the reason for problems as explained in FAQ entry
700 4.12 and the SSLCERTS document
Daniel Stenberg6b485c72016-02-02 00:24:30 +0100701 (https://curl.haxx.se/docs/sslcerts.html). Server certificates that are
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200702 "self-signed" or otherwise signed by a CA that you do not have a CA cert
703 for, cannot be verified. If the verification during a connect fails, you are
704 refused access. You then need to explicitly disable the verification to
705 connect to the server.
Daniel Stenberg9a44fa82005-11-02 09:34:53 +0000706
Daniel Stenberg951fdeb2004-12-21 09:37:55 +0000707 3.17 How do I list the root dir of an FTP server?
708
709 There are two ways. The way defined in the RFC is to use an encoded slash
710 in the first path part. List the "/tmp" dir like this:
711
712 curl ftp://ftp.sunet.se/%2ftmp/
713
714 or the not-quite-kosher-but-more-readable way, by simply starting the path
715 section of the URL with a slash:
716
717 curl ftp://ftp.sunet.se//tmp/
718
Daniel Stenberge9eb5232005-04-05 14:36:37 +0000719 3.18 Can I use curl to send a POST/PUT and not wait for a response?
Yang Tsea07bc792010-02-14 19:40:18 +0000720
Daniel Stenberge9eb5232005-04-05 14:36:37 +0000721 No.
722
Daniel Stenberg9a44fa82005-11-02 09:34:53 +0000723 But you could easily write your own program using libcurl to do such stunts.
724
Daniel Stenberg64f12a32010-09-07 19:05:07 +0200725 3.19 How do I get HTTP from a host using a specific IP address?
726
727 For example, you may be trying out a web site installation that isn't yet in
728 the DNS. Or you have a site using multiple IP addresses for a given host
729 name and you want to address a specific one out of the set.
730
731 Set a custom Host: header that identifies the server name you want to reach
732 but use the target IP address in the URL:
733
734 curl --header "Host: www.example.com" http://127.0.0.1/
735
Daniel Stenberg50d88bf2011-12-07 23:08:15 +0100736 You can also opt to add faked host name entries to curl with the --resolve
737 option. That has the added benefit that things like redirects will also work
738 properly. The above operation would instead be done as:
739
740 curl --resolve www.example.com:80:127.0.0.1 http://www.example.com/
741
Daniel Stenberg3f7b7de2011-03-07 22:27:26 +0100742 3.20 How to SFTP from my user's home directory?
743
744 Contrary to how FTP works, SFTP and SCP URLs specify the exact directory to
745 work with. It means that if you don't specify that you want the user's home
746 directory, you get the actual root directory.
747
748 To specify a file in your user's home directory, you need to use the correct
749 URL syntax which for sftp might look similar to:
750
751 curl -O -u user:password sftp://example.com/~/file.txt
752
753 and for SCP it is just a different protocol prefix:
754
755 curl -O -u user:password scp://example.com/~/file.txt
756
Daniel Stenberg0d0f8082011-03-08 11:15:59 +0100757 3.21 Protocol xxx not supported or disabled in libcurl
758
759 When passing on a URL to curl to use, it may respond that the particular
760 protocol is not supported or disabled. The particular way this error message
761 is phrased is because curl doesn't make a distinction internally of whether
Dan Fandrich31c6e7a2013-04-15 22:26:18 +0200762 a particular protocol is not supported (i.e. never got any code added that
Daniel Stenberg0d0f8082011-03-08 11:15:59 +0100763 knows how to speak that protocol) or if it was explicitly disabled. curl can
764 be built to only support a given set of protocols, and the rest would then
765 be disabled or not supported.
766
767 Note that this error will also occur if you pass a wrongly spelled protocol
768 part as in "htpt://example.com" or as in the less evident case if you prefix
769 the protocol part with a space as in " http://example.com/".
770
Daniel Stenberg0ed4a092013-01-21 14:33:12 +0100771 3.22 curl -X gives me HTTP problems
772
773 In normal circumstances, -X should hardly ever be used.
774
775 By default you use curl without explicitly saying which request method to
776 use when the URL identifies a HTTP transfer. If you just pass in a URL like
777 "curl http://example.com" it will use GET. If you use -d or -F curl will use
778 POST, -I will cause a HEAD and -T will make it a PUT.
779
780 If for whatever reason you're not happy with these default choices that curl
781 does for you, you can override those request methods by specifying -X
782 [WHATEVER]. This way you can for example send a DELETE by doing "curl -X
783 DELETE [URL]".
784
785 It is thus pointless to do "curl -XGET [URL]" as GET would be used
786 anyway. In the same vein it is pointless to do "curl -X POST -d data
787 [URL]"... But you can make a fun and somewhat rare request that sends a
788 request-body in a GET request with something like "curl -X GET -d data
789 [URL]"
790
Daniel Stenberg7b534842015-02-02 15:38:29 +0100791 Note that -X doesn't actually change curl's behavior as it only modifies the
792 actual string sent in the request, but that may of course trigger a
793 different set of events.
Daniel Stenberg0ed4a092013-01-21 14:33:12 +0100794
795 Accordingly, by using -XPOST on a command line that for example would follow
796 a 303 redirect, you will effectively prevent curl from behaving
797 correctly. Be aware.
798
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000799
Daniel Stenbergc3318b42000-08-17 14:06:42 +00008004. Running Problems
801
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000802 4.1 Problems connecting to SSL servers.
Daniel Stenberge9640b62000-08-02 07:17:56 +0000803
Daniel Stenberg11d718b2001-03-13 11:47:30 +0000804 It took a very long time before we could sort out why curl had problems to
805 connect to certain SSL servers when using SSLeay or OpenSSL v0.9+. The
806 error sometimes showed up similar to:
Daniel Stenberge9640b62000-08-02 07:17:56 +0000807
808 16570:error:1407D071:SSL routines:SSL2_READ:bad mac decode:s2_pkt.c:233:
809
810 It turned out to be because many older SSL servers don't deal with SSLv3
811 requests properly. To correct this problem, tell curl to select SSLv2 from
812 the command line (-2/--sslv2).
813
Daniel Stenbergeea22872004-03-16 07:56:51 +0000814 There have also been examples where the remote server didn't like the SSLv2
Daniel Stenberge9640b62000-08-02 07:17:56 +0000815 request and instead you had to force curl to use SSLv3 with -3/--sslv3.
816
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000817 4.2 Why do I get problems when I use & or % in the URL?
Daniel Stenberg29470102000-06-02 13:32:01 +0000818
Daniel Stenberg07d46882009-02-13 09:12:52 +0000819 In general unix shells, the & symbol is treated specially and when used, it
Daniel Stenbergc3c77392000-07-31 22:42:34 +0000820 runs the specified command in the background. To safely send the & as a part
Daniel Stenberg4c485992001-04-22 15:45:27 +0000821 of a URL, you should quote the entire URL by using single (') or double (")
Dan Fandrich5c9fff92009-01-30 18:28:29 +0000822 quotes around it. Similar problems can also occur on some shells with other
823 characters, including ?*!$~(){}<>\|;`. When in doubt, quote the URL.
Daniel Stenberg29470102000-06-02 13:32:01 +0000824
Daniel Stenberg07d46882009-02-13 09:12:52 +0000825 An example that would invoke a remote CGI that uses &-symbols could be:
Daniel Stenberg8f037322000-06-06 14:09:01 +0000826
Daniel Stenbergedcd5df2000-06-06 14:13:36 +0000827 curl 'http://www.altavista.com/cgi-bin/query?text=yes&q=curl'
Daniel Stenberg8f037322000-06-06 14:09:01 +0000828
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200829 In Windows, the standard DOS shell treats the percent sign specially and you
830 need to use TWO percent signs for each single one you want to use in the
831 URL.
Daniel Stenberge26ee092001-01-15 10:26:37 +0000832
Daniel Stenberg1a911f72013-08-24 17:13:46 +0200833 If you want a literal percent sign to be part of the data you pass in a POST
834 using -d/--data you must encode it as '%25' (which then also needs the
835 percent sign doubled on Windows machines).
Daniel Stenberg1b77c182001-01-29 10:24:51 +0000836
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000837 4.3 How can I use {, }, [ or ] to specify multiple URLs?
Daniel Stenberg29470102000-06-02 13:32:01 +0000838
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600839 Because those letters have a special meaning to the shell, to be used in
Daniel Stenbergc3c77392000-07-31 22:42:34 +0000840 a URL specified to curl you must quote them.
Daniel Stenberg29470102000-06-02 13:32:01 +0000841
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600842 An example that downloads two URLs (sequentially) would be:
Daniel Stenberg8f037322000-06-06 14:09:01 +0000843
Daniel Stenbergedcd5df2000-06-06 14:13:36 +0000844 curl '{curl,www}.haxx.se'
Daniel Stenberg8f037322000-06-06 14:09:01 +0000845
railsnewbie257cd6b99e2017-01-11 23:48:22 -0600846 To be able to use those characters as actual parts of the URL (without using
Daniel Stenbergdb5c9cd2003-02-25 08:52:32 +0000847 them for the curl URL "globbing" system), use the -g/--globoff option:
Daniel Stenberge26ee092001-01-15 10:26:37 +0000848
849 curl -g 'www.site.com/weirdname[].html'
850
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000851 4.4 Why do I get downloaded data even though the web page doesn't exist?
Daniel Stenberg29470102000-06-02 13:32:01 +0000852
Daniel Stenbergc3c77392000-07-31 22:42:34 +0000853 Curl asks remote servers for the page you specify. If the page doesn't exist
854 at the server, the HTTP protocol defines how the server should respond and
855 that means that headers and a "page" will be returned. That's simply how
856 HTTP works.
Daniel Stenberg29470102000-06-02 13:32:01 +0000857
Daniel Stenbergc3c77392000-07-31 22:42:34 +0000858 By using the --fail option you can tell curl explicitly to not get any data
859 if the HTTP return code doesn't say success.
Daniel Stenberg8f037322000-06-06 14:09:01 +0000860
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000861 4.5 Why do I get return code XXX from a HTTP server?
Daniel Stenberg29470102000-06-02 13:32:01 +0000862
Daniel Stenberg11d718b2001-03-13 11:47:30 +0000863 RFC2616 clearly explains the return codes. This is a short transcript. Go
864 read the RFC for exact details:
Daniel Stenberg29470102000-06-02 13:32:01 +0000865
Daniel Stenberg09ba8562000-10-27 12:25:00 +0000866 4.5.1 "400 Bad Request"
Daniel Stenberg29470102000-06-02 13:32:01 +0000867
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000868 The request could not be understood by the server due to malformed
869 syntax. The client SHOULD NOT repeat the request without modifications.
870
Daniel Stenberg09ba8562000-10-27 12:25:00 +0000871 4.5.2 "401 Unauthorized"
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000872
873 The request requires user authentication.
874
Daniel Stenberg09ba8562000-10-27 12:25:00 +0000875 4.5.3 "403 Forbidden"
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000876
Dan Fandrichcb787b72012-07-20 21:02:58 +0200877 The server understood the request, but is refusing to fulfil it.
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000878 Authorization will not help and the request SHOULD NOT be repeated.
879
Daniel Stenberg09ba8562000-10-27 12:25:00 +0000880 4.5.4 "404 Not Found"
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000881
882 The server has not found anything matching the Request-URI. No indication
883 is given of whether the condition is temporary or permanent.
884
Daniel Stenberg09ba8562000-10-27 12:25:00 +0000885 4.5.5 "405 Method Not Allowed"
Daniel Stenbergc3318b42000-08-17 14:06:42 +0000886
887 The method specified in the Request-Line is not allowed for the resource
888 identified by the Request-URI. The response MUST include an Allow header
889 containing a list of valid methods for the requested resource.
890
Daniel Stenbergd60029d2001-12-19 23:25:04 +0000891 4.5.6 "301 Moved Permanently"
Daniel Stenbergeea22872004-03-16 07:56:51 +0000892
Daniel Stenberg98871d12002-05-22 22:14:03 +0000893 If you get this return code and an HTML output similar to this:
Daniel Stenbergd60029d2001-12-19 23:25:04 +0000894
895 <H1>Moved Permanently</H1> The document has moved <A
896 HREF="http://same_url_now_with_a_trailing_slash/">here</A>.
897
898 it might be because you request a directory URL but without the trailing
899 slash. Try the same operation again _with_ the trailing URL, or use the
900 -L/--location option to follow the redirection.
901
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000902 4.6 Can you tell me what error code 142 means?
Daniel Stenberg29470102000-06-02 13:32:01 +0000903
Daniel Stenberg8b5f0ab2004-12-21 21:35:00 +0000904 All curl error codes are described at the end of the man page, in the
905 section called "EXIT CODES".
906
907 Error codes that are larger than the highest documented error code means
Daniel Stenberg13bf9642001-08-23 11:11:13 +0000908 that curl has exited due to a crash. This is a serious error, and we
Daniel Stenberg25fe47f2001-11-14 20:13:38 +0000909 appreciate a detailed bug report from you that describes how we could go
Daniel Stenberg13bf9642001-08-23 11:11:13 +0000910 ahead and repeat this!
Daniel Stenberg29470102000-06-02 13:32:01 +0000911
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000912 4.7 How do I keep user names and passwords secret in Curl command lines?
Daniel Stenberg29470102000-06-02 13:32:01 +0000913
Daniel Stenberg11d718b2001-03-13 11:47:30 +0000914 This problem has two sides:
Daniel Stenberg29470102000-06-02 13:32:01 +0000915
Daniel Stenbergc3c77392000-07-31 22:42:34 +0000916 The first part is to avoid having clear-text passwords in the command line
917 so that they don't appear in 'ps' outputs and similar. That is easily
Daniel Stenbergeea22872004-03-16 07:56:51 +0000918 avoided by using the "-K" option to tell curl to read parameters from a file
919 or stdin to which you can pass the secret info. curl itself will also
920 attempt to "hide" the given password by blanking out the option - this
921 doesn't work on all platforms.
Daniel Stenberg29470102000-06-02 13:32:01 +0000922
Daniel Stenbergc3c77392000-07-31 22:42:34 +0000923 To keep the passwords in your account secret from the rest of the world is
924 not a task that curl addresses. You could of course encrypt them somehow to
925 at least hide them from being read by human eyes, but that is not what
926 anyone would call security.
Daniel Stenberg29470102000-06-02 13:32:01 +0000927
Daniel Stenbergeea22872004-03-16 07:56:51 +0000928 Also note that regular HTTP (using Basic authentication) and FTP passwords
929 are sent in clear across the network. All it takes for anyone to fetch them
930 is to listen on the network. Eavesdropping is very easy. Use more secure
931 authentication methods (like Digest, Negotiate or even NTLM) or consider the
932 SSL-based alternatives HTTPS and FTPS.
Daniel Stenberg887e7282001-01-03 09:13:07 +0000933
Daniel Stenberg09ba8562000-10-27 12:25:00 +0000934 4.8 I found a bug!
935
Daniel Stenberg4c485992001-04-22 15:45:27 +0000936 It is not a bug if the behavior is documented. Read the docs first.
Daniel Stenbergeea22872004-03-16 07:56:51 +0000937 Especially check out the KNOWN_BUGS file, it may be a documented bug!
Daniel Stenberg09ba8562000-10-27 12:25:00 +0000938
939 If it is a problem with a binary you've downloaded or a package for your
940 particular platform, try contacting the person who built the package/archive
941 you have.
942
Daniel Stenberg8eaa7fe2002-04-27 18:12:26 +0000943 If there is a bug, read the BUGS document first. Then report it as described
944 in there.
Daniel Stenberg09ba8562000-10-27 12:25:00 +0000945
Daniel Stenberg811edcd2004-08-10 08:41:41 +0000946 4.9 Curl can't authenticate to the server that requires NTLM?
Daniel Stenberg2c100372000-12-19 07:30:51 +0000947
Bill Nagel497e7c92016-07-07 08:40:45 -0700948 NTLM support requires OpenSSL, GnuTLS, mbedTLS, NSS, Secure Transport, or
949 Microsoft Windows libraries at build-time to provide this functionality.
Daniel Stenberg3a552b12003-06-26 11:35:48 +0000950
951 NTLM is a Microsoft proprietary protocol. Proprietary formats are evil. You
952 should not use such ones.
Daniel Stenberg29470102000-06-02 13:32:01 +0000953
Daniel Stenbergbc743752002-05-15 21:40:29 +0000954 4.10 My HTTP request using HEAD, PUT or DELETE doesn't work!
955
956 Many web servers allow or demand that the administrator configures the
957 server properly for these requests to work on the web server.
958
959 Some servers seem to support HEAD only on certain kinds of URLs.
960
961 To fully grasp this, try the documentation for the particular server
962 software you're trying to interact with. This is not anything curl can do
963 anything about.
964
Daniel Stenberg522b85a2002-11-12 20:00:02 +0000965 4.11 Why does my HTTP range requests return the full document?
966
967 Because the range may not be supported by the server, or the server may
968 choose to ignore it and return the full document anyway.
Daniel Stenbergbc743752002-05-15 21:40:29 +0000969
Daniel Stenberg16077112002-11-20 19:17:43 +0000970 4.12 Why do I get "certificate verify failed" ?
971
972 You invoke curl 7.10 or later to communicate on a https:// URL and get an
973 error back looking something similar to this:
974
Daniel Stenbergeea22872004-03-16 07:56:51 +0000975 curl: (35) SSL: error:14090086:SSL routines:
Daniel Stenberg16077112002-11-20 19:17:43 +0000976 SSL3_GET_SERVER_CERTIFICATE:certificate verify failed
977
978 Then it means that curl couldn't verify that the server's certificate was
979 good. Curl verifies the certificate using the CA cert bundle that comes with
980 the curl installation.
981
982 To disable the verification (which makes it act like curl did before 7.10),
983 use -k. This does however enable man-in-the-middle attacks.
984
985 If you get this failure but are having a CA cert bundle installed and used,
986 the server's certificate is not signed by one of the CA's in the bundle. It
987 might for example be self-signed. You then correct this problem by obtaining
988 a valid CA cert for the server. Or again, decrease the security by disabling
989 this check.
990
991 Details are also in the SSLCERTS file in the release archives, found online
Daniel Stenberg6b485c72016-02-02 00:24:30 +0100992 here: https://curl.haxx.se/docs/sslcerts.html
Daniel Stenberg16077112002-11-20 19:17:43 +0000993
Daniel Stenberg1dc0ce92005-06-13 18:33:40 +0000994 4.13 Why is curl -R on Windows one hour off?
995
Jay Satiroee3c83f2016-11-11 02:48:52 -0500996 Since curl 7.53.0 this issue should be fixed as long as curl was built with
997 any modern compiler that allows for a 64-bit curl_off_t type. For older
998 compilers or prior curl versions it may set a time that appears one hour off.
999 This happens due to a flaw in how Windows stores and uses file modification
1000 times and it is not easily worked around. For more details read this:
1001 http://www.codeproject.com/datetime/dstbugs.asp
Daniel Stenberg1dc0ce92005-06-13 18:33:40 +00001002
Daniel Stenberg09cb9c72005-08-26 13:22:39 +00001003 4.14 Redirects work in browser but not with curl!
1004
railsnewbie257cd6b99e2017-01-11 23:48:22 -06001005 curl supports HTTP redirects well (see item 3.8). Browsers generally support
Daniel Stenberg1a911f72013-08-24 17:13:46 +02001006 at least two other ways to perform redirects that curl does not:
Daniel Stenberg09cb9c72005-08-26 13:22:39 +00001007
Daniel Stenberg1a911f72013-08-24 17:13:46 +02001008 Meta tags. You can write a HTML tag that will cause the browser to redirect
1009 to another given URL after a certain time.
Daniel Stenberg09cb9c72005-08-26 13:22:39 +00001010
Daniel Stenberg1a911f72013-08-24 17:13:46 +02001011 Javascript. You can write a Javascript program embedded in a HTML page that
1012 redirects the browser to another given URL.
Daniel Stenberg09cb9c72005-08-26 13:22:39 +00001013
1014 There is no way to make curl follow these redirects. You must either
1015 manually figure out what the page is set to do, or you write a script that
1016 parses the results and fetches the new URL.
1017
Daniel Stenberg844cbc72007-07-29 22:17:39 +00001018 4.15 FTPS doesn't work
1019
1020 curl supports FTPS (sometimes known as FTP-SSL) both implicit and explicit
1021 mode.
1022
1023 When a URL is used that starts with FTPS://, curl assumes implicit SSL on
1024 the control connection and will therefore immediately connect and try to
1025 speak SSL. FTPS:// connections default to port 990.
1026
1027 To use explicit FTPS, you use a FTP:// URL and the --ftp-ssl option (or one
1028 of its related flavours). This is the most common method, and the one
railsnewbie257cd6b99e2017-01-11 23:48:22 -06001029 mandated by RFC4217. This kind of connection will then of course use the
Daniel Stenberg844cbc72007-07-29 22:17:39 +00001030 standard FTP port 21 by default.
1031
Daniel Stenberg95df5d02008-09-24 07:50:46 +00001032 4.16 My HTTP POST or PUT requests are slow!
1033
1034 libcurl makes all POST and PUT requests (except for POST requests with a
1035 very tiny request body) use the "Expect: 100-continue" header. This header
1036 allows the server to deny the operation early so that libcurl can bail out
railsnewbie257cd6b99e2017-01-11 23:48:22 -06001037 before having to send any data. This is useful in authentication
Daniel Stenberg95df5d02008-09-24 07:50:46 +00001038 cases and others.
1039
1040 However, many servers don't implement the Expect: stuff properly and if the
1041 server doesn't respond (positively) within 1 second libcurl will continue
1042 and send off the data anyway.
1043
1044 You can disable libcurl's use of the Expect: header the same way you disable
1045 any header, using -H / CURLOPT_HTTPHEADER, or by forcing it to use HTTP 1.0.
Daniel Stenberg811edcd2004-08-10 08:41:41 +00001046
Daniel Stenberg2afb88e2009-02-23 21:21:00 +00001047 4.17 Non-functional connect timeouts
1048
1049 In most Windows setups having a timeout longer than 21 seconds make no
1050 difference, as it will only send 3 TCP SYN packets and no more. The second
1051 packet sent three seconds after the first and the third six seconds after
1052 the second. No more than three packets are sent, no matter how long the
1053 timeout is set.
1054
1055 See option TcpMaxConnectRetransmissions on this page:
Viktor Szakats45f21e02015-06-16 00:47:26 +02001056 https://support.microsoft.com/en-us/kb/175523/en-us
Daniel Stenberg2afb88e2009-02-23 21:21:00 +00001057
1058 Also, even on non-Windows systems there may run a firewall or anti-virus
1059 software or similar that accepts the connection but does not actually do
1060 anything else. This will make (lib)curl to consider the connection connected
1061 and thus the connect timeout won't trigger.
1062
Daniel Stenbergb8012ea2009-11-07 21:52:41 +00001063 4.18 file:// URLs containing drive letters (Windows, NetWare)
1064
Daniel Stenberg0f199632016-10-18 13:59:54 +02001065 When using curl to try to download a local file, one might use a URL
Daniel Stenbergb8012ea2009-11-07 21:52:41 +00001066 in this format:
1067
1068 file://D:/blah.txt
1069
Daniel Stenberg0f199632016-10-18 13:59:54 +02001070 You'll find that even if D:\blah.txt does exist, curl returns a 'file
Daniel Stenbergb8012ea2009-11-07 21:52:41 +00001071 not found' error.
1072
Viktor Szakats45f21e02015-06-16 00:47:26 +02001073 According to RFC 1738 (https://www.ietf.org/rfc/rfc1738.txt),
Daniel Stenbergb8012ea2009-11-07 21:52:41 +00001074 file:// URLs must contain a host component, but it is ignored by
1075 most implementations. In the above example, 'D:' is treated as the
Daniel Stenberg0f199632016-10-18 13:59:54 +02001076 host component, and is taken away. Thus, curl tries to open '/blah.txt'.
Daniel Stenbergb8012ea2009-11-07 21:52:41 +00001077 If your system is installed to drive C:, that will resolve to 'C:\blah.txt',
1078 and if that doesn't exist you will get the not found error.
1079
1080 To fix this problem, use file:// URLs with *three* leading slashes:
1081
1082 file:///D:/blah.txt
1083
1084 Alternatively, if it makes more sense, specify 'localhost' as the host
1085 component:
1086
1087 file://localhost/D:/blah.txt
1088
Daniel Stenberg0f199632016-10-18 13:59:54 +02001089 In either case, curl should now be looking for the correct file.
Daniel Stenberg2afb88e2009-02-23 21:21:00 +00001090
Daniel Stenberg0f199632016-10-18 13:59:54 +02001091 4.19 Why doesn't curl return an error when the network cable is unplugged?
Dan Fandrich7d166b02010-07-21 15:15:07 -07001092
Dan Fandrich31c6e7a2013-04-15 22:26:18 +02001093 Unplugging a cable is not an error situation. The TCP/IP protocol stack
Dan Fandrich7d166b02010-07-21 15:15:07 -07001094 was designed to be fault tolerant, so even though there may be a physical
1095 break somewhere the connection shouldn't be affected, just possibly
1096 delayed. Eventually, the physical break will be fixed or the data will be
Dan Fandrich31c6e7a2013-04-15 22:26:18 +02001097 re-routed around the physical problem through another path.
Dan Fandrich7d166b02010-07-21 15:15:07 -07001098
1099 In such cases, the TCP/IP stack is responsible for detecting when the
1100 network connection is irrevocably lost. Since with some protocols it is
Daniel Stenberg14f92f22016-01-25 11:11:29 +01001101 perfectly legal for the client to wait indefinitely for data, the stack may
Dan Fandrich7d166b02010-07-21 15:15:07 -07001102 never report a problem, and even when it does, it can take up to 20 minutes
1103 for it to detect an issue. The curl option --keepalive-time enables
1104 keep-alive support in the TCP/IP stack which makes it periodically probe the
1105 connection to make sure it is still available to send data. That should
1106 reliably detect any TCP/IP network failure.
1107
1108 But even that won't detect the network going down before the TCP/IP
1109 connection is established (e.g. during a DNS lookup) or using protocols that
1110 don't use TCP. To handle those situations, curl offers a number of timeouts
1111 on its own. --speed-limit/--speed-time will abort if the data transfer rate
1112 falls too low, and --connect-timeout and --max-time can be used to put an
1113 overall timeout on the connection phase or the entire transfer.
1114
Dan Fandrich31c6e7a2013-04-15 22:26:18 +02001115 A libcurl-using application running in a known physical environment (e.g.
1116 an embedded device with only a single network connection) may want to act
1117 immediately if its lone network connection goes down. That can be achieved
1118 by having the application monitor the network connection on its own using an
1119 OS-specific mechanism, then signalling libcurl to abort (see also item 5.13).
Daniel Stenberg889de6b2014-08-28 11:39:39 +02001120
1121 4.20 curl doesn't return error for HTTP non-200 responses!
1122
1123 Correct. Unless you use -f (--fail).
1124
1125 When doing HTTP transfers, curl will perform exactly what you're asking it
1126 to do and if successful it will not return an error. You can use curl to
1127 test your web server's "file not found" page (that gets 404 back), you can
railsnewbie257cd6b99e2017-01-11 23:48:22 -06001128 use it to check your authentication protected web pages (that gets a 401
Daniel Stenberg889de6b2014-08-28 11:39:39 +02001129 back) and so on.
1130
1131 The specific HTTP response code does not constitute a problem or error for
1132 curl. It simply sends and delivers HTTP as you asked and if that worked,
1133 everything is fine and dandy. The response code is generally providing more
1134 higher level error information that curl doesn't care about. The error was
1135 not in the HTTP transfer.
1136
1137 If you want your command line to treat error codes in the 400 and up range
1138 as errors and thus return a non-zero value and possibly show an error
1139 message, curl has a dedicated option for that: -f (CURLOPT_FAILONERROR in
1140 libcurl speak).
1141
Daniel Stenbergaccbbd72014-08-28 11:42:00 +02001142 You can also use the -w option and the variable %{response_code} to extract
railsnewbie257cd6b99e2017-01-11 23:48:22 -06001143 the exact response code that was returned in the response.
Daniel Stenbergaccbbd72014-08-28 11:42:00 +02001144
Daniel Stenbergae823552015-03-04 18:24:46 +01001145 4.21 Why is there a HTTP/1.1 in my HTTP/2 request?
1146
1147 If you use verbose to see the HTTP request when you send off a HTTP/2
1148 request, it will still say 1.1.
1149
1150 The reason for this is that we first generate the request to send using the
1151 old 1.1 style and show that request in the verbose output, and then we
1152 convert it over to the binary header-compressed HTTP/2 style. The actual
Daniel Stenberg6d496952017-05-12 19:58:06 +02001153 "1.1" part from that request is then not actually used in the transfer.
railsnewbie257cd6b99e2017-01-11 23:48:22 -06001154 The binary HTTP/2 headers are not human readable.
Dan Fandrich7d166b02010-07-21 15:15:07 -07001155
Daniel Stenbergc3318b42000-08-17 14:06:42 +000011565. libcurl Issues
Daniel Stenberg29470102000-06-02 13:32:01 +00001157
Daniel Stenberg811edcd2004-08-10 08:41:41 +00001158 5.1 Is libcurl thread-safe?
Daniel Stenberg29470102000-06-02 13:32:01 +00001159
Daniel Stenberg7d09e512001-01-11 12:52:07 +00001160 Yes.
1161
Dan Fandrichec2ad572005-04-13 19:31:00 +00001162 We have written the libcurl code specifically adjusted for multi-threaded
Daniel Stenberg7d09e512001-01-11 12:52:07 +00001163 programs. libcurl will use thread-safe functions instead of non-safe ones if
Dan Fandrich31c6e7a2013-04-15 22:26:18 +02001164 your system has such. Note that you must never share the same handle in
1165 multiple threads.
1166
Jay Satirobefa21f2016-05-05 14:34:27 -04001167 There may be some exceptions to thread safety depending on how libcurl was
1168 built. Please review the guidelines for thread safety to learn more:
1169 https://curl.haxx.se/libcurl/c/threadsafe.html
Daniel Stenberg7f70dbc2007-02-12 22:32:37 +00001170
Daniel Stenberga40b55d2000-11-22 07:27:26 +00001171 5.2 How can I receive all data into a large memory chunk?
1172
Daniel Stenberga84af982001-05-15 13:09:27 +00001173 [ See also the examples/getinmemory.c source ]
1174
Daniel Stenberga40b55d2000-11-22 07:27:26 +00001175 You are in full control of the callback function that gets called every time
1176 there is data received from the remote server. You can make that callback do
Daniel Stenberg4c485992001-04-22 15:45:27 +00001177 whatever you want. You do not have to write the received data to a file.
Daniel Stenberga40b55d2000-11-22 07:27:26 +00001178
1179 One solution to this problem could be to have a pointer to a struct that you
1180 pass to the callback function. You set the pointer using the
Daniel Stenberg9a44fa82005-11-02 09:34:53 +00001181 CURLOPT_WRITEDATA option. Then that pointer will be passed to the callback
1182 instead of a FILE * to a file:
Daniel Stenberga40b55d2000-11-22 07:27:26 +00001183
1184 /* imaginary struct */
1185 struct MemoryStruct {
1186 char *memory;
1187 size_t size;
1188 };
1189
1190 /* imaginary callback function */
1191 size_t
1192 WriteMemoryCallback(void *ptr, size_t size, size_t nmemb, void *data)
1193 {
Daniel Stenberg811edcd2004-08-10 08:41:41 +00001194 size_t realsize = size * nmemb;
Daniel Stenberga40b55d2000-11-22 07:27:26 +00001195 struct MemoryStruct *mem = (struct MemoryStruct *)data;
Daniel Stenbergeea22872004-03-16 07:56:51 +00001196
Daniel Stenberga40b55d2000-11-22 07:27:26 +00001197 mem->memory = (char *)realloc(mem->memory, mem->size + realsize + 1);
1198 if (mem->memory) {
1199 memcpy(&(mem->memory[mem->size]), ptr, realsize);
1200 mem->size += realsize;
1201 mem->memory[mem->size] = 0;
1202 }
1203 return realsize;
1204 }
1205
Daniel Stenberg2c100372000-12-19 07:30:51 +00001206 5.3 How do I fetch multiple files with libcurl?
Daniel Stenbergec5ac822000-12-14 08:37:09 +00001207
Daniel Stenbergdb5c9cd2003-02-25 08:52:32 +00001208 libcurl has excellent support for transferring multiple files. You should
1209 just repeatedly set new URLs with curl_easy_setopt() and then transfer it
1210 with curl_easy_perform(). The handle you get from curl_easy_init() is not
1211 only reusable, but you're even encouraged to reuse it if you can, as that
1212 will enable libcurl to use persistent connections.
Daniel Stenberga40b55d2000-11-22 07:27:26 +00001213
Daniel Stenbergbc5954f2001-03-23 08:16:24 +00001214 5.4 Does libcurl do Winsock initialization on win32 systems?
Daniel Stenberg910fc852000-12-30 11:48:51 +00001215
Daniel Stenbergdb5c9cd2003-02-25 08:52:32 +00001216 Yes, if told to in the curl_global_init() call.
Daniel Stenberg910fc852000-12-30 11:48:51 +00001217
Daniel Stenberg7e3cd822003-12-08 13:59:35 +00001218 5.5 Does CURLOPT_WRITEDATA and CURLOPT_READDATA work on win32 ?
Daniel Stenberg41084e52001-01-22 08:42:00 +00001219
1220 Yes, but you cannot open a FILE * and pass the pointer to a DLL and have
Daniel Stenberg7e3cd822003-12-08 13:59:35 +00001221 that DLL use the FILE * (as the DLL and the client application cannot access
1222 each others' variable memory areas). If you set CURLOPT_WRITEDATA you must
1223 also use CURLOPT_WRITEFUNCTION as well to set a function that writes the
1224 file, even if that simply writes the data to the specified FILE *.
1225 Similarly, if you use CURLOPT_READDATA you must also specify
1226 CURLOPT_READFUNCTION.
Daniel Stenberg41084e52001-01-22 08:42:00 +00001227
Daniel Stenberg4c485992001-04-22 15:45:27 +00001228 5.6 What about Keep-Alive or persistent connections?
Daniel Stenberg6dc5c6f2001-01-27 20:51:31 +00001229
Daniel Stenbergdb5c9cd2003-02-25 08:52:32 +00001230 curl and libcurl have excellent support for persistent connections when
1231 transferring several files from the same server. Curl will attempt to reuse
1232 connections for all URLs specified on the same command line/config file, and
1233 libcurl will reuse connections for all transfers that are made using the
1234 same libcurl handle.
Daniel Stenberg6dc5c6f2001-01-27 20:51:31 +00001235
Daniel Stenberg6d496952017-05-12 19:58:06 +02001236 When you use the easy interface the connection cache is kept within the easy
1237 handle. If you instead use the multi interface, the connection cache will be
1238 kept within the multi handle and will be shared among all the easy handles
railsnewbie257cd6b99e2017-01-11 23:48:22 -06001239 that are used within the same multi handle.
Daniel Stenbergc9a82f32011-06-21 08:44:42 +02001240
Daniel Stenbergdd82d692002-10-08 07:16:17 +00001241 5.7 Link errors when building libcurl on Windows!
1242
1243 You need to make sure that your project, and all the libraries (both static
1244 and dynamic) that it links against, are compiled/linked against the same run
1245 time library.
1246
1247 This is determined by the /MD, /ML, /MT (and their corresponding /M?d)
1248 options to the command line compiler. /MD (linking against MSVCRT dll) seems
1249 to be the most commonly used option.
1250
Gisle Vanem51a87fa2004-11-24 15:14:42 +00001251 When building an application that uses the static libcurl library, you must
1252 add -DCURL_STATICLIB to your CFLAGS. Otherwise the linker will look for
Daniel Stenberg6ce76e62010-09-08 23:23:19 +02001253 dynamic import symbols. If you're using Visual Studio, you need to instead
1254 add CURL_STATICLIB in the "Preprocessor Definitions" section.
1255
1256 If you get linker error like "unknown symbol __imp__curl_easy_init ..." you
1257 have linked against the wrong (static) library. If you want to use the
1258 libcurl.dll and import lib, you don't need any extra CFLAGS, but use one of
1259 the import libraries below. These are the libraries produced by the various
1260 lib/Makefile.* files:
Gisle Vanem51a87fa2004-11-24 15:14:42 +00001261
Daniel Stenberg77110862011-03-14 13:31:05 +01001262 Target: static lib. import lib for libcurl*.dll.
1263 -----------------------------------------------------------
1264 MingW: libcurl.a libcurldll.a
1265 MSVC (release): libcurl.lib libcurl_imp.lib
1266 MSVC (debug): libcurld.lib libcurld_imp.lib
1267 Borland: libcurl.lib libcurl_imp.lib
Gisle Vanem51a87fa2004-11-24 15:14:42 +00001268
Daniel Stenberg9754b202010-08-11 09:15:43 +02001269 5.8 libcurl.so.X: open failed: No such file or directory
Daniel Stenberg811edcd2004-08-10 08:41:41 +00001270
1271 This is an error message you might get when you try to run a program linked
1272 with a shared version of libcurl and your run-time linker (ld.so) couldn't
Daniel Stenberg9754b202010-08-11 09:15:43 +02001273 find the shared library named libcurl.so.X. (Where X is the number of the
1274 current libcurl ABI, typically 3 or 4).
Daniel Stenberg811edcd2004-08-10 08:41:41 +00001275
Daniel Stenberg9754b202010-08-11 09:15:43 +02001276 You need to make sure that ld.so finds libcurl.so.X. You can do that
Daniel Stenberg811edcd2004-08-10 08:41:41 +00001277 multiple ways, and it differs somewhat between different operating systems,
1278 but they are usually:
1279
1280 * Add an option to the linker command line that specify the hard-coded path
1281 the run-time linker should check for the lib (usually -R)
1282
1283 * Set an environment variable (LD_LIBRARY_PATH for example) where ld.so
1284 should check for libs
1285
1286 * Adjust the system's config to check for libs in the directory where you've
1287 put the dir (like Linux's /etc/ld.so.conf)
1288
1289 'man ld.so' and 'man ld' will tell you more details
1290
Daniel Stenberg1d323362004-08-12 14:09:10 +00001291 5.9 How does libcurl resolve host names?
1292
Daniel Stenberg9a44fa82005-11-02 09:34:53 +00001293 libcurl supports a large a number of different name resolve functions. One
1294 of them is picked at build-time and will be used unconditionally. Thus, if
1295 you want to change name resolver function you must rebuild libcurl and tell
1296 it to use a different function.
Daniel Stenberg1d323362004-08-12 14:09:10 +00001297
Daniel Stenberg6d496952017-05-12 19:58:06 +02001298 - The non-IPv6 resolver that can use one of four different host name resolve
railsnewbie257cd6b99e2017-01-11 23:48:22 -06001299 calls (depending on what your system supports):
Daniel Stenberg1d323362004-08-12 14:09:10 +00001300
Daniel Stenberg77110862011-03-14 13:31:05 +01001301 A - gethostbyname()
1302 B - gethostbyname_r() with 3 arguments
1303 C - gethostbyname_r() with 5 arguments
1304 D - gethostbyname_r() with 6 arguments
Daniel Stenberg1d323362004-08-12 14:09:10 +00001305
Steve Holme151ae592014-12-27 11:09:01 +00001306 - The IPv6-resolver that uses getaddrinfo()
Daniel Stenberg1d323362004-08-12 14:09:10 +00001307
1308 - The c-ares based name resolver that uses the c-ares library for resolves.
Daniel Stenbergfa811932011-04-14 23:12:27 +02001309 Using this offers asynchronous name resolves.
Daniel Stenberg1d323362004-08-12 14:09:10 +00001310
Daniel Stenberg18a9ee62010-06-30 15:52:58 +02001311 - The threaded resolver (default option on Windows). It uses:
Daniel Stenberg1d323362004-08-12 14:09:10 +00001312
Steve Holme151ae592014-12-27 11:09:01 +00001313 A - gethostbyname() on plain IPv4 hosts
1314 B - getaddrinfo() on IPv6 enabled hosts
Daniel Stenbergdd82d692002-10-08 07:16:17 +00001315
Daniel Stenberge9eb5232005-04-05 14:36:37 +00001316 Also note that libcurl never resolves or reverse-lookups addresses given as
1317 pure numbers, such as 127.0.0.1 or ::1.
1318
1319 5.10 How do I prevent libcurl from writing the response to stdout?
1320
1321 libcurl provides a default built-in write function that writes received data
Daniel Stenberg9a44fa82005-11-02 09:34:53 +00001322 to stdout. Set the CURLOPT_WRITEFUNCTION to receive the data, or possibly
1323 set CURLOPT_WRITEDATA to a different FILE * handle.
Daniel Stenberge9eb5232005-04-05 14:36:37 +00001324
Daniel Stenberg6e8e0412005-04-05 14:38:38 +00001325 5.11 How do I make libcurl not receive the whole HTTP response?
1326
1327 You make the write callback (or progress callback) return an error and
1328 libcurl will then abort the transfer.
1329
Daniel Stenbergb5d50e92005-04-11 13:39:55 +00001330 5.12 Can I make libcurl fake or hide my real IP address?
1331
Daniel Stenberg1a911f72013-08-24 17:13:46 +02001332 No. libcurl operates on a higher level. Besides, faking IP address would
railsnewbie257cd6b99e2017-01-11 23:48:22 -06001333 imply sending IP packets with a made-up source address, and then you normally
Daniel Stenberg1a911f72013-08-24 17:13:46 +02001334 get a problem with receiving the packet sent back as they would then not be
1335 routed to you!
Daniel Stenbergb5d50e92005-04-11 13:39:55 +00001336
1337 If you use a proxy to access remote sites, the sites will not see your local
1338 IP address but instead the address of the proxy.
1339
1340 Also note that on many networks NATs or other IP-munging techniques are used
1341 that makes you see and use a different IP address locally than what the
Daniel Stenberg1a911f72013-08-24 17:13:46 +02001342 remote server will see you coming from. You may also consider using
Viktor Szakats45f21e02015-06-16 00:47:26 +02001343 https://www.torproject.org/ .
Daniel Stenbergb5d50e92005-04-11 13:39:55 +00001344
Daniel Stenberg24602ed2007-12-10 10:28:56 +00001345 5.13 How do I stop an ongoing transfer?
1346
Daniel Stenberg4b837a72011-01-24 22:18:43 +01001347 With the easy interface you make sure to return the correct error code from
1348 one of the callbacks, but none of them are instant. There is no function you
1349 can call from another thread or similar that will stop it immediately.
Dan Fandrichb3740f02011-06-02 18:41:57 -07001350 Instead, you need to make sure that one of the callbacks you use returns an
1351 appropriate value that will stop the transfer. Suitable callbacks that you
1352 can do this with include the progress callback, the read callback and the
1353 write callback.
Daniel Stenberg24602ed2007-12-10 10:28:56 +00001354
Daniel Stenberg4b837a72011-01-24 22:18:43 +01001355 If you're using the multi interface, you can also stop a transfer by
Dan Fandrichb3740f02011-06-02 18:41:57 -07001356 removing the particular easy handle from the multi stack at any moment you
Daniel Stenberg9ca812f2013-02-04 22:46:51 +01001357 think the transfer is done or when you wish to abort the transfer.
Daniel Stenberge9eb5232005-04-05 14:36:37 +00001358
Daniel Stenberg22059852008-09-24 07:39:42 +00001359 5.14 Using C++ non-static functions for callbacks?
1360
1361 libcurl is a C library, it doesn't know anything about C++ member functions.
1362
railsnewbie257cd6b99e2017-01-11 23:48:22 -06001363 You can overcome this "limitation" with relative ease using a static
Daniel Stenberg22059852008-09-24 07:39:42 +00001364 member function that is passed a pointer to the class:
1365
1366 // f is the pointer to your object.
Stephen Brokenshire2a1d5382016-10-01 16:36:50 +01001367 static size_t YourClass::func(void *buffer, size_t sz, size_t n, void *f)
Daniel Stenberg22059852008-09-24 07:39:42 +00001368 {
1369 // Call non-static member function.
1370 static_cast<YourClass*>(f)->nonStaticFunction();
1371 }
1372
1373 // This is how you pass pointer to the static function:
Stephen Brokenshire2a1d5382016-10-01 16:36:50 +01001374 curl_easy_setopt(hcurl, CURLOPT_WRITEFUNCTION, YourClass::func);
Daniel Stenberg22059852008-09-24 07:39:42 +00001375 curl_easy_setopt(hcurl, CURLOPT_WRITEDATA, this);
1376
Yang Tsea07bc792010-02-14 19:40:18 +00001377 5.15 How do I get an FTP directory listing?
Daniel Stenberg8740d142009-06-09 09:02:39 +00001378
1379 If you end the FTP URL you request with a slash, libcurl will provide you
1380 with a directory listing of that given directory. You can also set
1381 CURLOPT_CUSTOMREQUEST to alter what exact listing command libcurl would use
1382 to list the files.
1383
Jay Satirof9eed592016-07-09 03:05:55 -04001384 The follow-up question tends to be how is a program supposed to parse the
1385 directory listing. How does it know what's a file and what's a dir and what's
1386 a symlink etc. If the FTP server supports the MLSD command then it will
1387 return data in a machine-readable format that can be parsed for type. The
1388 types are specified by RFC3659 section 7.5.1. If MLSD is not supported then
1389 you have to work with what you're given. The LIST output format is entirely
1390 at the server's own liking and the NLST output doesn't reveal any types and
1391 in many cases doesn't even include all the directory entries. Also, both LIST
1392 and NLST tend to hide unix-style hidden files (those that start with a dot)
1393 by default so you need to do "LIST -a" or similar to see them.
Daniel Stenberg8740d142009-06-09 09:02:39 +00001394
Jay Satirof9eed592016-07-09 03:05:55 -04001395 Example - List only directories.
1396 ftp.funet.fi supports MLSD and ftp.kernel.org does not:
1397
1398 curl -s ftp.funet.fi/pub/ -X MLSD | \
1399 perl -lne 'print if s/(?:^|;)type=dir;[^ ]+ (.+)$/$1/'
1400
1401 curl -s ftp.kernel.org/pub/linux/kernel/ | \
1402 perl -lne 'print if s/^d[-rwx]{9}(?: +[^ ]+){7} (.+)$/$1/'
1403
1404 If you need to parse LIST output in libcurl one such existing
Viktor Szakatsd49881c2016-02-03 05:09:25 +01001405 list parser is available at https://cr.yp.to/ftpparse.html Versions of
Dan Fandrich7d166b02010-07-21 15:15:07 -07001406 libcurl since 7.21.0 also provide the ability to specify a wildcard to
1407 download multiple files from one FTP directory.
Daniel Stenberg8740d142009-06-09 09:02:39 +00001408
Daniel Stenberge8ab9a02012-09-28 15:50:18 +02001409 5.16 I want a different time-out!
1410
1411 Time and time again users realize that CURLOPT_TIMEOUT and
1412 CURLOPT_CONNECTIMEOUT are not sufficiently advanced or flexible to cover all
1413 the various use cases and scenarios applications end up with.
1414
1415 libcurl offers many more ways to time-out operations. A common alternative
1416 is to use the CURLOPT_LOW_SPEED_LIMIT and CURLOPT_LOW_SPEED_TIME options to
1417 specify the lowest possible speed to accept before to consider the transfer
1418 timed out.
1419
1420 The most flexible way is by writing your own time-out logic and using
1421 CURLOPT_PROGRESSFUNCTION (perhaps in combination with other callbacks) and
1422 use that to figure out exactly when the right condition is met when the
1423 transfer should get stopped.
1424
Daniel Stenbergdbf93a82013-01-03 10:15:02 +01001425 5.17 Can I write a server with libcurl?
1426
1427 No. libcurl offers no functions or building blocks to build any kind of
1428 internet protocol server. libcurl is only a client-side library. For server
1429 libraries, you need to continue your search elsewhere but there exist many
1430 good open source ones out there for most protocols you could possibly want a
1431 server for. And there are really good stand-alone ones that have been tested
1432 and proven for many years. There's no need for you to reinvent them!
1433
Daniel Stenberg1495f422014-05-08 09:30:35 +02001434 5.18 Does libcurl use threads?
1435
1436 Put simply: no, libcurl will execute in the same thread you call it in. All
1437 callbacks will be called in the same thread as the one you call libcurl in.
1438
1439 If you want to avoid your thread to be blocked by the libcurl call, you make
1440 sure you use the non-blocking API which will do transfers asynchronously -
1441 but still in the same single thread.
1442
1443 libcurl will potentially internally use threads for name resolving, if it
1444 was built to work like that, but in those cases it'll create the child
1445 threads by itself and they will only be used and then killed internally by
1446 libcurl and never exposed to the outside.
Daniel Stenberg8740d142009-06-09 09:02:39 +00001447
Daniel Stenbergc3318b42000-08-17 14:06:42 +000014486. License Issues
Daniel Stenbergc3c77392000-07-31 22:42:34 +00001449
Daniel Stenberg1c961282002-09-03 11:58:18 +00001450 Curl and libcurl are released under a MIT/X derivate license. The license is
1451 very liberal and should not impose a problem for your project. This section
1452 is just a brief summary for the cases we get the most questions. (Parts of
1453 this section was much enhanced by Bjorn Reese.)
Daniel Stenbergc3c77392000-07-31 22:42:34 +00001454
Daniel Stenberg9a44fa82005-11-02 09:34:53 +00001455 We are not lawyers and this is not legal advice. You should probably consult
Dan Fandrichc28443c2010-12-08 10:16:25 -08001456 one if you want true and accurate legal insights without our prejudice. Note
1457 especially that this section concerns the libcurl license only; compiling in
1458 features of libcurl that depend on other libraries (e.g. OpenSSL) may affect
1459 the licensing obligations of your application.
Daniel Stenberg9a44fa82005-11-02 09:34:53 +00001460
Daniel Stenberg811edcd2004-08-10 08:41:41 +00001461 6.1 I have a GPL program, can I use the libcurl library?
Daniel Stenbergc3c77392000-07-31 22:42:34 +00001462
Daniel Stenberg0d181b52001-01-04 12:43:53 +00001463 Yes!
Daniel Stenberg7d1ef962000-08-14 06:31:59 +00001464
Daniel Stenberg0d181b52001-01-04 12:43:53 +00001465 Since libcurl may be distributed under the MIT/X derivate license, it can be
1466 used together with GPL in any software.
Daniel Stenbergc3c77392000-07-31 22:42:34 +00001467
Daniel Stenberg811edcd2004-08-10 08:41:41 +00001468 6.2 I have a closed-source program, can I use the libcurl library?
Daniel Stenbergc3c77392000-07-31 22:42:34 +00001469
Daniel Stenbergc59baa02001-02-12 10:05:09 +00001470 Yes!
Daniel Stenberg0d181b52001-01-04 12:43:53 +00001471
Daniel Stenbergc59baa02001-02-12 10:05:09 +00001472 libcurl does not put any restrictions on the program that uses the library.
Daniel Stenbergc3c77392000-07-31 22:42:34 +00001473
Daniel Stenberg811edcd2004-08-10 08:41:41 +00001474 6.3 I have a BSD licensed program, can I use the libcurl library?
Daniel Stenberg31b8eea2000-08-23 07:27:00 +00001475
Daniel Stenbergc59baa02001-02-12 10:05:09 +00001476 Yes!
Daniel Stenberg0d181b52001-01-04 12:43:53 +00001477
Daniel Stenbergc59baa02001-02-12 10:05:09 +00001478 libcurl does not put any restrictions on the program that uses the library.
Daniel Stenberg31b8eea2000-08-23 07:27:00 +00001479
Daniel Stenberg811edcd2004-08-10 08:41:41 +00001480 6.4 I have a program that uses LGPL libraries, can I use libcurl?
Daniel Stenbergc3c77392000-07-31 22:42:34 +00001481
Daniel Stenbergc59baa02001-02-12 10:05:09 +00001482 Yes!
Daniel Stenbergc3c77392000-07-31 22:42:34 +00001483
Daniel Stenbergc59baa02001-02-12 10:05:09 +00001484 The LGPL license doesn't clash with other licenses.
Daniel Stenbergc3318b42000-08-17 14:06:42 +00001485
Daniel Stenberg811edcd2004-08-10 08:41:41 +00001486 6.5 Can I modify curl/libcurl for my program and keep the changes secret?
Daniel Stenbergc3c77392000-07-31 22:42:34 +00001487
Daniel Stenbergc59baa02001-02-12 10:05:09 +00001488 Yes!
Daniel Stenberg0d181b52001-01-04 12:43:53 +00001489
1490 The MIT/X derivate license practically allows you to do almost anything with
1491 the sources, on the condition that the copyright texts in the sources are
1492 left intact.
Daniel Stenbergc3c77392000-07-31 22:42:34 +00001493
Daniel Stenberg811edcd2004-08-10 08:41:41 +00001494 6.6 Can you please change the curl/libcurl license to XXXX?
Daniel Stenbergc3c77392000-07-31 22:42:34 +00001495
Daniel Stenbergc59baa02001-02-12 10:05:09 +00001496 No.
1497
Daniel Stenberg11d718b2001-03-13 11:47:30 +00001498 We have carefully picked this license after years of development and
1499 discussions and a large amount of people have contributed with source code
1500 knowing that this is the license we use. This license puts the restrictions
1501 we want on curl/libcurl and it does not spread to other programs or
Daniel Stenberg3a552b12003-06-26 11:35:48 +00001502 libraries that use it. It should be possible for everyone to use libcurl or
1503 curl in their projects, no matter what license they already have in use.
Daniel Stenberg9ac76292004-08-18 11:18:36 +00001504
Dan Fandrich5c9fff92009-01-30 18:28:29 +00001505 6.7 What are my obligations when using libcurl in my commercial apps?
Daniel Stenberg9a44fa82005-11-02 09:34:53 +00001506
1507 Next to none. All you need to adhere to is the MIT-style license (stated in
1508 the COPYING file) which basically says you have to include the copyright
1509 notice in "all copies" and that you may not use the copyright holder's name
1510 when promoting your software.
1511
1512 You do not have to release any of your source code.
1513
1514 You do not have to reveal or make public any changes to the libcurl source
1515 code.
1516
Daniel Stenberg819dfdd2011-01-29 23:52:40 +01001517 You do not have to broadcast to the world that you are using libcurl within
Daniel Stenberg9a44fa82005-11-02 09:34:53 +00001518 your app.
1519
Daniel Stenberg819dfdd2011-01-29 23:52:40 +01001520 All we ask is that you disclose "the copyright notice and this permission
1521 notice" somewhere. Most probably like in the documentation or in the section
1522 where other third party dependencies already are mentioned and acknowledged.
1523
Daniel Stenberg6b485c72016-02-02 00:24:30 +01001524 As can be seen here: https://curl.haxx.se/docs/companies.html and elsewhere,
Daniel Stenberg819dfdd2011-01-29 23:52:40 +01001525 more and more companies are discovering the power of libcurl and take
1526 advantage of it even in commercial environments.
Daniel Stenberg9a44fa82005-11-02 09:34:53 +00001527
1528
Daniel Stenberg9ac76292004-08-18 11:18:36 +000015297. PHP/CURL Issues
1530
1531 7.1 What is PHP/CURL?
1532
1533 The module for PHP that makes it possible for PHP programs to access curl-
Daniel Stenbergb6c876b2005-07-30 23:37:05 +00001534 functions from within PHP.
1535
1536 In the cURL project we call this module PHP/CURL to differentiate it from
1537 curl the command line tool and libcurl the library. The PHP team however
1538 does not refer to it like this (for unknown reasons). They call it plain
Daniel Stenberg844cbc72007-07-29 22:17:39 +00001539 CURL (often using all caps) or sometimes ext/curl, but both cause much
1540 confusion to users which in turn gives us a higher question load.
Daniel Stenberg9ac76292004-08-18 11:18:36 +00001541
Daniel Stenberge38a7882011-03-17 11:30:29 +01001542 7.2 Who wrote PHP/CURL?
Daniel Stenberg9ac76292004-08-18 11:18:36 +00001543
MaxGiting05cd55f2015-11-18 23:00:24 -05001544 PHP/CURL was initially written by Sterling Hughes.
Daniel Stenberg9ac76292004-08-18 11:18:36 +00001545
1546 7.3 Can I perform multiple requests using the same handle?
1547
Daniel Stenbergee400f92004-08-19 06:31:29 +00001548 Yes - at least in PHP version 4.3.8 and later (this has been known to not
1549 work in earlier versions, but the exact version when it started to work is
1550 unknown to me).
Daniel Stenberg9ac76292004-08-18 11:18:36 +00001551
Daniel Stenbergee400f92004-08-19 06:31:29 +00001552 After a transfer, you just set new options in the handle and make another
MaxGiting05cd55f2015-11-18 23:00:24 -05001553 transfer. This will make libcurl re-use the same connection if it can.
1554
1555 7.4 Does PHP/CURL have dependencies?
1556
1557 PHP/CURL is a module that comes with the regular PHP package. It depends on
1558 and uses libcurl, so you need to have libcurl installed properly before
1559 PHP/CURL can be used.