browser/external/curl-8.3.0/docs/libcurl/curl_version_info.3

.\" **************************************************************************
.\" *                                  _   _ ____  _
.\" *  Project                     ___| | | |  _ \| |
.\" *                             / __| | | | |_) | |
.\" *                            | (__| |_| |  _ <| |___
.\" *                             \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
.\" * are also available at https://curl.se/docs/copyright.html.
.\" *
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
.\" * copies of the Software, and permit persons to whom the Software is
.\" * furnished to do so, under the terms of the COPYING file.
.\" *
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
.\" * KIND, either express or implied.
.\" *
.\" * SPDX-License-Identifier: curl
.\" *
.\" **************************************************************************
.\"
.TH curl_version_info 3 "August 22, 2023" "libcurl 8.3.0" "libcurl"

.SH NAME
curl_version_info - returns runtime libcurl version info
.SH SYNOPSIS
.nf
#include <curl/curl.h>

curl_version_info_data *curl_version_info(CURLversion age);
.fi
.SH DESCRIPTION
Returns a pointer to a filled in static struct with information about various
features in the running version of libcurl. \fIage\fP should be set to the
version of this functionality by the time you write your program. This way,
libcurl always returns a proper struct that your program understands, while
programs in the future might get a different struct. \fBCURLVERSION_NOW\fP is
the most recent one for the library you have installed:
.nf
  data = curl_version_info(CURLVERSION_NOW);
.fi
Applications should use this information to judge if things are possible to do
or not, instead of using compile-time checks, as dynamic/DLL libraries can be
changed independent of applications.

This function can alter the returned static data as long as
\fIcurl_global_init\fP has not been called. It is therefore not thread-safe
before libcurl initialization occurs.

The curl_version_info_data struct looks like this

.nf
typedef struct {
  CURLversion age;          /* see description below */

  const char *version;      /* human readable string */
  unsigned int version_num; /* numeric representation */
  const char *host;         /* human readable string */
  int features;             /* bitmask, see below */
  char *ssl_version;        /* human readable string */
  long ssl_version_num;     /* not used, always zero */
  const char *libz_version; /* human readable string */
  const char *const *protocols; /* protocols */

  /* when 'age' is CURLVERSION_SECOND or higher, the members below exist */
  const char *ares;         /* human readable string */
  int ares_num;             /* number */

  /* when 'age' is CURLVERSION_THIRD or higher, the members below exist */
  const char *libidn;       /* human readable string */

  /* when 'age' is CURLVERSION_FOURTH or higher (>= 7.16.1), the members
     below exist */
  int iconv_ver_num;       /* '_libiconv_version' if iconv support enabled */

  const char *libssh_version; /* human readable string */

  /* when 'age' is CURLVERSION_FIFTH or higher (>= 7.57.0), the members
     below exist */
  unsigned int brotli_ver_num; /* Numeric Brotli version
                                  (MAJOR << 24) | (MINOR << 12) | PATCH */
  const char *brotli_version; /* human readable string. */

  /* when 'age' is CURLVERSION_SIXTH or higher (>= 7.66.0), the members
     below exist */
  unsigned int nghttp2_ver_num; /* Numeric nghttp2 version
                                   (MAJOR << 16) | (MINOR << 8) | PATCH */
  const char *nghttp2_version; /* human readable string. */

  const char *quic_version;    /* human readable quic (+ HTTP/3) library +
                                  version or NULL */

  /* when 'age' is CURLVERSION_SEVENTH or higher (>= 7.70.0), the members
     below exist */
  const char *cainfo;          /* the built-in default CURLOPT_CAINFO, might
                                  be NULL */
  const char *capath;          /* the built-in default CURLOPT_CAPATH, might
                                  be NULL */
  /* when 'age' is CURLVERSION_EIGHTH or higher (>= 7.71.0), the members
     below exist */
  unsigned int zstd_ver_num; /* Numeric Zstd version
                                  (MAJOR << 24) | (MINOR << 12) | PATCH */
  const char *zstd_version; /* human readable string. */
  /* when 'age' is CURLVERSION_NINTH or higher (>= 7.75.0), the members
     below exist */
  const char *hyper_version; /* human readable string. */
  /* 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

\fIage\fP describes what the age of this struct is. The number depends on how
new the libcurl you are using is. You are however guaranteed to get a struct
that you have a matching struct for in the header, as you tell libcurl your
"age" with the input argument.

\fIversion\fP is just an ascii string for the libcurl version.

\fIversion_num\fP is a 24 bit number created like this: <8 bits major number>
| <8 bits minor number> | <8 bits patch number>. Version 7.9.8 is therefore
returned as 0x070908.

\fIhost\fP is an ascii string showing what host information that this libcurl
was built for. As discovered by a configure script or set by the build
environment.

\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 """alt-svc"""
\fIfeatures\fP mask bit: CURL_VERSION_ALTSVC
.br
HTTP Alt-Svc parsing and the associated options (Added in 7.64.1)
.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 """brotli"""
\fIfeatures\fP mask bit: CURL_VERSION_BROTLI
.br
supports HTTP Brotli content encoding using libbrotlidec (Added in 7.57.0)
.IP """Debug"""
\fIfeatures\fP mask bit: CURL_VERSION_DEBUG
.br
libcurl was built with debug capabilities (added in 7.10.6)
.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 """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 """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 """HTTP2"""
\fIfeatures\fP mask bit: CURL_VERSION_HTTP2
.br
libcurl was built with support for HTTP2.
(Added in 7.33.0)
.IP """HTTP3"""
\fIfeatures\fP mask bit: CURL_VERSION_HTTP3
.br
HTTP/3 and QUIC support are built-in (Added in 7.66.0)
.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 """IPv6"""
\fIfeatures\fP mask bit: CURL_VERSION_IPV6
.br
supports IPv6
.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 """Largefile"""
\fIfeatures\fP mask bit: CURL_VERSION_LARGEFILE
.br
libcurl was built with support for large files. (Added in 7.11.1)
.IP """libz"""
\fIfeatures\fP mask bit: CURL_VERSION_LIBZ
.br
supports HTTP deflate using libz (Added in 7.10)
.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 """NTLM"""
\fIfeatures\fP mask bit: CURL_VERSION_NTLM
.br
supports HTTP NTLM (added in 7.10.6)
.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 """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 """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 """SSL"""
\fIfeatures\fP mask bit: CURL_VERSION_SSL
.br
supports SSL (HTTPS/FTPS) (Added in 7.10)
.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 """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 """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 """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".

\fIssl_version_num\fP is always 0.

\fIlibz_version\fP is an ASCII string (there is no numerical version). If
libcurl has no libz support, this is NULL.

\fIprotocols\fP is a pointer to an array of char * pointers, containing the
names protocols that libcurl supports (using lowercase letters). The protocol
names are the same as would be used in URLs. The array is terminated by a NULL
entry.
.SH EXAMPLE
.nf
curl_version_info_data *ver = curl_version_info(CURLVERSION_NOW);
printf("libcurl version %u.%u.%u\\n",
       (ver->version_num >> 16) & 0xff,
       (ver->version_num >> 8) & 0xff,
       ver->version_num & 0xff);
.fi
.SH AVAILABILITY
Added in 7.10
.SH RETURN VALUE
A pointer to a curl_version_info_data struct.
.SH "SEE ALSO"
\fIcurl_version(3)\fP