mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-01-30 14:22:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

version: add a feature names array to curl_version_info_data

Browse Source 
Field feature_names contains a null-terminated sorted array of feature
names. Bitmask field features is deprecated.

Documentation is updated. Test 1177 and tests/version-scan.pl updated to
match new documentation format and extended to check feature names too.

Closes #9583
This commit is contained in:
Patrick Monnerat 2022-11-09 00:27:32 +01:00 committed by Daniel Stenberg
parent 00ea0aaf46
commit e780aae77a
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
6 changed files with 307 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

160
docs/libcurl/curl_version_info.3
View File

@ -106,6 +106,9 @@ typedef struct {
/* when 'age' is CURLVERSION_TENTH or higher (>= 7.77.0), the members
below exist */
const char *gsasl_version; /* human readable string. */
/* when 'age' is CURLVERSION_ELEVENTH or higher (>= 7.87.0), the members
below exist */
const char *const *feature_names; /* Feature names. */
} curl_version_info_data;
.fi
@ -124,98 +127,167 @@ returned as 0x070908.
was built for. As discovered by a configure script or set by the build
environment.
\fIfeatures\fP can have none, one or more bits set, and the currently defined
bits are:
\fIfeatures\fP is a bit mask representing available features. It can
have none, one or more bits set.
The use of this field is deprecated: use \fIfeature_names\fP instead.
The feature names description below lists the associated bits.
\fIfeature_names\fP is a pointer to an array of string pointers, containing the
names of the features that libcurl supports. The array is terminated by a NULL
entry. Currently defined names are:
.RS
.IP CURL_VERSION_ALTSVC
.IP """alt-svc"""
\fIfeatures\fP mask bit: CURL_VERSION_ALTSVC
.br
HTTP Alt-Svc parsing and the associated options (Added in 7.64.1)
.IP CURL_VERSION_ASYNCHDNS
.IP """AsynchDNS"""
\fIfeatures\fP mask bit: CURL_VERSION_ASYNCHDNS
.br
libcurl was built with support for asynchronous name lookups, which allows
more exact timeouts (even on Windows) and less blocking when using the multi
interface. (added in 7.10.7)
.IP CURL_VERSION_BROTLI
.IP """brotli"""
\fIfeatures\fP mask bit: CURL_VERSION_BROTLI
.br
supports HTTP Brotli content encoding using libbrotlidec (Added in 7.57.0)
.IP CURL_VERSION_ZSTD
supports HTTP zstd content encoding using zstd library (Added in 7.72.0)
.IP CURL_VERSION_CONV
libcurl was built with support for character conversions, as provided by the
CURLOPT_CONV_* callbacks. (Added in 7.15.4)
.IP CURL_VERSION_CURLDEBUG
libcurl was built with memory tracking debug capabilities. This is mainly of
interest for libcurl hackers. (added in 7.19.6)
.IP CURL_VERSION_DEBUG
.IP """Debug"""
\fIfeatures\fP mask bit: CURL_VERSION_DEBUG
.br
libcurl was built with debug capabilities (added in 7.10.6)
.IP CURL_VERSION_GSASL
.IP """gsasl"""
\fIfeatures\fP mask bit: CURL_VERSION_GSASL
.br
libcurl was built with libgsasl and thus with some extra SCRAM-SHA
authentication methods. (added in 7.76.0)
.IP CURL_VERSION_GSSAPI
.IP """GSS-API"""
\fIfeatures\fP mask bit: CURL_VERSION_GSSAPI
.br
libcurl was built with support for GSS-API. This makes libcurl use provided
functions for Kerberos and SPNEGO authentication. It also allows libcurl
to use the current user credentials without the app having to pass them on.
(Added in 7.38.0)
.IP CURL_VERSION_GSSNEGOTIATE
supports HTTP GSS-Negotiate (added in 7.10.6)
.IP CURL_VERSION_HSTS
.IP """HSTS"""
\fIfeatures\fP mask bit: CURL_VERSION_HSTS
.br
libcurl was built with support for HSTS (HTTP Strict Transport Security)
(Added in 7.74.0)
.IP CURL_VERSION_HTTPS_PROXY
libcurl was built with support for HTTPS-proxy.
(Added in 7.52.0)
.IP CURL_VERSION_HTTP2
.IP """HTTP2"""
\fIfeatures\fP mask bit: CURL_VERSION_HTTP2
.br
libcurl was built with support for HTTP2.
(Added in 7.33.0)
.IP CURL_VERSION_HTTP3
.IP """HTTP3"""
\fIfeatures\fP mask bit: CURL_VERSION_HTTP3
.br
HTTP/3 and QUIC support are built-in (Added in 7.66.0)
.IP CURL_VERSION_IDN
.IP """HTTPS-proxy"""
\fIfeatures\fP mask bit: CURL_VERSION_HTTPS_PROXY
.br
libcurl was built with support for HTTPS-proxy.
(Added in 7.52.0)
.IP """IDN"""
\fIfeatures\fP mask bit: CURL_VERSION_IDN
.br
libcurl was built with support for IDNA, domain names with international
letters. (Added in 7.12.0)
.IP CURL_VERSION_IPV6
.IP """IPv6"""
\fIfeatures\fP mask bit: CURL_VERSION_IPV6
.br
supports IPv6
.IP CURL_VERSION_KERBEROS4
supports Kerberos V4 (when using FTP). Legacy bit. Deprecated since 7.33.0.
.IP CURL_VERSION_KERBEROS5
.IP """Kerberos"""
\fIfeatures\fP mask bit: CURL_VERSION_KERBEROS5
.br
supports Kerberos V5 authentication for FTP, IMAP, LDAP, POP3, SMTP and
SOCKSv5 proxy. (Added in 7.40.0)
.IP CURL_VERSION_LARGEFILE
.IP """Largefile"""
\fIfeatures\fP mask bit: CURL_VERSION_LARGEFILE
.br
libcurl was built with support for large files. (Added in 7.11.1)
.IP CURL_VERSION_UNICODE
libcurl was built with Unicode support on Windows. This makes non-ASCII
characters work in filenames and options passed to libcurl. (Added in 7.72.0)
.IP CURL_VERSION_LIBZ
.IP """libz"""
\fIfeatures\fP mask bit: CURL_VERSION_LIBZ
.br
supports HTTP deflate using libz (Added in 7.10)
.IP CURL_VERSION_MULTI_SSL
.IP """MultiSSL"""
\fIfeatures\fP mask bit: CURL_VERSION_MULTI_SSL
.br
libcurl was built with multiple SSL backends. For details, see
\fIcurl_global_sslset(3)\fP.
(Added in 7.56.0)
.IP CURL_VERSION_NTLM
.IP """NTLM"""
\fIfeatures\fP mask bit: CURL_VERSION_NTLM
.br
supports HTTP NTLM (added in 7.10.6)
.IP CURL_VERSION_NTLM_WB
.IP """NTLM_WB"""
\fIfeatures\fP mask bit: CURL_VERSION_NTLM_WB
.br
libcurl was built with support for NTLM delegation to a winbind helper.
(Added in 7.22.0)
.IP CURL_VERSION_PSL
.IP """PSL"""
\fIfeatures\fP mask bit: CURL_VERSION_PSL
.br
libcurl was built with support for Mozilla's Public Suffix List. This makes
libcurl ignore cookies with a domain that is on the list.
(Added in 7.47.0)
.IP CURL_VERSION_SPNEGO
.IP """SPNEGO"""
\fIfeatures\fP mask bit: CURL_VERSION_SPNEGO
.br
libcurl was built with support for SPNEGO authentication (Simple and Protected
GSS-API Negotiation Mechanism, defined in RFC 2478.) (added in 7.10.8)
.IP CURL_VERSION_SSL
.IP """SSL"""
\fIfeatures\fP mask bit: CURL_VERSION_SSL
.br
supports SSL (HTTPS/FTPS) (Added in 7.10)
.IP CURL_VERSION_SSPI
.IP """SSPI"""
\fIfeatures\fP mask bit: CURL_VERSION_SSPI
.br
libcurl was built with support for SSPI. This is only available on Windows and
makes libcurl use Windows-provided functions for Kerberos, NTLM, SPNEGO and
Digest authentication. It also allows libcurl to use the current user
credentials without the app having to pass them on. (Added in 7.13.2)
.IP CURL_VERSION_THREADSAFE
.IP """threadsafe"""
\fIfeatures\fP mask bit: CURL_VERSION_THREADSAFE
.br
libcurl was built with thread-safety support (Atomic or SRWLOCK) to protect
curl initialization. (Added in 7.84.0) See \fIlibcurl-thread(3)\fP
.IP CURL_VERSION_TLSAUTH_SRP
.IP """TLS-SRP"""
\fIfeatures\fP mask bit: CURL_VERSION_TLSAUTH_SRP
.br
libcurl was built with support for TLS-SRP (in one or more of the built-in TLS
backends). (Added in 7.21.4)
.IP CURL_VERSION_UNIX_SOCKETS
.IP """TrackMemory"""
\fIfeatures\fP mask bit: CURL_VERSION_CURLDEBUG
.br
libcurl was built with memory tracking debug capabilities. This is mainly of
interest for libcurl hackers. (added in 7.19.6)
.IP """Unicode"""
\fIfeatures\fP mask bit: CURL_VERSION_UNICODE
.br
libcurl was built with Unicode support on Windows. This makes non-ASCII
characters work in filenames and options passed to libcurl. (Added in 7.72.0)
.IP """UnixSockets"""
\fIfeatures\fP mask bit: CURL_VERSION_UNIX_SOCKETS
.br
libcurl was built with support for Unix domain sockets.
(Added in 7.40.0)
.IP """zstd"""
\fIfeatures\fP mask bit: CURL_VERSION_ZSTD
.br
supports HTTP zstd content encoding using zstd library (Added in 7.72.0)
.IP none
\fIfeatures\fP mask bit: CURL_VERSION_CONV
.br
libcurl was built with support for character conversions, as provided by the
CURLOPT_CONV_* callbacks. Always 0 since 7.82.0. (Added in 7.15.4)
.IP none
\fIfeatures\fP mask bit: CURL_VERSION_GSSNEGOTIATE
.br
supports HTTP GSS-Negotiate (added in 7.10.6, deprecated in 7.38.0)
.IP none
\fIfeatures\fP mask bit: CURL_VERSION_KERBEROS4
.br
supports Kerberos V4 (when using FTP). Legacy bit. Deprecated since 7.33.0.
.RE
\fIssl_version\fP is an ASCII string for the TLS library name + version
used. If libcurl has no SSL support, this is NULL. For example "Schannel",
\&"Secure Transport" or "OpenSSL/1.1.0g".

