source: networking/netlibs/curl.xml@ 85ab851

trunk
Last change on this file since 85ab851 was 99c90fa, checked in by Douglas R. Reno <renodr@…>, 2 months ago

Lots of tags

  • Property mode set to 100644
File size: 21.0 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY curl-download-http "https://curl.se/download/curl-&curl-version;.tar.xz">
8 <!ENTITY curl-download-ftp " ">
9 <!ENTITY curl-md5sum "8f28f7e08c91cc679a45fccf66184fbc">
10 <!ENTITY curl-size "2.5 MB">
11 <!ENTITY curl-buildsize "42 MB (add 18 MB for tests)">
12 <!ENTITY curl-time "0.2 SBU (with parallelism=4; add 4.1 SBU for tests (without valgrind, add 36 SBU with valgrind))">
13]>
14
15<sect1 id="curl" xreflabel="cURL-&curl-version;">
16 <?dbhtml filename="curl.html"?>
17
18
19 <title>cURL-&curl-version;</title>
20
21 <indexterm zone="curl">
22 <primary sortas="a-cURL">cURL</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to cURL</title>
27
28 <para>
29 The <application>cURL</application> package contains an utility
30 and a library used for transferring files with URL syntax to any of
31 the following protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP,
32 HTTPS, IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTSP, SMB, SMBS,
33 SMTP, SMPTS, TELNET, and TFTP. Its ability to both download
34 and upload files can be incorporated into other programs to support
35 functions like streaming media.
36 </para>
37
38 &lfs121_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&curl-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&curl-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &curl-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &curl-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &curl-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &curl-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73<!--
74 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
75 <itemizedlist spacing="compact">
76 <listitem>
77 <para>
78 Required patch:
79 <ulink url="&patch-root;/curl-&curl-version;-function_naming-1.patch"/>
80 </para>
81 </listitem>
82 </itemizedlist>
83-->
84
85 <bridgehead renderas="sect3">cURL Dependencies</bridgehead>
86
87 <bridgehead renderas="sect4">Recommended</bridgehead>
88 <para role="recommended">
89 <xref linkend="libpsl"/>
90 </para>
91
92 <note>
93 <para>
94 While there is an option to build the package without libpsl, both
95 the upstream developers and the BLFS editors alike highly recommend
96 not disabling support for libpsl due to severe security implications.
97 </para>
98 </note>
99
100 <bridgehead renderas="sect4">Recommended at runtime</bridgehead>
101 <para role="recommended">
102 <xref role="runtime" linkend="make-ca"/>
103 </para>
104
105 <bridgehead renderas="sect4">Optional</bridgehead>
106 <para role="optional">
107 <xref linkend="brotli"/>,
108 <xref linkend="c-ares"/>,
109 <xref linkend="gnutls"/>,
110 <xref linkend="libidn2"/>,
111 <xref linkend="libssh2"/>,
112 <xref linkend="mitkrb"/>,
113 <xref linkend="nghttp2"/>,
114 <xref linkend="openldap"/>,
115 <!-- cURL implements the SMB client with own code. Samba is only
116 used for /usr/bin/ntlm_auth helper. The path is correctly
117 guessed even if Samba is not installed, so "runtime". -->
118 <xref role='runtime' linkend="samba"/>
119 (runtime, for NTLM authentication),
120 <ulink url="https://www.gnu.org/software/gsasl/">gsasl</ulink>,
121 <ulink url="https://www.secureauth.com/labs/open-source-tools/impacket/">impacket</ulink>,
122 <ulink url="https://launchpad.net/libmetalink/">libmetalink</ulink>,
123 <ulink url="https://rtmpdump.mplayerhq.hu/">librtmp</ulink>,
124 <ulink url="https://github.com/ngtcp2/ngtcp2/">ngtcp2</ulink>,
125 <!--<ulink url="https://tls.mbed.org/">mbed TLS</ulink> (formerly known as
126 PolarSSL), and -->
127 <!-- mbedTLS/PolarSSL support was removed in 7.65.1 -->
128 <ulink url="https://github.com/cloudflare/quiche">quiche</ulink>, and
129 <ulink url="https://spnego.sourceforge.net/">SPNEGO</ulink>
130 </para>
131
132 <bridgehead renderas="sect4">Optional if Running the Test Suite</bridgehead>
133 <para role="optional">
134 <!-- stunnel is still listed in the docs as required, but 7.58.0
135 tests completed happily without it, although the test for unit1323
136 reported that the tool set in the test case does not exist - ken -->
137 <xref linkend="apache"/> and
138 <xref linkend="stunnel"/> (for the HTTPS and FTPS tests),
139 <xref linkend="openssh"/>, and
140 <xref linkend="valgrind"/> (this will slow the tests down and may cause failures.)
141 </para>
142
143 </sect2>
144
145 <sect2 role="installation">
146 <title>Installation of cURL</title>
147
148 <para>
149 Install <application>cURL</application> by running the following
150 commands:
151 </para>
152
153<screen><userinput>./configure --prefix=/usr \
154 --disable-static \
155 --with-openssl \
156 --enable-threaded-resolver \
157 --with-ca-path=/etc/ssl/certs &amp;&amp;
158make</userinput></screen>
159
160<!--
161 For version 7.54.1 I got:
162 TESTDONE: 869 tests out of 869 reported OK: 100%
163 TESTDONE: 1092 tests were considered during 1080 seconds
164
165 <para>
166 Running the test suite is optional. About 2% of the tests fail. Increase
167 in test time by each failed test is about 10%. Tests SBU above was
168 obtained disabling failing tests, with:
169 </para>
170
171 2017-10-29 - bdubbs
172 For version 7.56.1 I had a lot of test failures which included long
173 timeouts. Could not determine the cause of the timeouts or failures,
174 but I was missing c-ares, MIT Kerberos, ldap, samba, and the six
175 external packages.
176
177 2017-12-01 - bdubbs
178 Still a lot of test failures. I did have c-ares, Kerberos, and ldap
179 installed this time. Best guess is that servers are not available.
180
181 2018-08-01 - renodr
182 No test failures, but I didn't have any of the optional dependencies except
183 for c-ares and libidn2. I might re-run this test suite before release with
184 all of the optional deps, but right now, it isn't a priority - rather
185 the security fix is.
186-->
187
188 <para>
189 To run the test suite, issue: <command>make test</command>.
190 <!--One test, <filename>1477</filename>, is known to fail due to
191 a missing file in the curl tarball.--> Some tests are flaky,
192 so if some tests have failed it's possible to
193 run a test again with: <command>(cd tests; ./runtests.pl
194 <replaceable>&lt;test ID&gt;</replaceable>)</command> (the ID of
195 failed tests are shown in the <quote><computeroutput>These test cases
196 failed:</computeroutput></quote> message). If you run the tests after
197 the package has been installed, some tests may fail because the man
198 pages were deleted by the 'find' command in the installation instructions
199 below.
200 </para>
201<!-- Two (of 857) tests
202fail for unknown reasons, and all tests fail is valgrind is installed. Moving
203valgrind out of $PATH is recommended if you wish to run the test suite while
204it is installed.
205
206Added by Pierre for curl-7.59.0:
207no stunnel, no valgrind, no options
208Warning: smb server unexpectedly alive
209Warning: dict server unexpectedly alive
210TESTDONE: 950 tests out of 951 reported OK: 99%
211TESTFAIL: These test cases failed: 1148
212TESTDONE: 1189 tests were considered during 362 seconds.
213__________
214
215 if stunnel and valgrind are not installed, and also most options
216 (I had rtmpdump), the tests complete without problems.
217Warning: smb server unexpectedly alive
218Warning: dict server unexpectedly alive
219TESTDONE: 938 tests out of 938 reported OK: 100%
220TESTDONE: 1175 tests were considered during 355 seconds.
221 and no. I don't have smb - so commenting the rest of this:
222 To run the test suite, issue: <command>make test</command>. Many tests
223 may fail that depend on optional dependencies that may not be installed
224 or upstream servers that may not be available, especially for tests
225 numbered 700 and above.
226 Test time may be significantly increase due to hanging tests that fail.
227__________
228Added by Bruce for curl-7.60.0:
229TESTDONE: 957 tests out of 959 reported OK: 99%
230TESTFAIL: These test cases failed: 1139 1140
231TESTDONE: 1196 tests were considered during 1184 seconds.
232From the logs, both appear to be ipv6 releated.
233
234==========
235Added by Douglas for curl-7.61.0:
236TESTDONE: 961 tests out of 961 reported OK: 100%
237TESTDONE: 1202 tests were considered during 338 seconds.
238I only have c-ares and libidn2 installed, I will likely try before release
239with all optional dependencies in the book installed.
240
241=========
2427.61.1 NOTE: The test suite is extremely noisy, complaining about verification errors.
243It's possible this is due to openssl-1.1.1, BUT 79/79 tests report as 100% OK. I had
244c-ares, libpsl, and libidn1/2 installed. - Doug
245
246========
2477.62.0: All tests passed. libpsl, c-ares, libssh2, libidn2 installed.
248All 1098 tests report OK.
249
250=======
251Added by Douglas for curl-7.64.0:
252TESTDONE: 1022 tests out of 1023 reported OK: 99%
253TESTFAIL: These tests cases failed: 323
254TESTDONE: 1235 tests were considered during 1279 seconds.
255For dependencies, I had c-ares, gnutls, libidn2, libpsl, krb5, libssh2, nghttp2,
256OpenLDAP, Samba, stunnel, and Valgrind installed.
257=======
258Added by bdubbs for curl-7.64.1:
259TESTDONE: 1022 tests out of 1025 reported OK: 99%
260TESTFAIL: These test cases failed: 323 1139 1140
261TESTDONE: 1242 tests were considered during 1483 seconds
262
263=======
264Added by renodr for curl-7.65.1:
265TESTDONE: 996 tests out of 997 reported OK: 99%
266TESTFAIL: These test cases failed: 1560
267TESTDONE: 1249 tests were considered during 1091 seconds.
268All dependencies except for externals installed.
269=======
270Added by bdubbs for curl-7.65.2:
271TESTDONE: 1034 tests out of 1036 reported OK: 99%
272TESTFAIL: These test cases failed: 323 1560
273TESTDONE: 1254 tests were considered during 1362 seconds.
274Time above does not include test build time.
275All dependencies except for externals installed.
276=======
277Added by bdubbs for curl-7.65.3:
278TESTDONE: 1031 tests out of 1036 reported OK: 99%
279TESTFAIL: These test cases failed: 323 1139 1140 1173 1560
280TESTDONE: 1254 tests were considered during 1364 seconds.
281
282The tests that fail seem to be somewhat random. What happened between
283yesterday and today that that tests 1139 1140 1173 now fail?
284
285=======
286Added by bdubbs for curl-7.68.0:
287TESTDONE: 1066 tests out of 1071 reported OK: 99%
288TESTFAIL: These test cases failed: 323 1139 1140 1173 1560
289TESTDONE: 1290 tests were considered during 1515 seconds.
290
291=======
292Added by bdubbs for curl-7.69.0:
293TESTDONE: 074 tests out of 1079 reported OK: 99%
294TESTFAIL: These test cases failed: 323 1139 1140 1173 1560
295TESTDONE: 1320 tests were considered during 1514 seconds.
296
297For curl-7.69.1, 1082 tests out of 1086 reported OK. 1560 now passes.
2981330 tests were considered during 1528 seconds.
299
300======
301Added by renodr for curl-7.70.0:
302TESTDONE: 1062 tests out of 1062 reported OK: 100%
303TESTDONE: 1352 tests were considered during 1218 seconds.
304Tests were ran with all dependencies present except for stunnel.
305impacket only seems to add one extra test to the mix as well.
306
307======
308Added by renodr for curl-7.71.0:
309TESTDONE: 1072 tests out of 1072 reported OK: 100%
310TESTDONE: 1364 tests were considered during 1202 seconds.
311Tests were run similarly to 7.70.0 - all deps except for stunnel.
312
313======
314Added by renodr for curl-7.71.1:
315TESTDONE: 1076 tests out of 1076 reported OK: 100%
316TESTDONE: 1368 tests were considered during 1207 seconds.
317Tests were run similarly to 7.71.0, including impacket, but no stunnel.
318
319======
320Added by renodr for curl-7.72.0:
321TESTDONE: 1094 tests out of 1097 reported OK: 99%
322TESTFAIL: These test cases failed: 1700 1701 1702
323TESTDONE: 1374 tests were considered during 1285 seconds.
324Tests have all BLFS dependencies with the exception of stunnel;
325and the optional impacket python module was installed.
326Tests seem to be failing due to a missing 'nghttpx' executable
327used to start a test server.
328
329======
330Added by renodr for curl-7.73.0:
331TESTDONE: 1121 tests out of 1121 reported OK: 100%
332TESTDONE: 1387 tests were considered during 1303 seconds.
333Tests have all BLFS dependencies installed with the exception of stunnel,
334as well as the optional impacket installed.
335
336======
337Added by renodr for curl-7.74.0:
338TESTDONE: 1119 tests out of 1119 reported OK: 100%
339TESTDONE: 1388 tests were considered during 1370 seconds.
340Tests have all BLFS dependencies installed, as well as impacket.
341stunnel not installed.
342
343======
344Added by bdubbs for curl-7.79.0:
345TESTDONE: 1432 tests were considered during 1543 seconds.
346TESTDONE: 1208 tests out of 1212 reported OK: 99%
347
348Tests have all BLFS dependencies installed but without impacket.
349
350======
351Added by plabs for curl-7.79.1:
352TESTDONE: 1434 tests were considered during 1652 seconds.
353TESTDONE: 1171 tests out of 1171 reported OK: 100%
354Tests have all BLFS dependencies installed except stunnel but without impacket.
355====
356bdubbs curl-7.83.0 2022-04-28
357TESTDONE: 1497 tests were considered during 1666 seconds.
358TESTDONE: 1252 tests out of 1256 reported OK: 99%
359TESTFAIL: These test cases failed: 1139 1140 1173 1177
360====
361Added by xry111 for curl-7.85.0 on 2022-09-01:
362With:
363 all BLFS dependencies but stunnel installed
364 libssh2-2.10.0 patched with libssh2-1.10.0-upstream_fix-1.patch
365 with-{gssapi,libssh2} enable-threaded-resolver
366TESTDONE: 1520 tests were considered during 508 seconds.
367TESTDONE: 1327 tests out of 1328 reported OK: 99%
368TESTFAIL: These test cases failed: 1459
369 It is a SCP test for bad .known_hosts file and fails because of a mismatch
370 of error codes, I don't think it indicated a serious issue.
371[renodr] - Test results for 7.85.0 (2022-09-03), no libssh2 enabled or gssapi
372TESTDONE: 1528 tests were considered during 2041 seconds.
373TESTDONE: 1326 tests out of 1326 reported OK: 100%
374
375[renodr] - Test results for 7.87.0 (2022-12-30)
376TESTDONE: 1559 tests were considered during 2112 seconds.
377TESTDONE: 1342 tests out of 1342 reported OK: 100%
378libssh2 installed and enabled
379
380[renodr] - Test results for 8.0.1 (2023-03-27)
381TESTDONE: 1593 tests were considered during 4761 seconds.
382TESTDONE: 1356 tests out of 1356 reported OK: 100%
383All BLFS dependencies installed.
384Note that if I move /usr/bin/valgrind to a place where it can't be found, I get
385TESTDONE: 1593 tests were considered during 595 seconds.
386TESTDONE: 1356 tests out of 1356 reported OK: 100%
387It appears that every test is now run under valgrind.
388
389[renodr] - Test results for 8.2.1 (2023-07-26)
390TESTDONE: 1611 tests were considered during 2129 seconds.
391TESTDONE: 1369 tests out of 1369 reported OK: 100%
392All BLFS dependencies installed, and run under valgrind.
393
394[renodr] - Test results for 8.3.0 (2023-09-14)
395TESTDONE: 1635 tests were considered during 4068 seconds.
396TESTDONE: 1386 tests out of 1387 reported OK: 99%
397TESTFAIL: These test cases failed: 1474
398All BLFS dependencies installed, and run under valgrind. Test 1474 is flaky.
399
400[renodr] - Test results for 8.4.0 (2023-10-11)
401TESTDONE: 1646 tests were considered during 2290 seconds.
402TESTDONE: 1449 tests out of 1452 reported OK: 99%
403TESTFAIL: These test cases failed: 1474 3021 3022
404All BLFS dependencies are installed, and the tests were run with Valgrind
405installed as well. Test 3021 and 3022 fails due to incompatibilities with
406our version of SSH. See https://github.com/curl/curl/issues/12096
407Test 1474 is still flaky.
408
409[bdubbs] - Test results for 8.6.0 (2024-02-01)
410TESTDONE: 1673 tests were considered during 395 seconds.
411TESTDONE: 1355 tests out of 1360 reported OK: 99%
412TESTFAIL: These test cases failed: 1139 1140 1173 1177 1477
413Run without valgrind.
414Tests seem to looking for man pages that are missing.
415- renodr: this is because tests were run after the man pages were deleted by
416 the find command after 'make install'
417-->
418
419 <para>
420 Now, as the <systemitem class="username">root</systemitem>
421 user:
422 </para>
423
424<screen role="root"><userinput>make install &amp;&amp;
425
426rm -rf docs/examples/.deps &amp;&amp;
427
428find docs \( -name Makefile\* -o \
429 -name \*.1 -o \
430 -name \*.3 -o \
431 -name CMakeLists.txt \) -delete &amp;&amp;
432
433cp -v -R docs -T /usr/share/doc/curl-&curl-version;</userinput></screen>
434
435 <para>
436 To run some simple verification tests on the newly installed
437 <command>curl</command>, issue the following commands:
438 <command>curl --trace-ascii debugdump.txt https://www.example.com/</command>
439 and
440 <command>curl --trace-ascii d.txt --trace-time https://example.com/</command>.
441 Inspect the locally created trace files <filename>debugdump.txt</filename>
442 and <filename>d.txt</filename>, which contains version information,
443 downloaded files information, etc. One file has the time for each action logged.
444 </para>
445 </sect2>
446
447 <sect2 role="commands">
448 <title>Command Explanations</title>
449
450 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
451 href="../../xincludes/static-libraries.xml"/>
452
453 <para>
454 <parameter>--enable-threaded-resolver</parameter>: This switch enables
455 <application>cURL</application>'s builtin threaded DNS resolver.
456 </para>
457
458 <para>
459 <parameter>--with-ca-path=/etc/ssl/certs</parameter>: This
460 switch sets the location of the BLFS Certificate Authority store.
461 </para>
462
463 <para>
464 <parameter>--with-openssl</parameter>: This parameter chooses
465 <application>OpenSSL</application> as SSL/TLS implementation.
466 This seems mandatory now.
467 </para>
468
469 <para>
470 <option>--with-gssapi</option>: This parameter adds
471 <application>Kerberos 5</application> support to
472 <filename class="libraryfile">libcurl</filename>.
473 </para>
474
475 <para>
476 <option>--without-ssl --with-gnutls</option>: Use this switch to
477 build with <application>GnuTLS</application> support
478 instead of <application>OpenSSL</application> for SSL/TLS.
479 </para>
480
481 <para>
482 <option>--with-ca-bundle=/etc/pki/tls/certs/ca-bundle.crt</option>: Use
483 this switch instead of <parameter>--with-ca-path</parameter> if
484 building with <application>GnuTLS</application> support
485 instead of <application>OpenSSL</application> for SSL/TLS.
486 </para>
487
488 <para>
489 <option>--with-libssh2</option>: This parameter adds
490 <application>SSH</application> support to cURL. This is disabled
491 by default.
492 </para>
493
494 <para>
495 <option>--enable-ares</option>: This parameter adds
496 support for DNS resolution through the c-ares library. It overrides
497 <parameter>--enable-threaded-resolver</parameter> and is not widely
498 tested by the editors.
499 </para>
500
501 <para>
502 <command>find docs ... -exec rm {} \;</command>: This command removes
503 <filename>Makefiles</filename> and man files from the documentation
504 directory that would otherwise be installed by the commands that follow.
505 </para>
506
507 </sect2>
508
509 <sect2 role="content">
510 <title>Contents</title>
511
512 <segmentedlist>
513 <segtitle>Installed Programs</segtitle>
514 <segtitle>Installed Library</segtitle>
515 <segtitle>Installed Directories</segtitle>
516
517 <seglistitem>
518 <seg>
519 curl and curl-config
520 </seg>
521 <seg>
522 libcurl.so
523 </seg>
524 <seg>
525 /usr/include/curl and
526 /usr/share/doc/curl-&curl-version;
527 </seg>
528 </seglistitem>
529 </segmentedlist>
530
531 <variablelist>
532 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
533 <?dbfo list-presentation="list"?>
534 <?dbhtml list-presentation="table"?>
535
536 <varlistentry id="curl-prog">
537 <term><command>curl</command></term>
538 <listitem>
539 <para>
540 is a command line tool for transferring files with URL syntax
541 </para>
542 <indexterm zone="curl curl-prog">
543 <primary sortas="b-curl">curl</primary>
544 </indexterm>
545 </listitem>
546 </varlistentry>
547
548 <varlistentry id="curl-config">
549 <term><command>curl-config</command></term>
550 <listitem>
551 <para>
552 prints information about the last compile, like libraries
553 linked to and prefix setting
554 </para>
555 <indexterm zone="curl curl-config">
556 <primary sortas="b-curl-config">curl-config</primary>
557 </indexterm>
558 </listitem>
559 </varlistentry>
560
561 <varlistentry id="libcurl">
562 <term><filename class="libraryfile">libcurl.so</filename></term>
563 <listitem>
564 <para>
565 provides the API functions required by
566 <command>curl</command> and other programs
567 </para>
568 <indexterm zone="curl libcurl">
569 <primary sortas="c-libcurl">libcurl.so</primary>
570 </indexterm>
571 </listitem>
572 </varlistentry>
573
574 </variablelist>
575
576 </sect2>
577
578</sect1>
Note: See TracBrowser for help on using the repository browser.