blob: c8ba7feb3d6fc5f22f6d91c14a06d3387a126f45 [file] [log] [blame]
xf.li6c8fc1e2023-08-12 00:11:09 -07001 _ _ ____ _
2 ___| | | | _ \| |
3 / __| | | | |_) | |
4 | (__| |_| | _ <| |___
5 \___|\___/|_| \_\_____|
6
7FAQ
8
9 1. Philosophy
10 1.1 What is cURL?
11 1.2 What is libcurl?
12 1.3 What is curl not?
13 1.4 When will you make curl do XXXX ?
14 1.5 Who makes curl?
15 1.6 What do you get for making curl?
16 1.7 What about CURL from curl.com?
17 1.8 I have a problem, who do I mail?
18 1.9 Where do I buy commercial support for curl?
19 1.10 How many are using curl?
20 1.11 Why do you not update ca-bundle.crt
21 1.12 I have a problem, who can I chat with?
22 1.13 curl's ECCN number?
23 1.14 How do I submit my patch?
24 1.15 How do I port libcurl to my OS?
25
26 2. Install Related Problems
27 2.1 configure fails when using static libraries
28 2.2 Does curl work/build with other SSL libraries?
29 2.4 Does curl support SOCKS (RFC 1928) ?
30
31 3. Usage Problems
32 3.1 curl: (1) SSL is disabled, https: not supported
33 3.2 How do I tell curl to resume a transfer?
34 3.3 Why does my posting using -F not work?
35 3.4 How do I tell curl to run custom FTP commands?
36 3.5 How can I disable the Accept: */* header?
37 3.6 Does curl support ASP, XML, XHTML or HTML version Y?
38 3.7 Can I use curl to delete/rename a file through FTP?
39 3.8 How do I tell curl to follow HTTP redirects?
40 3.9 How do I use curl in my favorite programming language?
41 3.10 What about SOAP, WebDAV, XML-RPC or similar protocols over HTTP?
42 3.11 How do I POST with a different Content-Type?
43 3.12 Why do FTP-specific features over HTTP proxy fail?
44 3.13 Why do my single/double quotes fail?
45 3.14 Does curl support JavaScript or PAC (automated proxy config)?
46 3.15 Can I do recursive fetches with curl?
47 3.16 What certificates do I need when I use SSL?
48 3.17 How do I list the root directory of an FTP server?
49 3.18 Can I use curl to send a POST/PUT and not wait for a response?
50 3.19 How do I get HTTP from a host using a specific IP address?
51 3.20 How to SFTP from my user's home directory?
52 3.21 Protocol xxx not supported or disabled in libcurl
53 3.22 curl -X gives me HTTP problems
54
55 4. Running Problems
56 4.2 Why do I get problems when I use & or % in the URL?
57 4.3 How can I use {, }, [ or ] to specify multiple URLs?
58 4.4 Why do I get downloaded data even though the web page does not exist?
59 4.5 Why do I get return code XXX from an HTTP server?
60 4.5.1 "400 Bad Request"
61 4.5.2 "401 Unauthorized"
62 4.5.3 "403 Forbidden"
63 4.5.4 "404 Not Found"
64 4.5.5 "405 Method Not Allowed"
65 4.5.6 "301 Moved Permanently"
66 4.6 Can you tell me what error code 142 means?
67 4.7 How do I keep user names and passwords secret in curl command lines?
68 4.8 I found a bug
69 4.9 curl cannot authenticate to a server that requires NTLM?
70 4.10 My HTTP request using HEAD, PUT or DELETE does not work
71 4.11 Why do my HTTP range requests return the full document?
72 4.12 Why do I get "certificate verify failed" ?
73 4.13 Why is curl -R on Windows one hour off?
74 4.14 Redirects work in browser but not with curl
75 4.15 FTPS does not work
76 4.16 My HTTP POST or PUT requests are slow
77 4.17 Non-functional connect timeouts on Windows
78 4.18 file:// URLs containing drive letters (Windows, NetWare)
79 4.19 Why does not curl return an error when the network cable is unplugged?
80 4.20 curl does not return error for HTTP non-200 responses
81
82 5. libcurl Issues
83 5.1 Is libcurl thread-safe?
84 5.2 How can I receive all data into a large memory chunk?
85 5.3 How do I fetch multiple files with libcurl?
86 5.4 Does libcurl do Winsock initialization on win32 systems?
87 5.5 Does CURLOPT_WRITEDATA and CURLOPT_READDATA work on win32 ?
88 5.6 What about Keep-Alive or persistent connections?
89 5.7 Link errors when building libcurl on Windows
90 5.8 libcurl.so.X: open failed: No such file or directory
91 5.9 How does libcurl resolve host names?
92 5.10 How do I prevent libcurl from writing the response to stdout?
93 5.11 How do I make libcurl not receive the whole HTTP response?
94 5.12 Can I make libcurl fake or hide my real IP address?
95 5.13 How do I stop an ongoing transfer?
96 5.14 Using C++ non-static functions for callbacks?
97 5.15 How do I get an FTP directory listing?
98 5.16 I want a different time-out
99 5.17 Can I write a server with libcurl?
100 5.18 Does libcurl use threads?
101
102 6. License Issues
103 6.1 I have a GPL program, can I use the libcurl library?
104 6.2 I have a closed-source program, can I use the libcurl library?
105 6.3 I have a BSD licensed program, can I use the libcurl library?
106 6.4 I have a program that uses LGPL libraries, can I use libcurl?
107 6.5 Can I modify curl/libcurl for my program and keep the changes secret?
108 6.6 Can you please change the curl/libcurl license to XXXX?
109 6.7 What are my obligations when using libcurl in my commercial apps?
110
111 7. PHP/CURL Issues
112 7.1 What is PHP/CURL?
113 7.2 Who wrote PHP/CURL?
114 7.3 Can I perform multiple requests using the same handle?
115 7.4 Does PHP/CURL have dependencies?
116
117 8. Development
118 8.1 Why does curl use C89?
119 8.2 Will curl be rewritten?
120
121==============================================================================
122
1231. Philosophy
124
125 1.1 What is cURL?
126
127 cURL is the name of the project. The name is a play on 'Client for URLs',
128 originally with URL spelled in uppercase to make it obvious it deals with
129 URLs. The fact it can also be read as 'see URL' also helped, it works as
130 an abbreviation for "Client URL Request Library" or why not the recursive
131 version: "curl URL Request Library".
132
133 The cURL project produces two products:
134
135 libcurl
136
137 A client-side URL transfer library, supporting DICT, FILE, FTP, FTPS,
138 GOPHER, GOPHERS, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S,
139 RTMP, RTMPS, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS
140 and WSS.
141
142 libcurl supports HTTPS certificates, HTTP POST, HTTP PUT, FTP uploading,
143 Kerberos, SPNEGO, HTTP form based upload, proxies, cookies, user+password
144 authentication, file transfer resume, http proxy tunneling and more.
145
146 libcurl is highly portable, it builds and works identically on numerous
147 platforms, including Solaris, NetBSD, FreeBSD, OpenBSD, Darwin, HP-UX,
148 IRIX, AIX, Tru64, Linux, UnixWare, HURD, Windows, Amiga, OS/2, macOS,
149 Ultrix, QNX, OpenVMS, RISC OS, Novell NetWare, DOS, Symbian, OSF, Android,
150 Minix, IBM TPF and more...
151
152 libcurl is free, thread-safe, IPv6 compatible, feature rich, well
153 supported and fast.
154
155 curl
156
157 A command line tool for getting or sending data using URL syntax.
158
159 Since curl uses libcurl, curl supports the same wide range of common
160 Internet protocols that libcurl does.
161
162 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
165 https://media.merriam-webster.com/soundc11/c/curl0001.wav
166
167 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
169 notice that this FAQ is directed at the command-line tool named curl (and
170 libcurl the library), and may therefore not be valid for other curl-related
171 projects. (There is however a small section for the PHP/CURL in this FAQ.)
172
173 1.2 What is libcurl?
174
175 libcurl is a reliable and portable library for doing Internet data transfers
176 using one or more of its supported Internet protocols.
177
178 You can use libcurl freely in your application, be it open source,
179 commercial or closed-source.
180
181 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
185 1.3 What is curl not?
186
187 curl is not a wget clone. That is a common misconception. Never, during
188 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 website mirroring program. If you want to use curl to mirror
192 something: fine, go ahead and write a script that wraps around curl or use
193 libcurl to make it reality.
194
195 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
197 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
200 or with PHP (when using the PHP/CURL module).
201
202 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, OS/2, macOS,
205 QNX etc.
206
207 1.4 When will you make curl do XXXX ?
208
209 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
211 curl:
212
213 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.
216
217 We do not add things to curl that other small and available tools already do
218 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.
220
221 We focus on protocol related issues and improvements. If you want to do more
222 magic with the supported protocols than curl currently does, chances are
223 good we will agree. If you want to add more protocols, we may agree.
224
225 If you want someone else to do all the work while you wait for us to
226 implement it for you, that is not a 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
229 effort in return. Simply go to the GitHub repository which resides at
230 https://github.com/curl/curl, fork the project, and create pull requests
231 with your proposed changes.
232
233 If you write the code, chances are better that it will get into curl faster.
234
235 1.5 Who makes curl?
236
237 curl and libcurl are not made by any single individual. Daniel Stenberg is
238 project leader and main developer, but other persons' submissions are
239 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
241 condition that developers agree that the fixes are good).
242
243 The full list of all contributors is found in the docs/THANKS file.
244
245 curl is developed by a community, with Daniel at the wheel.
246
247 1.6 What do you get for making curl?
248
249 Project cURL is entirely free and open. We do this voluntarily, mostly in
250 our spare time. Companies may pay individual developers to work on curl.
251 This is not controlled by nor supervised in any way by the curl project.
252
253 We get help from companies. Haxx provides website, bandwidth, mailing lists
254 etc, GitHub hosts the primary git repository and other services like the bug
255 tracker at https://github.com/curl/curl. Also again, some companies have
256 sponsored certain parts of the development in the past and I hope some will
257 continue to do so in the future.
258
259 If you want to support our project, consider a donation or a banner-program
260 or even better: by helping us with coding, documenting or testing etc.
261
262 See also: https://curl.se/sponsors.html
263
264 1.7 What about CURL from curl.com?
265
266 During the summer of 2001, curl.com was busy advertising their client-side
267 programming language for the web, named CURL.
268
269 We are in no way associated with curl.com or their CURL programming
270 language.
271
272 Our project name curl has been in effective use since 1998. We were not the
273 first computer related project to use the name "curl" and do not claim any
274 rights to the name.
275
276 We recognize that we will be living in parallel with curl.com and wish them
277 every success.
278
279 1.8 I have a problem, who do I mail?
280
281 Please do not mail any single individual unless you really need to. Keep
282 curl-related questions on a suitable mailing list. All available mailing
283 lists are listed in the MANUAL document and online at
284 https://curl.se/mail/
285
286 Keeping curl-related questions and discussions on mailing lists allows
287 others to join in and help, to share their ideas, to contribute their
288 suggestions and to spread their wisdom. Keeping discussions on public mailing
289 lists also allows for others to learn from this (both current and future
290 users thanks to the web based archives of the mailing lists), thus saving us
291 from having to repeat ourselves even more. Thanks for respecting this.
292
293 If you have found or simply suspect a security problem in curl or libcurl,
294 submit all the details at https://hackerone.one/curl. On there we keep the
295 issue private while we investigate, confirm it, work and validate a fix and
296 agree on a time schedule for publication etc. That way we produce a fix in a
297 timely manner before the flaw is announced to the world, reducing the impact
298 the problem risks having on existing users.
299
300 Security issues can also be taking to the curl security team by emailing
301 security at curl.se (closed list of receivers, mails are not disclosed).
302
303 1.9 Where do I buy commercial support for curl?
304
305 curl is fully open source. It means you can hire any skilled engineer to fix
306 your curl-related problems.
307
308 We list available alternatives on the curl website:
309 https://curl.se/support.html
310
311 1.10 How many are using curl?
312
313 It is impossible to tell.
314
315 We do not know how many users that knowingly have installed and use curl.
316
317 We do not know how many users that use curl without knowing that they are in
318 fact using it.
319
320 We do not know how many users that downloaded or installed curl and then
321 never use it.
322
323 In 2020, we estimate that curl runs in roughly ten billion installations
324 world wide.
325
326 1.11 Why do you not update ca-bundle.crt
327
328 In the cURL project we have decided not to attempt to keep this file updated
329 (or even present) since deciding what to add to a ca cert bundle is an
330 undertaking we have not been ready to accept, and the one we can get from
331 Mozilla is perfectly fine so there is no need to duplicate that work.
332
333 Today, with many services performed over HTTPS, every operating system
334 should come with a default ca cert bundle that can be deemed somewhat
335 trustworthy and that collection (if reasonably updated) should be deemed to
336 be a lot better than a private curl version.
337
338 If you want the most recent collection of ca certs that Mozilla Firefox
339 uses, we recommend that you extract the collection yourself from Mozilla
340 Firefox (by running 'make ca-bundle), or by using our online service setup
341 for this purpose: https://curl.se/docs/caextract.html
342
343 1.12 I have a problem who, can I chat with?
344
345 There is a bunch of friendly people hanging out in the #curl channel on the
346 IRC network libera.chat. If you are polite and nice, chances are good that
347 you can get -- or provide -- help instantly.
348
349 1.13 curl's ECCN number?
350
351 The US government restricts exports of software that contains or uses
352 cryptography. When doing so, the Export Control Classification Number (ECCN)
353 is used to identify the level of export control etc.
354
355 Apache Software Foundation gives a good explanation of ECCNs at
356 https://www.apache.org/dev/crypto.html
357
358 We believe curl's number might be ECCN 5D002, another possibility is
359 5D992. It seems necessary to write them (the authority that administers ECCN
360 numbers), asking to confirm.
361
362 Comprehensible explanations of the meaning of such numbers and how to obtain
363 them (resp.) are here
364
365 https://www.bis.doc.gov/licensing/exportingbasics.htm
366 https://www.bis.doc.gov/licensing/do_i_needaneccn.html
367
368 An incomprehensible description of the two numbers above is here
369 https://www.bis.doc.gov/index.php/documents/new-encryption/1653-ccl5-pt2-3
370
371 1.14 How do I submit my patch?
372
373 We strongly encourage you to submit changes and improvements directly as
374 "pull requests" on GitHub: https://github.com/curl/curl/pulls
375
376 If you for any reason cannot or will not deal with GitHub, send your patch to
377 the curl-library mailing list. We are many subscribers there and there are
378 lots of people who can review patches, comment on them and "receive" them
379 properly.
380
381 Lots of more details are found in the CONTRIBUTE.md and INTERNALS.md
382 documents.
383
384 1.15 How do I port libcurl to my OS?
385
386 Here's a rough step-by-step:
387
388 1. copy a suitable lib/config-*.h file as a start to lib/config-[youros].h
389
390 2. edit lib/config-[youros].h to match your OS and setup
391
392 3. edit lib/curl_setup.h to include config-[youros].h when your OS is
393 detected by the preprocessor, in the style others already exist
394
395 4. compile lib/*.c and make them into a library
396
397
3982. Install Related Problems
399
400 2.1 configure fails when using static libraries
401
402 You may find that configure fails to properly detect the entire dependency
403 chain of libraries when you provide static versions of the libraries that
404 configure checks for.
405
406 The reason why static libraries is much harder to deal with is that for them
407 we do not get any help but the script itself must know or check what more
408 libraries that are needed (with shared libraries, that dependency "chain" is
409 handled automatically). This is a error-prone process and one that also
410 tends to vary over time depending on the release versions of the involved
411 components and may also differ between operating systems.
412
413 For that reason, configure does few attempts to actually figure this out and
414 you are instead encouraged to set LIBS and LDFLAGS accordingly when you
415 invoke configure, and point out the needed libraries and set the necessary
416 flags yourself.
417
418 2.2 Does curl work with other SSL libraries?
419
420 curl has been written to use a generic SSL function layer internally, and
421 that SSL functionality can then be provided by one out of many different SSL
422 backends.
423
424 curl can be built to use one of the following SSL alternatives: OpenSSL,
425 libressl, BoringSSL, GnuTLS, wolfSSL, NSS, mbedTLS, Secure
426 Transport (native iOS/OS X), Schannel (native Windows), GSKit (native IBM
427 i), BearSSL, or Rustls. They all have their pros and cons, and we try to
428 maintain a comparison of them here: https://curl.se/docs/ssl-compared.html
429
430 2.4 Does curl support SOCKS (RFC 1928) ?
431
432 Yes, SOCKS 4 and 5 are supported.
433
4343. Usage problems
435
436 3.1 curl: (1) SSL is disabled, https: not supported
437
438 If you get this output when trying to get anything from an https:// server,
439 it means that the instance of curl/libcurl that you are using was built
440 without support for this protocol.
441
442 This could have happened if the configure script that was run at build time
443 could not find all libs and include files curl requires for SSL to work. If
444 the configure script fails to find them, curl is simply built without SSL
445 support.
446
447 To get the https:// support into a curl that was previously built but that
448 reports that https:// is not supported, you should dig through the document
449 and logs and check out why the configure script does not find the SSL libs
450 and/or include files.
451
452 Also, check out the other paragraph in this FAQ labeled "configure does not
453 find OpenSSL even when it is installed".
454
455 3.2 How do I tell curl to resume a transfer?
456
457 curl supports resumed transfers both ways on both FTP and HTTP.
458 Try the -C option.
459
460 3.3 Why does my posting using -F not work?
461
462 You cannot arbitrarily use -F or -d, the choice between -F or -d depends on
463 the HTTP operation you need curl to do and what the web server that will
464 receive your post expects.
465
466 If the form you are trying to submit uses the type 'multipart/form-data',
467 then and only then you must use the -F type. In all the most common cases,
468 you should use -d which then causes a posting with the type
469 'application/x-www-form-urlencoded'.
470
471 This is described in some detail in the MANUAL and TheArtOfHttpScripting
472 documents, and if you do not understand it the first time, read it again
473 before you post questions about this to the mailing list. Also, try reading
474 through the mailing list archives for old postings and questions regarding
475 this.
476
477 3.4 How do I tell curl to run custom FTP commands?
478
479 You can tell curl to perform optional commands both before and/or after a
480 file transfer. Study the -Q/--quote option.
481
482 Since curl is used for file transfers, you do not normally use curl to
483 perform FTP commands without transferring anything. Therefore you must
484 always specify a URL to transfer to/from even when doing custom FTP
485 commands, or use -I which implies the "no body" option sent to libcurl.
486
487 3.5 How can I disable the Accept: */* header?
488
489 You can change all internally generated headers by adding a replacement with
490 the -H/--header option. By adding a header with empty contents you safely
491 disable that one. Use -H "Accept:" to disable that specific header.
492
493 3.6 Does curl support ASP, XML, XHTML or HTML version Y?
494
495 To curl, all contents are alike. It does not matter how the page was
496 generated. It may be ASP, PHP, Perl, shell-script, SSI or plain HTML
497 files. There is no difference to curl and it does not even know what kind of
498 language that generated the page.
499
500 See also item 3.14 regarding JavaScript.
501
502 3.7 Can I use curl to delete/rename a file through FTP?
503
504 Yes. You specify custom FTP commands with -Q/--quote.
505
506 One example would be to delete a file after you have downloaded it:
507
508 curl -O ftp://download.com/coolfile -Q '-DELE coolfile'
509
510 or rename a file after upload:
511
512 curl -T infile ftp://upload.com/dir/ -Q "-RNFR infile" -Q "-RNTO newname"
513
514 3.8 How do I tell curl to follow HTTP redirects?
515
516 curl does not follow so-called redirects by default. The Location: header
517 that informs the client about this is only interpreted if you are using the
518 -L/--location option. As in:
519
520 curl -L http://redirector.com
521
522 Not all redirects are HTTP ones, see 4.14
523
524 3.9 How do I use curl in my favorite programming language?
525
526 Many programming languages have interfaces/bindings that allow you to use
527 curl without having to use the command line tool. If you are fluent in such
528 a language, you may prefer to use one of these interfaces instead.
529
530 Find out more about which languages that support curl directly, and how to
531 install and use them, in the libcurl section of the curl website:
532 https://curl.se/libcurl/
533
534 All the various bindings to libcurl are made by other projects and people,
535 outside of the cURL project. The cURL project itself only produces libcurl
536 with its plain C API. If you do not find anywhere else to ask you can ask
537 about bindings on the curl-library list too, but be prepared that people on
538 that list may not know anything about bindings.
539
540 In December 2021, there were interfaces available for the following
541 languages: Ada95, Basic, C, C++, Ch, Cocoa, D, Delphi, Dylan, Eiffel,
542 Euphoria, Falcon, Ferite, Gambas, glib/GTK+, Go, Guile, Harbour, Haskell,
543 Java, Julia, Lisp, Lua, Mono, .NET, node.js, Object-Pascal, OCaml, Pascal,
544 Perl, PHP, PostgreSQL, Python, R, Rexx, Ring, RPG, Ruby, Rust, Scheme,
545 Scilab, S-Lang, Smalltalk, SP-Forth, SPL, Tcl, Visual Basic, Visual FoxPro,
546 Q, wxwidgets, XBLite and Xoho. By the time you read this, additional ones
547 may have appeared.
548
549 3.10 What about SOAP, WebDAV, XML-RPC or similar protocols over HTTP?
550
551 curl adheres to the HTTP spec, which basically means you can play with *any*
552 protocol that is built on top of HTTP. Protocols such as SOAP, WEBDAV and
553 XML-RPC are all such ones. You can use -X to set custom requests and -H to
554 set custom headers (or replace internally generated ones).
555
556 Using libcurl is of course just as good and you would just use the proper
557 library options to do the same.
558
559 3.11 How do I POST with a different Content-Type?
560
561 You can always replace the internally generated headers with -H/--header.
562 To make a simple HTTP POST with text/xml as content-type, do something like:
563
564 curl -d "datatopost" -H "Content-Type: text/xml" [URL]
565
566 3.12 Why do FTP-specific features over HTTP proxy fail?
567
568 Because when you use an HTTP proxy, the protocol spoken on the network will
569 be HTTP, even if you specify an FTP URL. This effectively means that you
570 normally cannot use FTP-specific features such as FTP upload and FTP quote
571 etc.
572
573 There is one exception to this rule, and that is if you can "tunnel through"
574 the given HTTP proxy. Proxy tunneling is enabled with a special option (-p)
575 and is generally not available as proxy admins usually disable tunneling to
576 ports other than 443 (which is used for HTTPS access through proxies).
577
578 3.13 Why do my single/double quotes fail?
579
580 To specify a command line option that includes spaces, you might need to
581 put the entire option within quotes. Like in:
582
583 curl -d " with spaces " url.com
584
585 or perhaps
586
587 curl -d ' with spaces ' url.com
588
589 Exactly what kind of quotes and how to do this is entirely up to the shell
590 or command line interpreter that you are using. For most unix shells, you
591 can more or less pick either single (') or double (") quotes. For
592 Windows/DOS command prompts you must use double (") quotes, and if the
593 option string contains inner double quotes you can escape them with a
594 backslash.
595
596 For Windows powershell the arguments are not always passed on as expected
597 because curl is not a powershell script. You may or may not be able to use
598 single quotes. To escape inner double quotes seems to require a
599 backslash-backtick escape sequence and the outer quotes as double quotes.
600
601 Please study the documentation for your particular environment. Examples in
602 the curl docs will use a mix of both of these as shown above. You must
603 adjust them to work in your environment.
604
605 Remember that curl works and runs on more operating systems than most single
606 individuals have ever tried.
607
608 3.14 Does curl support JavaScript or PAC (automated proxy config)?
609
610 Many web pages do magic stuff using embedded JavaScript. curl and libcurl
611 have no built-in support for that, so it will be treated just like any other
612 contents.
613
614 .pac files are a Netscape invention and are sometimes used by organizations
615 to allow them to differentiate which proxies to use. The .pac contents is
616 just a JavaScript program that gets invoked by the browser and that returns
617 the name of the proxy to connect to. Since curl does not support JavaScript,
618 it cannot support .pac proxy configuration either.
619
620 Some workarounds usually suggested to overcome this JavaScript dependency:
621
622 Depending on the JavaScript complexity, write up a script that translates it
623 to another language and execute that.
624
625 Read the JavaScript code and rewrite the same logic in another language.
626
627 Implement a JavaScript interpreter, people have successfully used the
628 Mozilla JavaScript engine in the past.
629
630 Ask your admins to stop this, for a static proxy setup or similar.
631
632 3.15 Can I do recursive fetches with curl?
633
634 No. curl itself has no code that performs recursive operations, such as
635 those performed by wget and similar tools.
636
637 There exists wrapper scripts with that functionality (for example the
638 curlmirror perl script), and you can write programs based on libcurl to do
639 it, but the command line tool curl itself cannot.
640
641 3.16 What certificates do I need when I use SSL?
642
643 There are three different kinds of "certificates" to keep track of when we
644 talk about using SSL-based protocols (HTTPS or FTPS) using curl or libcurl.
645
646 CLIENT CERTIFICATE
647
648 The server you communicate with may require that you can provide this in
649 order to prove that you actually are who you claim to be. If the server
650 does not require this, you do not need a client certificate.
651
652 A client certificate is always used together with a private key, and the
653 private key has a pass phrase that protects it.
654
655 SERVER CERTIFICATE
656
657 The server you communicate with has a server certificate. You can and should
658 verify this certificate to make sure that you are truly talking to the real
659 server and not a server impersonating it.
660
661 CERTIFICATE AUTHORITY CERTIFICATE ("CA cert")
662
663 You often have several CA certs in a CA cert bundle that can be used to
664 verify a server certificate that was signed by one of the authorities in the
665 bundle. curl does not come with a CA cert bundle but most curl installs
666 provide one. You can also override the default.
667
668 The server certificate verification process is made by using a Certificate
669 Authority certificate ("CA cert") that was used to sign the server
670 certificate. Server certificate verification is enabled by default in curl
671 and libcurl and is often the reason for problems as explained in FAQ entry
672 4.12 and the SSLCERTS document
673 (https://curl.se/docs/sslcerts.html). Server certificates that are
674 "self-signed" or otherwise signed by a CA that you do not have a CA cert
675 for, cannot be verified. If the verification during a connect fails, you are
676 refused access. You then need to explicitly disable the verification to
677 connect to the server.
678
679 3.17 How do I list the root directory of an FTP server?
680
681 There are two ways. The way defined in the RFC is to use an encoded slash
682 in the first path part. List the "/tmp" directory like this:
683
684 curl ftp://ftp.sunet.se/%2ftmp/
685
686 or the not-quite-kosher-but-more-readable way, by simply starting the path
687 section of the URL with a slash:
688
689 curl ftp://ftp.sunet.se//tmp/
690
691 3.18 Can I use curl to send a POST/PUT and not wait for a response?
692
693 No.
694
695 You can easily write your own program using libcurl to do such stunts.
696
697 3.19 How do I get HTTP from a host using a specific IP address?
698
699 For example, you may be trying out a website installation that is not yet in
700 the DNS. Or you have a site using multiple IP addresses for a given host
701 name and you want to address a specific one out of the set.
702
703 Set a custom Host: header that identifies the server name you want to reach
704 but use the target IP address in the URL:
705
706 curl --header "Host: www.example.com" http://127.0.0.1/
707
708 You can also opt to add faked host name entries to curl with the --resolve
709 option. That has the added benefit that things like redirects will also work
710 properly. The above operation would instead be done as:
711
712 curl --resolve www.example.com:80:127.0.0.1 http://www.example.com/
713
714 3.20 How to SFTP from my user's home directory?
715
716 Contrary to how FTP works, SFTP and SCP URLs specify the exact directory to
717 work with. It means that if you do not specify that you want the user's home
718 directory, you get the actual root directory.
719
720 To specify a file in your user's home directory, you need to use the correct
721 URL syntax which for SFTP might look similar to:
722
723 curl -O -u user:password sftp://example.com/~/file.txt
724
725 and for SCP it is just a different protocol prefix:
726
727 curl -O -u user:password scp://example.com/~/file.txt
728
729 3.21 Protocol xxx not supported or disabled in libcurl
730
731 When passing on a URL to curl to use, it may respond that the particular
732 protocol is not supported or disabled. The particular way this error message
733 is phrased is because curl does not make a distinction internally of whether
734 a particular protocol is not supported (i.e. never got any code added that
735 knows how to speak that protocol) or if it was explicitly disabled. curl can
736 be built to only support a given set of protocols, and the rest would then
737 be disabled or not supported.
738
739 Note that this error will also occur if you pass a wrongly spelled protocol
740 part as in "htpt://example.com" or as in the less evident case if you prefix
741 the protocol part with a space as in " http://example.com/".
742
743 3.22 curl -X gives me HTTP problems
744
745 In normal circumstances, -X should hardly ever be used.
746
747 By default you use curl without explicitly saying which request method to
748 use when the URL identifies an HTTP transfer. If you just pass in a URL like
749 "curl http://example.com" it will use GET. If you use -d or -F curl will use
750 POST, -I will cause a HEAD and -T will make it a PUT.
751
752 If for whatever reason you are not happy with these default choices that curl
753 does for you, you can override those request methods by specifying -X
754 [WHATEVER]. This way you can for example send a DELETE by doing "curl -X
755 DELETE [URL]".
756
757 It is thus pointless to do "curl -XGET [URL]" as GET would be used
758 anyway. In the same vein it is pointless to do "curl -X POST -d data
759 [URL]"... But you can make a fun and somewhat rare request that sends a
760 request-body in a GET request with something like "curl -X GET -d data
761 [URL]"
762
763 Note that -X does not actually change curl's behavior as it only modifies the
764 actual string sent in the request, but that may of course trigger a
765 different set of events.
766
767 Accordingly, by using -XPOST on a command line that for example would follow
768 a 303 redirect, you will effectively prevent curl from behaving
769 correctly. Be aware.
770
771
7724. Running Problems
773
774 4.2 Why do I get problems when I use & or % in the URL?
775
776 In general Unix shells, the & symbol is treated specially and when used, it
777 runs the specified command in the background. To safely send the & as a part
778 of a URL, you should quote the entire URL by using single (') or double (")
779 quotes around it. Similar problems can also occur on some shells with other
780 characters, including ?*!$~(){}<>\|;`. When in doubt, quote the URL.
781
782 An example that would invoke a remote CGI that uses &-symbols could be:
783
784 curl 'http://www.altavista.com/cgi-bin/query?text=yes&q=curl'
785
786 In Windows, the standard DOS shell treats the percent sign specially and you
787 need to use TWO percent signs for each single one you want to use in the
788 URL.
789
790 If you want a literal percent sign to be part of the data you pass in a POST
791 using -d/--data you must encode it as '%25' (which then also needs the
792 percent sign doubled on Windows machines).
793
794 4.3 How can I use {, }, [ or ] to specify multiple URLs?
795
796 Because those letters have a special meaning to the shell, to be used in
797 a URL specified to curl you must quote them.
798
799 An example that downloads two URLs (sequentially) would be:
800
801 curl '{curl,www}.haxx.se'
802
803 To be able to use those characters as actual parts of the URL (without using
804 them for the curl URL "globbing" system), use the -g/--globoff option:
805
806 curl -g 'www.site.com/weirdname[].html'
807
808 4.4 Why do I get downloaded data even though the web page does not exist?
809
810 curl asks remote servers for the page you specify. If the page does not exist
811 at the server, the HTTP protocol defines how the server should respond and
812 that means that headers and a "page" will be returned. That is simply how
813 HTTP works.
814
815 By using the --fail option you can tell curl explicitly to not get any data
816 if the HTTP return code does not say success.
817
818 4.5 Why do I get return code XXX from an HTTP server?
819
820 RFC2616 clearly explains the return codes. This is a short transcript. Go
821 read the RFC for exact details:
822
823 4.5.1 "400 Bad Request"
824
825 The request could not be understood by the server due to malformed
826 syntax. The client SHOULD NOT repeat the request without modifications.
827
828 4.5.2 "401 Unauthorized"
829
830 The request requires user authentication.
831
832 4.5.3 "403 Forbidden"
833
834 The server understood the request, but is refusing to fulfill it.
835 Authorization will not help and the request SHOULD NOT be repeated.
836
837 4.5.4 "404 Not Found"
838
839 The server has not found anything matching the Request-URI. No indication
840 is given as to whether the condition is temporary or permanent.
841
842 4.5.5 "405 Method Not Allowed"
843
844 The method specified in the Request-Line is not allowed for the resource
845 identified by the Request-URI. The response MUST include an Allow header
846 containing a list of valid methods for the requested resource.
847
848 4.5.6 "301 Moved Permanently"
849
850 If you get this return code and an HTML output similar to this:
851
852 <H1>Moved Permanently</H1> The document has moved <A
853 HREF="http://same_url_now_with_a_trailing_slash/">here</A>.
854
855 it might be because you requested a directory URL but without the trailing
856 slash. Try the same operation again _with_ the trailing URL, or use the
857 -L/--location option to follow the redirection.
858
859 4.6 Can you tell me what error code 142 means?
860
861 All curl error codes are described at the end of the man page, in the
862 section called "EXIT CODES".
863
864 Error codes that are larger than the highest documented error code means
865 that curl has exited due to a crash. This is a serious error, and we
866 appreciate a detailed bug report from you that describes how we could go
867 ahead and repeat this.
868
869 4.7 How do I keep user names and passwords secret in curl command lines?
870
871 This problem has two sides:
872
873 The first part is to avoid having clear-text passwords in the command line
874 so that they do not appear in 'ps' outputs and similar. That is easily
875 avoided by using the "-K" option to tell curl to read parameters from a file
876 or stdin to which you can pass the secret info. curl itself will also
877 attempt to "hide" the given password by blanking out the option - this
878 does not work on all platforms.
879
880 To keep the passwords in your account secret from the rest of the world is
881 not a task that curl addresses. You could of course encrypt them somehow to
882 at least hide them from being read by human eyes, but that is not what
883 anyone would call security.
884
885 Also note that regular HTTP (using Basic authentication) and FTP passwords
886 are sent as cleartext across the network. All it takes for anyone to fetch
887 them is to listen on the network. Eavesdropping is easy. Use more secure
888 authentication methods (like Digest, Negotiate or even NTLM) or consider the
889 SSL-based alternatives HTTPS and FTPS.
890
891 4.8 I found a bug
892
893 It is not a bug if the behavior is documented. Read the docs first.
894 Especially check out the KNOWN_BUGS file, it may be a documented bug.
895
896 If it is a problem with a binary you have downloaded or a package for your
897 particular platform, try contacting the person who built the package/archive
898 you have.
899
900 If there is a bug, read the BUGS document first. Then report it as described
901 in there.
902
903 4.9 curl cannot authenticate to a server that requires NTLM?
904
905 NTLM support requires OpenSSL, GnuTLS, mbedTLS, NSS, Secure Transport, or
906 Microsoft Windows libraries at build-time to provide this functionality.
907
908 4.10 My HTTP request using HEAD, PUT or DELETE does not work
909
910 Many web servers allow or demand that the administrator configures the
911 server properly for these requests to work on the web server.
912
913 Some servers seem to support HEAD only on certain kinds of URLs.
914
915 To fully grasp this, try the documentation for the particular server
916 software you are trying to interact with. This is not anything curl can do
917 anything about.
918
919 4.11 Why do my HTTP range requests return the full document?
920
921 Because the range may not be supported by the server, or the server may
922 choose to ignore it and return the full document anyway.
923
924 4.12 Why do I get "certificate verify failed" ?
925
926 When you invoke curl and get an error 60 error back it means that curl
927 could not verify that the server's certificate was good. curl verifies the
928 certificate using the CA cert bundle and verifying for which names the
929 certificate has been granted.
930
931 To completely disable the certificate verification, use -k. This does
932 however enable man-in-the-middle attacks and makes the transfer INSECURE.
933 We strongly advise against doing this for more than experiments.
934
935 If you get this failure with a CA cert bundle installed and used, the
936 server's certificate might not be signed by one of the CA's in your CA
937 store. It might for example be self-signed. You then correct this problem by
938 obtaining a valid CA cert for the server. Or again, decrease the security by
939 disabling this check.
940
941 At times, you find that the verification works in your favorite browser but
942 fails in curl. When this happens, the reason is usually that the server
943 sends an incomplete cert chain. The server is mandated to send all
944 "intermediate certificates" but does not. This typically works with browsers
945 anyway since they A) cache such certs and B) supports AIA which downloads
946 such missing certificates on demand. This is a server misconfiguration. A
947 good way to figure out if this is the case it to use the SSL Labs server
948 test and check the certificate chain: https://www.ssllabs.com/ssltest/
949
950 Details are also in the SSLCERTS.md document, found online here:
951 https://curl.se/docs/sslcerts.html
952
953 4.13 Why is curl -R on Windows one hour off?
954
955 Since curl 7.53.0 this issue should be fixed as long as curl was built with
956 any modern compiler that allows for a 64-bit curl_off_t type. For older
957 compilers or prior curl versions it may set a time that appears one hour off.
958 This happens due to a flaw in how Windows stores and uses file modification
959 times and it is not easily worked around. For more details read this:
960 https://www.codeproject.com/Articles/1144/Beating-the-Daylight-Savings-Time-bug-and-getting
961
962 4.14 Redirects work in browser but not with curl
963
964 curl supports HTTP redirects well (see item 3.8). Browsers generally support
965 at least two other ways to perform redirects that curl does not:
966
967 Meta tags. You can write an HTML tag that will cause the browser to redirect
968 to another given URL after a certain time.
969
970 JavaScript. You can write a JavaScript program embedded in an HTML page that
971 redirects the browser to another given URL.
972
973 There is no way to make curl follow these redirects. You must either
974 manually figure out what the page is set to do, or write a script that parses
975 the results and fetches the new URL.
976
977 4.15 FTPS does not work
978
979 curl supports FTPS (sometimes known as FTP-SSL) both implicit and explicit
980 mode.
981
982 When a URL is used that starts with FTPS://, curl assumes implicit SSL on
983 the control connection and will therefore immediately connect and try to
984 speak SSL. FTPS:// connections default to port 990.
985
986 To use explicit FTPS, you use an FTP:// URL and the --ftp-ssl option (or one
987 of its related flavors). This is the most common method, and the one
988 mandated by RFC4217. This kind of connection will then of course use the
989 standard FTP port 21 by default.
990
991 4.16 My HTTP POST or PUT requests are slow
992
993 libcurl makes all POST and PUT requests (except for POST requests with a
994 tiny request body) use the "Expect: 100-continue" header. This header
995 allows the server to deny the operation early so that libcurl can bail out
996 before having to send any data. This is useful in authentication
997 cases and others.
998
999 However, many servers do not implement the Expect: stuff properly and if the
1000 server does not respond (positively) within 1 second libcurl will continue
1001 and send off the data anyway.
1002
1003 You can disable libcurl's use of the Expect: header the same way you disable
1004 any header, using -H / CURLOPT_HTTPHEADER, or by forcing it to use HTTP 1.0.
1005
1006 4.17 Non-functional connect timeouts
1007
1008 In most Windows setups having a timeout longer than 21 seconds make no
1009 difference, as it will only send 3 TCP SYN packets and no more. The second
1010 packet sent three seconds after the first and the third six seconds after
1011 the second. No more than three packets are sent, no matter how long the
1012 timeout is set.
1013
1014 See option TcpMaxConnectRetransmissions on this page:
1015 https://support.microsoft.com/en-us/kb/175523/en-us
1016
1017 Also, even on non-Windows systems there may run a firewall or anti-virus
1018 software or similar that accepts the connection but does not actually do
1019 anything else. This will make (lib)curl to consider the connection connected
1020 and thus the connect timeout will not trigger.
1021
1022 4.18 file:// URLs containing drive letters (Windows, NetWare)
1023
1024 When using curl to try to download a local file, one might use a URL
1025 in this format:
1026
1027 file://D:/blah.txt
1028
1029 you will find that even if D:\blah.txt does exist, curl returns a 'file
1030 not found' error.
1031
1032 According to RFC 1738 (https://www.ietf.org/rfc/rfc1738.txt),
1033 file:// URLs must contain a host component, but it is ignored by
1034 most implementations. In the above example, 'D:' is treated as the
1035 host component, and is taken away. Thus, curl tries to open '/blah.txt'.
1036 If your system is installed to drive C:, that will resolve to 'C:\blah.txt',
1037 and if that does not exist you will get the not found error.
1038
1039 To fix this problem, use file:// URLs with *three* leading slashes:
1040
1041 file:///D:/blah.txt
1042
1043 Alternatively, if it makes more sense, specify 'localhost' as the host
1044 component:
1045
1046 file://localhost/D:/blah.txt
1047
1048 In either case, curl should now be looking for the correct file.
1049
1050 4.19 Why does not curl return an error when the network cable is unplugged?
1051
1052 Unplugging a cable is not an error situation. The TCP/IP protocol stack
1053 was designed to be fault tolerant, so even though there may be a physical
1054 break somewhere the connection should not be affected, just possibly
1055 delayed. Eventually, the physical break will be fixed or the data will be
1056 re-routed around the physical problem through another path.
1057
1058 In such cases, the TCP/IP stack is responsible for detecting when the
1059 network connection is irrevocably lost. Since with some protocols it is
1060 perfectly legal for the client to wait indefinitely for data, the stack may
1061 never report a problem, and even when it does, it can take up to 20 minutes
1062 for it to detect an issue. The curl option --keepalive-time enables
1063 keep-alive support in the TCP/IP stack which makes it periodically probe the
1064 connection to make sure it is still available to send data. That should
1065 reliably detect any TCP/IP network failure.
1066
1067 TCP keep alive will not detect the network going down before the TCP/IP
1068 connection is established (e.g. during a DNS lookup) or using protocols that
1069 do not use TCP. To handle those situations, curl offers a number of timeouts
1070 on its own. --speed-limit/--speed-time will abort if the data transfer rate
1071 falls too low, and --connect-timeout and --max-time can be used to put an
1072 overall timeout on the connection phase or the entire transfer.
1073
1074 A libcurl-using application running in a known physical environment (e.g.
1075 an embedded device with only a single network connection) may want to act
1076 immediately if its lone network connection goes down. That can be achieved
1077 by having the application monitor the network connection on its own using an
1078 OS-specific mechanism, then signaling libcurl to abort (see also item 5.13).
1079
1080 4.20 curl does not return error for HTTP non-200 responses
1081
1082 Correct. Unless you use -f (--fail).
1083
1084 When doing HTTP transfers, curl will perform exactly what you are asking it
1085 to do and if successful it will not return an error. You can use curl to
1086 test your web server's "file not found" page (that gets 404 back), you can
1087 use it to check your authentication protected web pages (that gets a 401
1088 back) and so on.
1089
1090 The specific HTTP response code does not constitute a problem or error for
1091 curl. It simply sends and delivers HTTP as you asked and if that worked,
1092 everything is fine and dandy. The response code is generally providing more
1093 higher level error information that curl does not care about. The error was
1094 not in the HTTP transfer.
1095
1096 If you want your command line to treat error codes in the 400 and up range
1097 as errors and thus return a non-zero value and possibly show an error
1098 message, curl has a dedicated option for that: -f (CURLOPT_FAILONERROR in
1099 libcurl speak).
1100
1101 You can also use the -w option and the variable %{response_code} to extract
1102 the exact response code that was returned in the response.
1103
11045. libcurl Issues
1105
1106 5.1 Is libcurl thread-safe?
1107
1108 Yes.
1109
1110 We have written the libcurl code specifically adjusted for multi-threaded
1111 programs. libcurl will use thread-safe functions instead of non-safe ones if
1112 your system has such. Note that you must never share the same handle in
1113 multiple threads.
1114
1115 There may be some exceptions to thread safety depending on how libcurl was
1116 built. Please review the guidelines for thread safety to learn more:
1117 https://curl.se/libcurl/c/threadsafe.html
1118
1119 5.2 How can I receive all data into a large memory chunk?
1120
1121 [ See also the examples/getinmemory.c source ]
1122
1123 You are in full control of the callback function that gets called every time
1124 there is data received from the remote server. You can make that callback do
1125 whatever you want. You do not have to write the received data to a file.
1126
1127 One solution to this problem could be to have a pointer to a struct that you
1128 pass to the callback function. You set the pointer using the
1129 CURLOPT_WRITEDATA option. Then that pointer will be passed to the callback
1130 instead of a FILE * to a file:
1131
1132 /* imaginary struct */
1133 struct MemoryStruct {
1134 char *memory;
1135 size_t size;
1136 };
1137
1138 /* imaginary callback function */
1139 size_t
1140 WriteMemoryCallback(void *ptr, size_t size, size_t nmemb, void *data)
1141 {
1142 size_t realsize = size * nmemb;
1143 struct MemoryStruct *mem = (struct MemoryStruct *)data;
1144
1145 mem->memory = (char *)realloc(mem->memory, mem->size + realsize + 1);
1146 if (mem->memory) {
1147 memcpy(&(mem->memory[mem->size]), ptr, realsize);
1148 mem->size += realsize;
1149 mem->memory[mem->size] = 0;
1150 }
1151 return realsize;
1152 }
1153
1154 5.3 How do I fetch multiple files with libcurl?
1155
1156 libcurl has excellent support for transferring multiple files. You should
1157 just repeatedly set new URLs with curl_easy_setopt() and then transfer it
1158 with curl_easy_perform(). The handle you get from curl_easy_init() is not
1159 only reusable, but you are even encouraged to reuse it if you can, as that
1160 will enable libcurl to use persistent connections.
1161
1162 5.4 Does libcurl do Winsock initialization on win32 systems?
1163
1164 Yes, if told to in the curl_global_init() call.
1165
1166 5.5 Does CURLOPT_WRITEDATA and CURLOPT_READDATA work on win32 ?
1167
1168 Yes, but you cannot open a FILE * and pass the pointer to a DLL and have
1169 that DLL use the FILE * (as the DLL and the client application cannot access
1170 each others' variable memory areas). If you set CURLOPT_WRITEDATA you must
1171 also use CURLOPT_WRITEFUNCTION as well to set a function that writes the
1172 file, even if that simply writes the data to the specified FILE *.
1173 Similarly, if you use CURLOPT_READDATA you must also specify
1174 CURLOPT_READFUNCTION.
1175
1176 5.6 What about Keep-Alive or persistent connections?
1177
1178 curl and libcurl have excellent support for persistent connections when
1179 transferring several files from the same server. curl will attempt to reuse
1180 connections for all URLs specified on the same command line/config file, and
1181 libcurl will reuse connections for all transfers that are made using the
1182 same libcurl handle.
1183
1184 When you use the easy interface the connection cache is kept within the easy
1185 handle. If you instead use the multi interface, the connection cache will be
1186 kept within the multi handle and will be shared among all the easy handles
1187 that are used within the same multi handle.
1188
1189 5.7 Link errors when building libcurl on Windows
1190
1191 You need to make sure that your project, and all the libraries (both static
1192 and dynamic) that it links against, are compiled/linked against the same run
1193 time library.
1194
1195 This is determined by the /MD, /ML, /MT (and their corresponding /M?d)
1196 options to the command line compiler. /MD (linking against MSVCRT dll) seems
1197 to be the most commonly used option.
1198
1199 When building an application that uses the static libcurl library, you must
1200 add -DCURL_STATICLIB to your CFLAGS. Otherwise the linker will look for
1201 dynamic import symbols. If you are using Visual Studio, you need to instead
1202 add CURL_STATICLIB in the "Preprocessor Definitions" section.
1203
1204 If you get a linker error like "unknown symbol __imp__curl_easy_init ..." you
1205 have linked against the wrong (static) library. If you want to use the
1206 libcurl.dll and import lib, you do not need any extra CFLAGS, but use one of
1207 the import libraries below. These are the libraries produced by the various
1208 lib/Makefile.* files:
1209
1210 Target: static lib. import lib for libcurl*.dll.
1211 -----------------------------------------------------------
1212 MinGW: libcurl.a libcurldll.a
1213 MSVC (release): libcurl.lib libcurl_imp.lib
1214 MSVC (debug): libcurld.lib libcurld_imp.lib
1215 Borland: libcurl.lib libcurl_imp.lib
1216
1217 5.8 libcurl.so.X: open failed: No such file or directory
1218
1219 This is an error message you might get when you try to run a program linked
1220 with a shared version of libcurl and your runtime linker (ld.so) could not
1221 find the shared library named libcurl.so.X. (Where X is the number of the
1222 current libcurl ABI, typically 3 or 4).
1223
1224 You need to make sure that ld.so finds libcurl.so.X. You can do that
1225 multiple ways, and it differs somewhat between different operating systems.
1226 They are usually:
1227
1228 * Add an option to the linker command line that specify the hard-coded path
1229 the runtime linker should check for the lib (usually -R)
1230
1231 * Set an environment variable (LD_LIBRARY_PATH for example) where ld.so
1232 should check for libs
1233
1234 * Adjust the system's config to check for libs in the directory where you have
1235 put the library (like Linux's /etc/ld.so.conf)
1236
1237 'man ld.so' and 'man ld' will tell you more details
1238
1239 5.9 How does libcurl resolve host names?
1240
1241 libcurl supports a large number of name resolve functions. One of them is
1242 picked at build-time and will be used unconditionally. Thus, if you want to
1243 change name resolver function you must rebuild libcurl and tell it to use a
1244 different function.
1245
1246 - The non-IPv6 resolver that can use one of four different host name resolve
1247 calls (depending on what your system supports):
1248
1249 A - gethostbyname()
1250 B - gethostbyname_r() with 3 arguments
1251 C - gethostbyname_r() with 5 arguments
1252 D - gethostbyname_r() with 6 arguments
1253
1254 - The IPv6-resolver that uses getaddrinfo()
1255
1256 - The c-ares based name resolver that uses the c-ares library for resolves.
1257 Using this offers asynchronous name resolves.
1258
1259 - The threaded resolver (default option on Windows). It uses:
1260
1261 A - gethostbyname() on plain IPv4 hosts
1262 B - getaddrinfo() on IPv6 enabled hosts
1263
1264 Also note that libcurl never resolves or reverse-lookups addresses given as
1265 pure numbers, such as 127.0.0.1 or ::1.
1266
1267 5.10 How do I prevent libcurl from writing the response to stdout?
1268
1269 libcurl provides a default built-in write function that writes received data
1270 to stdout. Set the CURLOPT_WRITEFUNCTION to receive the data, or possibly
1271 set CURLOPT_WRITEDATA to a different FILE * handle.
1272
1273 5.11 How do I make libcurl not receive the whole HTTP response?
1274
1275 You make the write callback (or progress callback) return an error and
1276 libcurl will then abort the transfer.
1277
1278 5.12 Can I make libcurl fake or hide my real IP address?
1279
1280 No. libcurl operates on a higher level. Besides, faking IP address would
1281 imply sending IP packets with a made-up source address, and then you normally
1282 get a problem with receiving the packet sent back as they would then not be
1283 routed to you.
1284
1285 If you use a proxy to access remote sites, the sites will not see your local
1286 IP address but instead the address of the proxy.
1287
1288 Also note that on many networks NATs or other IP-munging techniques are used
1289 that makes you see and use a different IP address locally than what the
1290 remote server will see you coming from. You may also consider using
1291 https://www.torproject.org/ .
1292
1293 5.13 How do I stop an ongoing transfer?
1294
1295 With the easy interface you make sure to return the correct error code from
1296 one of the callbacks, but none of them are instant. There is no function you
1297 can call from another thread or similar that will stop it immediately.
1298 Instead, you need to make sure that one of the callbacks you use returns an
1299 appropriate value that will stop the transfer. Suitable callbacks that you
1300 can do this with include the progress callback, the read callback and the
1301 write callback.
1302
1303 If you are using the multi interface, you can also stop a transfer by
1304 removing the particular easy handle from the multi stack at any moment you
1305 think the transfer is done or when you wish to abort the transfer.
1306
1307 5.14 Using C++ non-static functions for callbacks?
1308
1309 libcurl is a C library, it does not know anything about C++ member functions.
1310
1311 You can overcome this "limitation" with relative ease using a static
1312 member function that is passed a pointer to the class:
1313
1314 // f is the pointer to your object.
1315 static size_t YourClass::func(void *buffer, size_t sz, size_t n, void *f)
1316 {
1317 // Call non-static member function.
1318 static_cast<YourClass*>(f)->nonStaticFunction();
1319 }
1320
1321 // This is how you pass pointer to the static function:
1322 curl_easy_setopt(hcurl, CURLOPT_WRITEFUNCTION, YourClass::func);
1323 curl_easy_setopt(hcurl, CURLOPT_WRITEDATA, this);
1324
1325 5.15 How do I get an FTP directory listing?
1326
1327 If you end the FTP URL you request with a slash, libcurl will provide you
1328 with a directory listing of that given directory. You can also set
1329 CURLOPT_CUSTOMREQUEST to alter what exact listing command libcurl would use
1330 to list the files.
1331
1332 The follow-up question tends to be how is a program supposed to parse the
1333 directory listing. How does it know what's a file and what's a directory and
1334 what's a symlink etc. If the FTP server supports the MLSD command then it
1335 will return data in a machine-readable format that can be parsed for type.
1336 The types are specified by RFC3659 section 7.5.1. If MLSD is not supported
1337 then you have to work with what you are given. The LIST output format is
1338 entirely at the server's own liking and the NLST output does not reveal any
1339 types and in many cases does not even include all the directory entries.
1340 Also, both LIST and NLST tend to hide unix-style hidden files (those that
1341 start with a dot) by default so you need to do "LIST -a" or similar to see
1342 them.
1343
1344 Example - List only directories.
1345 ftp.funet.fi supports MLSD and ftp.kernel.org does not:
1346
1347 curl -s ftp.funet.fi/pub/ -X MLSD | \
1348 perl -lne 'print if s/(?:^|;)type=dir;[^ ]+ (.+)$/$1/'
1349
1350 curl -s ftp.kernel.org/pub/linux/kernel/ | \
1351 perl -lne 'print if s/^d[-rwx]{9}(?: +[^ ]+){7} (.+)$/$1/'
1352
1353 If you need to parse LIST output in libcurl one such existing
1354 list parser is available at https://cr.yp.to/ftpparse.html Versions of
1355 libcurl since 7.21.0 also provide the ability to specify a wildcard to
1356 download multiple files from one FTP directory.
1357
1358 5.16 I want a different time-out
1359
1360 Sometimes users realize that CURLOPT_TIMEOUT and CURLOPT_CONNECTIMEOUT are
1361 not sufficiently advanced or flexible to cover all the various use cases and
1362 scenarios applications end up with.
1363
1364 libcurl offers many more ways to time-out operations. A common alternative
1365 is to use the CURLOPT_LOW_SPEED_LIMIT and CURLOPT_LOW_SPEED_TIME options to
1366 specify the lowest possible speed to accept before to consider the transfer
1367 timed out.
1368
1369 The most flexible way is by writing your own time-out logic and using
1370 CURLOPT_XFERINFOFUNCTION (perhaps in combination with other callbacks) and
1371 use that to figure out exactly when the right condition is met when the
1372 transfer should get stopped.
1373
1374 5.17 Can I write a server with libcurl?
1375
1376 No. libcurl offers no functions or building blocks to build any kind of
1377 Internet protocol server. libcurl is only a client-side library. For server
1378 libraries, you need to continue your search elsewhere but there exist many
1379 good open source ones out there for most protocols you could want a server
1380 for. There are also really good stand-alone servers that have been tested
1381 and proven for many years. There is no need for you to reinvent them.
1382
1383 5.18 Does libcurl use threads?
1384
1385 Put simply: no, libcurl will execute in the same thread you call it in. All
1386 callbacks will be called in the same thread as the one you call libcurl in.
1387
1388 If you want to avoid your thread to be blocked by the libcurl call, you make
1389 sure you use the non-blocking multi API which will do transfers
1390 asynchronously - still in the same single thread.
1391
1392 libcurl will potentially internally use threads for name resolving, if it
1393 was built to work like that, but in those cases it will create the child
1394 threads by itself and they will only be used and then killed internally by
1395 libcurl and never exposed to the outside.
1396
13976. License Issues
1398
1399 curl and libcurl are released under a MIT/X derivative license. The license
1400 is liberal and should not impose a problem for your project. This section is
1401 just a brief summary for the cases we get the most questions. (Parts of this
1402 section was much enhanced by Bjorn Reese.)
1403
1404 We are not lawyers and this is not legal advice. You should probably consult
1405 one if you want true and accurate legal insights without our prejudice. Note
1406 especially that this section concerns the libcurl license only; compiling in
1407 features of libcurl that depend on other libraries (e.g. OpenSSL) may affect
1408 the licensing obligations of your application.
1409
1410 6.1 I have a GPL program, can I use the libcurl library?
1411
1412 Yes
1413
1414 Since libcurl may be distributed under the MIT/X derivative license, it can
1415 be used together with GPL in any software.
1416
1417 6.2 I have a closed-source program, can I use the libcurl library?
1418
1419 Yes
1420
1421 libcurl does not put any restrictions on the program that uses the library.
1422
1423 6.3 I have a BSD licensed program, can I use the libcurl library?
1424
1425 Yes
1426
1427 libcurl does not put any restrictions on the program that uses the library.
1428
1429 6.4 I have a program that uses LGPL libraries, can I use libcurl?
1430
1431 Yes
1432
1433 The LGPL license does not clash with other licenses.
1434
1435 6.5 Can I modify curl/libcurl for my program and keep the changes secret?
1436
1437 Yes
1438
1439 The MIT/X derivative license practically allows you to do almost anything
1440 with the sources, on the condition that the copyright texts in the sources
1441 are left intact.
1442
1443 6.6 Can you please change the curl/libcurl license to XXXX?
1444
1445 No.
1446
1447 We have carefully picked this license after years of development and
1448 discussions and a large amount of people have contributed with source code
1449 knowing that this is the license we use. This license puts the restrictions
1450 we want on curl/libcurl and it does not spread to other programs or
1451 libraries that use it. It should be possible for everyone to use libcurl or
1452 curl in their projects, no matter what license they already have in use.
1453
1454 6.7 What are my obligations when using libcurl in my commercial apps?
1455
1456 Next to none. All you need to adhere to is the MIT-style license (stated in
1457 the COPYING file) which basically says you have to include the copyright
1458 notice in "all copies" and that you may not use the copyright holder's name
1459 when promoting your software.
1460
1461 You do not have to release any of your source code.
1462
1463 You do not have to reveal or make public any changes to the libcurl source
1464 code.
1465
1466 You do not have to broadcast to the world that you are using libcurl within
1467 your app.
1468
1469 All we ask is that you disclose "the copyright notice and this permission
1470 notice" somewhere. Most probably like in the documentation or in the section
1471 where other third party dependencies already are mentioned and acknowledged.
1472
1473 As can be seen here: https://curl.se/docs/companies.html and elsewhere,
1474 more and more companies are discovering the power of libcurl and take
1475 advantage of it even in commercial environments.
1476
1477
14787. PHP/CURL Issues
1479
1480 7.1 What is PHP/CURL?
1481
1482 The module for PHP that makes it possible for PHP programs to access curl-
1483 functions from within PHP.
1484
1485 In the cURL project we call this module PHP/CURL to differentiate it from
1486 curl the command line tool and libcurl the library. The PHP team however
1487 does not refer to it like this (for unknown reasons). They call it plain
1488 CURL (often using all caps) or sometimes ext/curl, but both cause much
1489 confusion to users which in turn gives us a higher question load.
1490
1491 7.2 Who wrote PHP/CURL?
1492
1493 PHP/CURL was initially written by Sterling Hughes.
1494
1495 7.3 Can I perform multiple requests using the same handle?
1496
1497 Yes - at least in PHP version 4.3.8 and later (this has been known to not
1498 work in earlier versions, but the exact version when it started to work is
1499 unknown to me).
1500
1501 After a transfer, you just set new options in the handle and make another
1502 transfer. This will make libcurl re-use the same connection if it can.
1503
1504 7.4 Does PHP/CURL have dependencies?
1505
1506 PHP/CURL is a module that comes with the regular PHP package. It depends on
1507 and uses libcurl, so you need to have libcurl installed properly before
1508 PHP/CURL can be used.
1509
15108. Development
1511
1512 8.1 Why does curl use C89?
1513
1514 As with everything in curl, there is a history and we keep using what we have
1515 used before until someone brings up the subject and argues for and works on
1516 changing it.
1517
1518 We started out using C89 in the 1990s because that was the only way to write
1519 a truly portable C program and have it run as widely as possible. C89 was for
1520 a long time even necessary to make things work on otherwise considered modern
1521 platforms such as Windows. Today, we do not really know how many users that
1522 still require the use of a C89 compiler.
1523
1524 We will continue to use C89 for as long as nobody brings up a strong enough
1525 reason for us to change our minds. The core developers of the project do not
1526 feel restricted by this and we are not convinced that going C99 will offer us
1527 enough of a benefit to warrant the risk of cutting off a share of users.
1528
1529 8.2 Will curl be rewritten?
1530
1531 In one go: no. Little by little over time? Maybe.
1532
1533 Over the years, new languages and clever operating environments come and go.
1534 Every now and then the urge apparently arises to request that we rewrite curl
1535 in another language.
1536
1537 Some the most important properties in curl are maintaining the API and ABI
1538 for libcurl and keeping the behavior for the command line tool. As long as we
1539 can do that, everything else is up for discussion. To maintain the ABI, we
1540 probably have to maintain a certain amount of code in C, and to remain rock
1541 stable, we will never risk anything by rewriting a lot of things in one go.
1542 That said, we can certainly offer more and more optional backends written in
1543 other languages, as long as those backends can be plugged in at build-time.
1544 Backends can be written in any language, but should probably provide APIs
1545 usable from C to ease integration and transition.