1
docs/libcurl/symbols-in-versions
View File

@ -1099,6 +1099,7 @@ CURLUSESSL_CONTROL 7.17.0
CURLUSESSL_NONE 7.17.0
CURLUSESSL_TRY 7.17.0
CURLVERSION_EIGHTH 7.72.0
CURLVERSION_ELEVENTH 7.87.0
CURLVERSION_FIFTH 7.57.0
CURLVERSION_FIRST 7.10
CURLVERSION_FOURTH 7.16.1

7
include/curl/curl.h
View File

@ -2952,6 +2952,7 @@ typedef enum {
CURLVERSION_EIGHTH,
CURLVERSION_NINTH,
CURLVERSION_TENTH,
CURLVERSION_ELEVENTH,
CURLVERSION_LAST /* never actually use this */
} CURLversion;
@ -2960,7 +2961,7 @@ typedef enum {
meant to be a built-in version number for what kind of struct the caller
expects. If the struct ever changes, we redefine the NOW to another enum
from above. */
#define CURLVERSION_NOW CURLVERSION_TENTH
#define CURLVERSION_NOW CURLVERSION_ELEVENTH
struct curl_version_info_data {
CURLversion age; /* age of the returned struct */
@ -3016,6 +3017,10 @@ struct curl_version_info_data {
/* These fields were added in CURLVERSION_TENTH */
const char *gsasl_version; /* human readable string. */
/* These fields were added in CURLVERSION_ELEVENTH */
/* feature_names is terminated by an entry with a NULL feature name */
const char * const *feature_names;
};
typedef struct curl_version_info_data curl_version_info_data;

249
lib/version.c
View File

@ -382,93 +382,145 @@ static const char * const protocols[] = {
NULL
};
/*
* Feature presence run-time check functions.
*
* Warning: the value returned by these should not change between
* curl_global_init() and curl_global_cleanup() calls.
*/
#if defined(USE_LIBIDN2)
static int idn_present(curl_version_info_data *info)
{
return info->libidn != NULL;
}
#else
#define idn_present NULL
#endif
#if defined(USE_SSL) && !defined(CURL_DISABLE_PROXY)
static int https_proxy_present(curl_version_info_data *info)
{
(void) info;
return Curl_ssl_supports(NULL, SSLSUPP_HTTPS_PROXY);
}
#endif
/*
* Features table.
*
* Keep the features alphabetically sorted.
* Use FEATURE() macro to define an entry: this allows documentation check.
*/
#define FEATURE(name, present, bitmask) {(name), (present), (bitmask)}
struct feat {
const char *name;
int (*present)(curl_version_info_data *info);
int bitmask;
};
static const struct feat features_table[] = {
#ifndef CURL_DISABLE_ALTSVC
FEATURE("alt-svc", NULL, CURL_VERSION_ALTSVC),
#endif
#ifdef CURLRES_ASYNCH
FEATURE("AsynchDNS", NULL, CURL_VERSION_ASYNCHDNS),
#endif
#ifdef HAVE_BROTLI
FEATURE("brotli", NULL, CURL_VERSION_BROTLI),
#endif
#ifdef DEBUGBUILD
FEATURE("Debug", NULL, CURL_VERSION_DEBUG),
#endif
#ifdef USE_GSASL
FEATURE("gsasl", NULL, CURL_VERSION_GSASL),
#endif
#ifdef HAVE_GSSAPI
FEATURE("GSS-API", NULL, CURL_VERSION_GSSAPI),
#endif
#ifndef CURL_DISABLE_HSTS
FEATURE("HSTS", NULL, CURL_VERSION_HSTS),
#endif
#if defined(USE_NGHTTP2) || defined(USE_HYPER)
FEATURE("HTTP2", NULL, CURL_VERSION_HTTP2),
#endif
#if defined(ENABLE_QUIC)
FEATURE("HTTP3", NULL, CURL_VERSION_HTTP3),
#endif
#if defined(USE_SSL) && !defined(CURL_DISABLE_PROXY)
FEATURE("HTTPS-proxy", https_proxy_present, CURL_VERSION_HTTPS_PROXY),
#endif
#if defined(USE_LIBIDN2) || defined(USE_WIN32_IDN)
FEATURE("IDN", idn_present, CURL_VERSION_IDN),
#endif
#ifdef ENABLE_IPV6
FEATURE("IPv6", NULL, CURL_VERSION_IPV6),
#endif
#ifdef USE_KERBEROS5
FEATURE("Kerberos", NULL, CURL_VERSION_KERBEROS5),
#endif
#if (SIZEOF_CURL_OFF_T > 4) && \
( (SIZEOF_OFF_T > 4) || defined(USE_WIN32_LARGE_FILES) )
FEATURE("Largefile", NULL, CURL_VERSION_LARGEFILE),
#endif
#ifdef HAVE_LIBZ
FEATURE("libz", NULL, CURL_VERSION_LIBZ),
#endif
#ifdef CURL_WITH_MULTI_SSL
FEATURE("MultiSSL", NULL, CURL_VERSION_MULTI_SSL),
#endif
#ifdef USE_NTLM
FEATURE("NTLM", NULL, CURL_VERSION_NTLM),
#endif
#if !defined(CURL_DISABLE_HTTP) && defined(USE_NTLM) && \
defined(NTLM_WB_ENABLED)
FEATURE("NTLM_WB", NULL, CURL_VERSION_NTLM_WB),
#endif
#if defined(USE_LIBPSL)
FEATURE("PSL", NULL, CURL_VERSION_PSL),
#endif
#ifdef USE_SPNEGO
FEATURE("SPNEGO", NULL, CURL_VERSION_SPNEGO),
#endif
#ifdef USE_SSL
FEATURE("SSL", NULL, CURL_VERSION_SSL),
#endif
#ifdef USE_WINDOWS_SSPI
FEATURE("SSPI", NULL, CURL_VERSION_SSPI),
#endif
#ifdef GLOBAL_INIT_IS_THREADSAFE
FEATURE("threadsafe", NULL, CURL_VERSION_THREADSAFE),
#endif
#ifdef USE_TLS_SRP
FEATURE("TLS-SRP", NULL, CURL_VERSION_TLSAUTH_SRP),
#endif
#ifdef CURLDEBUG
FEATURE("TrackMemory", NULL, CURL_VERSION_CURLDEBUG),
#endif
#if defined(WIN32) && defined(UNICODE) && defined(_UNICODE)
FEATURE("Unicode", NULL, CURL_VERSION_UNICODE),
#endif
#ifdef USE_UNIX_SOCKETS
FEATURE("UnixSockets", NULL, CURL_VERSION_UNIX_SOCKETS),
#endif
#ifdef HAVE_ZSTD
FEATURE("zstd", NULL, CURL_VERSION_ZSTD),
#endif
{NULL, NULL, 0}
};
static const char *feature_names[sizeof(features_table) /
sizeof(features_table[0])] = {NULL};
static curl_version_info_data version_info = {
CURLVERSION_NOW,
LIBCURL_VERSION,
LIBCURL_VERSION_NUM,
OS, /* as found by configure or set by hand at build-time */
0 /* features is 0 by default */
#ifdef ENABLE_IPV6
| CURL_VERSION_IPV6
#endif
#ifdef USE_SSL
| CURL_VERSION_SSL
#endif
#ifdef USE_NTLM
| CURL_VERSION_NTLM
#endif
#if !defined(CURL_DISABLE_HTTP) && defined(USE_NTLM) && \
defined(NTLM_WB_ENABLED)
| CURL_VERSION_NTLM_WB
#endif
#ifdef USE_SPNEGO
| CURL_VERSION_SPNEGO
#endif
#ifdef USE_KERBEROS5
| CURL_VERSION_KERBEROS5
#endif
#ifdef HAVE_GSSAPI
| CURL_VERSION_GSSAPI
#endif
#ifdef USE_WINDOWS_SSPI
| CURL_VERSION_SSPI
#endif
#ifdef HAVE_LIBZ
| CURL_VERSION_LIBZ
#endif
#ifdef DEBUGBUILD
| CURL_VERSION_DEBUG
#endif
#ifdef CURLDEBUG
| CURL_VERSION_CURLDEBUG
#endif
#ifdef CURLRES_ASYNCH
| CURL_VERSION_ASYNCHDNS
#endif
#if (SIZEOF_CURL_OFF_T > 4) && \
( (SIZEOF_OFF_T > 4) || defined(USE_WIN32_LARGE_FILES) )
| CURL_VERSION_LARGEFILE
#endif
#if defined(WIN32) && defined(UNICODE) && defined(_UNICODE)
| CURL_VERSION_UNICODE
#endif
#if defined(USE_TLS_SRP)
| CURL_VERSION_TLSAUTH_SRP
#endif
#if defined(USE_NGHTTP2) || defined(USE_HYPER)
| CURL_VERSION_HTTP2
#endif
#if defined(ENABLE_QUIC)
| CURL_VERSION_HTTP3
#endif
#if defined(USE_UNIX_SOCKETS)
| CURL_VERSION_UNIX_SOCKETS
#endif
#if defined(USE_LIBPSL)
| CURL_VERSION_PSL
#endif
#if defined(CURL_WITH_MULTI_SSL)
| CURL_VERSION_MULTI_SSL
#endif
#if defined(HAVE_BROTLI)
| CURL_VERSION_BROTLI
#endif
#if defined(HAVE_ZSTD)
| CURL_VERSION_ZSTD
#endif
#ifndef CURL_DISABLE_ALTSVC
| CURL_VERSION_ALTSVC
#endif
#ifndef CURL_DISABLE_HSTS
| CURL_VERSION_HSTS
#endif
#if defined(USE_GSASL)
| CURL_VERSION_GSASL
#endif
#if defined(GLOBAL_INIT_IS_THREADSAFE)
| CURL_VERSION_THREADSAFE
#endif
,
OS, /* as found by configure or set by hand at build-time */
0, /* features bitmask is built at run-time */
NULL, /* ssl_version */
0, /* ssl_version_num, this is kept at zero */
NULL, /* zlib_version */
@ -496,11 +548,16 @@ static curl_version_info_data version_info = {
0, /* zstd_ver_num */
NULL, /* zstd version */
NULL, /* Hyper version */
NULL /* gsasl version */
NULL, /* gsasl version */
feature_names
};
curl_version_info_data *curl_version_info(CURLversion stamp)
{
size_t n;
const struct feat *p;
int features = 0;
#if defined(USE_SSH)
static char ssh_buffer[80];
#endif
@ -518,15 +575,11 @@ curl_version_info_data *curl_version_info(CURLversion stamp)
static char zstd_buffer[80];
#endif
(void)stamp; /* avoid compiler warnings, we don't use this */
#ifdef USE_SSL
Curl_ssl_version(ssl_buffer, sizeof(ssl_buffer));
version_info.ssl_version = ssl_buffer;
#ifndef CURL_DISABLE_PROXY
if(Curl_ssl_supports(NULL, SSLSUPP_HTTPS_PROXY))
version_info.features |= CURL_VERSION_HTTPS_PROXY;
else
version_info.features &= ~CURL_VERSION_HTTPS_PROXY;
#endif
#endif
#ifdef HAVE_LIBZ
@ -544,10 +597,6 @@ curl_version_info_data *curl_version_info(CURLversion stamp)
/* This returns a version string if we use the given version or later,
otherwise it returns NULL */
version_info.libidn = idn2_check_version(IDN2_VERSION);
if(version_info.libidn)
version_info.features |= CURL_VERSION_IDN;
#elif defined(USE_WIN32_IDN)
version_info.features |= CURL_VERSION_IDN;
#endif
#if defined(USE_SSH)
@ -597,6 +646,16 @@ curl_version_info_data *curl_version_info(CURLversion stamp)
}
#endif
(void)stamp; /* avoid compiler warnings, we don't use this */
/* Get available features, build bitmask and names array. */
n = 0;
for(p = features_table; p->name; p++)
if(!p->present || p->present(&version_info)) {
features |= p->bitmask;
feature_names[n++] = p->name;
}
feature_names[n] = NULL; /* Terminate array. */
version_info.features = features;
return &version_info;
}

4
tests/data/test1177
View File

@ -14,11 +14,11 @@ none
</server>
<name>
Verify that CURL_VERSION_* in headers and docs are in sync
Verify that feature names and CURL_VERSION_* in lib and docs are in sync
</name>
<command type="perl">
%SRCDIR/version-scan.pl %SRCDIR/../docs/libcurl/curl_version_info.3 %SRCDIR/../include/curl/curl.h
%SRCDIR/version-scan.pl %SRCDIR/../docs/libcurl/curl_version_info.3 %SRCDIR/../include/curl/curl.h %SRCDIR/../lib/version.c
</command>
</client>

30
tests/version-scan.pl
View File

@ -32,15 +32,21 @@ use warnings;
my $manpage=$ARGV[0];
my $header=$ARGV[1];
my $source=$ARGV[2];
my %manversion;
my %headerversion;
my $error;
my %manname;
my %sourcename;
my $error=0;
open(M, "<$manpage");
while(<M>) {
if($_ =~ /^.ip (CURL_VERSION_[A-Z0-9_]+)/i) {
if($_ =~ / mask bit: (CURL_VERSION_[A-Z0-9_]+)/i) {
$manversion{$1}++;
}
if($_ =~ /^\.ip """([^"]+)"""/i) {
$manname{$1}++;
}
}
close(M);
@ -52,6 +58,14 @@ while(<H>) {
}
close(H);
open(S, "<$source");
while(<S>) {
if($_ =~ /FEATURE\("([^"]*)"/) {
$sourcename{$1}++;
}
}
close(S);
for my $h (keys %headerversion) {
if(!$manversion{$h}) {
print STDERR "$manpage: missing $h\n";
@ -64,5 +78,17 @@ for my $h (keys %manversion) {
$error++;
}
}
for my $n (keys %sourcename) {
if(!$manname{$n}) {
print STDERR "$manpage: missing feature name $n\n";
$error++;
}
}
for my $n (keys %manname) {
if(!$sourcename{$n}) {
print STDERR "$manpage: $n is not in the source!\n";
$error++;
}
}
exit $error;