source: networking/netlibs/curl.xml@ 50ceb065

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

Promote libpsl to recommended in wget, curl, and NetworkManager.

This is to protect against the "global cookie" issue outlined in
https://daniel.haxx.se/blog/2024/01/10/psl-in-curl/

After some discussion we've decided to promote these to recommended, and
in cURL I've added a note that while the package can technically be
built without psl support, it's not recommended due to the security
implications.

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