source: networking/netlibs/curl.xml@ 5251d104

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 5251d104 was 4f59c449, checked in by Douglas R. Reno <renodr@…>, 8 months ago

Update to curl-8.4.0 (Security Update)

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