source: networking/netlibs/curl.xml@ 3b3b59f

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 3b3b59f was 3b3b59f, checked in by Douglas R. Reno <renodr@…>, 8 months ago

Update to curl-8.3.0

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