source: networking/netlibs/curl.xml@ 51347047

12.1 ken/TL2024 lazarus rahul/power-profiles-daemon trunk xry111/llvm18
Last change on this file since 51347047 was afb30af9, checked in by Douglas R. Reno <renodr@…>, 5 months ago

curl: Make libpsl required and document that the test suite fails if you
run it after the package has been installed.

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