Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2026-11-03 10:19:47

0001 #ifndef CURLINC_CURL_H
0002 #define CURLINC_CURL_H
0003 /***************************************************************************
0004  *                                  _   _ ____  _
0005  *  Project                     ___| | | |  _ \| |
0006  *                             / __| | | | |_) | |
0007  *                            | (__| |_| |  _ <| |___
0008  *                             \___|\___/|_| \_\_____|
0009  *
0010  * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
0011  *
0012  * This software is licensed as described in the file COPYING, which
0013  * you should have received as part of this distribution. The terms
0014  * are also available at https://curl.se/docs/copyright.html.
0015  *
0016  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
0017  * copies of the Software, and permit persons to whom the Software is
0018  * furnished to do so, under the terms of the COPYING file.
0019  *
0020  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
0021  * KIND, either express or implied.
0022  *
0023  * SPDX-License-Identifier: curl
0024  *
0025  ***************************************************************************/
0026 
0027 /*
0028  * If you have libcurl problems, all docs and details are found here:
0029  *   https://curl.se/libcurl/
0030  */
0031 
0032 #ifdef CURL_NO_OLDIES
0033 #define CURL_STRICTER /* not used since 8.11.0 */
0034 #endif
0035 
0036 /* Compile-time deprecation macros. */
0037 #if (defined(__GNUC__) &&                                              \
0038   ((__GNUC__ > 12) || ((__GNUC__ == 12) && (__GNUC_MINOR__ >= 1))) ||  \
0039   (defined(__clang__) && __clang_major__ >= 3) ||                      \
0040   defined(__IAR_SYSTEMS_ICC__)) &&                                     \
0041   !defined(__INTEL_COMPILER) &&                                        \
0042   !defined(CURL_DISABLE_DEPRECATION) && !defined(BUILDING_LIBCURL)
0043 #define CURL_DEPRECATED(version, message)                       \
0044   __attribute__((deprecated("since " # version ". " message)))
0045 #ifdef __IAR_SYSTEMS_ICC__
0046 #define CURL_IGNORE_DEPRECATION(statements) \
0047       _Pragma("diag_suppress=Pe1444") \
0048       statements \
0049       _Pragma("diag_default=Pe1444")
0050 #else
0051 #define CURL_IGNORE_DEPRECATION(statements) \
0052       _Pragma("GCC diagnostic push") \
0053       _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") \
0054       statements \
0055       _Pragma("GCC diagnostic pop")
0056 #endif
0057 #else
0058 #define CURL_DEPRECATED(version, message)
0059 #define CURL_IGNORE_DEPRECATION(statements)     statements
0060 #endif
0061 
0062 #include "curlver.h"         /* libcurl version defines */
0063 #include "system.h"          /* determine things runtime */
0064 
0065 #include <stdio.h>
0066 #include <limits.h>
0067 
0068 #if defined(__FreeBSD__) || defined(__MidnightBSD__)
0069 /* Needed for __FreeBSD_version or __MidnightBSD_version symbol definition */
0070 #include <sys/param.h>
0071 #endif
0072 
0073 /* The include stuff here below is mainly for time_t! */
0074 #include <sys/types.h>
0075 #include <time.h>
0076 
0077 #if defined(_WIN32) && !defined(_WIN32_WCE) && !defined(__CYGWIN__)
0078 #if !(defined(_WINSOCKAPI_) || defined(_WINSOCK_H) || \
0079       defined(__LWIP_OPT_H__) || defined(LWIP_HDR_OPT_H))
0080 /* The check above prevents the winsock2.h inclusion if winsock.h already was
0081    included, since they cannot co-exist without problems */
0082 #include <winsock2.h>
0083 #include <ws2tcpip.h>
0084 #endif
0085 #endif
0086 
0087 /* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish
0088    libc5-based Linux systems. Only include it on systems that are known to
0089    require it! */
0090 #if defined(_AIX) || defined(__NOVELL_LIBC__) || defined(__NetBSD__) || \
0091     defined(__minix) || defined(__INTEGRITY) || \
0092     defined(ANDROID) || defined(__ANDROID__) || defined(__OpenBSD__) || \
0093     defined(__CYGWIN__) || defined(AMIGA) || defined(__NuttX__) || \
0094    (defined(__FreeBSD_version) && (__FreeBSD_version < 800000)) || \
0095    (defined(__MidnightBSD_version) && (__MidnightBSD_version < 100000)) || \
0096     defined(__sun__) || defined(__serenity__) || defined(__vxworks__) || \
0097    (defined(__linux__) && defined(_POSIX_C_SOURCE) && \
0098     _POSIX_C_SOURCE >= 200112L)
0099 #include <sys/select.h>
0100 #endif
0101 
0102 #ifndef _WIN32
0103 #include <sys/socket.h>
0104 #include <sys/time.h>
0105 #endif
0106 
0107 #ifdef __cplusplus
0108 extern "C" {
0109 #endif
0110 
0111 typedef void CURL;
0112 typedef void CURLSH;
0113 
0114 /*
0115  * libcurl external API function linkage decorations.
0116  */
0117 
0118 #ifdef __has_declspec_attribute
0119 #define CURL_HAS_DECLSPEC_ATTRIBUTE(x) __has_declspec_attribute(x)
0120 #else
0121 #define CURL_HAS_DECLSPEC_ATTRIBUTE(x) 0
0122 #endif
0123 
0124 #ifdef CURL_STATICLIB
0125 #  define CURL_EXTERN
0126 #elif defined(_WIN32) || \
0127      (CURL_HAS_DECLSPEC_ATTRIBUTE(dllexport) && \
0128       CURL_HAS_DECLSPEC_ATTRIBUTE(dllimport))
0129 #  ifdef BUILDING_LIBCURL
0130 #    define CURL_EXTERN  __declspec(dllexport)
0131 #  else
0132 #    define CURL_EXTERN  __declspec(dllimport)
0133 #  endif
0134 #elif defined(BUILDING_LIBCURL) && defined(CURL_HIDDEN_SYMBOLS)
0135 #  define CURL_EXTERN CURL_EXTERN_SYMBOL
0136 #else
0137 #  define CURL_EXTERN
0138 #endif
0139 
0140 #ifndef curl_socket_typedef
0141 /* socket typedef */
0142 #if defined(_WIN32) && !defined(__LWIP_OPT_H__) && !defined(LWIP_HDR_OPT_H)
0143 typedef SOCKET curl_socket_t;
0144 #define CURL_SOCKET_BAD INVALID_SOCKET
0145 #else
0146 typedef int curl_socket_t;
0147 #define CURL_SOCKET_BAD (-1)
0148 #endif
0149 #define curl_socket_typedef
0150 #endif /* curl_socket_typedef */
0151 
0152 /* enum for the different supported SSL backends */
0153 typedef enum {
0154   CURLSSLBACKEND_NONE = 0,
0155   CURLSSLBACKEND_OPENSSL = 1,
0156   CURLSSLBACKEND_GNUTLS = 2,
0157   CURLSSLBACKEND_NSS                    CURL_DEPRECATED(8.3.0, "") = 3,
0158   CURLSSLBACKEND_OBSOLETE4 = 4,  /* Was QSOSSL. */
0159   CURLSSLBACKEND_GSKIT                  CURL_DEPRECATED(8.3.0, "") = 5,
0160   CURLSSLBACKEND_POLARSSL               CURL_DEPRECATED(7.69.0, "") = 6,
0161   CURLSSLBACKEND_WOLFSSL = 7,
0162   CURLSSLBACKEND_SCHANNEL = 8,
0163   CURLSSLBACKEND_SECURETRANSPORT        CURL_DEPRECATED(8.15.0, "") = 9,
0164   CURLSSLBACKEND_AXTLS                  CURL_DEPRECATED(7.61.0, "") = 10,
0165   CURLSSLBACKEND_MBEDTLS = 11,
0166   CURLSSLBACKEND_MESALINK               CURL_DEPRECATED(7.82.0, "") = 12,
0167   CURLSSLBACKEND_BEARSSL                CURL_DEPRECATED(8.15.0, "") = 13,
0168   CURLSSLBACKEND_RUSTLS = 14
0169 } curl_sslbackend;
0170 
0171 /* aliases for library clones and renames */
0172 #define CURLSSLBACKEND_AWSLC CURLSSLBACKEND_OPENSSL
0173 #define CURLSSLBACKEND_BORINGSSL CURLSSLBACKEND_OPENSSL
0174 #define CURLSSLBACKEND_LIBRESSL CURLSSLBACKEND_OPENSSL
0175 
0176 /* deprecated names: */
0177 #define CURLSSLBACKEND_CYASSL CURLSSLBACKEND_WOLFSSL
0178 #define CURLSSLBACKEND_DARWINSSL CURLSSLBACKEND_SECURETRANSPORT
0179 
0180 /* bits for the CURLOPT_FOLLOWLOCATION option */
0181 #define CURLFOLLOW_ALL       1L /* generic follow redirects */
0182 
0183 /* Do not use the custom method in the follow-up request if the HTTP code
0184    instructs so (301, 302, 303). */
0185 #define CURLFOLLOW_OBEYCODE  2L
0186 
0187 /* Only use the custom method in the first request, always reset in the next */
0188 #define CURLFOLLOW_FIRSTONLY 3L
0189 
0190 struct curl_httppost {
0191   struct curl_httppost *next;       /* next entry in the list */
0192   char *name;                       /* pointer to allocated name */
0193   long namelength;                  /* length of name length */
0194   char *contents;                   /* pointer to allocated data contents */
0195   long contentslength;              /* length of contents field, see also
0196                                        CURL_HTTPPOST_LARGE */
0197   char *buffer;                     /* pointer to allocated buffer contents */
0198   long bufferlength;                /* length of buffer field */
0199   char *contenttype;                /* Content-Type */
0200   struct curl_slist *contentheader; /* list of extra headers for this form */
0201   struct curl_httppost *more;       /* if one field name has more than one
0202                                        file, this link should link to following
0203                                        files */
0204   long flags;                       /* as defined below */
0205 
0206 /* specified content is a filename */
0207 #define CURL_HTTPPOST_FILENAME (1 << 0)
0208 /* specified content is a filename */
0209 #define CURL_HTTPPOST_READFILE (1 << 1)
0210 /* name is only stored pointer do not free in formfree */
0211 #define CURL_HTTPPOST_PTRNAME (1 << 2)
0212 /* contents is only stored pointer do not free in formfree */
0213 #define CURL_HTTPPOST_PTRCONTENTS (1 << 3)
0214 /* upload file from buffer */
0215 #define CURL_HTTPPOST_BUFFER (1 << 4)
0216 /* upload file from pointer contents */
0217 #define CURL_HTTPPOST_PTRBUFFER (1 << 5)
0218 /* upload file contents by using the regular read callback to get the data and
0219    pass the given pointer as custom pointer */
0220 #define CURL_HTTPPOST_CALLBACK (1 << 6)
0221 /* use size in 'contentlen', added in 7.46.0 */
0222 #define CURL_HTTPPOST_LARGE (1 << 7)
0223 
0224   char *showfilename;               /* The filename to show. If not set, the
0225                                        actual filename is used (if this is
0226                                        a file part) */
0227   void *userp;                      /* custom pointer used for
0228                                        HTTPPOST_CALLBACK posts */
0229   curl_off_t contentlen;            /* alternative length of contents
0230                                        field. Used if CURL_HTTPPOST_LARGE is
0231                                        set. Added in 7.46.0 */
0232 };
0233 
0234 /* This is a return code for the progress callback that, when returned,
0235    signals libcurl to continue executing the default progress function */
0236 #define CURL_PROGRESSFUNC_CONTINUE 0x10000001
0237 
0238 /* This is the CURLOPT_PROGRESSFUNCTION callback prototype. It is now
0239    considered deprecated but was the only choice up until 7.31.0 */
0240 typedef int (*curl_progress_callback)(void *clientp,
0241                                       double dltotal,
0242                                       double dlnow,
0243                                       double ultotal,
0244                                       double ulnow);
0245 
0246 /* This is the CURLOPT_XFERINFOFUNCTION callback prototype. It was introduced
0247    in 7.32.0, avoids the use of floating point numbers and provides more
0248    detailed information. */
0249 typedef int (*curl_xferinfo_callback)(void *clientp,
0250                                       curl_off_t dltotal,
0251                                       curl_off_t dlnow,
0252                                       curl_off_t ultotal,
0253                                       curl_off_t ulnow);
0254 
0255 #ifndef CURL_MAX_READ_SIZE
0256   /* The maximum receive buffer size configurable via CURLOPT_BUFFERSIZE. */
0257 #define CURL_MAX_READ_SIZE (10 * 1024 * 1024)
0258 #endif
0259 
0260 #ifndef CURL_MAX_WRITE_SIZE
0261   /* Tests have proven that 20K is a bad buffer size for uploads on Windows,
0262      while 16K for some odd reason performed a lot better. We do the ifndef
0263      check to allow this value to easier be changed at build time for those
0264      who feel adventurous. The practical minimum is about 400 bytes since
0265      libcurl uses a buffer of this size as a scratch area (unrelated to
0266      network send operations). */
0267 #define CURL_MAX_WRITE_SIZE 16384
0268 #endif
0269 
0270 #ifndef CURL_MAX_HTTP_HEADER
0271 /* The only reason to have a max limit for this is to avoid the risk of a bad
0272    server feeding libcurl with a never-ending header that causes reallocs
0273    infinitely */
0274 #define CURL_MAX_HTTP_HEADER (100 * 1024)
0275 #endif
0276 
0277 /* This is a magic return code for the write callback that, when returned,
0278    signals libcurl to pause receiving on the current transfer. */
0279 #define CURL_WRITEFUNC_PAUSE 0x10000001
0280 
0281 /* This is a magic return code for the write callback that, when returned,
0282    signals an error from the callback. */
0283 #define CURL_WRITEFUNC_ERROR 0xFFFFFFFF
0284 
0285 typedef size_t (*curl_write_callback)(char *buffer,
0286                                       size_t size,
0287                                       size_t nitems,
0288                                       void *outstream);
0289 
0290 /* This callback is called when a new resolver request is made */
0291 typedef int (*curl_resolver_start_callback)(void *resolver_state,
0292                                             void *reserved, void *userdata);
0293 
0294 /* enumeration of file types */
0295 typedef enum {
0296   CURLFILETYPE_FILE = 0,
0297   CURLFILETYPE_DIRECTORY,
0298   CURLFILETYPE_SYMLINK,
0299   CURLFILETYPE_DEVICE_BLOCK,
0300   CURLFILETYPE_DEVICE_CHAR,
0301   CURLFILETYPE_NAMEDPIPE,
0302   CURLFILETYPE_SOCKET,
0303   CURLFILETYPE_DOOR, /* is possible only on Sun Solaris now */
0304 
0305   CURLFILETYPE_UNKNOWN /* should never occur */
0306 } curlfiletype;
0307 
0308 #define CURLFINFOFLAG_KNOWN_FILENAME    (1 << 0)
0309 #define CURLFINFOFLAG_KNOWN_FILETYPE    (1 << 1)
0310 #define CURLFINFOFLAG_KNOWN_TIME        (1 << 2)
0311 #define CURLFINFOFLAG_KNOWN_PERM        (1 << 3)
0312 #define CURLFINFOFLAG_KNOWN_UID         (1 << 4)
0313 #define CURLFINFOFLAG_KNOWN_GID         (1 << 5)
0314 #define CURLFINFOFLAG_KNOWN_SIZE        (1 << 6)
0315 #define CURLFINFOFLAG_KNOWN_HLINKCOUNT  (1 << 7)
0316 
0317 /* Information about a single file, used when doing FTP wildcard matching */
0318 struct curl_fileinfo {
0319   char *filename;
0320   curlfiletype filetype;
0321   time_t time; /* always zero! */
0322   unsigned int perm;
0323   int uid;
0324   int gid;
0325   curl_off_t size;
0326   long int hardlinks;
0327 
0328   struct {
0329     /* If some of these fields is not NULL, it is a pointer to b_data. */
0330     char *time;
0331     char *perm;
0332     char *user;
0333     char *group;
0334     char *target; /* pointer to the target filename of a symlink */
0335   } strings;
0336 
0337   unsigned int flags;
0338 
0339   /* These are libcurl private struct fields. Previously used by libcurl, so
0340      they must never be interfered with. */
0341   char *b_data;
0342   size_t b_size;
0343   size_t b_used;
0344 };
0345 
0346 /* return codes for CURLOPT_CHUNK_BGN_FUNCTION */
0347 #define CURL_CHUNK_BGN_FUNC_OK      0
0348 #define CURL_CHUNK_BGN_FUNC_FAIL    1 /* tell the lib to end the task */
0349 #define CURL_CHUNK_BGN_FUNC_SKIP    2 /* skip this chunk over */
0350 
0351 /* if splitting of data transfer is enabled, this callback is called before
0352    download of an individual chunk started. Note that parameter "remains" works
0353    only for FTP wildcard downloading (for now), otherwise is not used */
0354 typedef long (*curl_chunk_bgn_callback)(const void *transfer_info,
0355                                         void *ptr,
0356                                         int remains);
0357 
0358 /* return codes for CURLOPT_CHUNK_END_FUNCTION */
0359 #define CURL_CHUNK_END_FUNC_OK      0
0360 #define CURL_CHUNK_END_FUNC_FAIL    1 /* tell the lib to end the task */
0361 
0362 /* If splitting of data transfer is enabled this callback is called after
0363    download of an individual chunk finished.
0364    Note! After this callback was set then it have to be called FOR ALL chunks.
0365    Even if downloading of this chunk was skipped in CHUNK_BGN_FUNC.
0366    This is the reason why we do not need "transfer_info" parameter in this
0367    callback and we are not interested in "remains" parameter too. */
0368 typedef long (*curl_chunk_end_callback)(void *ptr);
0369 
0370 /* return codes for FNMATCHFUNCTION */
0371 #define CURL_FNMATCHFUNC_MATCH    0 /* string corresponds to the pattern */
0372 #define CURL_FNMATCHFUNC_NOMATCH  1 /* pattern does not match the string */
0373 #define CURL_FNMATCHFUNC_FAIL     2 /* an error occurred */
0374 
0375 /* callback type for wildcard downloading pattern matching. If the
0376    string matches the pattern, return CURL_FNMATCHFUNC_MATCH value, etc. */
0377 typedef int (*curl_fnmatch_callback)(void *ptr,
0378                                      const char *pattern,
0379                                      const char *string);
0380 
0381 /* These are the return codes for the seek callbacks */
0382 #define CURL_SEEKFUNC_OK       0
0383 #define CURL_SEEKFUNC_FAIL     1 /* fail the entire transfer */
0384 #define CURL_SEEKFUNC_CANTSEEK 2 /* tell libcurl seeking cannot be done, so
0385                                     libcurl might try other means instead */
0386 typedef int (*curl_seek_callback)(void *instream,
0387                                   curl_off_t offset,
0388                                   int origin); /* 'whence' */
0389 
0390 /* This is a return code for the read callback that, when returned,
0391    signals libcurl to immediately abort the current transfer. */
0392 #define CURL_READFUNC_ABORT 0x10000000
0393 /* This is a return code for the read callback that, when returned,
0394    signals libcurl to pause sending data on the current transfer. */
0395 #define CURL_READFUNC_PAUSE 0x10000001
0396 
0397 /* Return code for when the trailing headers' callback has terminated
0398    without any errors */
0399 #define CURL_TRAILERFUNC_OK 0
0400 /* Return code for when was an error in the trailing header's list and we
0401   want to abort the request */
0402 #define CURL_TRAILERFUNC_ABORT 1
0403 
0404 typedef size_t (*curl_read_callback)(char *buffer,
0405                                      size_t size,
0406                                      size_t nitems,
0407                                      void *instream);
0408 
0409 typedef int (*curl_trailer_callback)(struct curl_slist **list,
0410                                      void *userdata);
0411 
0412 typedef enum {
0413   CURLSOCKTYPE_IPCXN,  /* socket created for a specific IP connection */
0414   CURLSOCKTYPE_ACCEPT, /* socket created by accept() call */
0415   CURLSOCKTYPE_LAST    /* never use */
0416 } curlsocktype;
0417 
0418 /* The return code from the sockopt_callback can signal information back
0419    to libcurl: */
0420 #define CURL_SOCKOPT_OK 0
0421 #define CURL_SOCKOPT_ERROR 1 /* causes libcurl to abort and return
0422                                 CURLE_ABORTED_BY_CALLBACK */
0423 #define CURL_SOCKOPT_ALREADY_CONNECTED 2
0424 
0425 typedef int (*curl_sockopt_callback)(void *clientp,
0426                                      curl_socket_t curlfd,
0427                                      curlsocktype purpose);
0428 
0429 struct curl_sockaddr {
0430   int family;
0431   int socktype;
0432   int protocol;
0433   unsigned int addrlen; /* addrlen was a socklen_t type before 7.18.0 but it
0434                            turned really ugly and painful on the systems that
0435                            lack this type */
0436   struct sockaddr addr;
0437 };
0438 
0439 typedef curl_socket_t
0440 (*curl_opensocket_callback)(void *clientp,
0441                             curlsocktype purpose,
0442                             struct curl_sockaddr *address);
0443 
0444 typedef int
0445 (*curl_closesocket_callback)(void *clientp, curl_socket_t item);
0446 
0447 typedef enum {
0448   CURLIOE_OK,            /* I/O operation successful */
0449   CURLIOE_UNKNOWNCMD,    /* command was unknown to callback */
0450   CURLIOE_FAILRESTART,   /* failed to restart the read */
0451   CURLIOE_LAST           /* never use */
0452 } curlioerr;
0453 
0454 typedef enum {
0455   CURLIOCMD_NOP,         /* no operation */
0456   CURLIOCMD_RESTARTREAD, /* restart the read stream from start */
0457   CURLIOCMD_LAST         /* never use */
0458 } curliocmd;
0459 
0460 typedef curlioerr (*curl_ioctl_callback)(CURL *handle,
0461                                          int cmd,
0462                                          void *clientp);
0463 
0464 #ifndef CURL_DID_MEMORY_FUNC_TYPEDEFS
0465 /*
0466  * The following typedef's are signatures of malloc, free, realloc, strdup and
0467  * calloc respectively. Function pointers of these types can be passed to the
0468  * curl_global_init_mem() function to set user defined memory management
0469  * callback routines.
0470  */
0471 typedef void *(*curl_malloc_callback)(size_t size);
0472 typedef void (*curl_free_callback)(void *ptr);
0473 typedef void *(*curl_realloc_callback)(void *ptr, size_t size);
0474 typedef char *(*curl_strdup_callback)(const char *str);
0475 typedef void *(*curl_calloc_callback)(size_t nmemb, size_t size);
0476 
0477 #define CURL_DID_MEMORY_FUNC_TYPEDEFS
0478 #endif
0479 
0480 /* the kind of data that is passed to information_callback */
0481 typedef enum {
0482   CURLINFO_TEXT = 0,
0483   CURLINFO_HEADER_IN,    /* 1 */
0484   CURLINFO_HEADER_OUT,   /* 2 */
0485   CURLINFO_DATA_IN,      /* 3 */
0486   CURLINFO_DATA_OUT,     /* 4 */
0487   CURLINFO_SSL_DATA_IN,  /* 5 */
0488   CURLINFO_SSL_DATA_OUT, /* 6 */
0489   CURLINFO_END
0490 } curl_infotype;
0491 
0492 typedef int (*curl_debug_callback)
0493        (CURL *handle,      /* the handle/transfer this concerns */
0494         curl_infotype type, /* what kind of data */
0495         char *data,        /* points to the data */
0496         size_t size,       /* size of the data pointed to */
0497         void *userptr);    /* whatever the user please */
0498 
0499 /* This is the CURLOPT_PREREQFUNCTION callback prototype. */
0500 typedef int (*curl_prereq_callback)(void *clientp,
0501                                     char *conn_primary_ip,
0502                                     char *conn_local_ip,
0503                                     int conn_primary_port,
0504                                     int conn_local_port);
0505 
0506 /* Return code for when the pre-request callback has terminated without
0507    any errors */
0508 #define CURL_PREREQFUNC_OK 0
0509 /* Return code for when the pre-request callback wants to abort the
0510    request */
0511 #define CURL_PREREQFUNC_ABORT 1
0512 
0513 /* All possible error codes from all sorts of curl functions. Future versions
0514    may return other values, stay prepared.
0515 
0516    Always add new return codes last. Never *EVER* remove any. The return
0517    codes must remain the same!
0518  */
0519 
0520 typedef enum {
0521   CURLE_OK = 0,
0522   CURLE_UNSUPPORTED_PROTOCOL,    /* 1 */
0523   CURLE_FAILED_INIT,             /* 2 */
0524   CURLE_URL_MALFORMAT,           /* 3 */
0525   CURLE_NOT_BUILT_IN,            /* 4 - [was obsoleted in August 2007 for
0526                                     7.17.0, reused in April 2011 for 7.21.5] */
0527   CURLE_COULDNT_RESOLVE_PROXY,   /* 5 */
0528   CURLE_COULDNT_RESOLVE_HOST,    /* 6 */
0529   CURLE_COULDNT_CONNECT,         /* 7 */
0530   CURLE_WEIRD_SERVER_REPLY,      /* 8 */
0531   CURLE_REMOTE_ACCESS_DENIED,    /* 9 a service was denied by the server
0532                                     due to lack of access - when login fails
0533                                     this is not returned. */
0534   CURLE_FTP_ACCEPT_FAILED,       /* 10 - [was obsoleted in April 2006 for
0535                                     7.15.4, reused in Dec 2011 for 7.24.0]*/
0536   CURLE_FTP_WEIRD_PASS_REPLY,    /* 11 */
0537   CURLE_FTP_ACCEPT_TIMEOUT,      /* 12 - timeout occurred accepting server
0538                                     [was obsoleted in August 2007 for 7.17.0,
0539                                     reused in Dec 2011 for 7.24.0]*/
0540   CURLE_FTP_WEIRD_PASV_REPLY,    /* 13 */
0541   CURLE_FTP_WEIRD_227_FORMAT,    /* 14 */
0542   CURLE_FTP_CANT_GET_HOST,       /* 15 */
0543   CURLE_HTTP2,                   /* 16 - A problem in the http2 framing layer.
0544                                     [was obsoleted in August 2007 for 7.17.0,
0545                                     reused in July 2014 for 7.38.0] */
0546   CURLE_FTP_COULDNT_SET_TYPE,    /* 17 */
0547   CURLE_PARTIAL_FILE,            /* 18 */
0548   CURLE_FTP_COULDNT_RETR_FILE,   /* 19 */
0549   CURLE_OBSOLETE20,              /* 20 - NOT USED */
0550   CURLE_QUOTE_ERROR,             /* 21 - quote command failure */
0551   CURLE_HTTP_RETURNED_ERROR,     /* 22 */
0552   CURLE_WRITE_ERROR,             /* 23 */
0553   CURLE_OBSOLETE24,              /* 24 - NOT USED */
0554   CURLE_UPLOAD_FAILED,           /* 25 - failed upload "command" */
0555   CURLE_READ_ERROR,              /* 26 - could not open/read from file */
0556   CURLE_OUT_OF_MEMORY,           /* 27 */
0557   CURLE_OPERATION_TIMEDOUT,      /* 28 - the timeout time was reached */
0558   CURLE_OBSOLETE29,              /* 29 - NOT USED */
0559   CURLE_FTP_PORT_FAILED,         /* 30 - FTP PORT operation failed */
0560   CURLE_FTP_COULDNT_USE_REST,    /* 31 - the REST command failed */
0561   CURLE_OBSOLETE32,              /* 32 - NOT USED */
0562   CURLE_RANGE_ERROR,             /* 33 - RANGE "command" did not work */
0563   CURLE_OBSOLETE34,              /* 34 */
0564   CURLE_SSL_CONNECT_ERROR,       /* 35 - wrong when connecting with SSL */
0565   CURLE_BAD_DOWNLOAD_RESUME,     /* 36 - could not resume download */
0566   CURLE_FILE_COULDNT_READ_FILE,  /* 37 */
0567   CURLE_LDAP_CANNOT_BIND,        /* 38 */
0568   CURLE_LDAP_SEARCH_FAILED,      /* 39 */
0569   CURLE_OBSOLETE40,              /* 40 - NOT USED */
0570   CURLE_OBSOLETE41,              /* 41 - NOT USED starting with 7.53.0 */
0571   CURLE_ABORTED_BY_CALLBACK,     /* 42 */
0572   CURLE_BAD_FUNCTION_ARGUMENT,   /* 43 */
0573   CURLE_OBSOLETE44,              /* 44 - NOT USED */
0574   CURLE_INTERFACE_FAILED,        /* 45 - CURLOPT_INTERFACE failed */
0575   CURLE_OBSOLETE46,              /* 46 - NOT USED */
0576   CURLE_TOO_MANY_REDIRECTS,      /* 47 - catch endless re-direct loops */
0577   CURLE_UNKNOWN_OPTION,          /* 48 - User specified an unknown option */
0578   CURLE_SETOPT_OPTION_SYNTAX,    /* 49 - Malformed setopt option */
0579   CURLE_OBSOLETE50,              /* 50 - NOT USED */
0580   CURLE_OBSOLETE51,              /* 51 - NOT USED */
0581   CURLE_GOT_NOTHING,             /* 52 - when this is a specific error */
0582   CURLE_SSL_ENGINE_NOTFOUND,     /* 53 - SSL crypto engine not found */
0583   CURLE_SSL_ENGINE_SETFAILED,    /* 54 - can not set SSL crypto engine as
0584                                     default */
0585   CURLE_SEND_ERROR,              /* 55 - failed sending network data */
0586   CURLE_RECV_ERROR,              /* 56 - failure in receiving network data */
0587   CURLE_OBSOLETE57,              /* 57 - NOT IN USE */
0588   CURLE_SSL_CERTPROBLEM,         /* 58 - problem with the local certificate */
0589   CURLE_SSL_CIPHER,              /* 59 - could not use specified cipher */
0590   CURLE_PEER_FAILED_VERIFICATION, /* 60 - peer's certificate or fingerprint
0591                                      was not verified fine */
0592   CURLE_BAD_CONTENT_ENCODING,    /* 61 - Unrecognized/bad encoding */
0593   CURLE_OBSOLETE62,              /* 62 - NOT IN USE since 7.82.0 */
0594   CURLE_FILESIZE_EXCEEDED,       /* 63 - Maximum file size exceeded */
0595   CURLE_USE_SSL_FAILED,          /* 64 - Requested FTP SSL level failed */
0596   CURLE_SEND_FAIL_REWIND,        /* 65 - Sending the data requires a rewind
0597                                     that failed */
0598   CURLE_SSL_ENGINE_INITFAILED,   /* 66 - failed to initialize ENGINE */
0599   CURLE_LOGIN_DENIED,            /* 67 - user, password or similar was not
0600                                     accepted and we failed to login */
0601   CURLE_TFTP_NOTFOUND,           /* 68 - file not found on server */
0602   CURLE_TFTP_PERM,               /* 69 - permission problem on server */
0603   CURLE_REMOTE_DISK_FULL,        /* 70 - out of disk space on server */
0604   CURLE_TFTP_ILLEGAL,            /* 71 - Illegal TFTP operation */
0605   CURLE_TFTP_UNKNOWNID,          /* 72 - Unknown transfer ID */
0606   CURLE_REMOTE_FILE_EXISTS,      /* 73 - File already exists */
0607   CURLE_TFTP_NOSUCHUSER,         /* 74 - No such user */
0608   CURLE_OBSOLETE75,              /* 75 - NOT IN USE since 7.82.0 */
0609   CURLE_OBSOLETE76,              /* 76 - NOT IN USE since 7.82.0 */
0610   CURLE_SSL_CACERT_BADFILE,      /* 77 - could not load CACERT file, missing
0611                                     or wrong format */
0612   CURLE_REMOTE_FILE_NOT_FOUND,   /* 78 - remote file not found */
0613   CURLE_SSH,                     /* 79 - error from the SSH layer, somewhat
0614                                     generic so the error message is of
0615                                     interest when this has happened */
0616 
0617   CURLE_SSL_SHUTDOWN_FAILED,     /* 80 - Failed to shut down the SSL
0618                                     connection */
0619   CURLE_AGAIN,                   /* 81 - socket is not ready for send/recv,
0620                                     wait till it is ready and try again (Added
0621                                     in 7.18.2) */
0622   CURLE_SSL_CRL_BADFILE,         /* 82 - could not load CRL file, missing or
0623                                     wrong format (Added in 7.19.0) */
0624   CURLE_SSL_ISSUER_ERROR,        /* 83 - Issuer check failed.  (Added in
0625                                     7.19.0) */
0626   CURLE_FTP_PRET_FAILED,         /* 84 - a PRET command failed */
0627   CURLE_RTSP_CSEQ_ERROR,         /* 85 - mismatch of RTSP CSeq numbers */
0628   CURLE_RTSP_SESSION_ERROR,      /* 86 - mismatch of RTSP Session Ids */
0629   CURLE_FTP_BAD_FILE_LIST,       /* 87 - unable to parse FTP file list */
0630   CURLE_CHUNK_FAILED,            /* 88 - chunk callback reported error */
0631   CURLE_NO_CONNECTION_AVAILABLE, /* 89 - No connection available, the
0632                                     session is queued */
0633   CURLE_SSL_PINNEDPUBKEYNOTMATCH, /* 90 - specified pinned public key did not
0634                                      match */
0635   CURLE_SSL_INVALIDCERTSTATUS,   /* 91 - invalid certificate status */
0636   CURLE_HTTP2_STREAM,            /* 92 - stream error in HTTP/2 framing layer
0637                                   */
0638   CURLE_RECURSIVE_API_CALL,      /* 93 - an api function was called from
0639                                     inside a callback */
0640   CURLE_AUTH_ERROR,              /* 94 - an authentication function returned an
0641                                     error */
0642   CURLE_HTTP3,                   /* 95 - An HTTP/3 layer problem */
0643   CURLE_QUIC_CONNECT_ERROR,      /* 96 - QUIC connection error */
0644   CURLE_PROXY,                   /* 97 - proxy handshake error */
0645   CURLE_SSL_CLIENTCERT,          /* 98 - client-side certificate required */
0646   CURLE_UNRECOVERABLE_POLL,      /* 99 - poll/select returned fatal error */
0647   CURLE_TOO_LARGE,               /* 100 - a value/data met its maximum */
0648   CURLE_ECH_REQUIRED,            /* 101 - ECH tried but failed */
0649   CURL_LAST /* never use! */
0650 } CURLcode;
0651 
0652 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all
0653                           the obsolete stuff removed! */
0654 
0655 /* removed in 7.53.0 */
0656 #define CURLE_FUNCTION_NOT_FOUND CURLE_OBSOLETE41
0657 
0658 /* removed in 7.56.0 */
0659 #define CURLE_HTTP_POST_ERROR CURLE_OBSOLETE34
0660 
0661 /* Previously obsolete error code reused in 7.38.0 */
0662 #define CURLE_OBSOLETE16 CURLE_HTTP2
0663 
0664 /* Previously obsolete error codes reused in 7.24.0 */
0665 #define CURLE_OBSOLETE10 CURLE_FTP_ACCEPT_FAILED
0666 #define CURLE_OBSOLETE12 CURLE_FTP_ACCEPT_TIMEOUT
0667 
0668 /*  compatibility with older names */
0669 #define CURLOPT_ENCODING CURLOPT_ACCEPT_ENCODING
0670 #define CURLE_FTP_WEIRD_SERVER_REPLY CURLE_WEIRD_SERVER_REPLY
0671 
0672 /* The following were added in 7.62.0 */
0673 #define CURLE_SSL_CACERT CURLE_PEER_FAILED_VERIFICATION
0674 
0675 /* The following were added in 7.21.5, April 2011 */
0676 #define CURLE_UNKNOWN_TELNET_OPTION CURLE_UNKNOWN_OPTION
0677 
0678 /* Added for 7.78.0 */
0679 #define CURLE_TELNET_OPTION_SYNTAX CURLE_SETOPT_OPTION_SYNTAX
0680 
0681 /* The following were added in 7.17.1 */
0682 /* These are scheduled to disappear by 2009 */
0683 #define CURLE_SSL_PEER_CERTIFICATE CURLE_PEER_FAILED_VERIFICATION
0684 
0685 /* The following were added in 7.17.0 */
0686 /* These are scheduled to disappear by 2009 */
0687 #define CURLE_OBSOLETE CURLE_OBSOLETE50 /* no one should be using this! */
0688 #define CURLE_BAD_PASSWORD_ENTERED CURLE_OBSOLETE46
0689 #define CURLE_BAD_CALLING_ORDER CURLE_OBSOLETE44
0690 #define CURLE_FTP_USER_PASSWORD_INCORRECT CURLE_OBSOLETE10
0691 #define CURLE_FTP_CANT_RECONNECT CURLE_OBSOLETE16
0692 #define CURLE_FTP_COULDNT_GET_SIZE CURLE_OBSOLETE32
0693 #define CURLE_FTP_COULDNT_SET_ASCII CURLE_OBSOLETE29
0694 #define CURLE_FTP_WEIRD_USER_REPLY CURLE_OBSOLETE12
0695 #define CURLE_FTP_WRITE_ERROR CURLE_OBSOLETE20
0696 #define CURLE_LIBRARY_NOT_FOUND CURLE_OBSOLETE40
0697 #define CURLE_MALFORMAT_USER CURLE_OBSOLETE24
0698 #define CURLE_SHARE_IN_USE CURLE_OBSOLETE57
0699 #define CURLE_URL_MALFORMAT_USER CURLE_NOT_BUILT_IN
0700 
0701 #define CURLE_FTP_ACCESS_DENIED CURLE_REMOTE_ACCESS_DENIED
0702 #define CURLE_FTP_COULDNT_SET_BINARY CURLE_FTP_COULDNT_SET_TYPE
0703 #define CURLE_FTP_QUOTE_ERROR CURLE_QUOTE_ERROR
0704 #define CURLE_TFTP_DISKFULL CURLE_REMOTE_DISK_FULL
0705 #define CURLE_TFTP_EXISTS CURLE_REMOTE_FILE_EXISTS
0706 #define CURLE_HTTP_RANGE_ERROR CURLE_RANGE_ERROR
0707 #define CURLE_FTP_SSL_FAILED CURLE_USE_SSL_FAILED
0708 
0709 /* The following were added earlier */
0710 
0711 #define CURLE_OPERATION_TIMEOUTED CURLE_OPERATION_TIMEDOUT
0712 #define CURLE_HTTP_NOT_FOUND CURLE_HTTP_RETURNED_ERROR
0713 #define CURLE_HTTP_PORT_FAILED CURLE_INTERFACE_FAILED
0714 #define CURLE_FTP_COULDNT_STOR_FILE CURLE_UPLOAD_FAILED
0715 #define CURLE_FTP_PARTIAL_FILE CURLE_PARTIAL_FILE
0716 #define CURLE_FTP_BAD_DOWNLOAD_RESUME CURLE_BAD_DOWNLOAD_RESUME
0717 #define CURLE_LDAP_INVALID_URL CURLE_OBSOLETE62
0718 #define CURLE_CONV_REQD CURLE_OBSOLETE76
0719 #define CURLE_CONV_FAILED CURLE_OBSOLETE75
0720 
0721 /* This was the error code 50 in 7.7.3 and a few earlier versions, this
0722    is no longer used by libcurl but is instead #defined here only to not
0723    make programs break */
0724 #define CURLE_ALREADY_COMPLETE 99999
0725 
0726 /* Provide defines for really old option names */
0727 #define CURLOPT_FILE CURLOPT_WRITEDATA /* name changed in 7.9.7 */
0728 #define CURLOPT_INFILE CURLOPT_READDATA /* name changed in 7.9.7 */
0729 #define CURLOPT_WRITEHEADER CURLOPT_HEADERDATA
0730 
0731 /* Since long deprecated options with no code in the lib that does anything
0732    with them. */
0733 #define CURLOPT_WRITEINFO CURLOPT_OBSOLETE40
0734 #define CURLOPT_CLOSEPOLICY CURLOPT_OBSOLETE72
0735 #define CURLOPT_OBSOLETE72 9999
0736 #define CURLOPT_OBSOLETE40 9999
0737 
0738 #endif /* !CURL_NO_OLDIES */
0739 
0740 /*
0741  * Proxy error codes. Returned in CURLINFO_PROXY_ERROR if CURLE_PROXY was
0742  * return for the transfers.
0743  */
0744 typedef enum {
0745   CURLPX_OK,
0746   CURLPX_BAD_ADDRESS_TYPE,
0747   CURLPX_BAD_VERSION,
0748   CURLPX_CLOSED,
0749   CURLPX_GSSAPI,
0750   CURLPX_GSSAPI_PERMSG,
0751   CURLPX_GSSAPI_PROTECTION,
0752   CURLPX_IDENTD,
0753   CURLPX_IDENTD_DIFFER,
0754   CURLPX_LONG_HOSTNAME,
0755   CURLPX_LONG_PASSWD,
0756   CURLPX_LONG_USER,
0757   CURLPX_NO_AUTH,
0758   CURLPX_RECV_ADDRESS,
0759   CURLPX_RECV_AUTH,
0760   CURLPX_RECV_CONNECT,
0761   CURLPX_RECV_REQACK,
0762   CURLPX_REPLY_ADDRESS_TYPE_NOT_SUPPORTED,
0763   CURLPX_REPLY_COMMAND_NOT_SUPPORTED,
0764   CURLPX_REPLY_CONNECTION_REFUSED,
0765   CURLPX_REPLY_GENERAL_SERVER_FAILURE,
0766   CURLPX_REPLY_HOST_UNREACHABLE,
0767   CURLPX_REPLY_NETWORK_UNREACHABLE,
0768   CURLPX_REPLY_NOT_ALLOWED,
0769   CURLPX_REPLY_TTL_EXPIRED,
0770   CURLPX_REPLY_UNASSIGNED,
0771   CURLPX_REQUEST_FAILED,
0772   CURLPX_RESOLVE_HOST,
0773   CURLPX_SEND_AUTH,
0774   CURLPX_SEND_CONNECT,
0775   CURLPX_SEND_REQUEST,
0776   CURLPX_UNKNOWN_FAIL,
0777   CURLPX_UNKNOWN_MODE,
0778   CURLPX_USER_REJECTED,
0779   CURLPX_LAST /* never use */
0780 } CURLproxycode;
0781 
0782 /* This prototype applies to all conversion callbacks */
0783 typedef CURLcode (*curl_conv_callback)(char *buffer, size_t length);
0784 
0785 typedef CURLcode (*curl_ssl_ctx_callback)(CURL *curl,    /* easy handle */
0786                                           void *ssl_ctx, /* actually an OpenSSL
0787                                                             or wolfSSL SSL_CTX,
0788                                                             or an mbedTLS
0789                                                           mbedtls_ssl_config */
0790                                           void *userptr);
0791 
0792 #define CURLPROXY_HTTP            0L /* added in 7.10, new in 7.19.4 default is
0793                                         to use CONNECT HTTP/1.1 */
0794 #define CURLPROXY_HTTP_1_0        1L /* force to use CONNECT HTTP/1.0
0795                                         added in 7.19.4 */
0796 #define CURLPROXY_HTTPS           2L /* HTTPS but stick to HTTP/1
0797                                         added in 7.52.0 */
0798 #define CURLPROXY_HTTPS2          3L /* HTTPS and attempt HTTP/2
0799                                         added in 8.2.0 */
0800 #define CURLPROXY_SOCKS4          4L /* support added in 7.15.2, enum existed
0801                                         already in 7.10 */
0802 #define CURLPROXY_SOCKS5          5L /* added in 7.10 */
0803 #define CURLPROXY_SOCKS4A         6L /* added in 7.18.0 */
0804 #define CURLPROXY_SOCKS5_HOSTNAME 7L /* Use the SOCKS5 protocol but pass along
0805                                         the hostname rather than the IP
0806                                         address. added in 7.18.0 */
0807 #define CURLPROXY_HTTPS3          8L /* HTTPS and attempt HTTP/3
0808                                         added in 8.21.0 */
0809 
0810 typedef enum {
0811   CURLPROXY_LAST = 9 /* never use */
0812 } curl_proxytype;  /* this enum was added in 7.10 */
0813 
0814 /*
0815  * Bitmasks for CURLOPT_HTTPAUTH and CURLOPT_PROXYAUTH options:
0816  *
0817  * CURLAUTH_NONE         - No HTTP authentication
0818  * CURLAUTH_BASIC        - HTTP Basic authentication (default)
0819  * CURLAUTH_DIGEST       - HTTP Digest authentication
0820  * CURLAUTH_NEGOTIATE    - HTTP Negotiate (SPNEGO) authentication
0821  * CURLAUTH_GSSNEGOTIATE - Alias for CURLAUTH_NEGOTIATE (deprecated)
0822  * CURLAUTH_NTLM         - HTTP NTLM authentication
0823  * CURLAUTH_DIGEST_IE    - HTTP Digest authentication with IE flavor
0824  * CURLAUTH_NTLM_WB      - HTTP NTLM authentication delegated to winbind helper
0825  * CURLAUTH_BEARER       - HTTP Bearer token authentication
0826  * CURLAUTH_ONLY         - Use together with a single other type to force no
0827  *                         authentication or that single type
0828  * CURLAUTH_ANY          - All fine types set
0829  * CURLAUTH_ANYSAFE      - All fine types except Basic
0830  */
0831 
0832 #define CURLAUTH_NONE         ((unsigned long)0)
0833 #define CURLAUTH_BASIC        (((unsigned long)1) << 0)
0834 #define CURLAUTH_DIGEST       (((unsigned long)1) << 1)
0835 #define CURLAUTH_NEGOTIATE    (((unsigned long)1) << 2)
0836 /* Deprecated since the advent of CURLAUTH_NEGOTIATE */
0837 #define CURLAUTH_GSSNEGOTIATE CURLAUTH_NEGOTIATE
0838 /* Used for CURLOPT_SOCKS5_AUTH to stay terminologically correct */
0839 #define CURLAUTH_GSSAPI CURLAUTH_NEGOTIATE
0840 #define CURLAUTH_NTLM         (((unsigned long)1) << 3)
0841 #define CURLAUTH_DIGEST_IE    (((unsigned long)1) << 4)
0842 #ifndef CURL_NO_OLDIES
0843   /* functionality removed since 8.8.0 */
0844 #define CURLAUTH_NTLM_WB      (((unsigned long)1) << 5)
0845 #endif
0846 #define CURLAUTH_BEARER       (((unsigned long)1) << 6)
0847 #define CURLAUTH_AWS_SIGV4    (((unsigned long)1) << 7)
0848 #define CURLAUTH_HTTPSIG      (((unsigned long)1) << 8)
0849 #define CURLAUTH_ONLY         (((unsigned long)1) << 31)
0850 #define CURLAUTH_ANY          ((~(CURLAUTH_DIGEST_IE |                  \
0851                                   CURLAUTH_HTTPSIG)) &                  \
0852                                ((unsigned long)0xffffffff))
0853 #define CURLAUTH_ANYSAFE      ((~(CURLAUTH_BASIC | CURLAUTH_DIGEST_IE | \
0854                                   CURLAUTH_HTTPSIG)) &                  \
0855                                ((unsigned long)0xffffffff))
0856 
0857 /* constants for CURLOPT_HTTPSIG_ALGORITHM */
0858 #define CURLHTTPSIG_NONE          0L
0859 #define CURLHTTPSIG_ED25519       1L
0860 #define CURLHTTPSIG_HMAC_SHA256   2L
0861 
0862 /* all types supported by server */
0863 #define CURLSSH_AUTH_ANY       ((unsigned long)0xffffffff)
0864 #define CURLSSH_AUTH_NONE      0L        /* none allowed, silly but complete */
0865 #define CURLSSH_AUTH_PUBLICKEY (1L << 0) /* public/private key files */
0866 #define CURLSSH_AUTH_PASSWORD  (1L << 1) /* password */
0867 #define CURLSSH_AUTH_HOST      (1L << 2) /* host key files */
0868 #define CURLSSH_AUTH_KEYBOARD  (1L << 3) /* keyboard interactive */
0869 #define CURLSSH_AUTH_AGENT     (1L << 4) /* agent (ssh-agent, pageant...) */
0870 #define CURLSSH_AUTH_GSSAPI    (1L << 5) /* gssapi (kerberos, ...) */
0871 #define CURLSSH_AUTH_DEFAULT   CURLSSH_AUTH_ANY
0872 
0873 #define CURLGSSAPI_DELEGATION_NONE        0L      /* no delegation (default) */
0874 #define CURLGSSAPI_DELEGATION_POLICY_FLAG (1L<<0) /* if permitted by policy */
0875 #define CURLGSSAPI_DELEGATION_FLAG        (1L<<1) /* delegate always */
0876 
0877 #define CURL_ERROR_SIZE 256
0878 
0879 enum curl_khtype {
0880   CURLKHTYPE_UNKNOWN,
0881   CURLKHTYPE_RSA1,
0882   CURLKHTYPE_RSA,
0883   CURLKHTYPE_DSS,
0884   CURLKHTYPE_ECDSA,
0885   CURLKHTYPE_ED25519
0886 };
0887 
0888 struct curl_khkey {
0889   const char *key; /* points to a null-terminated string encoded with base64
0890                       if len is zero, otherwise to the "raw" data */
0891   size_t len;
0892   enum curl_khtype keytype;
0893 };
0894 
0895 /* this is the set of return values expected from the curl_sshkeycallback
0896    callback */
0897 enum curl_khstat {
0898   CURLKHSTAT_FINE_ADD_TO_FILE,
0899   CURLKHSTAT_FINE,
0900   CURLKHSTAT_REJECT, /* reject the connection, return an error */
0901   CURLKHSTAT_DEFER,  /* do not accept it, but we cannot answer right now.
0902                         Causes a CURLE_PEER_FAILED_VERIFICATION error but the
0903                         connection is left intact etc */
0904   CURLKHSTAT_FINE_REPLACE, /* accept and replace the wrong key */
0905   CURLKHSTAT_LAST    /* not for use, only a marker for last-in-list */
0906 };
0907 
0908 /* this is the set of status codes pass in to the callback */
0909 enum curl_khmatch {
0910   CURLKHMATCH_OK,       /* match */
0911   CURLKHMATCH_MISMATCH, /* host found, key mismatch! */
0912   CURLKHMATCH_MISSING,  /* no matching host/key found */
0913   CURLKHMATCH_LAST      /* not for use, only a marker for last-in-list */
0914 };
0915 
0916 typedef int
0917   (*curl_sshkeycallback)(CURL *easy,     /* easy handle */
0918                          const struct curl_khkey *knownkey, /* known */
0919                          const struct curl_khkey *foundkey, /* found */
0920                          enum curl_khmatch, /* libcurl's view on the keys */
0921                          void *clientp); /* custom pointer passed with */
0922                                          /* CURLOPT_SSH_KEYDATA */
0923 
0924 typedef int
0925   (*curl_sshhostkeycallback)(void *clientp,/* custom pointer passed */
0926                                            /* with CURLOPT_SSH_HOSTKEYDATA */
0927                           int keytype, /* CURLKHTYPE */
0928                           const char *key, /* hostkey to check */
0929                           size_t keylen); /* length of the key */
0930                           /* return CURLE_OK to accept */
0931                           /* or something else to refuse */
0932 
0933 /* parameter for the CURLOPT_USE_SSL option */
0934 #define CURLUSESSL_NONE    0L /* do not attempt to use SSL */
0935 #define CURLUSESSL_TRY     1L /* try using SSL, proceed anyway otherwise */
0936 #define CURLUSESSL_CONTROL 2L /* SSL for the control connection or fail */
0937 #define CURLUSESSL_ALL     3L /* SSL for all communication or fail */
0938 
0939 typedef enum {
0940   CURLUSESSL_LAST = 4 /* not an option, never use */
0941 } curl_usessl;
0942 
0943 /* Definition of bits for the CURLOPT_SSL_OPTIONS argument: */
0944 
0945 /* - ALLOW_BEAST tells libcurl to allow the BEAST SSL vulnerability in the
0946    name of improving interoperability with older servers. Some SSL libraries
0947    have introduced workarounds for this flaw but those workarounds sometimes
0948    make the SSL communication fail. To regain functionality with those broken
0949    servers, a user can this way allow the vulnerability back. */
0950 #define CURLSSLOPT_ALLOW_BEAST (1L << 0)
0951 
0952 /* - NO_REVOKE tells libcurl to disable certificate revocation checks for those
0953    SSL backends where such behavior is present. */
0954 #define CURLSSLOPT_NO_REVOKE (1L << 1)
0955 
0956 /* - NO_PARTIALCHAIN tells libcurl to *NOT* accept a partial certificate chain
0957    if possible. The OpenSSL backend has this ability. */
0958 #define CURLSSLOPT_NO_PARTIALCHAIN (1L << 2)
0959 
0960 /* - REVOKE_BEST_EFFORT tells libcurl to ignore certificate revocation offline
0961    checks and ignore missing revocation list for those SSL backends where such
0962    behavior is present. */
0963 #define CURLSSLOPT_REVOKE_BEST_EFFORT (1L << 3)
0964 
0965 /* - CURLSSLOPT_NATIVE_CA tells libcurl to use standard certificate store of
0966    operating system. Currently implemented under MS-Windows. */
0967 #define CURLSSLOPT_NATIVE_CA (1L << 4)
0968 
0969 /* - CURLSSLOPT_AUTO_CLIENT_CERT tells libcurl to automatically locate and use
0970    a client certificate for authentication. (Schannel) */
0971 #define CURLSSLOPT_AUTO_CLIENT_CERT (1L << 5)
0972 
0973 /* If possible, send data using TLS 1.3 early data */
0974 #define CURLSSLOPT_EARLYDATA (1L << 6)
0975 
0976 /* The default connection attempt delay in milliseconds for happy eyeballs.
0977    CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.3 and happy-eyeballs-timeout-ms.d document
0978    this value, keep them in sync. */
0979 #define CURL_HET_DEFAULT 200L
0980 
0981 /* The default connection upkeep interval in milliseconds. */
0982 #define CURL_UPKEEP_INTERVAL_DEFAULT 60000L
0983 
0984 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all
0985                           the obsolete stuff removed! */
0986 
0987 /* Backwards compatibility with older names */
0988 /* These are scheduled to disappear by 2009 */
0989 
0990 #define CURLFTPSSL_NONE CURLUSESSL_NONE
0991 #define CURLFTPSSL_TRY CURLUSESSL_TRY
0992 #define CURLFTPSSL_CONTROL CURLUSESSL_CONTROL
0993 #define CURLFTPSSL_ALL CURLUSESSL_ALL
0994 #define CURLFTPSSL_LAST CURLUSESSL_LAST
0995 #define curl_ftpssl curl_usessl
0996 #endif /* !CURL_NO_OLDIES */
0997 
0998 /* parameter for the CURLOPT_FTP_SSL_CCC option */
0999 #define CURLFTPSSL_CCC_NONE    0L /* do not send CCC */
1000 #define CURLFTPSSL_CCC_PASSIVE 1L /* Let the server initiate the shutdown */
1001 #define CURLFTPSSL_CCC_ACTIVE  2L /* Initiate the shutdown */
1002 
1003 typedef enum {
1004   CURLFTPSSL_CCC_LAST = 3 /* not an option, never use */
1005 } curl_ftpccc;
1006 
1007 /* parameter for the CURLOPT_FTPSSLAUTH option */
1008 #define CURLFTPAUTH_DEFAULT 0L /* let libcurl decide */
1009 #define CURLFTPAUTH_SSL     1L /* use "AUTH SSL" */
1010 #define CURLFTPAUTH_TLS     2L /* use "AUTH TLS" */
1011 
1012 typedef enum {
1013   CURLFTPAUTH_LAST = 3 /* not an option, never use */
1014 } curl_ftpauth;
1015 
1016 /* parameter for the CURLOPT_FTP_CREATE_MISSING_DIRS option */
1017 #define CURLFTP_CREATE_DIR_NONE  0L /* do NOT create missing dirs! */
1018 #define CURLFTP_CREATE_DIR       1L /* (FTP/SFTP) if CWD fails, try MKD and
1019                                        then CWD again if MKD succeeded, for
1020                                        SFTP this does similar magic */
1021 #define CURLFTP_CREATE_DIR_RETRY 2L /* (FTP only) if CWD fails, try MKD and
1022                                        then CWD again even if MKD failed! */
1023 
1024 typedef enum {
1025   CURLFTP_CREATE_DIR_LAST = 3 /* not an option, never use */
1026 } curl_ftpcreatedir;
1027 
1028 /* parameter for the CURLOPT_FTP_FILEMETHOD option */
1029 #define CURLFTPMETHOD_DEFAULT   0L /* let libcurl pick */
1030 #define CURLFTPMETHOD_MULTICWD  1L /* single CWD operation for each path
1031                                       part */
1032 #define CURLFTPMETHOD_NOCWD     2L /* no CWD at all */
1033 #define CURLFTPMETHOD_SINGLECWD 3L /* one CWD to full dir, then work on file */
1034 
1035 typedef enum {
1036   CURLFTPMETHOD_LAST = 4 /* not an option, never use */
1037 } curl_ftpmethod;
1038 
1039 /* bitmask defines for CURLOPT_HEADEROPT */
1040 #define CURLHEADER_UNIFIED  0L
1041 #define CURLHEADER_SEPARATE (1L << 0)
1042 
1043 /* CURLALTSVC_* are bits for the CURLOPT_ALTSVC_CTRL option */
1044 #define CURLALTSVC_READONLYFILE (1L << 2)
1045 #define CURLALTSVC_H1           (1L << 3)
1046 #define CURLALTSVC_H2           (1L << 4)
1047 #define CURLALTSVC_H3           (1L << 5)
1048 
1049 /* bitmask values for CURLOPT_UPLOAD_FLAGS */
1050 #define CURLULFLAG_ANSWERED (1L << 0)
1051 #define CURLULFLAG_DELETED  (1L << 1)
1052 #define CURLULFLAG_DRAFT    (1L << 2)
1053 #define CURLULFLAG_FLAGGED  (1L << 3)
1054 #define CURLULFLAG_SEEN     (1L << 4)
1055 
1056 struct curl_hstsentry {
1057   char *name;
1058   size_t namelen;
1059   unsigned int includeSubDomains:1;
1060   char expire[18]; /* YYYYMMDD HH:MM:SS [null-terminated] */
1061 };
1062 
1063 struct curl_index {
1064   size_t index; /* the provided entry's "index" or count */
1065   size_t total; /* total number of entries to save */
1066 };
1067 
1068 typedef enum {
1069   CURLSTS_OK,
1070   CURLSTS_DONE,
1071   CURLSTS_FAIL
1072 } CURLSTScode;
1073 
1074 typedef CURLSTScode (*curl_hstsread_callback)(CURL *easy,
1075                                               struct curl_hstsentry *e,
1076                                               void *userp);
1077 typedef CURLSTScode (*curl_hstswrite_callback)(CURL *easy,
1078                                                struct curl_hstsentry *e,
1079                                                struct curl_index *i,
1080                                                void *userp);
1081 
1082 /* CURLHSTS_* are bits for the CURLOPT_HSTS option */
1083 #define CURLHSTS_ENABLE       (1L << 0)
1084 #define CURLHSTS_READONLYFILE (1L << 1)
1085 
1086 /* The CURLPROTO_ defines below are for the **deprecated** CURLOPT_*PROTOCOLS
1087    options. Do not use. */
1088 #define CURLPROTO_HTTP    (1L << 0)
1089 #define CURLPROTO_HTTPS   (1L << 1)
1090 #define CURLPROTO_FTP     (1L << 2)
1091 #define CURLPROTO_FTPS    (1L << 3)
1092 #define CURLPROTO_SCP     (1L << 4)
1093 #define CURLPROTO_SFTP    (1L << 5)
1094 #define CURLPROTO_TELNET  (1L << 6)
1095 #define CURLPROTO_LDAP    (1L << 7)
1096 #define CURLPROTO_LDAPS   (1L << 8)
1097 #define CURLPROTO_DICT    (1L << 9)
1098 #define CURLPROTO_FILE    (1L << 10)
1099 #define CURLPROTO_TFTP    (1L << 11)
1100 #define CURLPROTO_IMAP    (1L << 12)
1101 #define CURLPROTO_IMAPS   (1L << 13)
1102 #define CURLPROTO_POP3    (1L << 14)
1103 #define CURLPROTO_POP3S   (1L << 15)
1104 #define CURLPROTO_SMTP    (1L << 16)
1105 #define CURLPROTO_SMTPS   (1L << 17)
1106 #define CURLPROTO_RTSP    (1L << 18)
1107 #define CURLPROTO_RTMP    (1L << 19)
1108 #define CURLPROTO_RTMPT   (1L << 20)
1109 #define CURLPROTO_RTMPE   (1L << 21)
1110 #define CURLPROTO_RTMPTE  (1L << 22)
1111 #define CURLPROTO_RTMPS   (1L << 23)
1112 #define CURLPROTO_RTMPTS  (1L << 24)
1113 #define CURLPROTO_GOPHER  (1L << 25)
1114 #define CURLPROTO_SMB     (1L << 26)
1115 #define CURLPROTO_SMBS    (1L << 27)
1116 #define CURLPROTO_MQTT    (1L << 28)
1117 #define CURLPROTO_GOPHERS (1L << 29)
1118 #define CURLPROTO_ALL     ((unsigned long)0xffffffff) /* old-style enable
1119                                                          "everything" */
1120 
1121 /* long may be 32 or 64 bits, but we should never depend on anything else
1122    but 32 */
1123 #define CURLOPTTYPE_LONG          0
1124 #define CURLOPTTYPE_OBJECTPOINT   10000
1125 #define CURLOPTTYPE_FUNCTIONPOINT 20000
1126 #define CURLOPTTYPE_OFF_T         30000
1127 #define CURLOPTTYPE_BLOB          40000
1128 
1129 /* *STRINGPOINT is an alias for OBJECTPOINT to allow tools to extract the
1130    string options from the header file */
1131 
1132 #define CURLOPT(na, t, nu) na = ((t) + (nu))
1133 #define CURLOPTDEPRECATED(na, t, nu, v, m) na CURL_DEPRECATED(v, m) \
1134   = ((t) + (nu))
1135 
1136 /* CURLOPT aliases that make no runtime difference */
1137 
1138 /* 'char *' argument to a string with a trailing zero */
1139 #define CURLOPTTYPE_STRINGPOINT CURLOPTTYPE_OBJECTPOINT
1140 
1141 /* 'struct curl_slist *' argument */
1142 #define CURLOPTTYPE_SLISTPOINT  CURLOPTTYPE_OBJECTPOINT
1143 
1144 /* 'void *' argument passed untouched to callback */
1145 #define CURLOPTTYPE_CBPOINT     CURLOPTTYPE_OBJECTPOINT
1146 
1147 /* 'long' argument with a set of values/bitmask */
1148 #define CURLOPTTYPE_VALUES      CURLOPTTYPE_LONG
1149 
1150 /*
1151  * All CURLOPT_* values.
1152  */
1153 
1154 typedef enum {
1155   /* This is the FILE * or void * the regular output should be written to. */
1156   CURLOPT(CURLOPT_WRITEDATA, CURLOPTTYPE_CBPOINT, 1),
1157 
1158   /* The full URL to get/put */
1159   CURLOPT(CURLOPT_URL, CURLOPTTYPE_STRINGPOINT, 2),
1160 
1161   /* Port number to connect to, if other than default. */
1162   CURLOPT(CURLOPT_PORT, CURLOPTTYPE_LONG, 3),
1163 
1164   /* Name of proxy to use. */
1165   CURLOPT(CURLOPT_PROXY, CURLOPTTYPE_STRINGPOINT, 4),
1166 
1167   /* "user:password;options" to use when fetching. */
1168   CURLOPT(CURLOPT_USERPWD, CURLOPTTYPE_STRINGPOINT, 5),
1169 
1170   /* "user:password" to use with proxy. */
1171   CURLOPT(CURLOPT_PROXYUSERPWD, CURLOPTTYPE_STRINGPOINT, 6),
1172 
1173   /* Range to get, specified as an ASCII string. */
1174   CURLOPT(CURLOPT_RANGE, CURLOPTTYPE_STRINGPOINT, 7),
1175 
1176   /* not used */
1177 
1178   /* Specified file stream to upload from (use as input): */
1179   CURLOPT(CURLOPT_READDATA, CURLOPTTYPE_CBPOINT, 9),
1180 
1181   /* Buffer to receive error messages in, must be at least CURL_ERROR_SIZE
1182    * bytes big. */
1183   CURLOPT(CURLOPT_ERRORBUFFER, CURLOPTTYPE_OBJECTPOINT, 10),
1184 
1185   /* Function that is called to store the output (instead of fwrite). The
1186    * parameters use fwrite() syntax, make sure to follow them. */
1187   CURLOPT(CURLOPT_WRITEFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 11),
1188 
1189   /* Function that is called to read the input (instead of fread). The
1190    * parameters use fread() syntax, make sure to follow them. */
1191   CURLOPT(CURLOPT_READFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 12),
1192 
1193   /* Time-out the read operation after this amount of seconds */
1194   CURLOPT(CURLOPT_TIMEOUT, CURLOPTTYPE_LONG, 13),
1195 
1196   /* If CURLOPT_READDATA is used, this can be used to inform libcurl about
1197    * how large the file being sent really is. That allows better error
1198    * checking and better verifies that the upload was successful. -1 means
1199    * unknown size.
1200    *
1201    * For large file support, there is also a _LARGE version of the key
1202    * which takes an off_t type, allowing platforms with larger off_t
1203    * sizes to handle larger files. See below for INFILESIZE_LARGE.
1204    */
1205   CURLOPT(CURLOPT_INFILESIZE, CURLOPTTYPE_LONG, 14),
1206 
1207   /* POST static input fields. */
1208   CURLOPT(CURLOPT_POSTFIELDS, CURLOPTTYPE_OBJECTPOINT, 15),
1209 
1210   /* Set the referrer page (needed by some CGIs) */
1211   CURLOPT(CURLOPT_REFERER, CURLOPTTYPE_STRINGPOINT, 16),
1212 
1213   /* Set the FTP PORT string (interface name, named or numerical IP address)
1214      Use i.e '-' to use default address. */
1215   CURLOPT(CURLOPT_FTPPORT, CURLOPTTYPE_STRINGPOINT, 17),
1216 
1217   /* Set the User-Agent string (examined by some CGIs) */
1218   CURLOPT(CURLOPT_USERAGENT, CURLOPTTYPE_STRINGPOINT, 18),
1219 
1220   /* If the download receives less than "low speed limit" bytes/second
1221    * during "low speed time" seconds, the operations is aborted.
1222    * You could i.e if you have a pretty high speed connection, abort if
1223    * it is less than 2000 bytes/sec during 20 seconds.
1224    */
1225 
1226   /* Set the "low speed limit" */
1227   CURLOPT(CURLOPT_LOW_SPEED_LIMIT, CURLOPTTYPE_LONG, 19),
1228 
1229   /* Set the "low speed time" */
1230   CURLOPT(CURLOPT_LOW_SPEED_TIME, CURLOPTTYPE_LONG, 20),
1231 
1232   /* Set the continuation offset.
1233    *
1234    * Note there is also a _LARGE version of this key which uses
1235    * off_t types, allowing for large file offsets on platforms which
1236    * use larger-than-32-bit off_t's. Look below for RESUME_FROM_LARGE.
1237    */
1238   CURLOPT(CURLOPT_RESUME_FROM, CURLOPTTYPE_LONG, 21),
1239 
1240   /* Set cookie in request: */
1241   CURLOPT(CURLOPT_COOKIE, CURLOPTTYPE_STRINGPOINT, 22),
1242 
1243   /* This points to a linked list of headers, struct curl_slist kind. This
1244      list is also used for RTSP (in spite of its name) */
1245   CURLOPT(CURLOPT_HTTPHEADER, CURLOPTTYPE_SLISTPOINT, 23),
1246 
1247   /* This points to a linked list of post entries, struct curl_httppost */
1248   CURLOPTDEPRECATED(CURLOPT_HTTPPOST, CURLOPTTYPE_OBJECTPOINT, 24,
1249                     7.56.0, "Use CURLOPT_MIMEPOST"),
1250 
1251   /* name of the file keeping your private SSL-certificate */
1252   CURLOPT(CURLOPT_SSLCERT, CURLOPTTYPE_STRINGPOINT, 25),
1253 
1254   /* password for the SSL or SSH private key */
1255   CURLOPT(CURLOPT_KEYPASSWD, CURLOPTTYPE_STRINGPOINT, 26),
1256 
1257   /* send TYPE parameter? */
1258   CURLOPT(CURLOPT_CRLF, CURLOPTTYPE_LONG, 27),
1259 
1260   /* send linked-list of QUOTE commands */
1261   CURLOPT(CURLOPT_QUOTE, CURLOPTTYPE_SLISTPOINT, 28),
1262 
1263   /* send FILE * or void * to store headers to, if you use a callback it
1264      is passed to the callback unmodified */
1265   CURLOPT(CURLOPT_HEADERDATA, CURLOPTTYPE_CBPOINT, 29),
1266 
1267   /* point to a file to read the initial cookies from, also enables
1268      "cookie awareness" */
1269   CURLOPT(CURLOPT_COOKIEFILE, CURLOPTTYPE_STRINGPOINT, 31),
1270 
1271   /* What version to specifically try to use.
1272      See CURL_SSLVERSION defines below. */
1273   CURLOPT(CURLOPT_SSLVERSION, CURLOPTTYPE_VALUES, 32),
1274 
1275   /* What kind of HTTP time condition to use, see defines */
1276   CURLOPT(CURLOPT_TIMECONDITION, CURLOPTTYPE_VALUES, 33),
1277 
1278   /* Time to use with the above condition. Specified in number of seconds
1279      since 1 Jan 1970 */
1280   CURLOPT(CURLOPT_TIMEVALUE, CURLOPTTYPE_LONG, 34),
1281 
1282   /* 35 = OBSOLETE */
1283 
1284   /* Custom request, for customizing the get command like
1285      HTTP: DELETE, TRACE and others
1286      FTP: to use a different list command
1287      */
1288   CURLOPT(CURLOPT_CUSTOMREQUEST, CURLOPTTYPE_STRINGPOINT, 36),
1289 
1290   /* FILE handle to use instead of stderr */
1291   CURLOPT(CURLOPT_STDERR, CURLOPTTYPE_OBJECTPOINT, 37),
1292 
1293   /* 38 is not used */
1294 
1295   /* send linked-list of post-transfer QUOTE commands */
1296   CURLOPT(CURLOPT_POSTQUOTE, CURLOPTTYPE_SLISTPOINT, 39),
1297 
1298   /* 40 is not used */
1299 
1300   /* talk a lot */
1301   CURLOPT(CURLOPT_VERBOSE, CURLOPTTYPE_LONG, 41),
1302 
1303   /* throw the header out too */
1304   CURLOPT(CURLOPT_HEADER, CURLOPTTYPE_LONG, 42),
1305 
1306   /* shut off the progress meter */
1307   CURLOPT(CURLOPT_NOPROGRESS, CURLOPTTYPE_LONG, 43),
1308 
1309   /* use HEAD to get http document */
1310   CURLOPT(CURLOPT_NOBODY, CURLOPTTYPE_LONG, 44),
1311 
1312   /* no output on http error codes >= 400 */
1313   CURLOPT(CURLOPT_FAILONERROR, CURLOPTTYPE_LONG, 45),
1314 
1315   /* this is an upload */
1316   CURLOPT(CURLOPT_UPLOAD, CURLOPTTYPE_LONG, 46),
1317 
1318   /* HTTP POST method */
1319   CURLOPT(CURLOPT_POST, CURLOPTTYPE_LONG, 47),
1320 
1321   /* bare names when listing directories */
1322   CURLOPT(CURLOPT_DIRLISTONLY, CURLOPTTYPE_LONG, 48),
1323 
1324   /* Append instead of overwrite on upload! */
1325   CURLOPT(CURLOPT_APPEND, CURLOPTTYPE_LONG, 50),
1326 
1327   /* Specify whether to read the user+password from the .netrc or the URL.
1328    * This must be one of the CURL_NETRC_* enums below. */
1329   CURLOPT(CURLOPT_NETRC, CURLOPTTYPE_VALUES, 51),
1330 
1331   /* use Location: Luke! */
1332   CURLOPT(CURLOPT_FOLLOWLOCATION, CURLOPTTYPE_LONG, 52),
1333 
1334    /* transfer data in text/ASCII format */
1335   CURLOPT(CURLOPT_TRANSFERTEXT, CURLOPTTYPE_LONG, 53),
1336 
1337   /* HTTP PUT */
1338   CURLOPTDEPRECATED(CURLOPT_PUT, CURLOPTTYPE_LONG, 54,
1339                     7.12.1, "Use CURLOPT_UPLOAD"),
1340 
1341   /* 55 = OBSOLETE */
1342 
1343   /* DEPRECATED
1344    * Function that is called instead of the internal progress display
1345    * function. This function should be defined as the curl_progress_callback
1346    * prototype defines. */
1347   CURLOPTDEPRECATED(CURLOPT_PROGRESSFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 56,
1348                     7.32.0, "Use CURLOPT_XFERINFOFUNCTION"),
1349 
1350   /* Data passed to the CURLOPT_PROGRESSFUNCTION and CURLOPT_XFERINFOFUNCTION
1351      callbacks */
1352   CURLOPT(CURLOPT_XFERINFODATA, CURLOPTTYPE_CBPOINT, 57),
1353 #define CURLOPT_PROGRESSDATA CURLOPT_XFERINFODATA
1354 
1355   /* We want the referrer field set automatically when following locations */
1356   CURLOPT(CURLOPT_AUTOREFERER, CURLOPTTYPE_LONG, 58),
1357 
1358   /* Port of the proxy, can be set in the proxy string as well with:
1359      "[host]:[port]" */
1360   CURLOPT(CURLOPT_PROXYPORT, CURLOPTTYPE_LONG, 59),
1361 
1362   /* size of the POST input data, if strlen() is not good to use */
1363   CURLOPT(CURLOPT_POSTFIELDSIZE, CURLOPTTYPE_LONG, 60),
1364 
1365   /* tunnel non-http operations through an HTTP proxy */
1366   CURLOPT(CURLOPT_HTTPPROXYTUNNEL, CURLOPTTYPE_LONG, 61),
1367 
1368   /* Set the interface string to use as outgoing network interface */
1369   CURLOPT(CURLOPT_INTERFACE, CURLOPTTYPE_STRINGPOINT, 62),
1370 
1371   /* Set the krb4/5 security level, this also enables krb4/5 awareness. This
1372    * is a string, 'clear', 'safe', 'confidential' or 'private'. If the string
1373    * is set but does not match one of these, 'private' is used. */
1374   CURLOPTDEPRECATED(CURLOPT_KRBLEVEL, CURLOPTTYPE_STRINGPOINT, 63,
1375                     8.17.0, "removed"),
1376 
1377   /* Set if we should verify the peer in SSL handshake, set 1 to verify. */
1378   CURLOPT(CURLOPT_SSL_VERIFYPEER, CURLOPTTYPE_LONG, 64),
1379 
1380   /* The CApath or CAfile used to validate the peer certificate
1381      this option is used only if SSL_VERIFYPEER is true */
1382   CURLOPT(CURLOPT_CAINFO, CURLOPTTYPE_STRINGPOINT, 65),
1383 
1384   /* 66 = OBSOLETE */
1385   /* 67 = OBSOLETE */
1386 
1387   /* Maximum number of http redirects to follow */
1388   CURLOPT(CURLOPT_MAXREDIRS, CURLOPTTYPE_LONG, 68),
1389 
1390   /* Pass a long set to 1 to get the date of the requested document (if
1391      possible)! Pass a zero to shut it off. */
1392   CURLOPT(CURLOPT_FILETIME, CURLOPTTYPE_LONG, 69),
1393 
1394   /* This points to a linked list of telnet options */
1395   CURLOPT(CURLOPT_TELNETOPTIONS, CURLOPTTYPE_SLISTPOINT, 70),
1396 
1397   /* Max amount of cached alive connections */
1398   CURLOPT(CURLOPT_MAXCONNECTS, CURLOPTTYPE_LONG, 71),
1399 
1400   /* 72 = OBSOLETE */
1401   /* 73 = OBSOLETE */
1402 
1403   /* Set to explicitly use a new connection for the upcoming transfer.
1404      Do not use this unless you are absolutely sure of this, as it makes the
1405      operation slower and is less friendly for the network. */
1406   CURLOPT(CURLOPT_FRESH_CONNECT, CURLOPTTYPE_LONG, 74),
1407 
1408   /* Set to explicitly forbid the upcoming transfer's connection to be reused
1409      when done. Do not use this unless you are absolutely sure of this, as it
1410      makes the operation slower and is less friendly for the network. */
1411   CURLOPT(CURLOPT_FORBID_REUSE, CURLOPTTYPE_LONG, 75),
1412 
1413   /* Set to a filename that contains random data for libcurl to use to
1414      seed the random engine when doing SSL connects. */
1415   CURLOPTDEPRECATED(CURLOPT_RANDOM_FILE, CURLOPTTYPE_STRINGPOINT, 76,
1416                     7.84.0, "Serves no purpose anymore"),
1417 
1418   /* Set to the Entropy Gathering Daemon socket pathname */
1419   CURLOPTDEPRECATED(CURLOPT_EGDSOCKET, CURLOPTTYPE_STRINGPOINT, 77,
1420                     7.84.0, "Serves no purpose anymore"),
1421 
1422   /* Time-out connect operations after this amount of seconds, if connects are
1423      OK within this time, then fine... This only aborts the connect phase. */
1424   CURLOPT(CURLOPT_CONNECTTIMEOUT, CURLOPTTYPE_LONG, 78),
1425 
1426   /* Function that is called to store headers (instead of fwrite). The
1427    * parameters use fwrite() syntax, make sure to follow them. */
1428   CURLOPT(CURLOPT_HEADERFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 79),
1429 
1430   /* Set this to force the HTTP request to get back to GET. Only really usable
1431      if POST, PUT or a custom request have been used first.
1432    */
1433   CURLOPT(CURLOPT_HTTPGET, CURLOPTTYPE_LONG, 80),
1434 
1435   /* Set if we should verify the Common name from the peer certificate in SSL
1436    * handshake, set 1 to check existence, 2 to ensure that it matches the
1437    * provided hostname. */
1438   CURLOPT(CURLOPT_SSL_VERIFYHOST, CURLOPTTYPE_LONG, 81),
1439 
1440   /* Specify which filename to write all known cookies in after completed
1441      operation. Set filename to "-" (dash) to make it go to stdout. */
1442   CURLOPT(CURLOPT_COOKIEJAR, CURLOPTTYPE_STRINGPOINT, 82),
1443 
1444   /* Specify which TLS 1.2 (1.1, 1.0) ciphers to use */
1445   CURLOPT(CURLOPT_SSL_CIPHER_LIST, CURLOPTTYPE_STRINGPOINT, 83),
1446 
1447   /* Specify which HTTP version to use! This must be set to one of the
1448      CURL_HTTP_VERSION* enums set below. */
1449   CURLOPT(CURLOPT_HTTP_VERSION, CURLOPTTYPE_VALUES, 84),
1450 
1451   /* Specifically switch on or off the FTP engine's use of the EPSV command. By
1452      default, that one is always attempted before the more traditional
1453      PASV command. */
1454   CURLOPT(CURLOPT_FTP_USE_EPSV, CURLOPTTYPE_LONG, 85),
1455 
1456   /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") */
1457   CURLOPT(CURLOPT_SSLCERTTYPE, CURLOPTTYPE_STRINGPOINT, 86),
1458 
1459   /* name of the file keeping your private SSL-key */
1460   CURLOPT(CURLOPT_SSLKEY, CURLOPTTYPE_STRINGPOINT, 87),
1461 
1462   /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") */
1463   CURLOPT(CURLOPT_SSLKEYTYPE, CURLOPTTYPE_STRINGPOINT, 88),
1464 
1465   /* crypto engine for the SSL-sub system */
1466   CURLOPT(CURLOPT_SSLENGINE, CURLOPTTYPE_STRINGPOINT, 89),
1467 
1468   /* set the crypto engine for the SSL-sub system as default
1469      the param has no meaning...
1470    */
1471   CURLOPT(CURLOPT_SSLENGINE_DEFAULT, CURLOPTTYPE_LONG, 90),
1472 
1473   /* Non-zero value means to use the global dns cache */
1474   /* DEPRECATED, do not use! */
1475   CURLOPTDEPRECATED(CURLOPT_DNS_USE_GLOBAL_CACHE, CURLOPTTYPE_LONG, 91,
1476                     7.11.1, "Use CURLOPT_SHARE"),
1477 
1478   /* DNS cache timeout */
1479   CURLOPT(CURLOPT_DNS_CACHE_TIMEOUT, CURLOPTTYPE_LONG, 92),
1480 
1481   /* send linked-list of pre-transfer QUOTE commands */
1482   CURLOPT(CURLOPT_PREQUOTE, CURLOPTTYPE_SLISTPOINT, 93),
1483 
1484   /* set the debug function */
1485   CURLOPT(CURLOPT_DEBUGFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 94),
1486 
1487   /* set the data for the debug function */
1488   CURLOPT(CURLOPT_DEBUGDATA, CURLOPTTYPE_CBPOINT, 95),
1489 
1490   /* mark this as start of a cookie session */
1491   CURLOPT(CURLOPT_COOKIESESSION, CURLOPTTYPE_LONG, 96),
1492 
1493   /* The CApath directory used to validate the peer certificate
1494      this option is used only if SSL_VERIFYPEER is true */
1495   CURLOPT(CURLOPT_CAPATH, CURLOPTTYPE_STRINGPOINT, 97),
1496 
1497   /* Instruct libcurl to use a smaller receive buffer */
1498   CURLOPT(CURLOPT_BUFFERSIZE, CURLOPTTYPE_LONG, 98),
1499 
1500   /* Instruct libcurl to not use any signal/alarm handlers, even when using
1501      timeouts. This option is useful for multi-threaded applications.
1502      See libcurl-the-guide for more background information. */
1503   CURLOPT(CURLOPT_NOSIGNAL, CURLOPTTYPE_LONG, 99),
1504 
1505   /* Provide a CURLShare for mutexing non-ts data */
1506   CURLOPT(CURLOPT_SHARE, CURLOPTTYPE_OBJECTPOINT, 100),
1507 
1508   /* indicates type of proxy. accepted values are CURLPROXY_HTTP (default),
1509      CURLPROXY_HTTPS, CURLPROXY_HTTPS2, CURLPROXY_HTTPS3, CURLPROXY_SOCKS4,
1510      CURLPROXY_SOCKS4A and CURLPROXY_SOCKS5. */
1511   CURLOPT(CURLOPT_PROXYTYPE, CURLOPTTYPE_VALUES, 101),
1512 
1513   /* Set the Accept-Encoding string. Use this to tell a server you would like
1514      the response to be compressed. Before 7.21.6, this was known as
1515      CURLOPT_ENCODING */
1516   CURLOPT(CURLOPT_ACCEPT_ENCODING, CURLOPTTYPE_STRINGPOINT, 102),
1517 
1518   /* Set pointer to private data */
1519   CURLOPT(CURLOPT_PRIVATE, CURLOPTTYPE_OBJECTPOINT, 103),
1520 
1521   /* Set aliases for HTTP 200 in the HTTP Response header */
1522   CURLOPT(CURLOPT_HTTP200ALIASES, CURLOPTTYPE_SLISTPOINT, 104),
1523 
1524   /* Continue to send authentication (user+password) when following locations,
1525      even when hostname changed. This can potentially send off the name
1526      and password to whatever host the server decides. */
1527   CURLOPT(CURLOPT_UNRESTRICTED_AUTH, CURLOPTTYPE_LONG, 105),
1528 
1529   /* Specifically switch on or off the FTP engine's use of the EPRT command (
1530      it also disables the LPRT attempt). By default, those ones are always
1531      attempted before the good old traditional PORT command. */
1532   CURLOPT(CURLOPT_FTP_USE_EPRT, CURLOPTTYPE_LONG, 106),
1533 
1534   /* Set this to a bitmask value to enable the particular authentications
1535      methods you like. Use this in combination with CURLOPT_USERPWD.
1536      Note that setting multiple bits may cause extra network round-trips. */
1537   CURLOPT(CURLOPT_HTTPAUTH, CURLOPTTYPE_VALUES, 107),
1538 
1539   /* Set the SSL context callback function, currently only for OpenSSL or
1540      wolfSSL ssl_ctx, or mbedTLS mbedtls_ssl_config in the second argument.
1541      The function must match the curl_ssl_ctx_callback prototype. */
1542   CURLOPT(CURLOPT_SSL_CTX_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 108),
1543 
1544   /* Set the userdata for the SSL context callback function's third
1545      argument */
1546   CURLOPT(CURLOPT_SSL_CTX_DATA, CURLOPTTYPE_CBPOINT, 109),
1547 
1548   /* FTP Option that causes missing dirs to be created on the remote server.
1549      In 7.19.4 we introduced the convenience enums for this option using the
1550      CURLFTP_CREATE_DIR prefix. */
1551   CURLOPT(CURLOPT_FTP_CREATE_MISSING_DIRS, CURLOPTTYPE_LONG, 110),
1552 
1553   /* Set this to a bitmask value to enable the particular authentications
1554      methods you like. Use this in combination with CURLOPT_PROXYUSERPWD.
1555      Note that setting multiple bits may cause extra network round-trips. */
1556   CURLOPT(CURLOPT_PROXYAUTH, CURLOPTTYPE_VALUES, 111),
1557 
1558   /* Option that changes the timeout, in seconds, associated with getting a
1559      response. This is different from transfer timeout time and essentially
1560      places a demand on the server to acknowledge commands in a timely
1561      manner. For FTP, SMTP, IMAP and POP3. */
1562   CURLOPT(CURLOPT_SERVER_RESPONSE_TIMEOUT, CURLOPTTYPE_LONG, 112),
1563 
1564   /* Set this option to one of the CURL_IPRESOLVE_* defines (see below) to
1565      tell libcurl to use those IP versions only. This only has effect on
1566      systems with support for more than one, i.e IPv4 _and_ IPv6. */
1567   CURLOPT(CURLOPT_IPRESOLVE, CURLOPTTYPE_VALUES, 113),
1568 
1569   /* Set this option to limit the size of a file that is to be downloaded from
1570      an HTTP or FTP server.
1571 
1572      Note there is also _LARGE version which adds large file support for
1573      platforms which have larger off_t sizes. See MAXFILESIZE_LARGE below. */
1574   CURLOPT(CURLOPT_MAXFILESIZE, CURLOPTTYPE_LONG, 114),
1575 
1576   /* See the comment for INFILESIZE above, but in short, specifies
1577    * the size of the file being uploaded.  -1 means unknown.
1578    */
1579   CURLOPT(CURLOPT_INFILESIZE_LARGE, CURLOPTTYPE_OFF_T, 115),
1580 
1581   /* Sets the continuation offset. There is also a CURLOPTTYPE_LONG version
1582    * of this; look above for RESUME_FROM.
1583    */
1584   CURLOPT(CURLOPT_RESUME_FROM_LARGE, CURLOPTTYPE_OFF_T, 116),
1585 
1586   /* Sets the maximum size of data that is to be downloaded from
1587    * an HTTP or FTP server. See MAXFILESIZE above for the LONG version.
1588    */
1589   CURLOPT(CURLOPT_MAXFILESIZE_LARGE, CURLOPTTYPE_OFF_T, 117),
1590 
1591   /* Set this option to the filename of your .netrc file you want libcurl
1592      to parse (using the CURLOPT_NETRC option). If not set, libcurl does
1593      a poor attempt to find the user's home directory and check for a .netrc
1594      file in there. */
1595   CURLOPT(CURLOPT_NETRC_FILE, CURLOPTTYPE_STRINGPOINT, 118),
1596 
1597   /* Enable SSL/TLS for FTP, pick one of:
1598      CURLUSESSL_TRY     - try using SSL, proceed anyway otherwise
1599      CURLUSESSL_CONTROL - SSL for the control connection or fail
1600      CURLUSESSL_ALL     - SSL for all communication or fail
1601    */
1602   CURLOPT(CURLOPT_USE_SSL, CURLOPTTYPE_VALUES, 119),
1603 
1604   /* The _LARGE version of the standard POSTFIELDSIZE option */
1605   CURLOPT(CURLOPT_POSTFIELDSIZE_LARGE, CURLOPTTYPE_OFF_T, 120),
1606 
1607   /* Enable/disable the TCP Nagle algorithm */
1608   CURLOPT(CURLOPT_TCP_NODELAY, CURLOPTTYPE_LONG, 121),
1609 
1610   /* 122 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
1611   /* 123 OBSOLETE. Gone in 7.16.0 */
1612   /* 124 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
1613   /* 125 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
1614   /* 126 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
1615   /* 127 OBSOLETE. Gone in 7.16.0 */
1616   /* 128 OBSOLETE. Gone in 7.16.0 */
1617 
1618   /* When FTP over SSL/TLS is selected (with CURLOPT_USE_SSL), this option
1619      can be used to change libcurl's default action which is to first try
1620      "AUTH SSL" and then "AUTH TLS" in this order, and proceed when a OK
1621      response has been received.
1622 
1623      Available parameters are:
1624      CURLFTPAUTH_DEFAULT - let libcurl decide
1625      CURLFTPAUTH_SSL     - try "AUTH SSL" first, then TLS
1626      CURLFTPAUTH_TLS     - try "AUTH TLS" first, then SSL
1627    */
1628   CURLOPT(CURLOPT_FTPSSLAUTH, CURLOPTTYPE_VALUES, 129),
1629 
1630   CURLOPTDEPRECATED(CURLOPT_IOCTLFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 130,
1631                     7.18.0, "Use CURLOPT_SEEKFUNCTION"),
1632   CURLOPTDEPRECATED(CURLOPT_IOCTLDATA, CURLOPTTYPE_CBPOINT, 131,
1633                     7.18.0, "Use CURLOPT_SEEKDATA"),
1634 
1635   /* 132 OBSOLETE. Gone in 7.16.0 */
1636   /* 133 OBSOLETE. Gone in 7.16.0 */
1637 
1638   /* null-terminated string for pass on to the FTP server when asked for
1639      "account" info */
1640   CURLOPT(CURLOPT_FTP_ACCOUNT, CURLOPTTYPE_STRINGPOINT, 134),
1641 
1642   /* feed cookie into cookie engine */
1643   CURLOPT(CURLOPT_COOKIELIST, CURLOPTTYPE_STRINGPOINT, 135),
1644 
1645   /* ignore Content-Length */
1646   CURLOPT(CURLOPT_IGNORE_CONTENT_LENGTH, CURLOPTTYPE_LONG, 136),
1647 
1648   /* Set to non-zero to skip the IP address received in a 227 PASV FTP server
1649      response. Typically used for FTP-SSL purposes but is not restricted to
1650      that. libcurl is then instead using the same IP address it used for the
1651      control connection. */
1652   CURLOPT(CURLOPT_FTP_SKIP_PASV_IP, CURLOPTTYPE_LONG, 137),
1653 
1654   /* Select "file method" to use when doing FTP, see the curl_ftpmethod
1655      above. */
1656   CURLOPT(CURLOPT_FTP_FILEMETHOD, CURLOPTTYPE_VALUES, 138),
1657 
1658   /* Local port number to bind the socket to */
1659   CURLOPT(CURLOPT_LOCALPORT, CURLOPTTYPE_LONG, 139),
1660 
1661   /* Number of ports to try, including the first one set with LOCALPORT.
1662      Thus, setting it to 1 makes no additional attempts but the first. */
1663   CURLOPT(CURLOPT_LOCALPORTRANGE, CURLOPTTYPE_LONG, 140),
1664 
1665   /* no transfer, set up connection and let application use the socket by
1666      extracting it with CURLINFO_LASTSOCKET */
1667   CURLOPT(CURLOPT_CONNECT_ONLY, CURLOPTTYPE_LONG, 141),
1668 
1669   /* Function that is called to convert from the
1670      network encoding (instead of using the iconv calls in libcurl) */
1671   CURLOPTDEPRECATED(CURLOPT_CONV_FROM_NETWORK_FUNCTION,
1672                     CURLOPTTYPE_FUNCTIONPOINT, 142,
1673                     7.82.0, "Serves no purpose anymore"),
1674 
1675   /* Function that is called to convert to the
1676      network encoding (instead of using the iconv calls in libcurl) */
1677   CURLOPTDEPRECATED(CURLOPT_CONV_TO_NETWORK_FUNCTION,
1678                     CURLOPTTYPE_FUNCTIONPOINT, 143,
1679                     7.82.0, "Serves no purpose anymore"),
1680 
1681   /* Function that is called to convert from UTF8
1682      (instead of using the iconv calls in libcurl)
1683      Note that this is used only for SSL certificate processing */
1684   CURLOPTDEPRECATED(CURLOPT_CONV_FROM_UTF8_FUNCTION,
1685                     CURLOPTTYPE_FUNCTIONPOINT, 144,
1686                     7.82.0, "Serves no purpose anymore"),
1687 
1688   /* if the connection proceeds too quickly then need to slow it down */
1689   /* limit-rate: maximum number of bytes per second to send or receive */
1690   CURLOPT(CURLOPT_MAX_SEND_SPEED_LARGE, CURLOPTTYPE_OFF_T, 145),
1691   CURLOPT(CURLOPT_MAX_RECV_SPEED_LARGE, CURLOPTTYPE_OFF_T, 146),
1692 
1693   /* Pointer to command string to send if USER/PASS fails. */
1694   CURLOPT(CURLOPT_FTP_ALTERNATIVE_TO_USER, CURLOPTTYPE_STRINGPOINT, 147),
1695 
1696   /* callback function for setting socket options */
1697   CURLOPT(CURLOPT_SOCKOPTFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 148),
1698   CURLOPT(CURLOPT_SOCKOPTDATA, CURLOPTTYPE_CBPOINT, 149),
1699 
1700   /* set to 0 to disable session ID reuse for this transfer, default is
1701      enabled (== 1) */
1702   CURLOPT(CURLOPT_SSL_SESSIONID_CACHE, CURLOPTTYPE_LONG, 150),
1703 
1704   /* allowed SSH authentication methods */
1705   CURLOPT(CURLOPT_SSH_AUTH_TYPES, CURLOPTTYPE_VALUES, 151),
1706 
1707   /* Used by scp/sftp to do public/private key authentication */
1708   CURLOPT(CURLOPT_SSH_PUBLIC_KEYFILE, CURLOPTTYPE_STRINGPOINT, 152),
1709   CURLOPT(CURLOPT_SSH_PRIVATE_KEYFILE, CURLOPTTYPE_STRINGPOINT, 153),
1710 
1711   /* Send CCC (Clear Command Channel) after authentication */
1712   CURLOPT(CURLOPT_FTP_SSL_CCC, CURLOPTTYPE_LONG, 154),
1713 
1714   /* Same as TIMEOUT and CONNECTTIMEOUT, but with ms resolution */
1715   CURLOPT(CURLOPT_TIMEOUT_MS, CURLOPTTYPE_LONG, 155),
1716   CURLOPT(CURLOPT_CONNECTTIMEOUT_MS, CURLOPTTYPE_LONG, 156),
1717 
1718   /* set to zero to disable the libcurl's decoding and thus pass the raw body
1719      data to the application even when it is encoded/compressed */
1720   CURLOPT(CURLOPT_HTTP_TRANSFER_DECODING, CURLOPTTYPE_LONG, 157),
1721   CURLOPT(CURLOPT_HTTP_CONTENT_DECODING, CURLOPTTYPE_LONG, 158),
1722 
1723   /* Permission used when creating new files and directories on the remote
1724      server for protocols that support it, SFTP/SCP/FILE */
1725   CURLOPT(CURLOPT_NEW_FILE_PERMS, CURLOPTTYPE_LONG, 159),
1726   CURLOPT(CURLOPT_NEW_DIRECTORY_PERMS, CURLOPTTYPE_LONG, 160),
1727 
1728   /* Set the behavior of POST when redirecting. Values must be set to one
1729      of CURL_REDIR* defines below. This used to be called CURLOPT_POST301 */
1730   CURLOPT(CURLOPT_POSTREDIR, CURLOPTTYPE_VALUES, 161),
1731 
1732   /* used by scp/sftp to verify the host's public key */
1733   CURLOPT(CURLOPT_SSH_HOST_PUBLIC_KEY_MD5, CURLOPTTYPE_STRINGPOINT, 162),
1734 
1735   /* Callback function for opening socket (instead of socket(2)). Optionally,
1736      callback is able change the address or refuse to connect returning
1737      CURL_SOCKET_BAD. The callback should have type
1738      curl_opensocket_callback */
1739   CURLOPT(CURLOPT_OPENSOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 163),
1740   CURLOPT(CURLOPT_OPENSOCKETDATA, CURLOPTTYPE_CBPOINT, 164),
1741 
1742   /* POST volatile input fields. */
1743   CURLOPT(CURLOPT_COPYPOSTFIELDS, CURLOPTTYPE_OBJECTPOINT, 165),
1744 
1745   /* set transfer mode (;type=<a|i>) when doing FTP via an HTTP proxy */
1746   CURLOPT(CURLOPT_PROXY_TRANSFER_MODE, CURLOPTTYPE_LONG, 166),
1747 
1748   /* Callback function for seeking in the input stream */
1749   CURLOPT(CURLOPT_SEEKFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 167),
1750   CURLOPT(CURLOPT_SEEKDATA, CURLOPTTYPE_CBPOINT, 168),
1751 
1752   /* CRL file */
1753   CURLOPT(CURLOPT_CRLFILE, CURLOPTTYPE_STRINGPOINT, 169),
1754 
1755   /* Issuer certificate */
1756   CURLOPT(CURLOPT_ISSUERCERT, CURLOPTTYPE_STRINGPOINT, 170),
1757 
1758   /* (IPv6) Address scope */
1759   CURLOPT(CURLOPT_ADDRESS_SCOPE, CURLOPTTYPE_LONG, 171),
1760 
1761   /* Collect certificate chain info and allow it to get retrievable with
1762      CURLINFO_CERTINFO after the transfer is complete. */
1763   CURLOPT(CURLOPT_CERTINFO, CURLOPTTYPE_LONG, 172),
1764 
1765   /* "name" and "pwd" to use when fetching. */
1766   CURLOPT(CURLOPT_USERNAME, CURLOPTTYPE_STRINGPOINT, 173),
1767   CURLOPT(CURLOPT_PASSWORD, CURLOPTTYPE_STRINGPOINT, 174),
1768 
1769     /* "name" and "pwd" to use with Proxy when fetching. */
1770   CURLOPT(CURLOPT_PROXYUSERNAME, CURLOPTTYPE_STRINGPOINT, 175),
1771   CURLOPT(CURLOPT_PROXYPASSWORD, CURLOPTTYPE_STRINGPOINT, 176),
1772 
1773   /* Comma separated list of hostnames defining no-proxy zones. These should
1774      match both hostnames directly, and hostnames within a domain. For
1775      example, local.com matches local.com and www.local.com, but NOT
1776      notlocal.com or www.notlocal.com. For compatibility with other
1777      implementations of this, .local.com is considered to be the same as
1778      local.com. A single * is the only valid wildcard, and effectively
1779      disables the use of proxy. */
1780   CURLOPT(CURLOPT_NOPROXY, CURLOPTTYPE_STRINGPOINT, 177),
1781 
1782   /* block size for TFTP transfers */
1783   CURLOPT(CURLOPT_TFTP_BLKSIZE, CURLOPTTYPE_LONG, 178),
1784 
1785   /* Socks Service */
1786   /* DEPRECATED, do not use! */
1787   CURLOPTDEPRECATED(CURLOPT_SOCKS5_GSSAPI_SERVICE,
1788                     CURLOPTTYPE_STRINGPOINT, 179,
1789                     7.49.0, "Use CURLOPT_PROXY_SERVICE_NAME"),
1790 
1791   /* Socks Service */
1792   CURLOPT(CURLOPT_SOCKS5_GSSAPI_NEC, CURLOPTTYPE_LONG, 180),
1793 
1794   /* set the bitmask for the protocols that are allowed to be used for the
1795      transfer, which thus helps the app which takes URLs from users or other
1796      external inputs and want to restrict what protocol(s) to deal
1797      with. Defaults to CURLPROTO_ALL. */
1798   CURLOPTDEPRECATED(CURLOPT_PROTOCOLS, CURLOPTTYPE_LONG, 181,
1799                     7.85.0, "Use CURLOPT_PROTOCOLS_STR"),
1800 
1801   /* set the bitmask for the protocols that libcurl is allowed to follow to,
1802      as a subset of the CURLOPT_PROTOCOLS ones. That means the protocol needs
1803      to be set in both bitmasks to be allowed to get redirected to. */
1804   CURLOPTDEPRECATED(CURLOPT_REDIR_PROTOCOLS, CURLOPTTYPE_LONG, 182,
1805                     7.85.0, "Use CURLOPT_REDIR_PROTOCOLS_STR"),
1806 
1807   /* set the SSH knownhost filename to use */
1808   CURLOPT(CURLOPT_SSH_KNOWNHOSTS, CURLOPTTYPE_STRINGPOINT, 183),
1809 
1810   /* set the SSH host key callback, must point to a curl_sshkeycallback
1811      function */
1812   CURLOPT(CURLOPT_SSH_KEYFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 184),
1813 
1814   /* set the SSH host key callback custom pointer */
1815   CURLOPT(CURLOPT_SSH_KEYDATA, CURLOPTTYPE_CBPOINT, 185),
1816 
1817   /* set the SMTP mail originator */
1818   CURLOPT(CURLOPT_MAIL_FROM, CURLOPTTYPE_STRINGPOINT, 186),
1819 
1820   /* set the list of SMTP mail receiver(s) */
1821   CURLOPT(CURLOPT_MAIL_RCPT, CURLOPTTYPE_SLISTPOINT, 187),
1822 
1823   /* FTP: send PRET before PASV */
1824   CURLOPT(CURLOPT_FTP_USE_PRET, CURLOPTTYPE_LONG, 188),
1825 
1826   /* RTSP request method (OPTIONS, SETUP, PLAY, etc...) */
1827   CURLOPT(CURLOPT_RTSP_REQUEST, CURLOPTTYPE_VALUES, 189),
1828 
1829   /* The RTSP session identifier */
1830   CURLOPT(CURLOPT_RTSP_SESSION_ID, CURLOPTTYPE_STRINGPOINT, 190),
1831 
1832   /* The RTSP stream URI */
1833   CURLOPT(CURLOPT_RTSP_STREAM_URI, CURLOPTTYPE_STRINGPOINT, 191),
1834 
1835   /* The Transport: header to use in RTSP requests */
1836   CURLOPT(CURLOPT_RTSP_TRANSPORT, CURLOPTTYPE_STRINGPOINT, 192),
1837 
1838   /* Manually initialize the client RTSP CSeq for this handle */
1839   CURLOPT(CURLOPT_RTSP_CLIENT_CSEQ, CURLOPTTYPE_LONG, 193),
1840 
1841   /* Manually initialize the server RTSP CSeq for this handle */
1842   CURLOPT(CURLOPT_RTSP_SERVER_CSEQ, CURLOPTTYPE_LONG, 194),
1843 
1844   /* The stream to pass to INTERLEAVEFUNCTION. */
1845   CURLOPT(CURLOPT_INTERLEAVEDATA, CURLOPTTYPE_CBPOINT, 195),
1846 
1847   /* Let the application define a custom write method for RTP data */
1848   CURLOPT(CURLOPT_INTERLEAVEFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 196),
1849 
1850   /* Turn on wildcard matching */
1851   CURLOPT(CURLOPT_WILDCARDMATCH, CURLOPTTYPE_LONG, 197),
1852 
1853   /* Directory matching callback called before downloading of an
1854      individual file (chunk) started */
1855   CURLOPT(CURLOPT_CHUNK_BGN_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 198),
1856 
1857   /* Directory matching callback called after the file (chunk)
1858      was downloaded, or skipped */
1859   CURLOPT(CURLOPT_CHUNK_END_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 199),
1860 
1861   /* Change match (fnmatch-like) callback for wildcard matching */
1862   CURLOPT(CURLOPT_FNMATCH_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 200),
1863 
1864   /* Let the application define custom chunk data pointer */
1865   CURLOPT(CURLOPT_CHUNK_DATA, CURLOPTTYPE_CBPOINT, 201),
1866 
1867   /* FNMATCH_FUNCTION user pointer */
1868   CURLOPT(CURLOPT_FNMATCH_DATA, CURLOPTTYPE_CBPOINT, 202),
1869 
1870   /* send linked-list of name:port:address sets */
1871   CURLOPT(CURLOPT_RESOLVE, CURLOPTTYPE_SLISTPOINT, 203),
1872 
1873   /* Set a username for authenticated TLS */
1874   CURLOPTDEPRECATED(CURLOPT_TLSAUTH_USERNAME, CURLOPTTYPE_STRINGPOINT, 204,
1875                     8.22.0, "Support was removed"),
1876 
1877   /* Set a password for authenticated TLS */
1878   CURLOPTDEPRECATED(CURLOPT_TLSAUTH_PASSWORD, CURLOPTTYPE_STRINGPOINT, 205,
1879                     8.22.0, "Support was removed"),
1880 
1881   /* Set authentication type for authenticated TLS */
1882   CURLOPTDEPRECATED(CURLOPT_TLSAUTH_TYPE, CURLOPTTYPE_STRINGPOINT, 206,
1883                     8.22.0, "Support was removed"),
1884 
1885   /* Set to 1 to enable the "TE:" header in HTTP requests to ask for
1886      compressed transfer-encoded responses. Set to 0 to disable the use of TE:
1887      in outgoing requests. The current default is 0, but it might change in a
1888      future libcurl release.
1889 
1890      libcurl asks for the compressed methods it knows of, and if that
1891      is not any, it does not ask for transfer-encoding at all even if this
1892      option is set to 1. */
1893   CURLOPT(CURLOPT_TRANSFER_ENCODING, CURLOPTTYPE_LONG, 207),
1894 
1895   /* Callback function for closing socket (instead of close(2)). The callback
1896      should have type curl_closesocket_callback */
1897   CURLOPT(CURLOPT_CLOSESOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 208),
1898   CURLOPT(CURLOPT_CLOSESOCKETDATA, CURLOPTTYPE_CBPOINT, 209),
1899 
1900   /* allow GSSAPI credential delegation */
1901   CURLOPT(CURLOPT_GSSAPI_DELEGATION, CURLOPTTYPE_VALUES, 210),
1902 
1903   /* Set the name servers to use for DNS resolution.
1904    * Only supported by the c-ares DNS backend */
1905   CURLOPT(CURLOPT_DNS_SERVERS, CURLOPTTYPE_STRINGPOINT, 211),
1906 
1907   /* Time-out accept operations (currently for FTP only) after this amount
1908      of milliseconds. */
1909   CURLOPT(CURLOPT_ACCEPTTIMEOUT_MS, CURLOPTTYPE_LONG, 212),
1910 
1911   /* Set TCP keepalive */
1912   CURLOPT(CURLOPT_TCP_KEEPALIVE, CURLOPTTYPE_LONG, 213),
1913 
1914   /* non-universal keepalive knobs (Linux, AIX, HP-UX, more) */
1915   CURLOPT(CURLOPT_TCP_KEEPIDLE, CURLOPTTYPE_LONG, 214),
1916   CURLOPT(CURLOPT_TCP_KEEPINTVL, CURLOPTTYPE_LONG, 215),
1917 
1918   /* Enable/disable specific SSL features with a bitmask, see CURLSSLOPT_* */
1919   CURLOPT(CURLOPT_SSL_OPTIONS, CURLOPTTYPE_VALUES, 216),
1920 
1921   /* Set the SMTP auth originator */
1922   CURLOPT(CURLOPT_MAIL_AUTH, CURLOPTTYPE_STRINGPOINT, 217),
1923 
1924   /* Enable/disable SASL initial response */
1925   CURLOPT(CURLOPT_SASL_IR, CURLOPTTYPE_LONG, 218),
1926 
1927   /* Function that is called instead of the internal progress display
1928    * function. This function should be defined as the curl_xferinfo_callback
1929    * prototype defines. (Deprecates CURLOPT_PROGRESSFUNCTION) */
1930   CURLOPT(CURLOPT_XFERINFOFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 219),
1931 
1932   /* The XOAUTH2 bearer token */
1933   CURLOPT(CURLOPT_XOAUTH2_BEARER, CURLOPTTYPE_STRINGPOINT, 220),
1934 
1935   /* Set the interface string to use as outgoing network
1936    * interface for DNS requests.
1937    * Only supported by the c-ares DNS backend */
1938   CURLOPT(CURLOPT_DNS_INTERFACE, CURLOPTTYPE_STRINGPOINT, 221),
1939 
1940   /* Set the local IPv4 address to use for outgoing DNS requests.
1941    * Only supported by the c-ares DNS backend */
1942   CURLOPT(CURLOPT_DNS_LOCAL_IP4, CURLOPTTYPE_STRINGPOINT, 222),
1943 
1944   /* Set the local IPv6 address to use for outgoing DNS requests.
1945    * Only supported by the c-ares DNS backend */
1946   CURLOPT(CURLOPT_DNS_LOCAL_IP6, CURLOPTTYPE_STRINGPOINT, 223),
1947 
1948   /* Set authentication options directly */
1949   CURLOPT(CURLOPT_LOGIN_OPTIONS, CURLOPTTYPE_STRINGPOINT, 224),
1950 
1951   /* Enable/disable TLS NPN extension (http2 over SSL might fail without) */
1952   CURLOPTDEPRECATED(CURLOPT_SSL_ENABLE_NPN, CURLOPTTYPE_LONG, 225,
1953                     7.86.0, "Has no function"),
1954 
1955   /* Enable/disable TLS ALPN extension (http2 over SSL might fail without) */
1956   CURLOPT(CURLOPT_SSL_ENABLE_ALPN, CURLOPTTYPE_LONG, 226),
1957 
1958   /* Time to wait for a response to an HTTP request containing an
1959    * Expect: 100-continue header before sending the data anyway. */
1960   CURLOPT(CURLOPT_EXPECT_100_TIMEOUT_MS, CURLOPTTYPE_LONG, 227),
1961 
1962   /* This points to a linked list of headers used for proxy requests only,
1963      struct curl_slist kind */
1964   CURLOPT(CURLOPT_PROXYHEADER, CURLOPTTYPE_SLISTPOINT, 228),
1965 
1966   /* Pass in a bitmask of "header options" */
1967   CURLOPT(CURLOPT_HEADEROPT, CURLOPTTYPE_VALUES, 229),
1968 
1969   /* The public key used to validate the peer public key */
1970   CURLOPT(CURLOPT_PINNEDPUBLICKEY, CURLOPTTYPE_STRINGPOINT, 230),
1971 
1972   /* Path to Unix domain socket */
1973   CURLOPT(CURLOPT_UNIX_SOCKET_PATH, CURLOPTTYPE_STRINGPOINT, 231),
1974 
1975   /* Set if we should verify the certificate status. */
1976   CURLOPT(CURLOPT_SSL_VERIFYSTATUS, CURLOPTTYPE_LONG, 232),
1977 
1978   /* Set if we should enable TLS false start. */
1979   CURLOPTDEPRECATED(CURLOPT_SSL_FALSESTART, CURLOPTTYPE_LONG, 233,
1980                     8.15.0, "Has no function"),
1981 
1982   /* Do not squash dot-dot sequences */
1983   CURLOPT(CURLOPT_PATH_AS_IS, CURLOPTTYPE_LONG, 234),
1984 
1985   /* Proxy Service Name */
1986   CURLOPT(CURLOPT_PROXY_SERVICE_NAME, CURLOPTTYPE_STRINGPOINT, 235),
1987 
1988   /* Service Name */
1989   CURLOPT(CURLOPT_SERVICE_NAME, CURLOPTTYPE_STRINGPOINT, 236),
1990 
1991   /* Wait/do not wait for pipe/mutex to clarify */
1992   CURLOPT(CURLOPT_PIPEWAIT, CURLOPTTYPE_LONG, 237),
1993 
1994   /* Set the protocol used when curl is given a URL without a protocol */
1995   CURLOPT(CURLOPT_DEFAULT_PROTOCOL, CURLOPTTYPE_STRINGPOINT, 238),
1996 
1997   /* Set stream weight, 1 - 256 (default is 16) */
1998   CURLOPT(CURLOPT_STREAM_WEIGHT, CURLOPTTYPE_LONG, 239),
1999 
2000   /* Set stream dependency on another curl handle */
2001   CURLOPTDEPRECATED(CURLOPT_STREAM_DEPENDS, CURLOPTTYPE_OBJECTPOINT, 240,
2002                     8.21.0, "Has no function"),
2003 
2004   /* Set E-xclusive stream dependency on another curl handle */
2005   CURLOPTDEPRECATED(CURLOPT_STREAM_DEPENDS_E, CURLOPTTYPE_OBJECTPOINT, 241,
2006                     8.21.0, "Has no function"),
2007 
2008   /* Do not send any tftp option requests to the server */
2009   CURLOPT(CURLOPT_TFTP_NO_OPTIONS, CURLOPTTYPE_LONG, 242),
2010 
2011   /* Linked-list of host:port:connect-to-host:connect-to-port,
2012      overrides the URL's host:port (only for the network layer) */
2013   CURLOPT(CURLOPT_CONNECT_TO, CURLOPTTYPE_SLISTPOINT, 243),
2014 
2015   /* Set TCP Fast Open */
2016   CURLOPT(CURLOPT_TCP_FASTOPEN, CURLOPTTYPE_LONG, 244),
2017 
2018   /* Continue to send data if the server responds early with an
2019    * HTTP status code >= 300 */
2020   CURLOPT(CURLOPT_KEEP_SENDING_ON_ERROR, CURLOPTTYPE_LONG, 245),
2021 
2022   /* The CApath or CAfile used to validate the proxy certificate
2023      this option is used only if PROXY_SSL_VERIFYPEER is true */
2024   CURLOPT(CURLOPT_PROXY_CAINFO, CURLOPTTYPE_STRINGPOINT, 246),
2025 
2026   /* The CApath directory used to validate the proxy certificate
2027      this option is used only if PROXY_SSL_VERIFYPEER is true */
2028   CURLOPT(CURLOPT_PROXY_CAPATH, CURLOPTTYPE_STRINGPOINT, 247),
2029 
2030   /* Set if we should verify the proxy in SSL handshake,
2031      set 1 to verify. */
2032   CURLOPT(CURLOPT_PROXY_SSL_VERIFYPEER, CURLOPTTYPE_LONG, 248),
2033 
2034   /* Set if we should verify the Common name from the proxy certificate in SSL
2035    * handshake, set 1 to check existence, 2 to ensure that it matches
2036    * the provided hostname. */
2037   CURLOPT(CURLOPT_PROXY_SSL_VERIFYHOST, CURLOPTTYPE_LONG, 249),
2038 
2039   /* What version to specifically try to use for proxy.
2040      See CURL_SSLVERSION defines below. */
2041   CURLOPT(CURLOPT_PROXY_SSLVERSION, CURLOPTTYPE_VALUES, 250),
2042 
2043   /* Set a username for authenticated TLS for proxy */
2044   CURLOPTDEPRECATED(CURLOPT_PROXY_TLSAUTH_USERNAME, CURLOPTTYPE_STRINGPOINT,
2045                     251, 8.22.0, "Support was removed"),
2046 
2047   /* Set a password for authenticated TLS for proxy */
2048   CURLOPTDEPRECATED(CURLOPT_PROXY_TLSAUTH_PASSWORD, CURLOPTTYPE_STRINGPOINT,
2049                     252, 8.22.0, "Support was removed"),
2050 
2051   /* Set authentication type for authenticated TLS for proxy */
2052   CURLOPTDEPRECATED(CURLOPT_PROXY_TLSAUTH_TYPE, CURLOPTTYPE_STRINGPOINT, 253,
2053                     8.22.0, "Support was removed"),
2054 
2055   /* name of the file keeping your private SSL-certificate for proxy */
2056   CURLOPT(CURLOPT_PROXY_SSLCERT, CURLOPTTYPE_STRINGPOINT, 254),
2057 
2058   /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") for
2059      proxy */
2060   CURLOPT(CURLOPT_PROXY_SSLCERTTYPE, CURLOPTTYPE_STRINGPOINT, 255),
2061 
2062   /* name of the file keeping your private SSL-key for proxy */
2063   CURLOPT(CURLOPT_PROXY_SSLKEY, CURLOPTTYPE_STRINGPOINT, 256),
2064 
2065   /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") for
2066      proxy */
2067   CURLOPT(CURLOPT_PROXY_SSLKEYTYPE, CURLOPTTYPE_STRINGPOINT, 257),
2068 
2069   /* password for the SSL private key for proxy */
2070   CURLOPT(CURLOPT_PROXY_KEYPASSWD, CURLOPTTYPE_STRINGPOINT, 258),
2071 
2072   /* Specify which TLS 1.2 (1.1, 1.0) ciphers to use for proxy */
2073   CURLOPT(CURLOPT_PROXY_SSL_CIPHER_LIST, CURLOPTTYPE_STRINGPOINT, 259),
2074 
2075   /* CRL file for proxy */
2076   CURLOPT(CURLOPT_PROXY_CRLFILE, CURLOPTTYPE_STRINGPOINT, 260),
2077 
2078   /* Enable/disable specific SSL features with a bitmask for proxy, see
2079      CURLSSLOPT_* */
2080   CURLOPT(CURLOPT_PROXY_SSL_OPTIONS, CURLOPTTYPE_LONG, 261),
2081 
2082   /* Name of pre proxy to use. */
2083   CURLOPT(CURLOPT_PRE_PROXY, CURLOPTTYPE_STRINGPOINT, 262),
2084 
2085   /* The public key in DER form used to validate the proxy public key
2086      this option is used only if PROXY_SSL_VERIFYPEER is true */
2087   CURLOPT(CURLOPT_PROXY_PINNEDPUBLICKEY, CURLOPTTYPE_STRINGPOINT, 263),
2088 
2089   /* Path to an abstract Unix domain socket */
2090   CURLOPT(CURLOPT_ABSTRACT_UNIX_SOCKET, CURLOPTTYPE_STRINGPOINT, 264),
2091 
2092   /* Suppress proxy CONNECT response headers from user callbacks */
2093   CURLOPT(CURLOPT_SUPPRESS_CONNECT_HEADERS, CURLOPTTYPE_LONG, 265),
2094 
2095   /* The request target, instead of extracted from the URL */
2096   CURLOPT(CURLOPT_REQUEST_TARGET, CURLOPTTYPE_STRINGPOINT, 266),
2097 
2098   /* bitmask of allowed auth methods for connections to SOCKS5 proxies */
2099   CURLOPT(CURLOPT_SOCKS5_AUTH, CURLOPTTYPE_LONG, 267),
2100 
2101   /* Enable/disable SSH compression */
2102   CURLOPT(CURLOPT_SSH_COMPRESSION, CURLOPTTYPE_LONG, 268),
2103 
2104   /* Post MIME data. */
2105   CURLOPT(CURLOPT_MIMEPOST, CURLOPTTYPE_OBJECTPOINT, 269),
2106 
2107   /* Time to use with the CURLOPT_TIMECONDITION. Specified in number of
2108      seconds since 1 Jan 1970. */
2109   CURLOPT(CURLOPT_TIMEVALUE_LARGE, CURLOPTTYPE_OFF_T, 270),
2110 
2111   /* Head start in milliseconds to give happy eyeballs. */
2112   CURLOPT(CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS, CURLOPTTYPE_LONG, 271),
2113 
2114   /* Function that is called before a resolver request is made */
2115   CURLOPT(CURLOPT_RESOLVER_START_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 272),
2116 
2117   /* User data to pass to the resolver start callback. */
2118   CURLOPT(CURLOPT_RESOLVER_START_DATA, CURLOPTTYPE_CBPOINT, 273),
2119 
2120   /* send HAProxy PROXY protocol header? */
2121   CURLOPT(CURLOPT_HAPROXYPROTOCOL, CURLOPTTYPE_LONG, 274),
2122 
2123   /* shuffle addresses before use when DNS returns multiple */
2124   CURLOPT(CURLOPT_DNS_SHUFFLE_ADDRESSES, CURLOPTTYPE_LONG, 275),
2125 
2126   /* Specify which TLS 1.3 ciphers suites to use */
2127   CURLOPT(CURLOPT_TLS13_CIPHERS, CURLOPTTYPE_STRINGPOINT, 276),
2128   CURLOPT(CURLOPT_PROXY_TLS13_CIPHERS, CURLOPTTYPE_STRINGPOINT, 277),
2129 
2130   /* Disallow specifying username/login in URL. */
2131   CURLOPT(CURLOPT_DISALLOW_USERNAME_IN_URL, CURLOPTTYPE_LONG, 278),
2132 
2133   /* DNS-over-HTTPS URL */
2134   CURLOPT(CURLOPT_DOH_URL, CURLOPTTYPE_STRINGPOINT, 279),
2135 
2136   /* Preferred buffer size to use for uploads */
2137   CURLOPT(CURLOPT_UPLOAD_BUFFERSIZE, CURLOPTTYPE_LONG, 280),
2138 
2139   /* Time in ms between connection upkeep calls for long-lived connections. */
2140   CURLOPT(CURLOPT_UPKEEP_INTERVAL_MS, CURLOPTTYPE_LONG, 281),
2141 
2142   /* Specify URL using CURL URL API. */
2143   CURLOPT(CURLOPT_CURLU, CURLOPTTYPE_OBJECTPOINT, 282),
2144 
2145   /* add trailing data after no more data is available */
2146   CURLOPT(CURLOPT_TRAILERFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 283),
2147 
2148   /* pointer to be passed to HTTP_TRAILER_FUNCTION */
2149   CURLOPT(CURLOPT_TRAILERDATA, CURLOPTTYPE_CBPOINT, 284),
2150 
2151   /* set this to 1L to allow HTTP/0.9 responses or 0L to disallow */
2152   CURLOPT(CURLOPT_HTTP09_ALLOWED, CURLOPTTYPE_LONG, 285),
2153 
2154   /* alt-svc control bitmask */
2155   CURLOPT(CURLOPT_ALTSVC_CTRL, CURLOPTTYPE_LONG, 286),
2156 
2157   /* alt-svc cache filename to possibly read from/write to */
2158   CURLOPT(CURLOPT_ALTSVC, CURLOPTTYPE_STRINGPOINT, 287),
2159 
2160   /* maximum age (idle time) of a connection to consider it for reuse
2161    * (in seconds) */
2162   CURLOPT(CURLOPT_MAXAGE_CONN, CURLOPTTYPE_LONG, 288),
2163 
2164   /* SASL authorization identity */
2165   CURLOPT(CURLOPT_SASL_AUTHZID, CURLOPTTYPE_STRINGPOINT, 289),
2166 
2167   /* allow RCPT TO command to fail for some recipients */
2168   CURLOPT(CURLOPT_MAIL_RCPT_ALLOWFAILS, CURLOPTTYPE_LONG, 290),
2169 
2170   /* the private SSL-certificate as a "blob" */
2171   CURLOPT(CURLOPT_SSLCERT_BLOB, CURLOPTTYPE_BLOB, 291),
2172   CURLOPT(CURLOPT_SSLKEY_BLOB, CURLOPTTYPE_BLOB, 292),
2173   CURLOPT(CURLOPT_PROXY_SSLCERT_BLOB, CURLOPTTYPE_BLOB, 293),
2174   CURLOPT(CURLOPT_PROXY_SSLKEY_BLOB, CURLOPTTYPE_BLOB, 294),
2175   CURLOPT(CURLOPT_ISSUERCERT_BLOB, CURLOPTTYPE_BLOB, 295),
2176 
2177   /* Issuer certificate for proxy */
2178   CURLOPT(CURLOPT_PROXY_ISSUERCERT, CURLOPTTYPE_STRINGPOINT, 296),
2179   CURLOPT(CURLOPT_PROXY_ISSUERCERT_BLOB, CURLOPTTYPE_BLOB, 297),
2180 
2181   /* the EC curves requested by the TLS client (RFC 8422, 5.1);
2182    * OpenSSL support via 'set_groups'/'set_curves':
2183    * https://docs.openssl.org/master/man3/SSL_CTX_set1_curves/
2184    */
2185   CURLOPT(CURLOPT_SSL_EC_CURVES, CURLOPTTYPE_STRINGPOINT, 298),
2186 
2187   /* HSTS bitmask */
2188   CURLOPT(CURLOPT_HSTS_CTRL, CURLOPTTYPE_LONG, 299),
2189   /* HSTS filename */
2190   CURLOPT(CURLOPT_HSTS, CURLOPTTYPE_STRINGPOINT, 300),
2191 
2192   /* HSTS read callback */
2193   CURLOPT(CURLOPT_HSTSREADFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 301),
2194   CURLOPT(CURLOPT_HSTSREADDATA, CURLOPTTYPE_CBPOINT, 302),
2195 
2196   /* HSTS write callback */
2197   CURLOPT(CURLOPT_HSTSWRITEFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 303),
2198   CURLOPT(CURLOPT_HSTSWRITEDATA, CURLOPTTYPE_CBPOINT, 304),
2199 
2200   /* Parameters for V4 signature */
2201   CURLOPT(CURLOPT_AWS_SIGV4, CURLOPTTYPE_STRINGPOINT, 305),
2202 
2203   /* Same as CURLOPT_SSL_VERIFYPEER but for DoH (DNS-over-HTTPS) servers. */
2204   CURLOPT(CURLOPT_DOH_SSL_VERIFYPEER, CURLOPTTYPE_LONG, 306),
2205 
2206   /* Same as CURLOPT_SSL_VERIFYHOST but for DoH (DNS-over-HTTPS) servers. */
2207   CURLOPT(CURLOPT_DOH_SSL_VERIFYHOST, CURLOPTTYPE_LONG, 307),
2208 
2209   /* Same as CURLOPT_SSL_VERIFYSTATUS but for DoH (DNS-over-HTTPS) servers. */
2210   CURLOPT(CURLOPT_DOH_SSL_VERIFYSTATUS, CURLOPTTYPE_LONG, 308),
2211 
2212   /* The CA certificates as "blob" used to validate the peer certificate
2213      this option is used only if SSL_VERIFYPEER is true */
2214   CURLOPT(CURLOPT_CAINFO_BLOB, CURLOPTTYPE_BLOB, 309),
2215 
2216   /* The CA certificates as "blob" used to validate the proxy certificate
2217      this option is used only if PROXY_SSL_VERIFYPEER is true */
2218   CURLOPT(CURLOPT_PROXY_CAINFO_BLOB, CURLOPTTYPE_BLOB, 310),
2219 
2220   /* used by scp/sftp to verify the host's public key */
2221   CURLOPT(CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256, CURLOPTTYPE_STRINGPOINT, 311),
2222 
2223   /* Function that is called immediately before the initial request
2224      is made on a connection (after any protocol negotiation step). */
2225   CURLOPT(CURLOPT_PREREQFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 312),
2226 
2227   /* Data passed to the CURLOPT_PREREQFUNCTION callback */
2228   CURLOPT(CURLOPT_PREREQDATA, CURLOPTTYPE_CBPOINT, 313),
2229 
2230   /* maximum age (since creation) of a connection to consider it for reuse
2231    * (in seconds) */
2232   CURLOPT(CURLOPT_MAXLIFETIME_CONN, CURLOPTTYPE_LONG, 314),
2233 
2234   /* Set MIME option flags. */
2235   CURLOPT(CURLOPT_MIME_OPTIONS, CURLOPTTYPE_LONG, 315),
2236 
2237   /* set the SSH host key callback, must point to a curl_sshkeycallback
2238      function */
2239   CURLOPT(CURLOPT_SSH_HOSTKEYFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 316),
2240 
2241   /* set the SSH host key callback custom pointer */
2242   CURLOPT(CURLOPT_SSH_HOSTKEYDATA, CURLOPTTYPE_CBPOINT, 317),
2243 
2244   /* specify which protocols that are allowed to be used for the transfer,
2245      which thus helps the app which takes URLs from users or other external
2246      inputs and want to restrict what protocol(s) to deal with. Defaults to
2247      all built-in protocols. */
2248   CURLOPT(CURLOPT_PROTOCOLS_STR, CURLOPTTYPE_STRINGPOINT, 318),
2249 
2250   /* specify which protocols that libcurl is allowed to follow directs to */
2251   CURLOPT(CURLOPT_REDIR_PROTOCOLS_STR, CURLOPTTYPE_STRINGPOINT, 319),
2252 
2253   /* WebSockets options */
2254   CURLOPT(CURLOPT_WS_OPTIONS, CURLOPTTYPE_LONG, 320),
2255 
2256   /* CA cache timeout */
2257   CURLOPT(CURLOPT_CA_CACHE_TIMEOUT, CURLOPTTYPE_LONG, 321),
2258 
2259   /* Can leak things, gonna exit() soon */
2260   CURLOPT(CURLOPT_QUICK_EXIT, CURLOPTTYPE_LONG, 322),
2261 
2262   /* set a specific client IP for HAProxy PROXY protocol header? */
2263   CURLOPT(CURLOPT_HAPROXY_CLIENT_IP, CURLOPTTYPE_STRINGPOINT, 323),
2264 
2265   /* millisecond version */
2266   CURLOPT(CURLOPT_SERVER_RESPONSE_TIMEOUT_MS, CURLOPTTYPE_LONG, 324),
2267 
2268   /* set ECH configuration */
2269   CURLOPT(CURLOPT_ECH, CURLOPTTYPE_STRINGPOINT, 325),
2270 
2271   /* maximum number of keepalive probes (Linux, *BSD, macOS, etc.) */
2272   CURLOPT(CURLOPT_TCP_KEEPCNT, CURLOPTTYPE_LONG, 326),
2273 
2274   CURLOPT(CURLOPT_UPLOAD_FLAGS, CURLOPTTYPE_LONG, 327),
2275 
2276   /* set TLS supported signature algorithms */
2277   CURLOPT(CURLOPT_SSL_SIGNATURE_ALGORITHMS, CURLOPTTYPE_STRINGPOINT, 328),
2278 
2279   /* RFC 9421 HTTP Message Signatures algorithm */
2280   CURLOPT(CURLOPT_HTTPSIG_ALGORITHM, CURLOPTTYPE_VALUES, 329),
2281 
2282   /* Hex-encoded key for HTTP Message Signatures */
2283   CURLOPT(CURLOPT_HTTPSIG_KEY, CURLOPTTYPE_STRINGPOINT, 330),
2284 
2285   /* Key identifier for HTTP Message Signatures */
2286   CURLOPT(CURLOPT_HTTPSIG_KEYID, CURLOPTTYPE_STRINGPOINT, 331),
2287 
2288   /* Space-separated list of components to sign for HTTP Message Signatures */
2289   CURLOPT(CURLOPT_HTTPSIG_HEADERS, CURLOPTTYPE_STRINGPOINT, 332),
2290 
2291   CURLOPT_LASTENTRY /* the last unused */
2292 } CURLoption;
2293 
2294 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all
2295                           the obsolete stuff removed! */
2296 
2297 /* Backwards compatibility with older names */
2298 /* These are scheduled to disappear by 2011 */
2299 
2300 /* This was added in version 7.19.1 */
2301 #define CURLOPT_POST301 CURLOPT_POSTREDIR
2302 
2303 /* These are scheduled to disappear by 2009 */
2304 
2305 /* The following were added in 7.17.0 */
2306 #define CURLOPT_SSLKEYPASSWD CURLOPT_KEYPASSWD
2307 #define CURLOPT_FTPAPPEND CURLOPT_APPEND
2308 #define CURLOPT_FTPLISTONLY CURLOPT_DIRLISTONLY
2309 #define CURLOPT_FTP_SSL CURLOPT_USE_SSL
2310 
2311 /* The following were added earlier */
2312 
2313 #define CURLOPT_SSLCERTPASSWD CURLOPT_KEYPASSWD
2314 #define CURLOPT_KRB4LEVEL CURLOPT_KRBLEVEL
2315 
2316 #define CURLOPT_FTP_RESPONSE_TIMEOUT CURLOPT_SERVER_RESPONSE_TIMEOUT
2317 
2318 /* Added in 8.2.0 */
2319 #define CURLOPT_MAIL_RCPT_ALLLOWFAILS CURLOPT_MAIL_RCPT_ALLOWFAILS
2320 
2321 #else
2322 /* This is set if CURL_NO_OLDIES is defined at compile-time */
2323 #undef CURLOPT_DNS_USE_GLOBAL_CACHE /* soon obsolete */
2324 #endif
2325 
2326 /* Below here follows defines for the CURLOPT_IPRESOLVE option. If a host
2327    name resolves addresses using more than one IP protocol version, this
2328    option might be handy to force libcurl to use a specific IP version. */
2329 #define CURL_IPRESOLVE_WHATEVER 0L /* default, uses addresses to all IP
2330                                      versions that your system allows */
2331 #define CURL_IPRESOLVE_V4       1L /* uses only IPv4 addresses/connections */
2332 #define CURL_IPRESOLVE_V6       2L /* uses only IPv6 addresses/connections */
2333 
2334   /* Convenient "aliases" */
2335 #define CURLOPT_RTSPHEADER CURLOPT_HTTPHEADER
2336 
2337 /* These constants are for use with the CURLOPT_HTTP_VERSION option. */
2338 #define CURL_HTTP_VERSION_NONE  0L /* setting this means we do not care, and
2339                                       that we would like the library to choose
2340                                       the best possible for us! */
2341 #define CURL_HTTP_VERSION_1_0   1L /* please use HTTP 1.0 in the request */
2342 #define CURL_HTTP_VERSION_1_1   2L /* please use HTTP 1.1 in the request */
2343 #define CURL_HTTP_VERSION_2_0   3L /* please use HTTP 2 in the request */
2344 #define CURL_HTTP_VERSION_2TLS  4L /* use version 2 for HTTPS, version 1.1 for
2345                                       HTTP */
2346 #define CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE 5L /* please use HTTP 2 without
2347                                                   HTTP/1.1 Upgrade */
2348 #define CURL_HTTP_VERSION_3     30L /* Use HTTP/3, fallback to HTTP/2 or
2349                                        HTTP/1 if needed. For HTTPS only. For
2350                                        HTTP, this option makes libcurl
2351                                        return error. */
2352 #define CURL_HTTP_VERSION_3ONLY 31L /* Use HTTP/3 without fallback. For
2353                                        HTTPS only. For HTTP, this makes
2354                                        libcurl return error. */
2355 #define CURL_HTTP_VERSION_LAST  32L /* *ILLEGAL* http version */
2356 
2357 /* Convenience definition simple because the name of the version is HTTP/2 and
2358    not 2.0. The 2_0 version of the enum name was set while the version was
2359    still planned to be 2.0 and we stick to it for compatibility. */
2360 #define CURL_HTTP_VERSION_2 CURL_HTTP_VERSION_2_0
2361 
2362 /*
2363  * Public API enums for RTSP requests
2364  */
2365 
2366 #define CURL_RTSPREQ_NONE          0L
2367 #define CURL_RTSPREQ_OPTIONS       1L
2368 #define CURL_RTSPREQ_DESCRIBE      2L
2369 #define CURL_RTSPREQ_ANNOUNCE      3L
2370 #define CURL_RTSPREQ_SETUP         4L
2371 #define CURL_RTSPREQ_PLAY          5L
2372 #define CURL_RTSPREQ_PAUSE         6L
2373 #define CURL_RTSPREQ_TEARDOWN      7L
2374 #define CURL_RTSPREQ_GET_PARAMETER 8L
2375 #define CURL_RTSPREQ_SET_PARAMETER 9L
2376 #define CURL_RTSPREQ_RECORD        10L
2377 #define CURL_RTSPREQ_RECEIVE       11L
2378 #define CURL_RTSPREQ_LAST          12L /* not used */
2379 
2380   /* These enums are for use with the CURLOPT_NETRC option. */
2381 #define CURL_NETRC_IGNORED  0L /* The .netrc is never read.
2382                                   This is the default. */
2383 #define CURL_NETRC_OPTIONAL 1L /* A user:password in the URL is preferred
2384                                   to one in the .netrc. */
2385 #define CURL_NETRC_REQUIRED 2L /* A user:password in the URL is ignored.
2386                                   Unless one is set programmatically, the
2387                                   .netrc is queried. */
2388 enum CURL_NETRC_OPTION {
2389   /* we set a single member here, to make sure we still provide the enum, but
2390      the values to use are defined above with L suffixes */
2391   CURL_NETRC_LAST = 3
2392 };
2393 
2394 #define CURL_SSLVERSION_DEFAULT 0L
2395 #define CURL_SSLVERSION_TLSv1   1L /* TLS 1.x */
2396 #define CURL_SSLVERSION_SSLv2   2L
2397 #define CURL_SSLVERSION_SSLv3   3L
2398 #define CURL_SSLVERSION_TLSv1_0 4L
2399 #define CURL_SSLVERSION_TLSv1_1 5L
2400 #define CURL_SSLVERSION_TLSv1_2 6L
2401 #define CURL_SSLVERSION_TLSv1_3 7L
2402 
2403 #define CURL_SSLVERSION_LAST    8L /* never use, keep last */
2404 
2405 #define CURL_SSLVERSION_MAX_NONE 0L
2406 #define CURL_SSLVERSION_MAX_DEFAULT (CURL_SSLVERSION_TLSv1   << 16)
2407 #define CURL_SSLVERSION_MAX_TLSv1_0 (CURL_SSLVERSION_TLSv1_0 << 16)
2408 #define CURL_SSLVERSION_MAX_TLSv1_1 (CURL_SSLVERSION_TLSv1_1 << 16)
2409 #define CURL_SSLVERSION_MAX_TLSv1_2 (CURL_SSLVERSION_TLSv1_2 << 16)
2410 #define CURL_SSLVERSION_MAX_TLSv1_3 (CURL_SSLVERSION_TLSv1_3 << 16)
2411 
2412 /* never use, keep last */
2413 #define CURL_SSLVERSION_MAX_LAST    (CURL_SSLVERSION_LAST    << 16)
2414 
2415 #define CURL_TLSAUTH_NONE 0L
2416 #define CURL_TLSAUTH_SRP  1L
2417 
2418 enum CURL_TLSAUTH {
2419   /* we set a single member here, to make sure we still provide the enum,
2420      but the values to use are defined above with L suffixes */
2421   CURL_TLSAUTH_LAST = 2
2422 };
2423 
2424 /* symbols to use with CURLOPT_POSTREDIR.
2425    CURL_REDIR_POST_301, CURL_REDIR_POST_302 and CURL_REDIR_POST_303
2426    can be bitwise ORed so that CURL_REDIR_POST_301 | CURL_REDIR_POST_302
2427    | CURL_REDIR_POST_303 == CURL_REDIR_POST_ALL */
2428 
2429 #define CURL_REDIR_GET_ALL  0L
2430 #define CURL_REDIR_POST_301 1L
2431 #define CURL_REDIR_POST_302 2L
2432 #define CURL_REDIR_POST_303 4L
2433 #define CURL_REDIR_POST_ALL \
2434   (CURL_REDIR_POST_301 | CURL_REDIR_POST_302 | CURL_REDIR_POST_303)
2435 
2436 #define CURL_TIMECOND_NONE         0L
2437 #define CURL_TIMECOND_IFMODSINCE   1L
2438 #define CURL_TIMECOND_IFUNMODSINCE 2L
2439 #define CURL_TIMECOND_LASTMOD      3L
2440 
2441 typedef enum {
2442   /* we set a single member here, to make sure we still provide
2443      the enum typedef, but the values to use are defined above with L
2444      suffixes */
2445   CURL_TIMECOND_LAST = 4
2446 } curl_TimeCond;
2447 
2448 /* Special size_t value signaling a null-terminated string. */
2449 #define CURL_ZERO_TERMINATED ((size_t)-1)
2450 
2451 /* curl_strequal() and curl_strnequal() are subject for removal in a future
2452    release */
2453 CURL_EXTERN int curl_strequal(const char *s1, const char *s2);
2454 CURL_EXTERN int curl_strnequal(const char *s1, const char *s2, size_t n);
2455 
2456 /* Mime/form handling support. */
2457 typedef struct curl_mime      curl_mime;      /* Mime context. */
2458 typedef struct curl_mimepart  curl_mimepart;  /* Mime part context. */
2459 
2460 /* CURLMIMEOPT_ defines are for the CURLOPT_MIME_OPTIONS option. */
2461 #define CURLMIMEOPT_FORMESCAPE (1L << 0) /* Use backslash-escaping for forms */
2462 
2463 /*
2464  * NAME curl_mime_init()
2465  *
2466  * DESCRIPTION
2467  *
2468  * Create a mime context and return its handle. The easy parameter is the
2469  * target handle.
2470  */
2471 CURL_EXTERN curl_mime *curl_mime_init(CURL *easy);
2472 
2473 /*
2474  * NAME curl_mime_free()
2475  *
2476  * DESCRIPTION
2477  *
2478  * release a mime handle and its substructures.
2479  */
2480 CURL_EXTERN void curl_mime_free(curl_mime *mime);
2481 
2482 /*
2483  * NAME curl_mime_addpart()
2484  *
2485  * DESCRIPTION
2486  *
2487  * Append a new empty part to the given mime context and return a handle to
2488  * the created part.
2489  */
2490 CURL_EXTERN curl_mimepart *curl_mime_addpart(curl_mime *mime);
2491 
2492 /*
2493  * NAME curl_mime_name()
2494  *
2495  * DESCRIPTION
2496  *
2497  * Set mime/form part name.
2498  */
2499 CURL_EXTERN CURLcode curl_mime_name(curl_mimepart *part, const char *name);
2500 
2501 /*
2502  * NAME curl_mime_filename()
2503  *
2504  * DESCRIPTION
2505  *
2506  * Set mime part remote filename.
2507  */
2508 CURL_EXTERN CURLcode curl_mime_filename(curl_mimepart *part,
2509                                         const char *filename);
2510 
2511 /*
2512  * NAME curl_mime_type()
2513  *
2514  * DESCRIPTION
2515  *
2516  * Set mime part type.
2517  */
2518 CURL_EXTERN CURLcode curl_mime_type(curl_mimepart *part, const char *mimetype);
2519 
2520 /*
2521  * NAME curl_mime_encoder()
2522  *
2523  * DESCRIPTION
2524  *
2525  * Set mime data transfer encoder.
2526  */
2527 CURL_EXTERN CURLcode curl_mime_encoder(curl_mimepart *part,
2528                                        const char *encoding);
2529 
2530 /*
2531  * NAME curl_mime_data()
2532  *
2533  * DESCRIPTION
2534  *
2535  * Set mime part data source from memory data,
2536  */
2537 CURL_EXTERN CURLcode curl_mime_data(curl_mimepart *part,
2538                                     const char *data, size_t datasize);
2539 
2540 /*
2541  * NAME curl_mime_filedata()
2542  *
2543  * DESCRIPTION
2544  *
2545  * Set mime part data source from named file.
2546  */
2547 CURL_EXTERN CURLcode curl_mime_filedata(curl_mimepart *part,
2548                                         const char *filename);
2549 
2550 /*
2551  * NAME curl_mime_data_cb()
2552  *
2553  * DESCRIPTION
2554  *
2555  * Set mime part data source from callback function.
2556  */
2557 CURL_EXTERN CURLcode curl_mime_data_cb(curl_mimepart *part,
2558                                        curl_off_t datasize,
2559                                        curl_read_callback readfunc,
2560                                        curl_seek_callback seekfunc,
2561                                        curl_free_callback freefunc,
2562                                        void *arg);
2563 
2564 /*
2565  * NAME curl_mime_subparts()
2566  *
2567  * DESCRIPTION
2568  *
2569  * Set mime part data source from subparts.
2570  */
2571 CURL_EXTERN CURLcode curl_mime_subparts(curl_mimepart *part,
2572                                         curl_mime *subparts);
2573 /*
2574  * NAME curl_mime_headers()
2575  *
2576  * DESCRIPTION
2577  *
2578  * Set mime part headers.
2579  */
2580 CURL_EXTERN CURLcode curl_mime_headers(curl_mimepart *part,
2581                                        struct curl_slist *headers,
2582                                        int take_ownership);
2583 
2584 typedef enum {
2585   /********* the first one is unused ************/
2586   CURLFORM_NOTHING         CURL_DEPRECATED(7.56.0, ""),
2587   CURLFORM_COPYNAME        CURL_DEPRECATED(7.56.0, "Use curl_mime_name()"),
2588   CURLFORM_PTRNAME         CURL_DEPRECATED(7.56.0, "Use curl_mime_name()"),
2589   CURLFORM_NAMELENGTH      CURL_DEPRECATED(7.56.0, ""),
2590   CURLFORM_COPYCONTENTS    CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"),
2591   CURLFORM_PTRCONTENTS     CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"),
2592   CURLFORM_CONTENTSLENGTH  CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"),
2593   CURLFORM_FILECONTENT     CURL_DEPRECATED(7.56.0, "Use curl_mime_data_cb()"),
2594   CURLFORM_ARRAY           CURL_DEPRECATED(7.56.0, ""),
2595   CURLFORM_OBSOLETE,
2596   CURLFORM_FILE            CURL_DEPRECATED(7.56.0, "Use curl_mime_filedata()"),
2597 
2598   CURLFORM_BUFFER          CURL_DEPRECATED(7.56.0, "Use curl_mime_filename()"),
2599   CURLFORM_BUFFERPTR       CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"),
2600   CURLFORM_BUFFERLENGTH    CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"),
2601 
2602   CURLFORM_CONTENTTYPE     CURL_DEPRECATED(7.56.0, "Use curl_mime_type()"),
2603   CURLFORM_CONTENTHEADER   CURL_DEPRECATED(7.56.0, "Use curl_mime_headers()"),
2604   CURLFORM_FILENAME        CURL_DEPRECATED(7.56.0, "Use curl_mime_filename()"),
2605   CURLFORM_END,
2606   CURLFORM_OBSOLETE2,
2607 
2608   CURLFORM_STREAM          CURL_DEPRECATED(7.56.0, "Use curl_mime_data_cb()"),
2609   CURLFORM_CONTENTLEN  /* added in 7.46.0, provide a curl_off_t length */
2610                            CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"),
2611 
2612   CURLFORM_LASTENTRY /* the last unused */
2613 } CURLformoption;
2614 
2615 /* structure to be used as parameter for CURLFORM_ARRAY */
2616 struct curl_forms {
2617   CURLformoption option;
2618   const char     *value;
2619 };
2620 
2621 /* use this for multipart formpost building */
2622 /* Returns code for curl_formadd()
2623  *
2624  * Returns:
2625  * CURL_FORMADD_OK             on success
2626  * CURL_FORMADD_MEMORY         if the FormInfo allocation fails
2627  * CURL_FORMADD_OPTION_TWICE   if one option is given twice for one Form
2628  * CURL_FORMADD_NULL           if a null pointer was given for a char
2629  * CURL_FORMADD_MEMORY         if the allocation of a FormInfo struct failed
2630  * CURL_FORMADD_UNKNOWN_OPTION if an unknown option was used
2631  * CURL_FORMADD_INCOMPLETE     if the some FormInfo is not complete (or error)
2632  * CURL_FORMADD_MEMORY         if a curl_httppost struct cannot be allocated
2633  * CURL_FORMADD_MEMORY         if some allocation for string copying failed.
2634  * CURL_FORMADD_ILLEGAL_ARRAY  if an illegal option is used in an array
2635  *
2636  ***************************************************************************/
2637 typedef enum {
2638   CURL_FORMADD_OK             CURL_DEPRECATED(7.56.0, ""), /* 1st, no error */
2639 
2640   CURL_FORMADD_MEMORY         CURL_DEPRECATED(7.56.0, ""),
2641   CURL_FORMADD_OPTION_TWICE   CURL_DEPRECATED(7.56.0, ""),
2642   CURL_FORMADD_NULL           CURL_DEPRECATED(7.56.0, ""),
2643   CURL_FORMADD_UNKNOWN_OPTION CURL_DEPRECATED(7.56.0, ""),
2644   CURL_FORMADD_INCOMPLETE     CURL_DEPRECATED(7.56.0, ""),
2645   CURL_FORMADD_ILLEGAL_ARRAY  CURL_DEPRECATED(7.56.0, ""),
2646   /* libcurl was built with form api disabled */
2647   CURL_FORMADD_DISABLED       CURL_DEPRECATED(7.56.0, ""),
2648 
2649   CURL_FORMADD_LAST /* last */
2650 } CURLFORMcode;
2651 
2652 /*
2653  * NAME curl_formadd()
2654  *
2655  * DESCRIPTION
2656  *
2657  * Pretty advanced function for building multi-part formposts. Each invoke
2658  * adds one part that together construct a full post. Then use
2659  * CURLOPT_HTTPPOST to send it off to libcurl.
2660  */
2661 CURL_EXTERN CURLFORMcode CURL_DEPRECATED(7.56.0, "Use curl_mime_init()")
2662 curl_formadd(struct curl_httppost **httppost,
2663              struct curl_httppost **last_post,
2664              ...);
2665 
2666 /*
2667  * callback function for curl_formget()
2668  * The void *arg pointer is the one passed as second argument to
2669  *   curl_formget().
2670  * The character buffer passed to it must not be freed.
2671  * Should return the buffer length passed to it as the argument "len" on
2672  *   success.
2673  */
2674 typedef size_t (*curl_formget_callback)(void *arg, const char *buf,
2675                                         size_t len);
2676 
2677 /*
2678  * NAME curl_formget()
2679  *
2680  * DESCRIPTION
2681  *
2682  * Serialize a curl_httppost struct built with curl_formadd().
2683  * Accepts a void pointer as second argument which is passed to
2684  * the curl_formget_callback function.
2685  * Returns 0 on success.
2686  */
2687 CURL_EXTERN int CURL_DEPRECATED(7.56.0, "")
2688 curl_formget(struct curl_httppost *form, void *arg,
2689              curl_formget_callback append);
2690 /*
2691  * NAME curl_formfree()
2692  *
2693  * DESCRIPTION
2694  *
2695  * Free a multipart formpost previously built with curl_formadd().
2696  */
2697 CURL_EXTERN void CURL_DEPRECATED(7.56.0, "Use curl_mime_free()")
2698 curl_formfree(struct curl_httppost *form);
2699 
2700 /*
2701  * NAME curl_getenv()
2702  *
2703  * DESCRIPTION
2704  *
2705  * Returns a malloc()'ed string that MUST be curl_free()ed after usage is
2706  * complete. DEPRECATED - see lib/README.curlx
2707  */
2708 CURL_EXTERN char *curl_getenv(const char *variable);
2709 
2710 /*
2711  * NAME curl_version()
2712  *
2713  * DESCRIPTION
2714  *
2715  * Returns a static ASCII string of the libcurl version.
2716  */
2717 CURL_EXTERN char *curl_version(void);
2718 
2719 /*
2720  * NAME curl_easy_escape()
2721  *
2722  * DESCRIPTION
2723  *
2724  * Escapes URL strings (converts all letters consider illegal in URLs to their
2725  * %XX versions). This function returns a new allocated string or NULL if an
2726  * error occurred.
2727  */
2728 CURL_EXTERN char *curl_easy_escape(CURL *curl,
2729                                    const char *string,
2730                                    int length);
2731 
2732 /* the previous version: */
2733 CURL_EXTERN char *curl_escape(const char *string,
2734                               int length);
2735 
2736 /*
2737  * NAME curl_easy_unescape()
2738  *
2739  * DESCRIPTION
2740  *
2741  * Unescapes URL encoding in strings (converts all %XX codes to their 8-bit
2742  * versions). This function returns a new allocated string or NULL if an error
2743  * occurred.
2744  * Conversion Note: On non-ASCII platforms the ASCII %XX codes are
2745  * converted into the host encoding.
2746  */
2747 CURL_EXTERN char *curl_easy_unescape(CURL *curl,
2748                                      const char *string,
2749                                      int inlength,
2750                                      int *outlength);
2751 
2752 /* the previous version */
2753 CURL_EXTERN char *curl_unescape(const char *string,
2754                                 int length);
2755 
2756 /*
2757  * NAME curl_free()
2758  *
2759  * DESCRIPTION
2760  *
2761  * Provided for de-allocation in the same translation unit that did the
2762  * allocation. Added in libcurl 7.10
2763  */
2764 CURL_EXTERN void curl_free(void *p);
2765 
2766 /*
2767  * NAME curl_global_init()
2768  *
2769  * DESCRIPTION
2770  *
2771  * curl_global_init() should be invoked exactly once for each application that
2772  * uses libcurl and before any call of other libcurl functions.
2773  *
2774  * This function is thread-safe if CURL_VERSION_THREADSAFE is set in the
2775  * curl_version_info_data.features flag (fetch by curl_version_info()).
2776  */
2777 CURL_EXTERN CURLcode curl_global_init(long flags);
2778 
2779 /*
2780  * NAME curl_global_init_mem()
2781  *
2782  * DESCRIPTION
2783  *
2784  * curl_global_init() or curl_global_init_mem() should be invoked exactly once
2785  * for each application that uses libcurl. This function can be used to
2786  * initialize libcurl and set user defined memory management callback
2787  * functions. Users can implement memory management routines to check for
2788  * memory leaks, check for misuse of the curl library etc. User registered
2789  * callback routines is invoked by this library instead of the system
2790  * memory management routines like malloc, free etc.
2791  */
2792 CURL_EXTERN CURLcode curl_global_init_mem(long flags,
2793                                           curl_malloc_callback m,
2794                                           curl_free_callback f,
2795                                           curl_realloc_callback r,
2796                                           curl_strdup_callback s,
2797                                           curl_calloc_callback c);
2798 
2799 /*
2800  * NAME curl_global_cleanup()
2801  *
2802  * DESCRIPTION
2803  *
2804  * curl_global_cleanup() should be invoked exactly once for each application
2805  * that uses libcurl
2806  */
2807 CURL_EXTERN void curl_global_cleanup(void);
2808 
2809 /*
2810  * NAME curl_global_trace()
2811  *
2812  * DESCRIPTION
2813  *
2814  * curl_global_trace() can be invoked at application start to
2815  * configure which components in curl should participate in tracing.
2816  *
2817  * This function is thread-safe if CURL_VERSION_THREADSAFE is set in the
2818  * curl_version_info_data.features flag (fetch by curl_version_info()).
2819  */
2820 CURL_EXTERN CURLcode curl_global_trace(const char *config);
2821 
2822 /* linked-list structure for the CURLOPT_QUOTE option (and other) */
2823 struct curl_slist {
2824   char *data;
2825   struct curl_slist *next;
2826 };
2827 
2828 /*
2829  * NAME curl_global_sslset()
2830  *
2831  * DESCRIPTION
2832  *
2833  * When built with multiple SSL backends, curl_global_sslset() allows to
2834  * choose one. This function can only be called once, and it must be called
2835  * *before* curl_global_init().
2836  *
2837  * The backend can be identified by the id (e.g. CURLSSLBACKEND_OPENSSL). The
2838  * backend can also be specified via the name parameter (passing -1 as id). If
2839  * both id and name are specified, the name is ignored. If neither id nor
2840  * name are specified, the function fails with CURLSSLSET_UNKNOWN_BACKEND
2841  * and set the "avail" pointer to the null-terminated list of available
2842  * backends.
2843  *
2844  * Upon success, the function returns CURLSSLSET_OK.
2845  *
2846  * If the specified SSL backend is not available, the function returns
2847  * CURLSSLSET_UNKNOWN_BACKEND and sets the "avail" pointer to a
2848  * null-terminated list of available SSL backends.
2849  *
2850  * The SSL backend can be set only once. If it has already been set, a
2851  * subsequent attempt to change it results in a CURLSSLSET_TOO_LATE.
2852  */
2853 
2854 struct curl_ssl_backend {
2855   curl_sslbackend id;
2856   const char *name;
2857 };
2858 typedef struct curl_ssl_backend curl_ssl_backend;
2859 
2860 typedef enum {
2861   CURLSSLSET_OK = 0,
2862   CURLSSLSET_UNKNOWN_BACKEND,
2863   CURLSSLSET_TOO_LATE,
2864   CURLSSLSET_NO_BACKENDS /* libcurl was built without any SSL support */
2865 } CURLsslset;
2866 
2867 CURL_EXTERN CURLsslset curl_global_sslset(curl_sslbackend id, const char *name,
2868                                           const curl_ssl_backend ***avail);
2869 
2870 /*
2871  * NAME curl_slist_append()
2872  *
2873  * DESCRIPTION
2874  *
2875  * Appends a string to a linked list. If no list exists, it is created first.
2876  * Returns the new list, after appending.
2877  */
2878 CURL_EXTERN struct curl_slist *curl_slist_append(struct curl_slist *list,
2879                                                  const char *data);
2880 
2881 /*
2882  * NAME curl_slist_free_all()
2883  *
2884  * DESCRIPTION
2885  *
2886  * free a previously built curl_slist.
2887  */
2888 CURL_EXTERN void curl_slist_free_all(struct curl_slist *list);
2889 
2890 /*
2891  * NAME curl_getdate()
2892  *
2893  * DESCRIPTION
2894  *
2895  * Returns the time, in seconds since 1 Jan 1970 of the time string given in
2896  * the first argument. The time argument in the second parameter is unused
2897  * and should be set to NULL.
2898  */
2899 CURL_EXTERN time_t curl_getdate(const char *p, const time_t *unused);
2900 
2901 /* info about the certificate chain, for SSL backends that support it. Asked
2902    for with CURLOPT_CERTINFO / CURLINFO_CERTINFO */
2903 struct curl_certinfo {
2904   int num_of_certs;             /* number of certificates with information */
2905   struct curl_slist **certinfo; /* for each index in this array, there is a
2906                                    linked list with textual information for a
2907                                    certificate in the format "name:content".
2908                                    eg "Subject:foo", "Issuer:bar", etc. */
2909 };
2910 
2911 /* Information about the SSL library used and the respective internal SSL
2912    handle, which can be used to obtain further information regarding the
2913    connection. Asked for with CURLINFO_TLS_SSL_PTR or CURLINFO_TLS_SESSION. */
2914 struct curl_tlssessioninfo {
2915   curl_sslbackend backend;
2916   void *internals;
2917 };
2918 
2919 #define CURLINFO_STRING   0x100000
2920 #define CURLINFO_LONG     0x200000
2921 #define CURLINFO_DOUBLE   0x300000
2922 #define CURLINFO_SLIST    0x400000
2923 #define CURLINFO_PTR      0x400000 /* same as SLIST */
2924 #define CURLINFO_SOCKET   0x500000
2925 #define CURLINFO_OFF_T    0x600000
2926 #define CURLINFO_MASK     0x0fffff
2927 #define CURLINFO_TYPEMASK 0xf00000
2928 
2929 typedef enum {
2930   CURLINFO_NONE, /* first, never use this */
2931   CURLINFO_EFFECTIVE_URL    = CURLINFO_STRING + 1,
2932   CURLINFO_RESPONSE_CODE    = CURLINFO_LONG   + 2,
2933   CURLINFO_TOTAL_TIME       = CURLINFO_DOUBLE + 3,
2934   CURLINFO_NAMELOOKUP_TIME  = CURLINFO_DOUBLE + 4,
2935   CURLINFO_CONNECT_TIME     = CURLINFO_DOUBLE + 5,
2936   CURLINFO_PRETRANSFER_TIME = CURLINFO_DOUBLE + 6,
2937   CURLINFO_SIZE_UPLOAD CURL_DEPRECATED(7.55.0, "Use CURLINFO_SIZE_UPLOAD_T")
2938                             = CURLINFO_DOUBLE + 7,
2939   CURLINFO_SIZE_UPLOAD_T    = CURLINFO_OFF_T  + 7,
2940   CURLINFO_SIZE_DOWNLOAD
2941                        CURL_DEPRECATED(7.55.0, "Use CURLINFO_SIZE_DOWNLOAD_T")
2942                             = CURLINFO_DOUBLE + 8,
2943   CURLINFO_SIZE_DOWNLOAD_T  = CURLINFO_OFF_T  + 8,
2944   CURLINFO_SPEED_DOWNLOAD
2945                        CURL_DEPRECATED(7.55.0, "Use CURLINFO_SPEED_DOWNLOAD_T")
2946                             = CURLINFO_DOUBLE + 9,
2947   CURLINFO_SPEED_DOWNLOAD_T = CURLINFO_OFF_T  + 9,
2948   CURLINFO_SPEED_UPLOAD
2949                        CURL_DEPRECATED(7.55.0, "Use CURLINFO_SPEED_UPLOAD_T")
2950                             = CURLINFO_DOUBLE + 10,
2951   CURLINFO_SPEED_UPLOAD_T   = CURLINFO_OFF_T  + 10,
2952   CURLINFO_HEADER_SIZE      = CURLINFO_LONG   + 11,
2953   CURLINFO_REQUEST_SIZE     = CURLINFO_LONG   + 12,
2954   CURLINFO_SSL_VERIFYRESULT = CURLINFO_LONG   + 13,
2955   CURLINFO_FILETIME         = CURLINFO_LONG   + 14,
2956   CURLINFO_FILETIME_T       = CURLINFO_OFF_T  + 14,
2957   CURLINFO_CONTENT_LENGTH_DOWNLOAD
2958                        CURL_DEPRECATED(7.55.0,
2959                                       "Use CURLINFO_CONTENT_LENGTH_DOWNLOAD_T")
2960                             = CURLINFO_DOUBLE + 15,
2961   CURLINFO_CONTENT_LENGTH_DOWNLOAD_T = CURLINFO_OFF_T  + 15,
2962   CURLINFO_CONTENT_LENGTH_UPLOAD
2963                        CURL_DEPRECATED(7.55.0,
2964                                        "Use CURLINFO_CONTENT_LENGTH_UPLOAD_T")
2965                             = CURLINFO_DOUBLE + 16,
2966   CURLINFO_CONTENT_LENGTH_UPLOAD_T   = CURLINFO_OFF_T  + 16,
2967   CURLINFO_STARTTRANSFER_TIME = CURLINFO_DOUBLE + 17,
2968   CURLINFO_CONTENT_TYPE     = CURLINFO_STRING + 18,
2969   CURLINFO_REDIRECT_TIME    = CURLINFO_DOUBLE + 19,
2970   CURLINFO_REDIRECT_COUNT   = CURLINFO_LONG   + 20,
2971   CURLINFO_PRIVATE          = CURLINFO_STRING + 21,
2972   CURLINFO_HTTP_CONNECTCODE = CURLINFO_LONG   + 22,
2973   CURLINFO_HTTPAUTH_AVAIL   = CURLINFO_LONG   + 23,
2974   CURLINFO_PROXYAUTH_AVAIL  = CURLINFO_LONG   + 24,
2975   CURLINFO_OS_ERRNO         = CURLINFO_LONG   + 25,
2976   CURLINFO_NUM_CONNECTS     = CURLINFO_LONG   + 26,
2977   CURLINFO_SSL_ENGINES      = CURLINFO_SLIST  + 27,
2978   CURLINFO_COOKIELIST       = CURLINFO_SLIST  + 28,
2979   CURLINFO_LASTSOCKET  CURL_DEPRECATED(7.45.0, "Use CURLINFO_ACTIVESOCKET")
2980                             = CURLINFO_LONG   + 29,
2981   CURLINFO_FTP_ENTRY_PATH   = CURLINFO_STRING + 30,
2982   CURLINFO_REDIRECT_URL     = CURLINFO_STRING + 31,
2983   CURLINFO_PRIMARY_IP       = CURLINFO_STRING + 32,
2984   CURLINFO_APPCONNECT_TIME  = CURLINFO_DOUBLE + 33,
2985   CURLINFO_CERTINFO         = CURLINFO_PTR    + 34,
2986   CURLINFO_CONDITION_UNMET  = CURLINFO_LONG   + 35,
2987   CURLINFO_RTSP_SESSION_ID  = CURLINFO_STRING + 36,
2988   CURLINFO_RTSP_CLIENT_CSEQ = CURLINFO_LONG   + 37,
2989   CURLINFO_RTSP_SERVER_CSEQ = CURLINFO_LONG   + 38,
2990   CURLINFO_RTSP_CSEQ_RECV   = CURLINFO_LONG   + 39,
2991   CURLINFO_PRIMARY_PORT     = CURLINFO_LONG   + 40,
2992   CURLINFO_LOCAL_IP         = CURLINFO_STRING + 41,
2993   CURLINFO_LOCAL_PORT       = CURLINFO_LONG   + 42,
2994   CURLINFO_TLS_SESSION CURL_DEPRECATED(7.48.0, "Use CURLINFO_TLS_SSL_PTR")
2995                             = CURLINFO_PTR    + 43,
2996   CURLINFO_ACTIVESOCKET     = CURLINFO_SOCKET + 44,
2997   CURLINFO_TLS_SSL_PTR      = CURLINFO_PTR    + 45,
2998   CURLINFO_HTTP_VERSION     = CURLINFO_LONG   + 46,
2999   CURLINFO_PROXY_SSL_VERIFYRESULT = CURLINFO_LONG + 47,
3000   CURLINFO_PROTOCOL    CURL_DEPRECATED(7.85.0, "Use CURLINFO_SCHEME")
3001                             = CURLINFO_LONG   + 48,
3002   CURLINFO_SCHEME           = CURLINFO_STRING + 49,
3003   CURLINFO_TOTAL_TIME_T     = CURLINFO_OFF_T + 50,
3004   CURLINFO_NAMELOOKUP_TIME_T = CURLINFO_OFF_T + 51,
3005   CURLINFO_CONNECT_TIME_T   = CURLINFO_OFF_T + 52,
3006   CURLINFO_PRETRANSFER_TIME_T = CURLINFO_OFF_T + 53,
3007   CURLINFO_STARTTRANSFER_TIME_T = CURLINFO_OFF_T + 54,
3008   CURLINFO_REDIRECT_TIME_T  = CURLINFO_OFF_T + 55,
3009   CURLINFO_APPCONNECT_TIME_T = CURLINFO_OFF_T + 56,
3010   CURLINFO_RETRY_AFTER      = CURLINFO_OFF_T + 57,
3011   CURLINFO_EFFECTIVE_METHOD = CURLINFO_STRING + 58,
3012   CURLINFO_PROXY_ERROR      = CURLINFO_LONG + 59,
3013   CURLINFO_REFERER          = CURLINFO_STRING + 60,
3014   CURLINFO_CAINFO           = CURLINFO_STRING + 61,
3015   CURLINFO_CAPATH           = CURLINFO_STRING + 62,
3016   CURLINFO_XFER_ID          = CURLINFO_OFF_T + 63,
3017   CURLINFO_CONN_ID          = CURLINFO_OFF_T + 64,
3018   CURLINFO_QUEUE_TIME_T     = CURLINFO_OFF_T + 65,
3019   CURLINFO_USED_PROXY       = CURLINFO_LONG + 66,
3020   CURLINFO_POSTTRANSFER_TIME_T = CURLINFO_OFF_T + 67,
3021   CURLINFO_EARLYDATA_SENT_T = CURLINFO_OFF_T + 68,
3022   CURLINFO_HTTPAUTH_USED    = CURLINFO_LONG + 69,
3023   CURLINFO_PROXYAUTH_USED   = CURLINFO_LONG + 70,
3024   CURLINFO_SIZE_DELIVERED   = CURLINFO_OFF_T + 71,
3025   CURLINFO_LASTONE          = 71
3026 } CURLINFO;
3027 
3028 /* CURLINFO_RESPONSE_CODE is the new name for the option previously known as
3029    CURLINFO_HTTP_CODE */
3030 #define CURLINFO_HTTP_CODE CURLINFO_RESPONSE_CODE
3031 
3032 typedef enum {
3033   CURLCLOSEPOLICY_NONE, /* first, never use this */
3034 
3035   CURLCLOSEPOLICY_OLDEST,
3036   CURLCLOSEPOLICY_LEAST_RECENTLY_USED,
3037   CURLCLOSEPOLICY_LEAST_TRAFFIC,
3038   CURLCLOSEPOLICY_SLOWEST,
3039   CURLCLOSEPOLICY_CALLBACK,
3040 
3041   CURLCLOSEPOLICY_LAST /* last, never use this */
3042 } curl_closepolicy;
3043 
3044 #define CURL_GLOBAL_SSL (1 << 0) /* no purpose since 7.57.0 */
3045 #define CURL_GLOBAL_WIN32 (1 << 1)
3046 #define CURL_GLOBAL_ALL (CURL_GLOBAL_SSL | CURL_GLOBAL_WIN32)
3047 #define CURL_GLOBAL_NOTHING 0
3048 #define CURL_GLOBAL_DEFAULT CURL_GLOBAL_ALL
3049 #define CURL_GLOBAL_ACK_EINTR (1 << 2)
3050 
3051 /*****************************************************************************
3052  * Setup defines, protos etc for the sharing stuff.
3053  */
3054 
3055 /* Different data locks for a single share */
3056 typedef enum {
3057   CURL_LOCK_DATA_NONE = 0,
3058   /*  CURL_LOCK_DATA_SHARE is used internally to say that the locking is made
3059    *  to change the internal state of the share itself.
3060    */
3061   CURL_LOCK_DATA_SHARE,
3062   CURL_LOCK_DATA_COOKIE,
3063   CURL_LOCK_DATA_DNS,
3064   CURL_LOCK_DATA_SSL_SESSION,
3065   CURL_LOCK_DATA_CONNECT,
3066   CURL_LOCK_DATA_PSL,
3067   CURL_LOCK_DATA_HSTS,
3068   CURL_LOCK_DATA_LAST
3069 } curl_lock_data;
3070 
3071 /* Different lock access types */
3072 typedef enum {
3073   CURL_LOCK_ACCESS_NONE = 0,   /* unspecified action */
3074   CURL_LOCK_ACCESS_SHARED = 1, /* for read perhaps */
3075   CURL_LOCK_ACCESS_SINGLE = 2, /* for write perhaps */
3076   CURL_LOCK_ACCESS_LAST        /* never use */
3077 } curl_lock_access;
3078 
3079 typedef void (*curl_lock_function)(CURL *handle,
3080                                    curl_lock_data data,
3081                                    curl_lock_access locktype,
3082                                    void *userptr);
3083 typedef void (*curl_unlock_function)(CURL *handle,
3084                                      curl_lock_data data,
3085                                      void *userptr);
3086 
3087 typedef enum {
3088   CURLSHE_OK,  /* all is fine */
3089   CURLSHE_BAD_OPTION, /* 1 */
3090   CURLSHE_IN_USE,     /* 2 */
3091   CURLSHE_INVALID,    /* 3 */
3092   CURLSHE_NOMEM,      /* 4 out of memory */
3093   CURLSHE_NOT_BUILT_IN, /* 5 feature not present in lib */
3094   CURLSHE_LAST        /* never use */
3095 } CURLSHcode;
3096 
3097 typedef enum {
3098   CURLSHOPT_NONE,  /* do not use */
3099   CURLSHOPT_SHARE,   /* specify a data type to share */
3100   CURLSHOPT_UNSHARE, /* specify which data type to stop sharing */
3101   CURLSHOPT_LOCKFUNC,   /* pass in a 'curl_lock_function' pointer */
3102   CURLSHOPT_UNLOCKFUNC, /* pass in a 'curl_unlock_function' pointer */
3103   CURLSHOPT_USERDATA,   /* pass in a user data pointer used in the lock/unlock
3104                            callback functions */
3105   CURLSHOPT_LAST  /* never use */
3106 } CURLSHoption;
3107 
3108 CURL_EXTERN CURLSH *curl_share_init(void);
3109 CURL_EXTERN CURLSHcode curl_share_setopt(CURLSH *sh, CURLSHoption option, ...);
3110 CURL_EXTERN CURLSHcode curl_share_cleanup(CURLSH *sh);
3111 
3112 /****************************************************************************
3113  * Structures for querying information about the curl library at runtime.
3114  */
3115 
3116 typedef enum {
3117   CURLVERSION_FIRST,    /* 7.10 */
3118   CURLVERSION_SECOND,   /* 7.11.1 */
3119   CURLVERSION_THIRD,    /* 7.12.0 */
3120   CURLVERSION_FOURTH,   /* 7.16.1 */
3121   CURLVERSION_FIFTH,    /* 7.57.0 */
3122   CURLVERSION_SIXTH,    /* 7.66.0 */
3123   CURLVERSION_SEVENTH,  /* 7.70.0 */
3124   CURLVERSION_EIGHTH,   /* 7.72.0 */
3125   CURLVERSION_NINTH,    /* 7.75.0 */
3126   CURLVERSION_TENTH,    /* 7.77.0 */
3127   CURLVERSION_ELEVENTH, /* 7.87.0 */
3128   CURLVERSION_TWELFTH,  /* 8.8.0 */
3129   CURLVERSION_LAST /* never actually use this */
3130 } CURLversion;
3131 
3132 /* The 'CURLVERSION_NOW' is the symbolic name meant to be used by programs
3133    that want to get version information. It is meant to be a built-in
3134    version number for what kind of struct the caller expects. If the struct
3135    ever changes, we redefine the NOW to another enum from above. */
3136 #define CURLVERSION_NOW CURLVERSION_TWELFTH
3137 
3138 struct curl_version_info_data {
3139   CURLversion age;          /* age of the returned struct */
3140   const char *version;      /* LIBCURL_VERSION */
3141   unsigned int version_num; /* LIBCURL_VERSION_NUM */
3142   const char *host;         /* OS/host/cpu/machine when configured */
3143   int features;             /* bitmask, see defines below */
3144   const char *ssl_version;  /* human readable string */
3145   long ssl_version_num;     /* not used anymore, always 0 */
3146   const char *libz_version; /* human readable string */
3147   /* protocols is terminated by an entry with a NULL protoname */
3148   const char * const *protocols;
3149 
3150   /* The fields below this were added in CURLVERSION_SECOND */
3151   const char *ares;
3152   int ares_num;
3153 
3154   /* This field was added in CURLVERSION_THIRD */
3155   const char *libidn;
3156 
3157   /* These field were added in CURLVERSION_FOURTH */
3158 
3159   /* Same as '_libiconv_version' if built with HAVE_ICONV */
3160   int iconv_ver_num;
3161 
3162   const char *libssh_version; /* human readable string */
3163 
3164   /* These fields were added in CURLVERSION_FIFTH */
3165   unsigned int brotli_ver_num; /* Numeric Brotli version
3166                                   (MAJOR << 24) | (MINOR << 12) | PATCH */
3167   const char *brotli_version; /* human readable string. */
3168 
3169   /* These fields were added in CURLVERSION_SIXTH */
3170   unsigned int nghttp2_ver_num; /* Numeric nghttp2 version
3171                                    (MAJOR << 16) | (MINOR << 8) | PATCH */
3172   const char *nghttp2_version; /* human readable string. */
3173   const char *quic_version;    /* human readable quic (+ HTTP/3) library +
3174                                   version or NULL */
3175 
3176   /* These fields were added in CURLVERSION_SEVENTH */
3177   const char *cainfo;          /* the built-in default CURLOPT_CAINFO, might
3178                                   be NULL */
3179   const char *capath;          /* the built-in default CURLOPT_CAPATH, might
3180                                   be NULL */
3181 
3182   /* These fields were added in CURLVERSION_EIGHTH */
3183   unsigned int zstd_ver_num; /* Numeric Zstd version
3184                                   (MAJOR << 24) | (MINOR << 12) | PATCH */
3185   const char *zstd_version; /* human readable string. */
3186 
3187   /* These fields were added in CURLVERSION_NINTH */
3188   const char *hyper_version; /* human readable string. */
3189 
3190   /* These fields were added in CURLVERSION_TENTH */
3191   const char *gsasl_version; /* human readable string. */
3192 
3193   /* These fields were added in CURLVERSION_ELEVENTH */
3194   /* feature_names is terminated by an entry with a NULL feature name */
3195   const char * const *feature_names;
3196 
3197   /* These fields were added in CURLVERSION_TWELFTH */
3198   const char *rtmp_version; /* human readable string. */
3199 };
3200 typedef struct curl_version_info_data curl_version_info_data;
3201 
3202 #define CURL_VERSION_IPV6         (1<<0)  /* IPv6-enabled */
3203 #define CURL_VERSION_KERBEROS4    (1<<1)  /* Kerberos V4 auth is supported
3204                                              (deprecated) */
3205 #define CURL_VERSION_SSL          (1<<2)  /* SSL options are present */
3206 #define CURL_VERSION_LIBZ         (1<<3)  /* libz features are present */
3207 #define CURL_VERSION_NTLM         (1<<4)  /* NTLM auth is supported */
3208 #define CURL_VERSION_GSSNEGOTIATE (1<<5)  /* Negotiate auth is supported
3209                                              (deprecated) */
3210 #define CURL_VERSION_DEBUG        (1<<6)  /* Built with debug capabilities */
3211 #define CURL_VERSION_ASYNCHDNS    (1<<7)  /* Asynchronous DNS resolves */
3212 #define CURL_VERSION_SPNEGO       (1<<8)  /* SPNEGO auth is supported */
3213 #define CURL_VERSION_LARGEFILE    (1<<9)  /* Supports files larger than 2GB */
3214 #define CURL_VERSION_IDN          (1<<10) /* Internationized Domain Names are
3215                                              supported */
3216 #define CURL_VERSION_SSPI         (1<<11) /* Built against Windows SSPI */
3217 #define CURL_VERSION_CONV         (1<<12) /* Character conversions supported */
3218 #define CURL_VERSION_CURLDEBUG    (1<<13) /* Debug memory tracking supported
3219                                              (deprecated) */
3220 #define CURL_VERSION_TLSAUTH_SRP  (1<<14) /* TLS-SRP auth is supported */
3221 #define CURL_VERSION_NTLM_WB      (1<<15) /* NTLM delegation to winbind helper
3222                                              is supported */
3223 #define CURL_VERSION_HTTP2        (1<<16) /* HTTP2 support built-in */
3224 #define CURL_VERSION_GSSAPI       (1<<17) /* Built against a GSS-API library */
3225 #define CURL_VERSION_KERBEROS5    (1<<18) /* Kerberos V5 auth is supported */
3226 #define CURL_VERSION_UNIX_SOCKETS (1<<19) /* Unix domain sockets support */
3227 #define CURL_VERSION_PSL          (1<<20) /* Mozilla's Public Suffix List, used
3228                                              for cookie domain verification */
3229 #define CURL_VERSION_HTTPS_PROXY  (1<<21) /* HTTPS-proxy support built-in */
3230 #define CURL_VERSION_MULTI_SSL    (1<<22) /* Multiple SSL backends available */
3231 #define CURL_VERSION_BROTLI       (1<<23) /* Brotli features are present. */
3232 #define CURL_VERSION_ALTSVC       (1<<24) /* Alt-Svc handling built-in */
3233 #define CURL_VERSION_HTTP3        (1<<25) /* HTTP3 support built-in */
3234 #define CURL_VERSION_ZSTD         (1<<26) /* zstd features are present */
3235 #define CURL_VERSION_UNICODE      (1<<27) /* Unicode support on Windows */
3236 #define CURL_VERSION_HSTS         (1<<28) /* HSTS is supported */
3237 #define CURL_VERSION_GSASL        (1<<29) /* libgsasl is supported */
3238 #define CURL_VERSION_THREADSAFE   (1<<30) /* libcurl API is thread-safe */
3239 
3240 /*
3241  * NAME curl_version_info()
3242  *
3243  * DESCRIPTION
3244  *
3245  * This function returns a pointer to a static copy of the version info
3246  * struct. See above.
3247  */
3248 CURL_EXTERN curl_version_info_data *curl_version_info(CURLversion stamp);
3249 
3250 /*
3251  * NAME curl_easy_strerror()
3252  *
3253  * DESCRIPTION
3254  *
3255  * The curl_easy_strerror function may be used to turn a CURLcode value
3256  * into the equivalent human readable error string. This is useful
3257  * for printing meaningful error messages.
3258  */
3259 CURL_EXTERN const char *curl_easy_strerror(CURLcode error);
3260 
3261 /*
3262  * NAME curl_share_strerror()
3263  *
3264  * DESCRIPTION
3265  *
3266  * The curl_share_strerror function may be used to turn a CURLSHcode value
3267  * into the equivalent human readable error string. This is useful
3268  * for printing meaningful error messages.
3269  */
3270 CURL_EXTERN const char *curl_share_strerror(CURLSHcode error);
3271 
3272 /*
3273  * NAME curl_easy_pause()
3274  *
3275  * DESCRIPTION
3276  *
3277  * The curl_easy_pause function pauses or unpauses transfers. Select the new
3278  * state by setting the action bitmask, use the convenience defines below.
3279  *
3280  */
3281 CURL_EXTERN CURLcode curl_easy_pause(CURL *curl, int action);
3282 
3283 #define CURLPAUSE_RECV      (1 << 0)
3284 #define CURLPAUSE_RECV_CONT 0
3285 
3286 #define CURLPAUSE_SEND      (1 << 2)
3287 #define CURLPAUSE_SEND_CONT 0
3288 
3289 #define CURLPAUSE_ALL       (CURLPAUSE_RECV | CURLPAUSE_SEND)
3290 #define CURLPAUSE_CONT      (CURLPAUSE_RECV_CONT | CURLPAUSE_SEND_CONT)
3291 
3292 /*
3293  * NAME curl_easy_ssls_import()
3294  *
3295  * DESCRIPTION
3296  *
3297  * The curl_easy_ssls_import function adds a previously exported SSL session
3298  * to the SSL session cache of the easy handle (or the underlying share).
3299  */
3300 CURL_EXTERN CURLcode curl_easy_ssls_import(CURL *curl,
3301                                            const char *session_key,
3302                                            const unsigned char *shmac,
3303                                            size_t shmac_len,
3304                                            const unsigned char *sdata,
3305                                            size_t sdata_len);
3306 
3307 /* This is the curl_ssls_export_cb callback prototype. It
3308  * is passed to curl_easy_ssls_export() to extract SSL sessions/tickets. */
3309 typedef CURLcode curl_ssls_export_cb(CURL *curl,
3310                                      void *userptr,
3311                                      const char *session_key,
3312                                      const unsigned char *shmac,
3313                                      size_t shmac_len,
3314                                      const unsigned char *sdata,
3315                                      size_t sdata_len,
3316                                      curl_off_t valid_until,
3317                                      int ietf_tls_id,
3318                                      const char *alpn,
3319                                      size_t earlydata_max);
3320 
3321 /*
3322  * NAME curl_easy_ssls_export()
3323  *
3324  * DESCRIPTION
3325  *
3326  * The curl_easy_ssls_export function iterates over all SSL sessions stored
3327  * in the easy handle (or underlying share) and invokes the passed
3328  * callback.
3329  *
3330  */
3331 CURL_EXTERN CURLcode curl_easy_ssls_export(CURL *curl,
3332                                            curl_ssls_export_cb *export_fn,
3333                                            void *userptr);
3334 
3335 #ifdef __cplusplus
3336 } /* end of extern "C" */
3337 #endif
3338 
3339 /* unfortunately, the easy.h and multi.h include files need options and info
3340    stuff before they can be included! */
3341 #include "easy.h" /* nothing in curl is fun without the easy stuff */
3342 #include "multi.h"
3343 #include "urlapi.h"
3344 #include "options.h"
3345 #include "header.h"
3346 #include "websockets.h"
3347 #include "mprintf.h"
3348 
3349 /* the typechecker does not work in C++ (yet) */
3350 #if ((defined(__GNUC__) && defined(__GNUC_MINOR__) && \
3351       ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3))) || \
3352     (defined(__clang__) && __clang_major__ >= 14)) && \
3353     !defined(__cplusplus) && !defined(CURL_DISABLE_TYPECHECK)
3354 #include "typecheck-gcc.h"
3355 #else
3356 #if defined(__STDC__) && (__STDC__ >= 1)
3357 /* This preprocessor magic ensures that application authors pass exactly three
3358    arguments to these functions. For compatibility with C++ global namespace
3359    '::' and reusing these symbols as method names, while also avoiding
3360    recursive macros, use a two-stage solution. */
3361 #define curl_exactly_three_arguments(a, b, c) (a, b, c)
3362 #define curl_easy_setopt(handle, opt, param) \
3363   curl_easy_setopt curl_exactly_three_arguments(handle, opt, param)
3364 #define curl_easy_getinfo(handle, info, arg) \
3365   curl_easy_getinfo curl_exactly_three_arguments(handle, info, arg)
3366 #define curl_share_setopt(share, opt, param) \
3367   curl_share_setopt curl_exactly_three_arguments(share, opt, param)
3368 #define curl_multi_setopt(handle, opt, param) \
3369   curl_multi_setopt curl_exactly_three_arguments(handle, opt, param)
3370 #endif /* __STDC__ >= 1 */
3371 #endif /* gcc >= 4.3 && !__cplusplus && !CURL_DISABLE_TYPECHECK */
3372 
3373 #endif /* CURLINC_CURL_H */