1 #ifndef CURLINC_CURL_H 2 #define CURLINC_CURL_H 3 /*************************************************************************** 4 * _ _ ____ _ 5 * Project ___| | | | _ \| | 6 * / __| | | | |_) | | 7 * | (__| |_| | _ <| |___ 8 * \___|\___/|_| \_\_____| 9 * 10 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 11 * 12 * This software is licensed as described in the file COPYING, which 13 * you should have received as part of this distribution. The terms 14 * are also available at https://curl.se/docs/copyright.html. 15 * 16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell 17 * copies of the Software, and permit persons to whom the Software is 18 * furnished to do so, under the terms of the COPYING file. 19 * 20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 21 * KIND, either express or implied. 22 * 23 * SPDX-License-Identifier: curl 24 * 25 ***************************************************************************/ 26 27 /* 28 * If you have libcurl problems, all docs and details are found here: 29 * https://curl.se/libcurl/ 30 */ 31 32 #ifdef CURL_NO_OLDIES 33 #define CURL_STRICTER 34 #endif 35 36 /* Compile-time deprecation macros. */ 37 #if defined(__GNUC__) && \ 38 ((__GNUC__ > 12) || ((__GNUC__ == 12) && (__GNUC_MINOR__ >= 1 ))) && \ 39 !defined(__INTEL_COMPILER) && \ 40 !defined(CURL_DISABLE_DEPRECATION) && !defined(BUILDING_LIBCURL) 41 #define CURL_DEPRECATED(version, message) \ 42 __attribute__((deprecated("since " # version ". " message))) 43 #define CURL_IGNORE_DEPRECATION(statements) \ 44 _Pragma("GCC diagnostic push") \ 45 _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") \ 46 statements \ 47 _Pragma("GCC diagnostic pop") 48 #else 49 #define CURL_DEPRECATED(version, message) 50 #define CURL_IGNORE_DEPRECATION(statements) statements 51 #endif 52 53 #include "curlver.h" /* libcurl version defines */ 54 #include "system.h" /* determine things run-time */ 55 56 #include <stdio.h> 57 #include <limits.h> 58 59 #if defined(__FreeBSD__) || defined(__MidnightBSD__) 60 /* Needed for __FreeBSD_version or __MidnightBSD_version symbol definition */ 61 #include <sys/param.h> 62 #endif 63 64 /* The include stuff here below is mainly for time_t! */ 65 #include <sys/types.h> 66 #include <time.h> 67 68 #if defined(_WIN32) && !defined(_WIN32_WCE) && !defined(__CYGWIN__) 69 #if !(defined(_WINSOCKAPI_) || defined(_WINSOCK_H) || \ 70 defined(__LWIP_OPT_H__) || defined(LWIP_HDR_OPT_H)) 71 /* The check above prevents the winsock2 inclusion if winsock.h already was 72 included, since they can't co-exist without problems */ 73 #include <winsock2.h> 74 #include <ws2tcpip.h> 75 #endif 76 #endif 77 78 /* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish 79 libc5-based Linux systems. Only include it on systems that are known to 80 require it! */ 81 #if defined(_AIX) || defined(__NOVELL_LIBC__) || defined(__NetBSD__) || \ 82 defined(__minix) || defined(__INTEGRITY) || \ 83 defined(ANDROID) || defined(__ANDROID__) || defined(__OpenBSD__) || \ 84 defined(__CYGWIN__) || defined(AMIGA) || defined(__NuttX__) || \ 85 (defined(__FreeBSD_version) && (__FreeBSD_version < 800000)) || \ 86 (defined(__MidnightBSD_version) && (__MidnightBSD_version < 100000)) || \ 87 defined(__sun__) || defined(__serenity__) || defined(__vxworks__) 88 #include <sys/select.h> 89 #endif 90 91 #if !defined(_WIN32) && !defined(_WIN32_WCE) 92 #include <sys/socket.h> 93 #endif 94 95 #if !defined(_WIN32) 96 #include <sys/time.h> 97 #endif 98 99 /* Compatibility for non-Clang compilers */ 100 #ifndef __has_declspec_attribute 101 # define __has_declspec_attribute(x) 0 102 #endif 103 104 #ifdef __cplusplus 105 extern "C" { 106 #endif 107 108 #if defined(BUILDING_LIBCURL) || defined(CURL_STRICTER) 109 typedef struct Curl_easy CURL; 110 typedef struct Curl_share CURLSH; 111 #else 112 typedef void CURL; 113 typedef void CURLSH; 114 #endif 115 116 /* 117 * libcurl external API function linkage decorations. 118 */ 119 120 #ifdef CURL_STATICLIB 121 # define CURL_EXTERN 122 #elif defined(_WIN32) || \ 123 (__has_declspec_attribute(dllexport) && \ 124 __has_declspec_attribute(dllimport)) 125 # if defined(BUILDING_LIBCURL) 126 # define CURL_EXTERN __declspec(dllexport) 127 # else 128 # define CURL_EXTERN __declspec(dllimport) 129 # endif 130 #elif defined(BUILDING_LIBCURL) && defined(CURL_HIDDEN_SYMBOLS) 131 # define CURL_EXTERN CURL_EXTERN_SYMBOL 132 #else 133 # define CURL_EXTERN 134 #endif 135 136 #ifndef curl_socket_typedef 137 /* socket typedef */ 138 #if defined(_WIN32) && !defined(__LWIP_OPT_H__) && !defined(LWIP_HDR_OPT_H) 139 typedef SOCKET curl_socket_t; 140 #define CURL_SOCKET_BAD INVALID_SOCKET 141 #else 142 typedef int curl_socket_t; 143 #define CURL_SOCKET_BAD -1 144 #endif 145 #define curl_socket_typedef 146 #endif /* curl_socket_typedef */ 147 148 /* enum for the different supported SSL backends */ 149 typedef enum { 150 CURLSSLBACKEND_NONE = 0, 151 CURLSSLBACKEND_OPENSSL = 1, 152 CURLSSLBACKEND_GNUTLS = 2, 153 CURLSSLBACKEND_NSS CURL_DEPRECATED(8.3.0, "") = 3, 154 CURLSSLBACKEND_OBSOLETE4 = 4, /* Was QSOSSL. */ 155 CURLSSLBACKEND_GSKIT CURL_DEPRECATED(8.3.0, "") = 5, 156 CURLSSLBACKEND_POLARSSL CURL_DEPRECATED(7.69.0, "") = 6, 157 CURLSSLBACKEND_WOLFSSL = 7, 158 CURLSSLBACKEND_SCHANNEL = 8, 159 CURLSSLBACKEND_SECURETRANSPORT = 9, 160 CURLSSLBACKEND_AXTLS CURL_DEPRECATED(7.61.0, "") = 10, 161 CURLSSLBACKEND_MBEDTLS = 11, 162 CURLSSLBACKEND_MESALINK CURL_DEPRECATED(7.82.0, "") = 12, 163 CURLSSLBACKEND_BEARSSL = 13, 164 CURLSSLBACKEND_RUSTLS = 14 165 } curl_sslbackend; 166 167 /* aliases for library clones and renames */ 168 #define CURLSSLBACKEND_AWSLC CURLSSLBACKEND_OPENSSL 169 #define CURLSSLBACKEND_BORINGSSL CURLSSLBACKEND_OPENSSL 170 #define CURLSSLBACKEND_LIBRESSL CURLSSLBACKEND_OPENSSL 171 172 /* deprecated names: */ 173 #define CURLSSLBACKEND_CYASSL CURLSSLBACKEND_WOLFSSL 174 #define CURLSSLBACKEND_DARWINSSL CURLSSLBACKEND_SECURETRANSPORT 175 176 struct curl_httppost { 177 struct curl_httppost *next; /* next entry in the list */ 178 char *name; /* pointer to allocated name */ 179 long namelength; /* length of name length */ 180 char *contents; /* pointer to allocated data contents */ 181 long contentslength; /* length of contents field, see also 182 CURL_HTTPPOST_LARGE */ 183 char *buffer; /* pointer to allocated buffer contents */ 184 long bufferlength; /* length of buffer field */ 185 char *contenttype; /* Content-Type */ 186 struct curl_slist *contentheader; /* list of extra headers for this form */ 187 struct curl_httppost *more; /* if one field name has more than one 188 file, this link should link to following 189 files */ 190 long flags; /* as defined below */ 191 192 /* specified content is a file name */ 193 #define CURL_HTTPPOST_FILENAME (1<<0) 194 /* specified content is a file name */ 195 #define CURL_HTTPPOST_READFILE (1<<1) 196 /* name is only stored pointer do not free in formfree */ 197 #define CURL_HTTPPOST_PTRNAME (1<<2) 198 /* contents is only stored pointer do not free in formfree */ 199 #define CURL_HTTPPOST_PTRCONTENTS (1<<3) 200 /* upload file from buffer */ 201 #define CURL_HTTPPOST_BUFFER (1<<4) 202 /* upload file from pointer contents */ 203 #define CURL_HTTPPOST_PTRBUFFER (1<<5) 204 /* upload file contents by using the regular read callback to get the data and 205 pass the given pointer as custom pointer */ 206 #define CURL_HTTPPOST_CALLBACK (1<<6) 207 /* use size in 'contentlen', added in 7.46.0 */ 208 #define CURL_HTTPPOST_LARGE (1<<7) 209 210 char *showfilename; /* The file name to show. If not set, the 211 actual file name will be used (if this 212 is a file part) */ 213 void *userp; /* custom pointer used for 214 HTTPPOST_CALLBACK posts */ 215 curl_off_t contentlen; /* alternative length of contents 216 field. Used if CURL_HTTPPOST_LARGE is 217 set. Added in 7.46.0 */ 218 }; 219 220 221 /* This is a return code for the progress callback that, when returned, will 222 signal libcurl to continue executing the default progress function */ 223 #define CURL_PROGRESSFUNC_CONTINUE 0x10000001 224 225 /* This is the CURLOPT_PROGRESSFUNCTION callback prototype. It is now 226 considered deprecated but was the only choice up until 7.31.0 */ 227 typedef int (*curl_progress_callback)(void *clientp, 228 double dltotal, 229 double dlnow, 230 double ultotal, 231 double ulnow); 232 233 /* This is the CURLOPT_XFERINFOFUNCTION callback prototype. It was introduced 234 in 7.32.0, avoids the use of floating point numbers and provides more 235 detailed information. */ 236 typedef int (*curl_xferinfo_callback)(void *clientp, 237 curl_off_t dltotal, 238 curl_off_t dlnow, 239 curl_off_t ultotal, 240 curl_off_t ulnow); 241 242 #ifndef CURL_MAX_READ_SIZE 243 /* The maximum receive buffer size configurable via CURLOPT_BUFFERSIZE. */ 244 #define CURL_MAX_READ_SIZE (10*1024*1024) 245 #endif 246 247 #ifndef CURL_MAX_WRITE_SIZE 248 /* Tests have proven that 20K is a very bad buffer size for uploads on 249 Windows, while 16K for some odd reason performed a lot better. 250 We do the ifndef check to allow this value to easier be changed at build 251 time for those who feel adventurous. The practical minimum is about 252 400 bytes since libcurl uses a buffer of this size as a scratch area 253 (unrelated to network send operations). */ 254 #define CURL_MAX_WRITE_SIZE 16384 255 #endif 256 257 #ifndef CURL_MAX_HTTP_HEADER 258 /* The only reason to have a max limit for this is to avoid the risk of a bad 259 server feeding libcurl with a never-ending header that will cause reallocs 260 infinitely */ 261 #define CURL_MAX_HTTP_HEADER (100*1024) 262 #endif 263 264 /* This is a magic return code for the write callback that, when returned, 265 will signal libcurl to pause receiving on the current transfer. */ 266 #define CURL_WRITEFUNC_PAUSE 0x10000001 267 268 /* This is a magic return code for the write callback that, when returned, 269 will signal an error from the callback. */ 270 #define CURL_WRITEFUNC_ERROR 0xFFFFFFFF 271 272 typedef size_t (*curl_write_callback)(char *buffer, 273 size_t size, 274 size_t nitems, 275 void *outstream); 276 277 /* This callback will be called when a new resolver request is made */ 278 typedef int (*curl_resolver_start_callback)(void *resolver_state, 279 void *reserved, void *userdata); 280 281 /* enumeration of file types */ 282 typedef enum { 283 CURLFILETYPE_FILE = 0, 284 CURLFILETYPE_DIRECTORY, 285 CURLFILETYPE_SYMLINK, 286 CURLFILETYPE_DEVICE_BLOCK, 287 CURLFILETYPE_DEVICE_CHAR, 288 CURLFILETYPE_NAMEDPIPE, 289 CURLFILETYPE_SOCKET, 290 CURLFILETYPE_DOOR, /* is possible only on Sun Solaris now */ 291 292 CURLFILETYPE_UNKNOWN /* should never occur */ 293 } curlfiletype; 294 295 #define CURLFINFOFLAG_KNOWN_FILENAME (1<<0) 296 #define CURLFINFOFLAG_KNOWN_FILETYPE (1<<1) 297 #define CURLFINFOFLAG_KNOWN_TIME (1<<2) 298 #define CURLFINFOFLAG_KNOWN_PERM (1<<3) 299 #define CURLFINFOFLAG_KNOWN_UID (1<<4) 300 #define CURLFINFOFLAG_KNOWN_GID (1<<5) 301 #define CURLFINFOFLAG_KNOWN_SIZE (1<<6) 302 #define CURLFINFOFLAG_KNOWN_HLINKCOUNT (1<<7) 303 304 /* Information about a single file, used when doing FTP wildcard matching */ 305 struct curl_fileinfo { 306 char *filename; 307 curlfiletype filetype; 308 time_t time; /* always zero! */ 309 unsigned int perm; 310 int uid; 311 int gid; 312 curl_off_t size; 313 long int hardlinks; 314 315 struct { 316 /* If some of these fields is not NULL, it is a pointer to b_data. */ 317 char *time; 318 char *perm; 319 char *user; 320 char *group; 321 char *target; /* pointer to the target filename of a symlink */ 322 } strings; 323 324 unsigned int flags; 325 326 /* These are libcurl private struct fields. Previously used by libcurl, so 327 they must never be interfered with. */ 328 char *b_data; 329 size_t b_size; 330 size_t b_used; 331 }; 332 333 /* return codes for CURLOPT_CHUNK_BGN_FUNCTION */ 334 #define CURL_CHUNK_BGN_FUNC_OK 0 335 #define CURL_CHUNK_BGN_FUNC_FAIL 1 /* tell the lib to end the task */ 336 #define CURL_CHUNK_BGN_FUNC_SKIP 2 /* skip this chunk over */ 337 338 /* if splitting of data transfer is enabled, this callback is called before 339 download of an individual chunk started. Note that parameter "remains" works 340 only for FTP wildcard downloading (for now), otherwise is not used */ 341 typedef long (*curl_chunk_bgn_callback)(const void *transfer_info, 342 void *ptr, 343 int remains); 344 345 /* return codes for CURLOPT_CHUNK_END_FUNCTION */ 346 #define CURL_CHUNK_END_FUNC_OK 0 347 #define CURL_CHUNK_END_FUNC_FAIL 1 /* tell the lib to end the task */ 348 349 /* If splitting of data transfer is enabled this callback is called after 350 download of an individual chunk finished. 351 Note! After this callback was set then it have to be called FOR ALL chunks. 352 Even if downloading of this chunk was skipped in CHUNK_BGN_FUNC. 353 This is the reason why we don't need "transfer_info" parameter in this 354 callback and we are not interested in "remains" parameter too. */ 355 typedef long (*curl_chunk_end_callback)(void *ptr); 356 357 /* return codes for FNMATCHFUNCTION */ 358 #define CURL_FNMATCHFUNC_MATCH 0 /* string corresponds to the pattern */ 359 #define CURL_FNMATCHFUNC_NOMATCH 1 /* pattern doesn't match the string */ 360 #define CURL_FNMATCHFUNC_FAIL 2 /* an error occurred */ 361 362 /* callback type for wildcard downloading pattern matching. If the 363 string matches the pattern, return CURL_FNMATCHFUNC_MATCH value, etc. */ 364 typedef int (*curl_fnmatch_callback)(void *ptr, 365 const char *pattern, 366 const char *string); 367 368 /* These are the return codes for the seek callbacks */ 369 #define CURL_SEEKFUNC_OK 0 370 #define CURL_SEEKFUNC_FAIL 1 /* fail the entire transfer */ 371 #define CURL_SEEKFUNC_CANTSEEK 2 /* tell libcurl seeking can't be done, so 372 libcurl might try other means instead */ 373 typedef int (*curl_seek_callback)(void *instream, 374 curl_off_t offset, 375 int origin); /* 'whence' */ 376 377 /* This is a return code for the read callback that, when returned, will 378 signal libcurl to immediately abort the current transfer. */ 379 #define CURL_READFUNC_ABORT 0x10000000 380 /* This is a return code for the read callback that, when returned, will 381 signal libcurl to pause sending data on the current transfer. */ 382 #define CURL_READFUNC_PAUSE 0x10000001 383 384 /* Return code for when the trailing headers' callback has terminated 385 without any errors */ 386 #define CURL_TRAILERFUNC_OK 0 387 /* Return code for when was an error in the trailing header's list and we 388 want to abort the request */ 389 #define CURL_TRAILERFUNC_ABORT 1 390 391 typedef size_t (*curl_read_callback)(char *buffer, 392 size_t size, 393 size_t nitems, 394 void *instream); 395 396 typedef int (*curl_trailer_callback)(struct curl_slist **list, 397 void *userdata); 398 399 typedef enum { 400 CURLSOCKTYPE_IPCXN, /* socket created for a specific IP connection */ 401 CURLSOCKTYPE_ACCEPT, /* socket created by accept() call */ 402 CURLSOCKTYPE_LAST /* never use */ 403 } curlsocktype; 404 405 /* The return code from the sockopt_callback can signal information back 406 to libcurl: */ 407 #define CURL_SOCKOPT_OK 0 408 #define CURL_SOCKOPT_ERROR 1 /* causes libcurl to abort and return 409 CURLE_ABORTED_BY_CALLBACK */ 410 #define CURL_SOCKOPT_ALREADY_CONNECTED 2 411 412 typedef int (*curl_sockopt_callback)(void *clientp, 413 curl_socket_t curlfd, 414 curlsocktype purpose); 415 416 struct curl_sockaddr { 417 int family; 418 int socktype; 419 int protocol; 420 unsigned int addrlen; /* addrlen was a socklen_t type before 7.18.0 but it 421 turned really ugly and painful on the systems that 422 lack this type */ 423 struct sockaddr addr; 424 }; 425 426 typedef curl_socket_t 427 (*curl_opensocket_callback)(void *clientp, 428 curlsocktype purpose, 429 struct curl_sockaddr *address); 430 431 typedef int 432 (*curl_closesocket_callback)(void *clientp, curl_socket_t item); 433 434 typedef enum { 435 CURLIOE_OK, /* I/O operation successful */ 436 CURLIOE_UNKNOWNCMD, /* command was unknown to callback */ 437 CURLIOE_FAILRESTART, /* failed to restart the read */ 438 CURLIOE_LAST /* never use */ 439 } curlioerr; 440 441 typedef enum { 442 CURLIOCMD_NOP, /* no operation */ 443 CURLIOCMD_RESTARTREAD, /* restart the read stream from start */ 444 CURLIOCMD_LAST /* never use */ 445 } curliocmd; 446 447 typedef curlioerr (*curl_ioctl_callback)(CURL *handle, 448 int cmd, 449 void *clientp); 450 451 #ifndef CURL_DID_MEMORY_FUNC_TYPEDEFS 452 /* 453 * The following typedef's are signatures of malloc, free, realloc, strdup and 454 * calloc respectively. Function pointers of these types can be passed to the 455 * curl_global_init_mem() function to set user defined memory management 456 * callback routines. 457 */ 458 typedef void *(*curl_malloc_callback)(size_t size); 459 typedef void (*curl_free_callback)(void *ptr); 460 typedef void *(*curl_realloc_callback)(void *ptr, size_t size); 461 typedef char *(*curl_strdup_callback)(const char *str); 462 typedef void *(*curl_calloc_callback)(size_t nmemb, size_t size); 463 464 #define CURL_DID_MEMORY_FUNC_TYPEDEFS 465 #endif 466 467 /* the kind of data that is passed to information_callback */ 468 typedef enum { 469 CURLINFO_TEXT = 0, 470 CURLINFO_HEADER_IN, /* 1 */ 471 CURLINFO_HEADER_OUT, /* 2 */ 472 CURLINFO_DATA_IN, /* 3 */ 473 CURLINFO_DATA_OUT, /* 4 */ 474 CURLINFO_SSL_DATA_IN, /* 5 */ 475 CURLINFO_SSL_DATA_OUT, /* 6 */ 476 CURLINFO_END 477 } curl_infotype; 478 479 typedef int (*curl_debug_callback) 480 (CURL *handle, /* the handle/transfer this concerns */ 481 curl_infotype type, /* what kind of data */ 482 char *data, /* points to the data */ 483 size_t size, /* size of the data pointed to */ 484 void *userptr); /* whatever the user please */ 485 486 /* This is the CURLOPT_PREREQFUNCTION callback prototype. */ 487 typedef int (*curl_prereq_callback)(void *clientp, 488 char *conn_primary_ip, 489 char *conn_local_ip, 490 int conn_primary_port, 491 int conn_local_port); 492 493 /* Return code for when the pre-request callback has terminated without 494 any errors */ 495 #define CURL_PREREQFUNC_OK 0 496 /* Return code for when the pre-request callback wants to abort the 497 request */ 498 #define CURL_PREREQFUNC_ABORT 1 499 500 /* All possible error codes from all sorts of curl functions. Future versions 501 may return other values, stay prepared. 502 503 Always add new return codes last. Never *EVER* remove any. The return 504 codes must remain the same! 505 */ 506 507 typedef enum { 508 CURLE_OK = 0, 509 CURLE_UNSUPPORTED_PROTOCOL, /* 1 */ 510 CURLE_FAILED_INIT, /* 2 */ 511 CURLE_URL_MALFORMAT, /* 3 */ 512 CURLE_NOT_BUILT_IN, /* 4 - [was obsoleted in August 2007 for 513 7.17.0, reused in April 2011 for 7.21.5] */ 514 CURLE_COULDNT_RESOLVE_PROXY, /* 5 */ 515 CURLE_COULDNT_RESOLVE_HOST, /* 6 */ 516 CURLE_COULDNT_CONNECT, /* 7 */ 517 CURLE_WEIRD_SERVER_REPLY, /* 8 */ 518 CURLE_REMOTE_ACCESS_DENIED, /* 9 a service was denied by the server 519 due to lack of access - when login fails 520 this is not returned. */ 521 CURLE_FTP_ACCEPT_FAILED, /* 10 - [was obsoleted in April 2006 for 522 7.15.4, reused in Dec 2011 for 7.24.0]*/ 523 CURLE_FTP_WEIRD_PASS_REPLY, /* 11 */ 524 CURLE_FTP_ACCEPT_TIMEOUT, /* 12 - timeout occurred accepting server 525 [was obsoleted in August 2007 for 7.17.0, 526 reused in Dec 2011 for 7.24.0]*/ 527 CURLE_FTP_WEIRD_PASV_REPLY, /* 13 */ 528 CURLE_FTP_WEIRD_227_FORMAT, /* 14 */ 529 CURLE_FTP_CANT_GET_HOST, /* 15 */ 530 CURLE_HTTP2, /* 16 - A problem in the http2 framing layer. 531 [was obsoleted in August 2007 for 7.17.0, 532 reused in July 2014 for 7.38.0] */ 533 CURLE_FTP_COULDNT_SET_TYPE, /* 17 */ 534 CURLE_PARTIAL_FILE, /* 18 */ 535 CURLE_FTP_COULDNT_RETR_FILE, /* 19 */ 536 CURLE_OBSOLETE20, /* 20 - NOT USED */ 537 CURLE_QUOTE_ERROR, /* 21 - quote command failure */ 538 CURLE_HTTP_RETURNED_ERROR, /* 22 */ 539 CURLE_WRITE_ERROR, /* 23 */ 540 CURLE_OBSOLETE24, /* 24 - NOT USED */ 541 CURLE_UPLOAD_FAILED, /* 25 - failed upload "command" */ 542 CURLE_READ_ERROR, /* 26 - couldn't open/read from file */ 543 CURLE_OUT_OF_MEMORY, /* 27 */ 544 CURLE_OPERATION_TIMEDOUT, /* 28 - the timeout time was reached */ 545 CURLE_OBSOLETE29, /* 29 - NOT USED */ 546 CURLE_FTP_PORT_FAILED, /* 30 - FTP PORT operation failed */ 547 CURLE_FTP_COULDNT_USE_REST, /* 31 - the REST command failed */ 548 CURLE_OBSOLETE32, /* 32 - NOT USED */ 549 CURLE_RANGE_ERROR, /* 33 - RANGE "command" didn't work */ 550 CURLE_HTTP_POST_ERROR, /* 34 */ 551 CURLE_SSL_CONNECT_ERROR, /* 35 - wrong when connecting with SSL */ 552 CURLE_BAD_DOWNLOAD_RESUME, /* 36 - couldn't resume download */ 553 CURLE_FILE_COULDNT_READ_FILE, /* 37 */ 554 CURLE_LDAP_CANNOT_BIND, /* 38 */ 555 CURLE_LDAP_SEARCH_FAILED, /* 39 */ 556 CURLE_OBSOLETE40, /* 40 - NOT USED */ 557 CURLE_FUNCTION_NOT_FOUND, /* 41 - NOT USED starting with 7.53.0 */ 558 CURLE_ABORTED_BY_CALLBACK, /* 42 */ 559 CURLE_BAD_FUNCTION_ARGUMENT, /* 43 */ 560 CURLE_OBSOLETE44, /* 44 - NOT USED */ 561 CURLE_INTERFACE_FAILED, /* 45 - CURLOPT_INTERFACE failed */ 562 CURLE_OBSOLETE46, /* 46 - NOT USED */ 563 CURLE_TOO_MANY_REDIRECTS, /* 47 - catch endless re-direct loops */ 564 CURLE_UNKNOWN_OPTION, /* 48 - User specified an unknown option */ 565 CURLE_SETOPT_OPTION_SYNTAX, /* 49 - Malformed setopt option */ 566 CURLE_OBSOLETE50, /* 50 - NOT USED */ 567 CURLE_OBSOLETE51, /* 51 - NOT USED */ 568 CURLE_GOT_NOTHING, /* 52 - when this is a specific error */ 569 CURLE_SSL_ENGINE_NOTFOUND, /* 53 - SSL crypto engine not found */ 570 CURLE_SSL_ENGINE_SETFAILED, /* 54 - can not set SSL crypto engine as 571 default */ 572 CURLE_SEND_ERROR, /* 55 - failed sending network data */ 573 CURLE_RECV_ERROR, /* 56 - failure in receiving network data */ 574 CURLE_OBSOLETE57, /* 57 - NOT IN USE */ 575 CURLE_SSL_CERTPROBLEM, /* 58 - problem with the local certificate */ 576 CURLE_SSL_CIPHER, /* 59 - couldn't use specified cipher */ 577 CURLE_PEER_FAILED_VERIFICATION, /* 60 - peer's certificate or fingerprint 578 wasn't verified fine */ 579 CURLE_BAD_CONTENT_ENCODING, /* 61 - Unrecognized/bad encoding */ 580 CURLE_OBSOLETE62, /* 62 - NOT IN USE since 7.82.0 */ 581 CURLE_FILESIZE_EXCEEDED, /* 63 - Maximum file size exceeded */ 582 CURLE_USE_SSL_FAILED, /* 64 - Requested FTP SSL level failed */ 583 CURLE_SEND_FAIL_REWIND, /* 65 - Sending the data requires a rewind 584 that failed */ 585 CURLE_SSL_ENGINE_INITFAILED, /* 66 - failed to initialise ENGINE */ 586 CURLE_LOGIN_DENIED, /* 67 - user, password or similar was not 587 accepted and we failed to login */ 588 CURLE_TFTP_NOTFOUND, /* 68 - file not found on server */ 589 CURLE_TFTP_PERM, /* 69 - permission problem on server */ 590 CURLE_REMOTE_DISK_FULL, /* 70 - out of disk space on server */ 591 CURLE_TFTP_ILLEGAL, /* 71 - Illegal TFTP operation */ 592 CURLE_TFTP_UNKNOWNID, /* 72 - Unknown transfer ID */ 593 CURLE_REMOTE_FILE_EXISTS, /* 73 - File already exists */ 594 CURLE_TFTP_NOSUCHUSER, /* 74 - No such user */ 595 CURLE_OBSOLETE75, /* 75 - NOT IN USE since 7.82.0 */ 596 CURLE_OBSOLETE76, /* 76 - NOT IN USE since 7.82.0 */ 597 CURLE_SSL_CACERT_BADFILE, /* 77 - could not load CACERT file, missing 598 or wrong format */ 599 CURLE_REMOTE_FILE_NOT_FOUND, /* 78 - remote file not found */ 600 CURLE_SSH, /* 79 - error from the SSH layer, somewhat 601 generic so the error message will be of 602 interest when this has happened */ 603 604 CURLE_SSL_SHUTDOWN_FAILED, /* 80 - Failed to shut down the SSL 605 connection */ 606 CURLE_AGAIN, /* 81 - socket is not ready for send/recv, 607 wait till it's ready and try again (Added 608 in 7.18.2) */ 609 CURLE_SSL_CRL_BADFILE, /* 82 - could not load CRL file, missing or 610 wrong format (Added in 7.19.0) */ 611 CURLE_SSL_ISSUER_ERROR, /* 83 - Issuer check failed. (Added in 612 7.19.0) */ 613 CURLE_FTP_PRET_FAILED, /* 84 - a PRET command failed */ 614 CURLE_RTSP_CSEQ_ERROR, /* 85 - mismatch of RTSP CSeq numbers */ 615 CURLE_RTSP_SESSION_ERROR, /* 86 - mismatch of RTSP Session Ids */ 616 CURLE_FTP_BAD_FILE_LIST, /* 87 - unable to parse FTP file list */ 617 CURLE_CHUNK_FAILED, /* 88 - chunk callback reported error */ 618 CURLE_NO_CONNECTION_AVAILABLE, /* 89 - No connection available, the 619 session will be queued */ 620 CURLE_SSL_PINNEDPUBKEYNOTMATCH, /* 90 - specified pinned public key did not 621 match */ 622 CURLE_SSL_INVALIDCERTSTATUS, /* 91 - invalid certificate status */ 623 CURLE_HTTP2_STREAM, /* 92 - stream error in HTTP/2 framing layer 624 */ 625 CURLE_RECURSIVE_API_CALL, /* 93 - an api function was called from 626 inside a callback */ 627 CURLE_AUTH_ERROR, /* 94 - an authentication function returned an 628 error */ 629 CURLE_HTTP3, /* 95 - An HTTP/3 layer problem */ 630 CURLE_QUIC_CONNECT_ERROR, /* 96 - QUIC connection error */ 631 CURLE_PROXY, /* 97 - proxy handshake error */ 632 CURLE_SSL_CLIENTCERT, /* 98 - client-side certificate required */ 633 CURLE_UNRECOVERABLE_POLL, /* 99 - poll/select returned fatal error */ 634 CURLE_TOO_LARGE, /* 100 - a value/data met its maximum */ 635 CURL_LAST /* never use! */ 636 } CURLcode; 637 638 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all 639 the obsolete stuff removed! */ 640 641 /* Previously obsolete error code reused in 7.38.0 */ 642 #define CURLE_OBSOLETE16 CURLE_HTTP2 643 644 /* Previously obsolete error codes reused in 7.24.0 */ 645 #define CURLE_OBSOLETE10 CURLE_FTP_ACCEPT_FAILED 646 #define CURLE_OBSOLETE12 CURLE_FTP_ACCEPT_TIMEOUT 647 648 /* compatibility with older names */ 649 #define CURLOPT_ENCODING CURLOPT_ACCEPT_ENCODING 650 #define CURLE_FTP_WEIRD_SERVER_REPLY CURLE_WEIRD_SERVER_REPLY 651 652 /* The following were added in 7.62.0 */ 653 #define CURLE_SSL_CACERT CURLE_PEER_FAILED_VERIFICATION 654 655 /* The following were added in 7.21.5, April 2011 */ 656 #define CURLE_UNKNOWN_TELNET_OPTION CURLE_UNKNOWN_OPTION 657 658 /* Added for 7.78.0 */ 659 #define CURLE_TELNET_OPTION_SYNTAX CURLE_SETOPT_OPTION_SYNTAX 660 661 /* The following were added in 7.17.1 */ 662 /* These are scheduled to disappear by 2009 */ 663 #define CURLE_SSL_PEER_CERTIFICATE CURLE_PEER_FAILED_VERIFICATION 664 665 /* The following were added in 7.17.0 */ 666 /* These are scheduled to disappear by 2009 */ 667 #define CURLE_OBSOLETE CURLE_OBSOLETE50 /* no one should be using this! */ 668 #define CURLE_BAD_PASSWORD_ENTERED CURLE_OBSOLETE46 669 #define CURLE_BAD_CALLING_ORDER CURLE_OBSOLETE44 670 #define CURLE_FTP_USER_PASSWORD_INCORRECT CURLE_OBSOLETE10 671 #define CURLE_FTP_CANT_RECONNECT CURLE_OBSOLETE16 672 #define CURLE_FTP_COULDNT_GET_SIZE CURLE_OBSOLETE32 673 #define CURLE_FTP_COULDNT_SET_ASCII CURLE_OBSOLETE29 674 #define CURLE_FTP_WEIRD_USER_REPLY CURLE_OBSOLETE12 675 #define CURLE_FTP_WRITE_ERROR CURLE_OBSOLETE20 676 #define CURLE_LIBRARY_NOT_FOUND CURLE_OBSOLETE40 677 #define CURLE_MALFORMAT_USER CURLE_OBSOLETE24 678 #define CURLE_SHARE_IN_USE CURLE_OBSOLETE57 679 #define CURLE_URL_MALFORMAT_USER CURLE_NOT_BUILT_IN 680 681 #define CURLE_FTP_ACCESS_DENIED CURLE_REMOTE_ACCESS_DENIED 682 #define CURLE_FTP_COULDNT_SET_BINARY CURLE_FTP_COULDNT_SET_TYPE 683 #define CURLE_FTP_QUOTE_ERROR CURLE_QUOTE_ERROR 684 #define CURLE_TFTP_DISKFULL CURLE_REMOTE_DISK_FULL 685 #define CURLE_TFTP_EXISTS CURLE_REMOTE_FILE_EXISTS 686 #define CURLE_HTTP_RANGE_ERROR CURLE_RANGE_ERROR 687 #define CURLE_FTP_SSL_FAILED CURLE_USE_SSL_FAILED 688 689 /* The following were added earlier */ 690 691 #define CURLE_OPERATION_TIMEOUTED CURLE_OPERATION_TIMEDOUT 692 #define CURLE_HTTP_NOT_FOUND CURLE_HTTP_RETURNED_ERROR 693 #define CURLE_HTTP_PORT_FAILED CURLE_INTERFACE_FAILED 694 #define CURLE_FTP_COULDNT_STOR_FILE CURLE_UPLOAD_FAILED 695 #define CURLE_FTP_PARTIAL_FILE CURLE_PARTIAL_FILE 696 #define CURLE_FTP_BAD_DOWNLOAD_RESUME CURLE_BAD_DOWNLOAD_RESUME 697 #define CURLE_LDAP_INVALID_URL CURLE_OBSOLETE62 698 #define CURLE_CONV_REQD CURLE_OBSOLETE76 699 #define CURLE_CONV_FAILED CURLE_OBSOLETE75 700 701 /* This was the error code 50 in 7.7.3 and a few earlier versions, this 702 is no longer used by libcurl but is instead #defined here only to not 703 make programs break */ 704 #define CURLE_ALREADY_COMPLETE 99999 705 706 /* Provide defines for really old option names */ 707 #define CURLOPT_FILE CURLOPT_WRITEDATA /* name changed in 7.9.7 */ 708 #define CURLOPT_INFILE CURLOPT_READDATA /* name changed in 7.9.7 */ 709 #define CURLOPT_WRITEHEADER CURLOPT_HEADERDATA 710 711 /* Since long deprecated options with no code in the lib that does anything 712 with them. */ 713 #define CURLOPT_WRITEINFO CURLOPT_OBSOLETE40 714 #define CURLOPT_CLOSEPOLICY CURLOPT_OBSOLETE72 715 716 #endif /* !CURL_NO_OLDIES */ 717 718 /* 719 * Proxy error codes. Returned in CURLINFO_PROXY_ERROR if CURLE_PROXY was 720 * return for the transfers. 721 */ 722 typedef enum { 723 CURLPX_OK, 724 CURLPX_BAD_ADDRESS_TYPE, 725 CURLPX_BAD_VERSION, 726 CURLPX_CLOSED, 727 CURLPX_GSSAPI, 728 CURLPX_GSSAPI_PERMSG, 729 CURLPX_GSSAPI_PROTECTION, 730 CURLPX_IDENTD, 731 CURLPX_IDENTD_DIFFER, 732 CURLPX_LONG_HOSTNAME, 733 CURLPX_LONG_PASSWD, 734 CURLPX_LONG_USER, 735 CURLPX_NO_AUTH, 736 CURLPX_RECV_ADDRESS, 737 CURLPX_RECV_AUTH, 738 CURLPX_RECV_CONNECT, 739 CURLPX_RECV_REQACK, 740 CURLPX_REPLY_ADDRESS_TYPE_NOT_SUPPORTED, 741 CURLPX_REPLY_COMMAND_NOT_SUPPORTED, 742 CURLPX_REPLY_CONNECTION_REFUSED, 743 CURLPX_REPLY_GENERAL_SERVER_FAILURE, 744 CURLPX_REPLY_HOST_UNREACHABLE, 745 CURLPX_REPLY_NETWORK_UNREACHABLE, 746 CURLPX_REPLY_NOT_ALLOWED, 747 CURLPX_REPLY_TTL_EXPIRED, 748 CURLPX_REPLY_UNASSIGNED, 749 CURLPX_REQUEST_FAILED, 750 CURLPX_RESOLVE_HOST, 751 CURLPX_SEND_AUTH, 752 CURLPX_SEND_CONNECT, 753 CURLPX_SEND_REQUEST, 754 CURLPX_UNKNOWN_FAIL, 755 CURLPX_UNKNOWN_MODE, 756 CURLPX_USER_REJECTED, 757 CURLPX_LAST /* never use */ 758 } CURLproxycode; 759 760 /* This prototype applies to all conversion callbacks */ 761 typedef CURLcode (*curl_conv_callback)(char *buffer, size_t length); 762 763 typedef CURLcode (*curl_ssl_ctx_callback)(CURL *curl, /* easy handle */ 764 void *ssl_ctx, /* actually an OpenSSL 765 or WolfSSL SSL_CTX, 766 or an mbedTLS 767 mbedtls_ssl_config */ 768 void *userptr); 769 770 typedef enum { 771 CURLPROXY_HTTP = 0, /* added in 7.10, new in 7.19.4 default is to use 772 CONNECT HTTP/1.1 */ 773 CURLPROXY_HTTP_1_0 = 1, /* added in 7.19.4, force to use CONNECT 774 HTTP/1.0 */ 775 CURLPROXY_HTTPS = 2, /* HTTPS but stick to HTTP/1 added in 7.52.0 */ 776 CURLPROXY_HTTPS2 = 3, /* HTTPS and attempt HTTP/2 added in 8.2.0 */ 777 CURLPROXY_SOCKS4 = 4, /* support added in 7.15.2, enum existed already 778 in 7.10 */ 779 CURLPROXY_SOCKS5 = 5, /* added in 7.10 */ 780 CURLPROXY_SOCKS4A = 6, /* added in 7.18.0 */ 781 CURLPROXY_SOCKS5_HOSTNAME = 7 /* Use the SOCKS5 protocol but pass along the 782 host name rather than the IP address. added 783 in 7.18.0 */ 784 } curl_proxytype; /* this enum was added in 7.10 */ 785 786 /* 787 * Bitmasks for CURLOPT_HTTPAUTH and CURLOPT_PROXYAUTH options: 788 * 789 * CURLAUTH_NONE - No HTTP authentication 790 * CURLAUTH_BASIC - HTTP Basic authentication (default) 791 * CURLAUTH_DIGEST - HTTP Digest authentication 792 * CURLAUTH_NEGOTIATE - HTTP Negotiate (SPNEGO) authentication 793 * CURLAUTH_GSSNEGOTIATE - Alias for CURLAUTH_NEGOTIATE (deprecated) 794 * CURLAUTH_NTLM - HTTP NTLM authentication 795 * CURLAUTH_DIGEST_IE - HTTP Digest authentication with IE flavour 796 * CURLAUTH_NTLM_WB - HTTP NTLM authentication delegated to winbind helper 797 * CURLAUTH_BEARER - HTTP Bearer token authentication 798 * CURLAUTH_ONLY - Use together with a single other type to force no 799 * authentication or just that single type 800 * CURLAUTH_ANY - All fine types set 801 * CURLAUTH_ANYSAFE - All fine types except Basic 802 */ 803 804 #define CURLAUTH_NONE ((unsigned long)0) 805 #define CURLAUTH_BASIC (((unsigned long)1)<<0) 806 #define CURLAUTH_DIGEST (((unsigned long)1)<<1) 807 #define CURLAUTH_NEGOTIATE (((unsigned long)1)<<2) 808 /* Deprecated since the advent of CURLAUTH_NEGOTIATE */ 809 #define CURLAUTH_GSSNEGOTIATE CURLAUTH_NEGOTIATE 810 /* Used for CURLOPT_SOCKS5_AUTH to stay terminologically correct */ 811 #define CURLAUTH_GSSAPI CURLAUTH_NEGOTIATE 812 #define CURLAUTH_NTLM (((unsigned long)1)<<3) 813 #define CURLAUTH_DIGEST_IE (((unsigned long)1)<<4) 814 #define CURLAUTH_NTLM_WB (((unsigned long)1)<<5) 815 #define CURLAUTH_BEARER (((unsigned long)1)<<6) 816 #define CURLAUTH_AWS_SIGV4 (((unsigned long)1)<<7) 817 #define CURLAUTH_ONLY (((unsigned long)1)<<31) 818 #define CURLAUTH_ANY (~CURLAUTH_DIGEST_IE) 819 #define CURLAUTH_ANYSAFE (~(CURLAUTH_BASIC|CURLAUTH_DIGEST_IE)) 820 821 #define CURLSSH_AUTH_ANY ~0 /* all types supported by the server */ 822 #define CURLSSH_AUTH_NONE 0 /* none allowed, silly but complete */ 823 #define CURLSSH_AUTH_PUBLICKEY (1<<0) /* public/private key files */ 824 #define CURLSSH_AUTH_PASSWORD (1<<1) /* password */ 825 #define CURLSSH_AUTH_HOST (1<<2) /* host key files */ 826 #define CURLSSH_AUTH_KEYBOARD (1<<3) /* keyboard interactive */ 827 #define CURLSSH_AUTH_AGENT (1<<4) /* agent (ssh-agent, pageant...) */ 828 #define CURLSSH_AUTH_GSSAPI (1<<5) /* gssapi (kerberos, ...) */ 829 #define CURLSSH_AUTH_DEFAULT CURLSSH_AUTH_ANY 830 831 #define CURLGSSAPI_DELEGATION_NONE 0 /* no delegation (default) */ 832 #define CURLGSSAPI_DELEGATION_POLICY_FLAG (1<<0) /* if permitted by policy */ 833 #define CURLGSSAPI_DELEGATION_FLAG (1<<1) /* delegate always */ 834 835 #define CURL_ERROR_SIZE 256 836 837 enum curl_khtype { 838 CURLKHTYPE_UNKNOWN, 839 CURLKHTYPE_RSA1, 840 CURLKHTYPE_RSA, 841 CURLKHTYPE_DSS, 842 CURLKHTYPE_ECDSA, 843 CURLKHTYPE_ED25519 844 }; 845 846 struct curl_khkey { 847 const char *key; /* points to a null-terminated string encoded with base64 848 if len is zero, otherwise to the "raw" data */ 849 size_t len; 850 enum curl_khtype keytype; 851 }; 852 853 /* this is the set of return values expected from the curl_sshkeycallback 854 callback */ 855 enum curl_khstat { 856 CURLKHSTAT_FINE_ADD_TO_FILE, 857 CURLKHSTAT_FINE, 858 CURLKHSTAT_REJECT, /* reject the connection, return an error */ 859 CURLKHSTAT_DEFER, /* do not accept it, but we can't answer right now. 860 Causes a CURLE_PEER_FAILED_VERIFICATION error but the 861 connection will be left intact etc */ 862 CURLKHSTAT_FINE_REPLACE, /* accept and replace the wrong key */ 863 CURLKHSTAT_LAST /* not for use, only a marker for last-in-list */ 864 }; 865 866 /* this is the set of status codes pass in to the callback */ 867 enum curl_khmatch { 868 CURLKHMATCH_OK, /* match */ 869 CURLKHMATCH_MISMATCH, /* host found, key mismatch! */ 870 CURLKHMATCH_MISSING, /* no matching host/key found */ 871 CURLKHMATCH_LAST /* not for use, only a marker for last-in-list */ 872 }; 873 874 typedef int 875 (*curl_sshkeycallback) (CURL *easy, /* easy handle */ 876 const struct curl_khkey *knownkey, /* known */ 877 const struct curl_khkey *foundkey, /* found */ 878 enum curl_khmatch, /* libcurl's view on the keys */ 879 void *clientp); /* custom pointer passed with */ 880 /* CURLOPT_SSH_KEYDATA */ 881 882 typedef int 883 (*curl_sshhostkeycallback) (void *clientp,/* custom pointer passed */ 884 /* with CURLOPT_SSH_HOSTKEYDATA */ 885 int keytype, /* CURLKHTYPE */ 886 const char *key, /* hostkey to check */ 887 size_t keylen); /* length of the key */ 888 /* return CURLE_OK to accept */ 889 /* or something else to refuse */ 890 891 892 /* parameter for the CURLOPT_USE_SSL option */ 893 typedef enum { 894 CURLUSESSL_NONE, /* do not attempt to use SSL */ 895 CURLUSESSL_TRY, /* try using SSL, proceed anyway otherwise */ 896 CURLUSESSL_CONTROL, /* SSL for the control connection or fail */ 897 CURLUSESSL_ALL, /* SSL for all communication or fail */ 898 CURLUSESSL_LAST /* not an option, never use */ 899 } curl_usessl; 900 901 /* Definition of bits for the CURLOPT_SSL_OPTIONS argument: */ 902 903 /* - ALLOW_BEAST tells libcurl to allow the BEAST SSL vulnerability in the 904 name of improving interoperability with older servers. Some SSL libraries 905 have introduced work-arounds for this flaw but those work-arounds sometimes 906 make the SSL communication fail. To regain functionality with those broken 907 servers, a user can this way allow the vulnerability back. */ 908 #define CURLSSLOPT_ALLOW_BEAST (1<<0) 909 910 /* - NO_REVOKE tells libcurl to disable certificate revocation checks for those 911 SSL backends where such behavior is present. */ 912 #define CURLSSLOPT_NO_REVOKE (1<<1) 913 914 /* - NO_PARTIALCHAIN tells libcurl to *NOT* accept a partial certificate chain 915 if possible. The OpenSSL backend has this ability. */ 916 #define CURLSSLOPT_NO_PARTIALCHAIN (1<<2) 917 918 /* - REVOKE_BEST_EFFORT tells libcurl to ignore certificate revocation offline 919 checks and ignore missing revocation list for those SSL backends where such 920 behavior is present. */ 921 #define CURLSSLOPT_REVOKE_BEST_EFFORT (1<<3) 922 923 /* - CURLSSLOPT_NATIVE_CA tells libcurl to use standard certificate store of 924 operating system. Currently implemented under MS-Windows. */ 925 #define CURLSSLOPT_NATIVE_CA (1<<4) 926 927 /* - CURLSSLOPT_AUTO_CLIENT_CERT tells libcurl to automatically locate and use 928 a client certificate for authentication. (Schannel) */ 929 #define CURLSSLOPT_AUTO_CLIENT_CERT (1<<5) 930 931 /* The default connection attempt delay in milliseconds for happy eyeballs. 932 CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.3 and happy-eyeballs-timeout-ms.d document 933 this value, keep them in sync. */ 934 #define CURL_HET_DEFAULT 200L 935 936 /* The default connection upkeep interval in milliseconds. */ 937 #define CURL_UPKEEP_INTERVAL_DEFAULT 60000L 938 939 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all 940 the obsolete stuff removed! */ 941 942 /* Backwards compatibility with older names */ 943 /* These are scheduled to disappear by 2009 */ 944 945 #define CURLFTPSSL_NONE CURLUSESSL_NONE 946 #define CURLFTPSSL_TRY CURLUSESSL_TRY 947 #define CURLFTPSSL_CONTROL CURLUSESSL_CONTROL 948 #define CURLFTPSSL_ALL CURLUSESSL_ALL 949 #define CURLFTPSSL_LAST CURLUSESSL_LAST 950 #define curl_ftpssl curl_usessl 951 #endif /* !CURL_NO_OLDIES */ 952 953 /* parameter for the CURLOPT_FTP_SSL_CCC option */ 954 typedef enum { 955 CURLFTPSSL_CCC_NONE, /* do not send CCC */ 956 CURLFTPSSL_CCC_PASSIVE, /* Let the server initiate the shutdown */ 957 CURLFTPSSL_CCC_ACTIVE, /* Initiate the shutdown */ 958 CURLFTPSSL_CCC_LAST /* not an option, never use */ 959 } curl_ftpccc; 960 961 /* parameter for the CURLOPT_FTPSSLAUTH option */ 962 typedef enum { 963 CURLFTPAUTH_DEFAULT, /* let libcurl decide */ 964 CURLFTPAUTH_SSL, /* use "AUTH SSL" */ 965 CURLFTPAUTH_TLS, /* use "AUTH TLS" */ 966 CURLFTPAUTH_LAST /* not an option, never use */ 967 } curl_ftpauth; 968 969 /* parameter for the CURLOPT_FTP_CREATE_MISSING_DIRS option */ 970 typedef enum { 971 CURLFTP_CREATE_DIR_NONE, /* do NOT create missing dirs! */ 972 CURLFTP_CREATE_DIR, /* (FTP/SFTP) if CWD fails, try MKD and then CWD 973 again if MKD succeeded, for SFTP this does 974 similar magic */ 975 CURLFTP_CREATE_DIR_RETRY, /* (FTP only) if CWD fails, try MKD and then CWD 976 again even if MKD failed! */ 977 CURLFTP_CREATE_DIR_LAST /* not an option, never use */ 978 } curl_ftpcreatedir; 979 980 /* parameter for the CURLOPT_FTP_FILEMETHOD option */ 981 typedef enum { 982 CURLFTPMETHOD_DEFAULT, /* let libcurl pick */ 983 CURLFTPMETHOD_MULTICWD, /* single CWD operation for each path part */ 984 CURLFTPMETHOD_NOCWD, /* no CWD at all */ 985 CURLFTPMETHOD_SINGLECWD, /* one CWD to full dir, then work on file */ 986 CURLFTPMETHOD_LAST /* not an option, never use */ 987 } curl_ftpmethod; 988 989 /* bitmask defines for CURLOPT_HEADEROPT */ 990 #define CURLHEADER_UNIFIED 0 991 #define CURLHEADER_SEPARATE (1<<0) 992 993 /* CURLALTSVC_* are bits for the CURLOPT_ALTSVC_CTRL option */ 994 #define CURLALTSVC_READONLYFILE (1<<2) 995 #define CURLALTSVC_H1 (1<<3) 996 #define CURLALTSVC_H2 (1<<4) 997 #define CURLALTSVC_H3 (1<<5) 998 999 1000 struct curl_hstsentry { 1001 char *name; 1002 size_t namelen; 1003 unsigned int includeSubDomains:1; 1004 char expire[18]; /* YYYYMMDD HH:MM:SS [null-terminated] */ 1005 }; 1006 1007 struct curl_index { 1008 size_t index; /* the provided entry's "index" or count */ 1009 size_t total; /* total number of entries to save */ 1010 }; 1011 1012 typedef enum { 1013 CURLSTS_OK, 1014 CURLSTS_DONE, 1015 CURLSTS_FAIL 1016 } CURLSTScode; 1017 1018 typedef CURLSTScode (*curl_hstsread_callback)(CURL *easy, 1019 struct curl_hstsentry *e, 1020 void *userp); 1021 typedef CURLSTScode (*curl_hstswrite_callback)(CURL *easy, 1022 struct curl_hstsentry *e, 1023 struct curl_index *i, 1024 void *userp); 1025 1026 /* CURLHSTS_* are bits for the CURLOPT_HSTS option */ 1027 #define CURLHSTS_ENABLE (long)(1<<0) 1028 #define CURLHSTS_READONLYFILE (long)(1<<1) 1029 1030 /* The CURLPROTO_ defines below are for the **deprecated** CURLOPT_*PROTOCOLS 1031 options. Do not use. */ 1032 #define CURLPROTO_HTTP (1<<0) 1033 #define CURLPROTO_HTTPS (1<<1) 1034 #define CURLPROTO_FTP (1<<2) 1035 #define CURLPROTO_FTPS (1<<3) 1036 #define CURLPROTO_SCP (1<<4) 1037 #define CURLPROTO_SFTP (1<<5) 1038 #define CURLPROTO_TELNET (1<<6) 1039 #define CURLPROTO_LDAP (1<<7) 1040 #define CURLPROTO_LDAPS (1<<8) 1041 #define CURLPROTO_DICT (1<<9) 1042 #define CURLPROTO_FILE (1<<10) 1043 #define CURLPROTO_TFTP (1<<11) 1044 #define CURLPROTO_IMAP (1<<12) 1045 #define CURLPROTO_IMAPS (1<<13) 1046 #define CURLPROTO_POP3 (1<<14) 1047 #define CURLPROTO_POP3S (1<<15) 1048 #define CURLPROTO_SMTP (1<<16) 1049 #define CURLPROTO_SMTPS (1<<17) 1050 #define CURLPROTO_RTSP (1<<18) 1051 #define CURLPROTO_RTMP (1<<19) 1052 #define CURLPROTO_RTMPT (1<<20) 1053 #define CURLPROTO_RTMPE (1<<21) 1054 #define CURLPROTO_RTMPTE (1<<22) 1055 #define CURLPROTO_RTMPS (1<<23) 1056 #define CURLPROTO_RTMPTS (1<<24) 1057 #define CURLPROTO_GOPHER (1<<25) 1058 #define CURLPROTO_SMB (1<<26) 1059 #define CURLPROTO_SMBS (1<<27) 1060 #define CURLPROTO_MQTT (1<<28) 1061 #define CURLPROTO_GOPHERS (1<<29) 1062 #define CURLPROTO_ALL (~0) /* enable everything */ 1063 1064 /* long may be 32 or 64 bits, but we should never depend on anything else 1065 but 32 */ 1066 #define CURLOPTTYPE_LONG 0 1067 #define CURLOPTTYPE_OBJECTPOINT 10000 1068 #define CURLOPTTYPE_FUNCTIONPOINT 20000 1069 #define CURLOPTTYPE_OFF_T 30000 1070 #define CURLOPTTYPE_BLOB 40000 1071 1072 /* *STRINGPOINT is an alias for OBJECTPOINT to allow tools to extract the 1073 string options from the header file */ 1074 1075 1076 #define CURLOPT(na,t,nu) na = t + nu 1077 #define CURLOPTDEPRECATED(na,t,nu,v,m) na CURL_DEPRECATED(v,m) = t + nu 1078 1079 /* CURLOPT aliases that make no run-time difference */ 1080 1081 /* 'char *' argument to a string with a trailing zero */ 1082 #define CURLOPTTYPE_STRINGPOINT CURLOPTTYPE_OBJECTPOINT 1083 1084 /* 'struct curl_slist *' argument */ 1085 #define CURLOPTTYPE_SLISTPOINT CURLOPTTYPE_OBJECTPOINT 1086 1087 /* 'void *' argument passed untouched to callback */ 1088 #define CURLOPTTYPE_CBPOINT CURLOPTTYPE_OBJECTPOINT 1089 1090 /* 'long' argument with a set of values/bitmask */ 1091 #define CURLOPTTYPE_VALUES CURLOPTTYPE_LONG 1092 1093 /* 1094 * All CURLOPT_* values. 1095 */ 1096 1097 typedef enum { 1098 /* This is the FILE * or void * the regular output should be written to. */ 1099 CURLOPT(CURLOPT_WRITEDATA, CURLOPTTYPE_CBPOINT, 1), 1100 1101 /* The full URL to get/put */ 1102 CURLOPT(CURLOPT_URL, CURLOPTTYPE_STRINGPOINT, 2), 1103 1104 /* Port number to connect to, if other than default. */ 1105 CURLOPT(CURLOPT_PORT, CURLOPTTYPE_LONG, 3), 1106 1107 /* Name of proxy to use. */ 1108 CURLOPT(CURLOPT_PROXY, CURLOPTTYPE_STRINGPOINT, 4), 1109 1110 /* "user:password;options" to use when fetching. */ 1111 CURLOPT(CURLOPT_USERPWD, CURLOPTTYPE_STRINGPOINT, 5), 1112 1113 /* "user:password" to use with proxy. */ 1114 CURLOPT(CURLOPT_PROXYUSERPWD, CURLOPTTYPE_STRINGPOINT, 6), 1115 1116 /* Range to get, specified as an ASCII string. */ 1117 CURLOPT(CURLOPT_RANGE, CURLOPTTYPE_STRINGPOINT, 7), 1118 1119 /* not used */ 1120 1121 /* Specified file stream to upload from (use as input): */ 1122 CURLOPT(CURLOPT_READDATA, CURLOPTTYPE_CBPOINT, 9), 1123 1124 /* Buffer to receive error messages in, must be at least CURL_ERROR_SIZE 1125 * bytes big. */ 1126 CURLOPT(CURLOPT_ERRORBUFFER, CURLOPTTYPE_OBJECTPOINT, 10), 1127 1128 /* Function that will be called to store the output (instead of fwrite). The 1129 * parameters will use fwrite() syntax, make sure to follow them. */ 1130 CURLOPT(CURLOPT_WRITEFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 11), 1131 1132 /* Function that will be called to read the input (instead of fread). The 1133 * parameters will use fread() syntax, make sure to follow them. */ 1134 CURLOPT(CURLOPT_READFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 12), 1135 1136 /* Time-out the read operation after this amount of seconds */ 1137 CURLOPT(CURLOPT_TIMEOUT, CURLOPTTYPE_LONG, 13), 1138 1139 /* If CURLOPT_READDATA is used, this can be used to inform libcurl about 1140 * how large the file being sent really is. That allows better error 1141 * checking and better verifies that the upload was successful. -1 means 1142 * unknown size. 1143 * 1144 * For large file support, there is also a _LARGE version of the key 1145 * which takes an off_t type, allowing platforms with larger off_t 1146 * sizes to handle larger files. See below for INFILESIZE_LARGE. 1147 */ 1148 CURLOPT(CURLOPT_INFILESIZE, CURLOPTTYPE_LONG, 14), 1149 1150 /* POST static input fields. */ 1151 CURLOPT(CURLOPT_POSTFIELDS, CURLOPTTYPE_OBJECTPOINT, 15), 1152 1153 /* Set the referrer page (needed by some CGIs) */ 1154 CURLOPT(CURLOPT_REFERER, CURLOPTTYPE_STRINGPOINT, 16), 1155 1156 /* Set the FTP PORT string (interface name, named or numerical IP address) 1157 Use i.e '-' to use default address. */ 1158 CURLOPT(CURLOPT_FTPPORT, CURLOPTTYPE_STRINGPOINT, 17), 1159 1160 /* Set the User-Agent string (examined by some CGIs) */ 1161 CURLOPT(CURLOPT_USERAGENT, CURLOPTTYPE_STRINGPOINT, 18), 1162 1163 /* If the download receives less than "low speed limit" bytes/second 1164 * during "low speed time" seconds, the operations is aborted. 1165 * You could i.e if you have a pretty high speed connection, abort if 1166 * it is less than 2000 bytes/sec during 20 seconds. 1167 */ 1168 1169 /* Set the "low speed limit" */ 1170 CURLOPT(CURLOPT_LOW_SPEED_LIMIT, CURLOPTTYPE_LONG, 19), 1171 1172 /* Set the "low speed time" */ 1173 CURLOPT(CURLOPT_LOW_SPEED_TIME, CURLOPTTYPE_LONG, 20), 1174 1175 /* Set the continuation offset. 1176 * 1177 * Note there is also a _LARGE version of this key which uses 1178 * off_t types, allowing for large file offsets on platforms which 1179 * use larger-than-32-bit off_t's. Look below for RESUME_FROM_LARGE. 1180 */ 1181 CURLOPT(CURLOPT_RESUME_FROM, CURLOPTTYPE_LONG, 21), 1182 1183 /* Set cookie in request: */ 1184 CURLOPT(CURLOPT_COOKIE, CURLOPTTYPE_STRINGPOINT, 22), 1185 1186 /* This points to a linked list of headers, struct curl_slist kind. This 1187 list is also used for RTSP (in spite of its name) */ 1188 CURLOPT(CURLOPT_HTTPHEADER, CURLOPTTYPE_SLISTPOINT, 23), 1189 1190 /* This points to a linked list of post entries, struct curl_httppost */ 1191 CURLOPTDEPRECATED(CURLOPT_HTTPPOST, CURLOPTTYPE_OBJECTPOINT, 24, 1192 7.56.0, "Use CURLOPT_MIMEPOST"), 1193 1194 /* name of the file keeping your private SSL-certificate */ 1195 CURLOPT(CURLOPT_SSLCERT, CURLOPTTYPE_STRINGPOINT, 25), 1196 1197 /* password for the SSL or SSH private key */ 1198 CURLOPT(CURLOPT_KEYPASSWD, CURLOPTTYPE_STRINGPOINT, 26), 1199 1200 /* send TYPE parameter? */ 1201 CURLOPT(CURLOPT_CRLF, CURLOPTTYPE_LONG, 27), 1202 1203 /* send linked-list of QUOTE commands */ 1204 CURLOPT(CURLOPT_QUOTE, CURLOPTTYPE_SLISTPOINT, 28), 1205 1206 /* send FILE * or void * to store headers to, if you use a callback it 1207 is simply passed to the callback unmodified */ 1208 CURLOPT(CURLOPT_HEADERDATA, CURLOPTTYPE_CBPOINT, 29), 1209 1210 /* point to a file to read the initial cookies from, also enables 1211 "cookie awareness" */ 1212 CURLOPT(CURLOPT_COOKIEFILE, CURLOPTTYPE_STRINGPOINT, 31), 1213 1214 /* What version to specifically try to use. 1215 See CURL_SSLVERSION defines below. */ 1216 CURLOPT(CURLOPT_SSLVERSION, CURLOPTTYPE_VALUES, 32), 1217 1218 /* What kind of HTTP time condition to use, see defines */ 1219 CURLOPT(CURLOPT_TIMECONDITION, CURLOPTTYPE_VALUES, 33), 1220 1221 /* Time to use with the above condition. Specified in number of seconds 1222 since 1 Jan 1970 */ 1223 CURLOPT(CURLOPT_TIMEVALUE, CURLOPTTYPE_LONG, 34), 1224 1225 /* 35 = OBSOLETE */ 1226 1227 /* Custom request, for customizing the get command like 1228 HTTP: DELETE, TRACE and others 1229 FTP: to use a different list command 1230 */ 1231 CURLOPT(CURLOPT_CUSTOMREQUEST, CURLOPTTYPE_STRINGPOINT, 36), 1232 1233 /* FILE handle to use instead of stderr */ 1234 CURLOPT(CURLOPT_STDERR, CURLOPTTYPE_OBJECTPOINT, 37), 1235 1236 /* 38 is not used */ 1237 1238 /* send linked-list of post-transfer QUOTE commands */ 1239 CURLOPT(CURLOPT_POSTQUOTE, CURLOPTTYPE_SLISTPOINT, 39), 1240 1241 /* OBSOLETE, do not use! */ 1242 CURLOPT(CURLOPT_OBSOLETE40, CURLOPTTYPE_OBJECTPOINT, 40), 1243 1244 /* talk a lot */ 1245 CURLOPT(CURLOPT_VERBOSE, CURLOPTTYPE_LONG, 41), 1246 1247 /* throw the header out too */ 1248 CURLOPT(CURLOPT_HEADER, CURLOPTTYPE_LONG, 42), 1249 1250 /* shut off the progress meter */ 1251 CURLOPT(CURLOPT_NOPROGRESS, CURLOPTTYPE_LONG, 43), 1252 1253 /* use HEAD to get http document */ 1254 CURLOPT(CURLOPT_NOBODY, CURLOPTTYPE_LONG, 44), 1255 1256 /* no output on http error codes >= 400 */ 1257 CURLOPT(CURLOPT_FAILONERROR, CURLOPTTYPE_LONG, 45), 1258 1259 /* this is an upload */ 1260 CURLOPT(CURLOPT_UPLOAD, CURLOPTTYPE_LONG, 46), 1261 1262 /* HTTP POST method */ 1263 CURLOPT(CURLOPT_POST, CURLOPTTYPE_LONG, 47), 1264 1265 /* bare names when listing directories */ 1266 CURLOPT(CURLOPT_DIRLISTONLY, CURLOPTTYPE_LONG, 48), 1267 1268 /* Append instead of overwrite on upload! */ 1269 CURLOPT(CURLOPT_APPEND, CURLOPTTYPE_LONG, 50), 1270 1271 /* Specify whether to read the user+password from the .netrc or the URL. 1272 * This must be one of the CURL_NETRC_* enums below. */ 1273 CURLOPT(CURLOPT_NETRC, CURLOPTTYPE_VALUES, 51), 1274 1275 /* use Location: Luke! */ 1276 CURLOPT(CURLOPT_FOLLOWLOCATION, CURLOPTTYPE_LONG, 52), 1277 1278 /* transfer data in text/ASCII format */ 1279 CURLOPT(CURLOPT_TRANSFERTEXT, CURLOPTTYPE_LONG, 53), 1280 1281 /* HTTP PUT */ 1282 CURLOPTDEPRECATED(CURLOPT_PUT, CURLOPTTYPE_LONG, 54, 1283 7.12.1, "Use CURLOPT_UPLOAD"), 1284 1285 /* 55 = OBSOLETE */ 1286 1287 /* DEPRECATED 1288 * Function that will be called instead of the internal progress display 1289 * function. This function should be defined as the curl_progress_callback 1290 * prototype defines. */ 1291 CURLOPTDEPRECATED(CURLOPT_PROGRESSFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 56, 1292 7.32.0, "Use CURLOPT_XFERINFOFUNCTION"), 1293 1294 /* Data passed to the CURLOPT_PROGRESSFUNCTION and CURLOPT_XFERINFOFUNCTION 1295 callbacks */ 1296 CURLOPT(CURLOPT_XFERINFODATA, CURLOPTTYPE_CBPOINT, 57), 1297 #define CURLOPT_PROGRESSDATA CURLOPT_XFERINFODATA 1298 1299 /* We want the referrer field set automatically when following locations */ 1300 CURLOPT(CURLOPT_AUTOREFERER, CURLOPTTYPE_LONG, 58), 1301 1302 /* Port of the proxy, can be set in the proxy string as well with: 1303 "[host]:[port]" */ 1304 CURLOPT(CURLOPT_PROXYPORT, CURLOPTTYPE_LONG, 59), 1305 1306 /* size of the POST input data, if strlen() is not good to use */ 1307 CURLOPT(CURLOPT_POSTFIELDSIZE, CURLOPTTYPE_LONG, 60), 1308 1309 /* tunnel non-http operations through an HTTP proxy */ 1310 CURLOPT(CURLOPT_HTTPPROXYTUNNEL, CURLOPTTYPE_LONG, 61), 1311 1312 /* Set the interface string to use as outgoing network interface */ 1313 CURLOPT(CURLOPT_INTERFACE, CURLOPTTYPE_STRINGPOINT, 62), 1314 1315 /* Set the krb4/5 security level, this also enables krb4/5 awareness. This 1316 * is a string, 'clear', 'safe', 'confidential' or 'private'. If the string 1317 * is set but doesn't match one of these, 'private' will be used. */ 1318 CURLOPT(CURLOPT_KRBLEVEL, CURLOPTTYPE_STRINGPOINT, 63), 1319 1320 /* Set if we should verify the peer in ssl handshake, set 1 to verify. */ 1321 CURLOPT(CURLOPT_SSL_VERIFYPEER, CURLOPTTYPE_LONG, 64), 1322 1323 /* The CApath or CAfile used to validate the peer certificate 1324 this option is used only if SSL_VERIFYPEER is true */ 1325 CURLOPT(CURLOPT_CAINFO, CURLOPTTYPE_STRINGPOINT, 65), 1326 1327 /* 66 = OBSOLETE */ 1328 /* 67 = OBSOLETE */ 1329 1330 /* Maximum number of http redirects to follow */ 1331 CURLOPT(CURLOPT_MAXREDIRS, CURLOPTTYPE_LONG, 68), 1332 1333 /* Pass a long set to 1 to get the date of the requested document (if 1334 possible)! Pass a zero to shut it off. */ 1335 CURLOPT(CURLOPT_FILETIME, CURLOPTTYPE_LONG, 69), 1336 1337 /* This points to a linked list of telnet options */ 1338 CURLOPT(CURLOPT_TELNETOPTIONS, CURLOPTTYPE_SLISTPOINT, 70), 1339 1340 /* Max amount of cached alive connections */ 1341 CURLOPT(CURLOPT_MAXCONNECTS, CURLOPTTYPE_LONG, 71), 1342 1343 /* OBSOLETE, do not use! */ 1344 CURLOPT(CURLOPT_OBSOLETE72, CURLOPTTYPE_LONG, 72), 1345 1346 /* 73 = OBSOLETE */ 1347 1348 /* Set to explicitly use a new connection for the upcoming transfer. 1349 Do not use this unless you're absolutely sure of this, as it makes the 1350 operation slower and is less friendly for the network. */ 1351 CURLOPT(CURLOPT_FRESH_CONNECT, CURLOPTTYPE_LONG, 74), 1352 1353 /* Set to explicitly forbid the upcoming transfer's connection to be reused 1354 when done. Do not use this unless you're absolutely sure of this, as it 1355 makes the operation slower and is less friendly for the network. */ 1356 CURLOPT(CURLOPT_FORBID_REUSE, CURLOPTTYPE_LONG, 75), 1357 1358 /* Set to a file name that contains random data for libcurl to use to 1359 seed the random engine when doing SSL connects. */ 1360 CURLOPTDEPRECATED(CURLOPT_RANDOM_FILE, CURLOPTTYPE_STRINGPOINT, 76, 1361 7.84.0, "Serves no purpose anymore"), 1362 1363 /* Set to the Entropy Gathering Daemon socket pathname */ 1364 CURLOPTDEPRECATED(CURLOPT_EGDSOCKET, CURLOPTTYPE_STRINGPOINT, 77, 1365 7.84.0, "Serves no purpose anymore"), 1366 1367 /* Time-out connect operations after this amount of seconds, if connects are 1368 OK within this time, then fine... This only aborts the connect phase. */ 1369 CURLOPT(CURLOPT_CONNECTTIMEOUT, CURLOPTTYPE_LONG, 78), 1370 1371 /* Function that will be called to store headers (instead of fwrite). The 1372 * parameters will use fwrite() syntax, make sure to follow them. */ 1373 CURLOPT(CURLOPT_HEADERFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 79), 1374 1375 /* Set this to force the HTTP request to get back to GET. Only really usable 1376 if POST, PUT or a custom request have been used first. 1377 */ 1378 CURLOPT(CURLOPT_HTTPGET, CURLOPTTYPE_LONG, 80), 1379 1380 /* Set if we should verify the Common name from the peer certificate in ssl 1381 * handshake, set 1 to check existence, 2 to ensure that it matches the 1382 * provided hostname. */ 1383 CURLOPT(CURLOPT_SSL_VERIFYHOST, CURLOPTTYPE_LONG, 81), 1384 1385 /* Specify which file name to write all known cookies in after completed 1386 operation. Set file name to "-" (dash) to make it go to stdout. */ 1387 CURLOPT(CURLOPT_COOKIEJAR, CURLOPTTYPE_STRINGPOINT, 82), 1388 1389 /* Specify which SSL ciphers to use */ 1390 CURLOPT(CURLOPT_SSL_CIPHER_LIST, CURLOPTTYPE_STRINGPOINT, 83), 1391 1392 /* Specify which HTTP version to use! This must be set to one of the 1393 CURL_HTTP_VERSION* enums set below. */ 1394 CURLOPT(CURLOPT_HTTP_VERSION, CURLOPTTYPE_VALUES, 84), 1395 1396 /* Specifically switch on or off the FTP engine's use of the EPSV command. By 1397 default, that one will always be attempted before the more traditional 1398 PASV command. */ 1399 CURLOPT(CURLOPT_FTP_USE_EPSV, CURLOPTTYPE_LONG, 85), 1400 1401 /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") */ 1402 CURLOPT(CURLOPT_SSLCERTTYPE, CURLOPTTYPE_STRINGPOINT, 86), 1403 1404 /* name of the file keeping your private SSL-key */ 1405 CURLOPT(CURLOPT_SSLKEY, CURLOPTTYPE_STRINGPOINT, 87), 1406 1407 /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") */ 1408 CURLOPT(CURLOPT_SSLKEYTYPE, CURLOPTTYPE_STRINGPOINT, 88), 1409 1410 /* crypto engine for the SSL-sub system */ 1411 CURLOPT(CURLOPT_SSLENGINE, CURLOPTTYPE_STRINGPOINT, 89), 1412 1413 /* set the crypto engine for the SSL-sub system as default 1414 the param has no meaning... 1415 */ 1416 CURLOPT(CURLOPT_SSLENGINE_DEFAULT, CURLOPTTYPE_LONG, 90), 1417 1418 /* Non-zero value means to use the global dns cache */ 1419 /* DEPRECATED, do not use! */ 1420 CURLOPTDEPRECATED(CURLOPT_DNS_USE_GLOBAL_CACHE, CURLOPTTYPE_LONG, 91, 1421 7.11.1, "Use CURLOPT_SHARE"), 1422 1423 /* DNS cache timeout */ 1424 CURLOPT(CURLOPT_DNS_CACHE_TIMEOUT, CURLOPTTYPE_LONG, 92), 1425 1426 /* send linked-list of pre-transfer QUOTE commands */ 1427 CURLOPT(CURLOPT_PREQUOTE, CURLOPTTYPE_SLISTPOINT, 93), 1428 1429 /* set the debug function */ 1430 CURLOPT(CURLOPT_DEBUGFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 94), 1431 1432 /* set the data for the debug function */ 1433 CURLOPT(CURLOPT_DEBUGDATA, CURLOPTTYPE_CBPOINT, 95), 1434 1435 /* mark this as start of a cookie session */ 1436 CURLOPT(CURLOPT_COOKIESESSION, CURLOPTTYPE_LONG, 96), 1437 1438 /* The CApath directory used to validate the peer certificate 1439 this option is used only if SSL_VERIFYPEER is true */ 1440 CURLOPT(CURLOPT_CAPATH, CURLOPTTYPE_STRINGPOINT, 97), 1441 1442 /* Instruct libcurl to use a smaller receive buffer */ 1443 CURLOPT(CURLOPT_BUFFERSIZE, CURLOPTTYPE_LONG, 98), 1444 1445 /* Instruct libcurl to not use any signal/alarm handlers, even when using 1446 timeouts. This option is useful for multi-threaded applications. 1447 See libcurl-the-guide for more background information. */ 1448 CURLOPT(CURLOPT_NOSIGNAL, CURLOPTTYPE_LONG, 99), 1449 1450 /* Provide a CURLShare for mutexing non-ts data */ 1451 CURLOPT(CURLOPT_SHARE, CURLOPTTYPE_OBJECTPOINT, 100), 1452 1453 /* indicates type of proxy. accepted values are CURLPROXY_HTTP (default), 1454 CURLPROXY_HTTPS, CURLPROXY_SOCKS4, CURLPROXY_SOCKS4A and 1455 CURLPROXY_SOCKS5. */ 1456 CURLOPT(CURLOPT_PROXYTYPE, CURLOPTTYPE_VALUES, 101), 1457 1458 /* Set the Accept-Encoding string. Use this to tell a server you would like 1459 the response to be compressed. Before 7.21.6, this was known as 1460 CURLOPT_ENCODING */ 1461 CURLOPT(CURLOPT_ACCEPT_ENCODING, CURLOPTTYPE_STRINGPOINT, 102), 1462 1463 /* Set pointer to private data */ 1464 CURLOPT(CURLOPT_PRIVATE, CURLOPTTYPE_OBJECTPOINT, 103), 1465 1466 /* Set aliases for HTTP 200 in the HTTP Response header */ 1467 CURLOPT(CURLOPT_HTTP200ALIASES, CURLOPTTYPE_SLISTPOINT, 104), 1468 1469 /* Continue to send authentication (user+password) when following locations, 1470 even when hostname changed. This can potentially send off the name 1471 and password to whatever host the server decides. */ 1472 CURLOPT(CURLOPT_UNRESTRICTED_AUTH, CURLOPTTYPE_LONG, 105), 1473 1474 /* Specifically switch on or off the FTP engine's use of the EPRT command ( 1475 it also disables the LPRT attempt). By default, those ones will always be 1476 attempted before the good old traditional PORT command. */ 1477 CURLOPT(CURLOPT_FTP_USE_EPRT, CURLOPTTYPE_LONG, 106), 1478 1479 /* Set this to a bitmask value to enable the particular authentications 1480 methods you like. Use this in combination with CURLOPT_USERPWD. 1481 Note that setting multiple bits may cause extra network round-trips. */ 1482 CURLOPT(CURLOPT_HTTPAUTH, CURLOPTTYPE_VALUES, 107), 1483 1484 /* Set the ssl context callback function, currently only for OpenSSL or 1485 WolfSSL ssl_ctx, or mbedTLS mbedtls_ssl_config in the second argument. 1486 The function must match the curl_ssl_ctx_callback prototype. */ 1487 CURLOPT(CURLOPT_SSL_CTX_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 108), 1488 1489 /* Set the userdata for the ssl context callback function's third 1490 argument */ 1491 CURLOPT(CURLOPT_SSL_CTX_DATA, CURLOPTTYPE_CBPOINT, 109), 1492 1493 /* FTP Option that causes missing dirs to be created on the remote server. 1494 In 7.19.4 we introduced the convenience enums for this option using the 1495 CURLFTP_CREATE_DIR prefix. 1496 */ 1497 CURLOPT(CURLOPT_FTP_CREATE_MISSING_DIRS, CURLOPTTYPE_LONG, 110), 1498 1499 /* Set this to a bitmask value to enable the particular authentications 1500 methods you like. Use this in combination with CURLOPT_PROXYUSERPWD. 1501 Note that setting multiple bits may cause extra network round-trips. */ 1502 CURLOPT(CURLOPT_PROXYAUTH, CURLOPTTYPE_VALUES, 111), 1503 1504 /* Option that changes the timeout, in seconds, associated with getting a 1505 response. This is different from transfer timeout time and essentially 1506 places a demand on the server to acknowledge commands in a timely 1507 manner. For FTP, SMTP, IMAP and POP3. */ 1508 CURLOPT(CURLOPT_SERVER_RESPONSE_TIMEOUT, CURLOPTTYPE_LONG, 112), 1509 1510 /* Set this option to one of the CURL_IPRESOLVE_* defines (see below) to 1511 tell libcurl to use those IP versions only. This only has effect on 1512 systems with support for more than one, i.e IPv4 _and_ IPv6. */ 1513 CURLOPT(CURLOPT_IPRESOLVE, CURLOPTTYPE_VALUES, 113), 1514 1515 /* Set this option to limit the size of a file that will be downloaded from 1516 an HTTP or FTP server. 1517 1518 Note there is also _LARGE version which adds large file support for 1519 platforms which have larger off_t sizes. See MAXFILESIZE_LARGE below. */ 1520 CURLOPT(CURLOPT_MAXFILESIZE, CURLOPTTYPE_LONG, 114), 1521 1522 /* See the comment for INFILESIZE above, but in short, specifies 1523 * the size of the file being uploaded. -1 means unknown. 1524 */ 1525 CURLOPT(CURLOPT_INFILESIZE_LARGE, CURLOPTTYPE_OFF_T, 115), 1526 1527 /* Sets the continuation offset. There is also a CURLOPTTYPE_LONG version 1528 * of this; look above for RESUME_FROM. 1529 */ 1530 CURLOPT(CURLOPT_RESUME_FROM_LARGE, CURLOPTTYPE_OFF_T, 116), 1531 1532 /* Sets the maximum size of data that will be downloaded from 1533 * an HTTP or FTP server. See MAXFILESIZE above for the LONG version. 1534 */ 1535 CURLOPT(CURLOPT_MAXFILESIZE_LARGE, CURLOPTTYPE_OFF_T, 117), 1536 1537 /* Set this option to the file name of your .netrc file you want libcurl 1538 to parse (using the CURLOPT_NETRC option). If not set, libcurl will do 1539 a poor attempt to find the user's home directory and check for a .netrc 1540 file in there. */ 1541 CURLOPT(CURLOPT_NETRC_FILE, CURLOPTTYPE_STRINGPOINT, 118), 1542 1543 /* Enable SSL/TLS for FTP, pick one of: 1544 CURLUSESSL_TRY - try using SSL, proceed anyway otherwise 1545 CURLUSESSL_CONTROL - SSL for the control connection or fail 1546 CURLUSESSL_ALL - SSL for all communication or fail 1547 */ 1548 CURLOPT(CURLOPT_USE_SSL, CURLOPTTYPE_VALUES, 119), 1549 1550 /* The _LARGE version of the standard POSTFIELDSIZE option */ 1551 CURLOPT(CURLOPT_POSTFIELDSIZE_LARGE, CURLOPTTYPE_OFF_T, 120), 1552 1553 /* Enable/disable the TCP Nagle algorithm */ 1554 CURLOPT(CURLOPT_TCP_NODELAY, CURLOPTTYPE_LONG, 121), 1555 1556 /* 122 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ 1557 /* 123 OBSOLETE. Gone in 7.16.0 */ 1558 /* 124 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ 1559 /* 125 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ 1560 /* 126 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ 1561 /* 127 OBSOLETE. Gone in 7.16.0 */ 1562 /* 128 OBSOLETE. Gone in 7.16.0 */ 1563 1564 /* When FTP over SSL/TLS is selected (with CURLOPT_USE_SSL), this option 1565 can be used to change libcurl's default action which is to first try 1566 "AUTH SSL" and then "AUTH TLS" in this order, and proceed when a OK 1567 response has been received. 1568 1569 Available parameters are: 1570 CURLFTPAUTH_DEFAULT - let libcurl decide 1571 CURLFTPAUTH_SSL - try "AUTH SSL" first, then TLS 1572 CURLFTPAUTH_TLS - try "AUTH TLS" first, then SSL 1573 */ 1574 CURLOPT(CURLOPT_FTPSSLAUTH, CURLOPTTYPE_VALUES, 129), 1575 1576 CURLOPTDEPRECATED(CURLOPT_IOCTLFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 130, 1577 7.18.0, "Use CURLOPT_SEEKFUNCTION"), 1578 CURLOPTDEPRECATED(CURLOPT_IOCTLDATA, CURLOPTTYPE_CBPOINT, 131, 1579 7.18.0, "Use CURLOPT_SEEKDATA"), 1580 1581 /* 132 OBSOLETE. Gone in 7.16.0 */ 1582 /* 133 OBSOLETE. Gone in 7.16.0 */ 1583 1584 /* null-terminated string for pass on to the FTP server when asked for 1585 "account" info */ 1586 CURLOPT(CURLOPT_FTP_ACCOUNT, CURLOPTTYPE_STRINGPOINT, 134), 1587 1588 /* feed cookie into cookie engine */ 1589 CURLOPT(CURLOPT_COOKIELIST, CURLOPTTYPE_STRINGPOINT, 135), 1590 1591 /* ignore Content-Length */ 1592 CURLOPT(CURLOPT_IGNORE_CONTENT_LENGTH, CURLOPTTYPE_LONG, 136), 1593 1594 /* Set to non-zero to skip the IP address received in a 227 PASV FTP server 1595 response. Typically used for FTP-SSL purposes but is not restricted to 1596 that. libcurl will then instead use the same IP address it used for the 1597 control connection. */ 1598 CURLOPT(CURLOPT_FTP_SKIP_PASV_IP, CURLOPTTYPE_LONG, 137), 1599 1600 /* Select "file method" to use when doing FTP, see the curl_ftpmethod 1601 above. */ 1602 CURLOPT(CURLOPT_FTP_FILEMETHOD, CURLOPTTYPE_VALUES, 138), 1603 1604 /* Local port number to bind the socket to */ 1605 CURLOPT(CURLOPT_LOCALPORT, CURLOPTTYPE_LONG, 139), 1606 1607 /* Number of ports to try, including the first one set with LOCALPORT. 1608 Thus, setting it to 1 will make no additional attempts but the first. 1609 */ 1610 CURLOPT(CURLOPT_LOCALPORTRANGE, CURLOPTTYPE_LONG, 140), 1611 1612 /* no transfer, set up connection and let application use the socket by 1613 extracting it with CURLINFO_LASTSOCKET */ 1614 CURLOPT(CURLOPT_CONNECT_ONLY, CURLOPTTYPE_LONG, 141), 1615 1616 /* Function that will be called to convert from the 1617 network encoding (instead of using the iconv calls in libcurl) */ 1618 CURLOPTDEPRECATED(CURLOPT_CONV_FROM_NETWORK_FUNCTION, 1619 CURLOPTTYPE_FUNCTIONPOINT, 142, 1620 7.82.0, "Serves no purpose anymore"), 1621 1622 /* Function that will be called to convert to the 1623 network encoding (instead of using the iconv calls in libcurl) */ 1624 CURLOPTDEPRECATED(CURLOPT_CONV_TO_NETWORK_FUNCTION, 1625 CURLOPTTYPE_FUNCTIONPOINT, 143, 1626 7.82.0, "Serves no purpose anymore"), 1627 1628 /* Function that will be called to convert from UTF8 1629 (instead of using the iconv calls in libcurl) 1630 Note that this is used only for SSL certificate processing */ 1631 CURLOPTDEPRECATED(CURLOPT_CONV_FROM_UTF8_FUNCTION, 1632 CURLOPTTYPE_FUNCTIONPOINT, 144, 1633 7.82.0, "Serves no purpose anymore"), 1634 1635 /* if the connection proceeds too quickly then need to slow it down */ 1636 /* limit-rate: maximum number of bytes per second to send or receive */ 1637 CURLOPT(CURLOPT_MAX_SEND_SPEED_LARGE, CURLOPTTYPE_OFF_T, 145), 1638 CURLOPT(CURLOPT_MAX_RECV_SPEED_LARGE, CURLOPTTYPE_OFF_T, 146), 1639 1640 /* Pointer to command string to send if USER/PASS fails. */ 1641 CURLOPT(CURLOPT_FTP_ALTERNATIVE_TO_USER, CURLOPTTYPE_STRINGPOINT, 147), 1642 1643 /* callback function for setting socket options */ 1644 CURLOPT(CURLOPT_SOCKOPTFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 148), 1645 CURLOPT(CURLOPT_SOCKOPTDATA, CURLOPTTYPE_CBPOINT, 149), 1646 1647 /* set to 0 to disable session ID reuse for this transfer, default is 1648 enabled (== 1) */ 1649 CURLOPT(CURLOPT_SSL_SESSIONID_CACHE, CURLOPTTYPE_LONG, 150), 1650 1651 /* allowed SSH authentication methods */ 1652 CURLOPT(CURLOPT_SSH_AUTH_TYPES, CURLOPTTYPE_VALUES, 151), 1653 1654 /* Used by scp/sftp to do public/private key authentication */ 1655 CURLOPT(CURLOPT_SSH_PUBLIC_KEYFILE, CURLOPTTYPE_STRINGPOINT, 152), 1656 CURLOPT(CURLOPT_SSH_PRIVATE_KEYFILE, CURLOPTTYPE_STRINGPOINT, 153), 1657 1658 /* Send CCC (Clear Command Channel) after authentication */ 1659 CURLOPT(CURLOPT_FTP_SSL_CCC, CURLOPTTYPE_LONG, 154), 1660 1661 /* Same as TIMEOUT and CONNECTTIMEOUT, but with ms resolution */ 1662 CURLOPT(CURLOPT_TIMEOUT_MS, CURLOPTTYPE_LONG, 155), 1663 CURLOPT(CURLOPT_CONNECTTIMEOUT_MS, CURLOPTTYPE_LONG, 156), 1664 1665 /* set to zero to disable the libcurl's decoding and thus pass the raw body 1666 data to the application even when it is encoded/compressed */ 1667 CURLOPT(CURLOPT_HTTP_TRANSFER_DECODING, CURLOPTTYPE_LONG, 157), 1668 CURLOPT(CURLOPT_HTTP_CONTENT_DECODING, CURLOPTTYPE_LONG, 158), 1669 1670 /* Permission used when creating new files and directories on the remote 1671 server for protocols that support it, SFTP/SCP/FILE */ 1672 CURLOPT(CURLOPT_NEW_FILE_PERMS, CURLOPTTYPE_LONG, 159), 1673 CURLOPT(CURLOPT_NEW_DIRECTORY_PERMS, CURLOPTTYPE_LONG, 160), 1674 1675 /* Set the behavior of POST when redirecting. Values must be set to one 1676 of CURL_REDIR* defines below. This used to be called CURLOPT_POST301 */ 1677 CURLOPT(CURLOPT_POSTREDIR, CURLOPTTYPE_VALUES, 161), 1678 1679 /* used by scp/sftp to verify the host's public key */ 1680 CURLOPT(CURLOPT_SSH_HOST_PUBLIC_KEY_MD5, CURLOPTTYPE_STRINGPOINT, 162), 1681 1682 /* Callback function for opening socket (instead of socket(2)). Optionally, 1683 callback is able change the address or refuse to connect returning 1684 CURL_SOCKET_BAD. The callback should have type 1685 curl_opensocket_callback */ 1686 CURLOPT(CURLOPT_OPENSOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 163), 1687 CURLOPT(CURLOPT_OPENSOCKETDATA, CURLOPTTYPE_CBPOINT, 164), 1688 1689 /* POST volatile input fields. */ 1690 CURLOPT(CURLOPT_COPYPOSTFIELDS, CURLOPTTYPE_OBJECTPOINT, 165), 1691 1692 /* set transfer mode (;type=<a|i>) when doing FTP via an HTTP proxy */ 1693 CURLOPT(CURLOPT_PROXY_TRANSFER_MODE, CURLOPTTYPE_LONG, 166), 1694 1695 /* Callback function for seeking in the input stream */ 1696 CURLOPT(CURLOPT_SEEKFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 167), 1697 CURLOPT(CURLOPT_SEEKDATA, CURLOPTTYPE_CBPOINT, 168), 1698 1699 /* CRL file */ 1700 CURLOPT(CURLOPT_CRLFILE, CURLOPTTYPE_STRINGPOINT, 169), 1701 1702 /* Issuer certificate */ 1703 CURLOPT(CURLOPT_ISSUERCERT, CURLOPTTYPE_STRINGPOINT, 170), 1704 1705 /* (IPv6) Address scope */ 1706 CURLOPT(CURLOPT_ADDRESS_SCOPE, CURLOPTTYPE_LONG, 171), 1707 1708 /* Collect certificate chain info and allow it to get retrievable with 1709 CURLINFO_CERTINFO after the transfer is complete. */ 1710 CURLOPT(CURLOPT_CERTINFO, CURLOPTTYPE_LONG, 172), 1711 1712 /* "name" and "pwd" to use when fetching. */ 1713 CURLOPT(CURLOPT_USERNAME, CURLOPTTYPE_STRINGPOINT, 173), 1714 CURLOPT(CURLOPT_PASSWORD, CURLOPTTYPE_STRINGPOINT, 174), 1715 1716 /* "name" and "pwd" to use with Proxy when fetching. */ 1717 CURLOPT(CURLOPT_PROXYUSERNAME, CURLOPTTYPE_STRINGPOINT, 175), 1718 CURLOPT(CURLOPT_PROXYPASSWORD, CURLOPTTYPE_STRINGPOINT, 176), 1719 1720 /* Comma separated list of hostnames defining no-proxy zones. These should 1721 match both hostnames directly, and hostnames within a domain. For 1722 example, local.com will match local.com and www.local.com, but NOT 1723 notlocal.com or www.notlocal.com. For compatibility with other 1724 implementations of this, .local.com will be considered to be the same as 1725 local.com. A single * is the only valid wildcard, and effectively 1726 disables the use of proxy. */ 1727 CURLOPT(CURLOPT_NOPROXY, CURLOPTTYPE_STRINGPOINT, 177), 1728 1729 /* block size for TFTP transfers */ 1730 CURLOPT(CURLOPT_TFTP_BLKSIZE, CURLOPTTYPE_LONG, 178), 1731 1732 /* Socks Service */ 1733 /* DEPRECATED, do not use! */ 1734 CURLOPTDEPRECATED(CURLOPT_SOCKS5_GSSAPI_SERVICE, 1735 CURLOPTTYPE_STRINGPOINT, 179, 1736 7.49.0, "Use CURLOPT_PROXY_SERVICE_NAME"), 1737 1738 /* Socks Service */ 1739 CURLOPT(CURLOPT_SOCKS5_GSSAPI_NEC, CURLOPTTYPE_LONG, 180), 1740 1741 /* set the bitmask for the protocols that are allowed to be used for the 1742 transfer, which thus helps the app which takes URLs from users or other 1743 external inputs and want to restrict what protocol(s) to deal 1744 with. Defaults to CURLPROTO_ALL. */ 1745 CURLOPTDEPRECATED(CURLOPT_PROTOCOLS, CURLOPTTYPE_LONG, 181, 1746 7.85.0, "Use CURLOPT_PROTOCOLS_STR"), 1747 1748 /* set the bitmask for the protocols that libcurl is allowed to follow to, 1749 as a subset of the CURLOPT_PROTOCOLS ones. That means the protocol needs 1750 to be set in both bitmasks to be allowed to get redirected to. */ 1751 CURLOPTDEPRECATED(CURLOPT_REDIR_PROTOCOLS, CURLOPTTYPE_LONG, 182, 1752 7.85.0, "Use CURLOPT_REDIR_PROTOCOLS_STR"), 1753 1754 /* set the SSH knownhost file name to use */ 1755 CURLOPT(CURLOPT_SSH_KNOWNHOSTS, CURLOPTTYPE_STRINGPOINT, 183), 1756 1757 /* set the SSH host key callback, must point to a curl_sshkeycallback 1758 function */ 1759 CURLOPT(CURLOPT_SSH_KEYFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 184), 1760 1761 /* set the SSH host key callback custom pointer */ 1762 CURLOPT(CURLOPT_SSH_KEYDATA, CURLOPTTYPE_CBPOINT, 185), 1763 1764 /* set the SMTP mail originator */ 1765 CURLOPT(CURLOPT_MAIL_FROM, CURLOPTTYPE_STRINGPOINT, 186), 1766 1767 /* set the list of SMTP mail receiver(s) */ 1768 CURLOPT(CURLOPT_MAIL_RCPT, CURLOPTTYPE_SLISTPOINT, 187), 1769 1770 /* FTP: send PRET before PASV */ 1771 CURLOPT(CURLOPT_FTP_USE_PRET, CURLOPTTYPE_LONG, 188), 1772 1773 /* RTSP request method (OPTIONS, SETUP, PLAY, etc...) */ 1774 CURLOPT(CURLOPT_RTSP_REQUEST, CURLOPTTYPE_VALUES, 189), 1775 1776 /* The RTSP session identifier */ 1777 CURLOPT(CURLOPT_RTSP_SESSION_ID, CURLOPTTYPE_STRINGPOINT, 190), 1778 1779 /* The RTSP stream URI */ 1780 CURLOPT(CURLOPT_RTSP_STREAM_URI, CURLOPTTYPE_STRINGPOINT, 191), 1781 1782 /* The Transport: header to use in RTSP requests */ 1783 CURLOPT(CURLOPT_RTSP_TRANSPORT, CURLOPTTYPE_STRINGPOINT, 192), 1784 1785 /* Manually initialize the client RTSP CSeq for this handle */ 1786 CURLOPT(CURLOPT_RTSP_CLIENT_CSEQ, CURLOPTTYPE_LONG, 193), 1787 1788 /* Manually initialize the server RTSP CSeq for this handle */ 1789 CURLOPT(CURLOPT_RTSP_SERVER_CSEQ, CURLOPTTYPE_LONG, 194), 1790 1791 /* The stream to pass to INTERLEAVEFUNCTION. */ 1792 CURLOPT(CURLOPT_INTERLEAVEDATA, CURLOPTTYPE_CBPOINT, 195), 1793 1794 /* Let the application define a custom write method for RTP data */ 1795 CURLOPT(CURLOPT_INTERLEAVEFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 196), 1796 1797 /* Turn on wildcard matching */ 1798 CURLOPT(CURLOPT_WILDCARDMATCH, CURLOPTTYPE_LONG, 197), 1799 1800 /* Directory matching callback called before downloading of an 1801 individual file (chunk) started */ 1802 CURLOPT(CURLOPT_CHUNK_BGN_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 198), 1803 1804 /* Directory matching callback called after the file (chunk) 1805 was downloaded, or skipped */ 1806 CURLOPT(CURLOPT_CHUNK_END_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 199), 1807 1808 /* Change match (fnmatch-like) callback for wildcard matching */ 1809 CURLOPT(CURLOPT_FNMATCH_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 200), 1810 1811 /* Let the application define custom chunk data pointer */ 1812 CURLOPT(CURLOPT_CHUNK_DATA, CURLOPTTYPE_CBPOINT, 201), 1813 1814 /* FNMATCH_FUNCTION user pointer */ 1815 CURLOPT(CURLOPT_FNMATCH_DATA, CURLOPTTYPE_CBPOINT, 202), 1816 1817 /* send linked-list of name:port:address sets */ 1818 CURLOPT(CURLOPT_RESOLVE, CURLOPTTYPE_SLISTPOINT, 203), 1819 1820 /* Set a username for authenticated TLS */ 1821 CURLOPT(CURLOPT_TLSAUTH_USERNAME, CURLOPTTYPE_STRINGPOINT, 204), 1822 1823 /* Set a password for authenticated TLS */ 1824 CURLOPT(CURLOPT_TLSAUTH_PASSWORD, CURLOPTTYPE_STRINGPOINT, 205), 1825 1826 /* Set authentication type for authenticated TLS */ 1827 CURLOPT(CURLOPT_TLSAUTH_TYPE, CURLOPTTYPE_STRINGPOINT, 206), 1828 1829 /* Set to 1 to enable the "TE:" header in HTTP requests to ask for 1830 compressed transfer-encoded responses. Set to 0 to disable the use of TE: 1831 in outgoing requests. The current default is 0, but it might change in a 1832 future libcurl release. 1833 1834 libcurl will ask for the compressed methods it knows of, and if that 1835 isn't any, it will not ask for transfer-encoding at all even if this 1836 option is set to 1. 1837 1838 */ 1839 CURLOPT(CURLOPT_TRANSFER_ENCODING, CURLOPTTYPE_LONG, 207), 1840 1841 /* Callback function for closing socket (instead of close(2)). The callback 1842 should have type curl_closesocket_callback */ 1843 CURLOPT(CURLOPT_CLOSESOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 208), 1844 CURLOPT(CURLOPT_CLOSESOCKETDATA, CURLOPTTYPE_CBPOINT, 209), 1845 1846 /* allow GSSAPI credential delegation */ 1847 CURLOPT(CURLOPT_GSSAPI_DELEGATION, CURLOPTTYPE_VALUES, 210), 1848 1849 /* Set the name servers to use for DNS resolution. 1850 * Only supported by the c-ares DNS backend */ 1851 CURLOPT(CURLOPT_DNS_SERVERS, CURLOPTTYPE_STRINGPOINT, 211), 1852 1853 /* Time-out accept operations (currently for FTP only) after this amount 1854 of milliseconds. */ 1855 CURLOPT(CURLOPT_ACCEPTTIMEOUT_MS, CURLOPTTYPE_LONG, 212), 1856 1857 /* Set TCP keepalive */ 1858 CURLOPT(CURLOPT_TCP_KEEPALIVE, CURLOPTTYPE_LONG, 213), 1859 1860 /* non-universal keepalive knobs (Linux, AIX, HP-UX, more) */ 1861 CURLOPT(CURLOPT_TCP_KEEPIDLE, CURLOPTTYPE_LONG, 214), 1862 CURLOPT(CURLOPT_TCP_KEEPINTVL, CURLOPTTYPE_LONG, 215), 1863 1864 /* Enable/disable specific SSL features with a bitmask, see CURLSSLOPT_* */ 1865 CURLOPT(CURLOPT_SSL_OPTIONS, CURLOPTTYPE_VALUES, 216), 1866 1867 /* Set the SMTP auth originator */ 1868 CURLOPT(CURLOPT_MAIL_AUTH, CURLOPTTYPE_STRINGPOINT, 217), 1869 1870 /* Enable/disable SASL initial response */ 1871 CURLOPT(CURLOPT_SASL_IR, CURLOPTTYPE_LONG, 218), 1872 1873 /* Function that will be called instead of the internal progress display 1874 * function. This function should be defined as the curl_xferinfo_callback 1875 * prototype defines. (Deprecates CURLOPT_PROGRESSFUNCTION) */ 1876 CURLOPT(CURLOPT_XFERINFOFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 219), 1877 1878 /* The XOAUTH2 bearer token */ 1879 CURLOPT(CURLOPT_XOAUTH2_BEARER, CURLOPTTYPE_STRINGPOINT, 220), 1880 1881 /* Set the interface string to use as outgoing network 1882 * interface for DNS requests. 1883 * Only supported by the c-ares DNS backend */ 1884 CURLOPT(CURLOPT_DNS_INTERFACE, CURLOPTTYPE_STRINGPOINT, 221), 1885 1886 /* Set the local IPv4 address to use for outgoing DNS requests. 1887 * Only supported by the c-ares DNS backend */ 1888 CURLOPT(CURLOPT_DNS_LOCAL_IP4, CURLOPTTYPE_STRINGPOINT, 222), 1889 1890 /* Set the local IPv6 address to use for outgoing DNS requests. 1891 * Only supported by the c-ares DNS backend */ 1892 CURLOPT(CURLOPT_DNS_LOCAL_IP6, CURLOPTTYPE_STRINGPOINT, 223), 1893 1894 /* Set authentication options directly */ 1895 CURLOPT(CURLOPT_LOGIN_OPTIONS, CURLOPTTYPE_STRINGPOINT, 224), 1896 1897 /* Enable/disable TLS NPN extension (http2 over ssl might fail without) */ 1898 CURLOPTDEPRECATED(CURLOPT_SSL_ENABLE_NPN, CURLOPTTYPE_LONG, 225, 1899 7.86.0, "Has no function"), 1900 1901 /* Enable/disable TLS ALPN extension (http2 over ssl might fail without) */ 1902 CURLOPT(CURLOPT_SSL_ENABLE_ALPN, CURLOPTTYPE_LONG, 226), 1903 1904 /* Time to wait for a response to an HTTP request containing an 1905 * Expect: 100-continue header before sending the data anyway. */ 1906 CURLOPT(CURLOPT_EXPECT_100_TIMEOUT_MS, CURLOPTTYPE_LONG, 227), 1907 1908 /* This points to a linked list of headers used for proxy requests only, 1909 struct curl_slist kind */ 1910 CURLOPT(CURLOPT_PROXYHEADER, CURLOPTTYPE_SLISTPOINT, 228), 1911 1912 /* Pass in a bitmask of "header options" */ 1913 CURLOPT(CURLOPT_HEADEROPT, CURLOPTTYPE_VALUES, 229), 1914 1915 /* The public key in DER form used to validate the peer public key 1916 this option is used only if SSL_VERIFYPEER is true */ 1917 CURLOPT(CURLOPT_PINNEDPUBLICKEY, CURLOPTTYPE_STRINGPOINT, 230), 1918 1919 /* Path to Unix domain socket */ 1920 CURLOPT(CURLOPT_UNIX_SOCKET_PATH, CURLOPTTYPE_STRINGPOINT, 231), 1921 1922 /* Set if we should verify the certificate status. */ 1923 CURLOPT(CURLOPT_SSL_VERIFYSTATUS, CURLOPTTYPE_LONG, 232), 1924 1925 /* Set if we should enable TLS false start. */ 1926 CURLOPT(CURLOPT_SSL_FALSESTART, CURLOPTTYPE_LONG, 233), 1927 1928 /* Do not squash dot-dot sequences */ 1929 CURLOPT(CURLOPT_PATH_AS_IS, CURLOPTTYPE_LONG, 234), 1930 1931 /* Proxy Service Name */ 1932 CURLOPT(CURLOPT_PROXY_SERVICE_NAME, CURLOPTTYPE_STRINGPOINT, 235), 1933 1934 /* Service Name */ 1935 CURLOPT(CURLOPT_SERVICE_NAME, CURLOPTTYPE_STRINGPOINT, 236), 1936 1937 /* Wait/don't wait for pipe/mutex to clarify */ 1938 CURLOPT(CURLOPT_PIPEWAIT, CURLOPTTYPE_LONG, 237), 1939 1940 /* Set the protocol used when curl is given a URL without a protocol */ 1941 CURLOPT(CURLOPT_DEFAULT_PROTOCOL, CURLOPTTYPE_STRINGPOINT, 238), 1942 1943 /* Set stream weight, 1 - 256 (default is 16) */ 1944 CURLOPT(CURLOPT_STREAM_WEIGHT, CURLOPTTYPE_LONG, 239), 1945 1946 /* Set stream dependency on another CURL handle */ 1947 CURLOPT(CURLOPT_STREAM_DEPENDS, CURLOPTTYPE_OBJECTPOINT, 240), 1948 1949 /* Set E-xclusive stream dependency on another CURL handle */ 1950 CURLOPT(CURLOPT_STREAM_DEPENDS_E, CURLOPTTYPE_OBJECTPOINT, 241), 1951 1952 /* Do not send any tftp option requests to the server */ 1953 CURLOPT(CURLOPT_TFTP_NO_OPTIONS, CURLOPTTYPE_LONG, 242), 1954 1955 /* Linked-list of host:port:connect-to-host:connect-to-port, 1956 overrides the URL's host:port (only for the network layer) */ 1957 CURLOPT(CURLOPT_CONNECT_TO, CURLOPTTYPE_SLISTPOINT, 243), 1958 1959 /* Set TCP Fast Open */ 1960 CURLOPT(CURLOPT_TCP_FASTOPEN, CURLOPTTYPE_LONG, 244), 1961 1962 /* Continue to send data if the server responds early with an 1963 * HTTP status code >= 300 */ 1964 CURLOPT(CURLOPT_KEEP_SENDING_ON_ERROR, CURLOPTTYPE_LONG, 245), 1965 1966 /* The CApath or CAfile used to validate the proxy certificate 1967 this option is used only if PROXY_SSL_VERIFYPEER is true */ 1968 CURLOPT(CURLOPT_PROXY_CAINFO, CURLOPTTYPE_STRINGPOINT, 246), 1969 1970 /* The CApath directory used to validate the proxy certificate 1971 this option is used only if PROXY_SSL_VERIFYPEER is true */ 1972 CURLOPT(CURLOPT_PROXY_CAPATH, CURLOPTTYPE_STRINGPOINT, 247), 1973 1974 /* Set if we should verify the proxy in ssl handshake, 1975 set 1 to verify. */ 1976 CURLOPT(CURLOPT_PROXY_SSL_VERIFYPEER, CURLOPTTYPE_LONG, 248), 1977 1978 /* Set if we should verify the Common name from the proxy certificate in ssl 1979 * handshake, set 1 to check existence, 2 to ensure that it matches 1980 * the provided hostname. */ 1981 CURLOPT(CURLOPT_PROXY_SSL_VERIFYHOST, CURLOPTTYPE_LONG, 249), 1982 1983 /* What version to specifically try to use for proxy. 1984 See CURL_SSLVERSION defines below. */ 1985 CURLOPT(CURLOPT_PROXY_SSLVERSION, CURLOPTTYPE_VALUES, 250), 1986 1987 /* Set a username for authenticated TLS for proxy */ 1988 CURLOPT(CURLOPT_PROXY_TLSAUTH_USERNAME, CURLOPTTYPE_STRINGPOINT, 251), 1989 1990 /* Set a password for authenticated TLS for proxy */ 1991 CURLOPT(CURLOPT_PROXY_TLSAUTH_PASSWORD, CURLOPTTYPE_STRINGPOINT, 252), 1992 1993 /* Set authentication type for authenticated TLS for proxy */ 1994 CURLOPT(CURLOPT_PROXY_TLSAUTH_TYPE, CURLOPTTYPE_STRINGPOINT, 253), 1995 1996 /* name of the file keeping your private SSL-certificate for proxy */ 1997 CURLOPT(CURLOPT_PROXY_SSLCERT, CURLOPTTYPE_STRINGPOINT, 254), 1998 1999 /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") for 2000 proxy */ 2001 CURLOPT(CURLOPT_PROXY_SSLCERTTYPE, CURLOPTTYPE_STRINGPOINT, 255), 2002 2003 /* name of the file keeping your private SSL-key for proxy */ 2004 CURLOPT(CURLOPT_PROXY_SSLKEY, CURLOPTTYPE_STRINGPOINT, 256), 2005 2006 /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") for 2007 proxy */ 2008 CURLOPT(CURLOPT_PROXY_SSLKEYTYPE, CURLOPTTYPE_STRINGPOINT, 257), 2009 2010 /* password for the SSL private key for proxy */ 2011 CURLOPT(CURLOPT_PROXY_KEYPASSWD, CURLOPTTYPE_STRINGPOINT, 258), 2012 2013 /* Specify which SSL ciphers to use for proxy */ 2014 CURLOPT(CURLOPT_PROXY_SSL_CIPHER_LIST, CURLOPTTYPE_STRINGPOINT, 259), 2015 2016 /* CRL file for proxy */ 2017 CURLOPT(CURLOPT_PROXY_CRLFILE, CURLOPTTYPE_STRINGPOINT, 260), 2018 2019 /* Enable/disable specific SSL features with a bitmask for proxy, see 2020 CURLSSLOPT_* */ 2021 CURLOPT(CURLOPT_PROXY_SSL_OPTIONS, CURLOPTTYPE_LONG, 261), 2022 2023 /* Name of pre proxy to use. */ 2024 CURLOPT(CURLOPT_PRE_PROXY, CURLOPTTYPE_STRINGPOINT, 262), 2025 2026 /* The public key in DER form used to validate the proxy public key 2027 this option is used only if PROXY_SSL_VERIFYPEER is true */ 2028 CURLOPT(CURLOPT_PROXY_PINNEDPUBLICKEY, CURLOPTTYPE_STRINGPOINT, 263), 2029 2030 /* Path to an abstract Unix domain socket */ 2031 CURLOPT(CURLOPT_ABSTRACT_UNIX_SOCKET, CURLOPTTYPE_STRINGPOINT, 264), 2032 2033 /* Suppress proxy CONNECT response headers from user callbacks */ 2034 CURLOPT(CURLOPT_SUPPRESS_CONNECT_HEADERS, CURLOPTTYPE_LONG, 265), 2035 2036 /* The request target, instead of extracted from the URL */ 2037 CURLOPT(CURLOPT_REQUEST_TARGET, CURLOPTTYPE_STRINGPOINT, 266), 2038 2039 /* bitmask of allowed auth methods for connections to SOCKS5 proxies */ 2040 CURLOPT(CURLOPT_SOCKS5_AUTH, CURLOPTTYPE_LONG, 267), 2041 2042 /* Enable/disable SSH compression */ 2043 CURLOPT(CURLOPT_SSH_COMPRESSION, CURLOPTTYPE_LONG, 268), 2044 2045 /* Post MIME data. */ 2046 CURLOPT(CURLOPT_MIMEPOST, CURLOPTTYPE_OBJECTPOINT, 269), 2047 2048 /* Time to use with the CURLOPT_TIMECONDITION. Specified in number of 2049 seconds since 1 Jan 1970. */ 2050 CURLOPT(CURLOPT_TIMEVALUE_LARGE, CURLOPTTYPE_OFF_T, 270), 2051 2052 /* Head start in milliseconds to give happy eyeballs. */ 2053 CURLOPT(CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS, CURLOPTTYPE_LONG, 271), 2054 2055 /* Function that will be called before a resolver request is made */ 2056 CURLOPT(CURLOPT_RESOLVER_START_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 272), 2057 2058 /* User data to pass to the resolver start callback. */ 2059 CURLOPT(CURLOPT_RESOLVER_START_DATA, CURLOPTTYPE_CBPOINT, 273), 2060 2061 /* send HAProxy PROXY protocol header? */ 2062 CURLOPT(CURLOPT_HAPROXYPROTOCOL, CURLOPTTYPE_LONG, 274), 2063 2064 /* shuffle addresses before use when DNS returns multiple */ 2065 CURLOPT(CURLOPT_DNS_SHUFFLE_ADDRESSES, CURLOPTTYPE_LONG, 275), 2066 2067 /* Specify which TLS 1.3 ciphers suites to use */ 2068 CURLOPT(CURLOPT_TLS13_CIPHERS, CURLOPTTYPE_STRINGPOINT, 276), 2069 CURLOPT(CURLOPT_PROXY_TLS13_CIPHERS, CURLOPTTYPE_STRINGPOINT, 277), 2070 2071 /* Disallow specifying username/login in URL. */ 2072 CURLOPT(CURLOPT_DISALLOW_USERNAME_IN_URL, CURLOPTTYPE_LONG, 278), 2073 2074 /* DNS-over-HTTPS URL */ 2075 CURLOPT(CURLOPT_DOH_URL, CURLOPTTYPE_STRINGPOINT, 279), 2076 2077 /* Preferred buffer size to use for uploads */ 2078 CURLOPT(CURLOPT_UPLOAD_BUFFERSIZE, CURLOPTTYPE_LONG, 280), 2079 2080 /* Time in ms between connection upkeep calls for long-lived connections. */ 2081 CURLOPT(CURLOPT_UPKEEP_INTERVAL_MS, CURLOPTTYPE_LONG, 281), 2082 2083 /* Specify URL using CURL URL API. */ 2084 CURLOPT(CURLOPT_CURLU, CURLOPTTYPE_OBJECTPOINT, 282), 2085 2086 /* add trailing data just after no more data is available */ 2087 CURLOPT(CURLOPT_TRAILERFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 283), 2088 2089 /* pointer to be passed to HTTP_TRAILER_FUNCTION */ 2090 CURLOPT(CURLOPT_TRAILERDATA, CURLOPTTYPE_CBPOINT, 284), 2091 2092 /* set this to 1L to allow HTTP/0.9 responses or 0L to disallow */ 2093 CURLOPT(CURLOPT_HTTP09_ALLOWED, CURLOPTTYPE_LONG, 285), 2094 2095 /* alt-svc control bitmask */ 2096 CURLOPT(CURLOPT_ALTSVC_CTRL, CURLOPTTYPE_LONG, 286), 2097 2098 /* alt-svc cache file name to possibly read from/write to */ 2099 CURLOPT(CURLOPT_ALTSVC, CURLOPTTYPE_STRINGPOINT, 287), 2100 2101 /* maximum age (idle time) of a connection to consider it for reuse 2102 * (in seconds) */ 2103 CURLOPT(CURLOPT_MAXAGE_CONN, CURLOPTTYPE_LONG, 288), 2104 2105 /* SASL authorization identity */ 2106 CURLOPT(CURLOPT_SASL_AUTHZID, CURLOPTTYPE_STRINGPOINT, 289), 2107 2108 /* allow RCPT TO command to fail for some recipients */ 2109 CURLOPT(CURLOPT_MAIL_RCPT_ALLOWFAILS, CURLOPTTYPE_LONG, 290), 2110 2111 /* the private SSL-certificate as a "blob" */ 2112 CURLOPT(CURLOPT_SSLCERT_BLOB, CURLOPTTYPE_BLOB, 291), 2113 CURLOPT(CURLOPT_SSLKEY_BLOB, CURLOPTTYPE_BLOB, 292), 2114 CURLOPT(CURLOPT_PROXY_SSLCERT_BLOB, CURLOPTTYPE_BLOB, 293), 2115 CURLOPT(CURLOPT_PROXY_SSLKEY_BLOB, CURLOPTTYPE_BLOB, 294), 2116 CURLOPT(CURLOPT_ISSUERCERT_BLOB, CURLOPTTYPE_BLOB, 295), 2117 2118 /* Issuer certificate for proxy */ 2119 CURLOPT(CURLOPT_PROXY_ISSUERCERT, CURLOPTTYPE_STRINGPOINT, 296), 2120 CURLOPT(CURLOPT_PROXY_ISSUERCERT_BLOB, CURLOPTTYPE_BLOB, 297), 2121 2122 /* the EC curves requested by the TLS client (RFC 8422, 5.1); 2123 * OpenSSL support via 'set_groups'/'set_curves': 2124 * https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set1_groups.html 2125 */ 2126 CURLOPT(CURLOPT_SSL_EC_CURVES, CURLOPTTYPE_STRINGPOINT, 298), 2127 2128 /* HSTS bitmask */ 2129 CURLOPT(CURLOPT_HSTS_CTRL, CURLOPTTYPE_LONG, 299), 2130 /* HSTS file name */ 2131 CURLOPT(CURLOPT_HSTS, CURLOPTTYPE_STRINGPOINT, 300), 2132 2133 /* HSTS read callback */ 2134 CURLOPT(CURLOPT_HSTSREADFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 301), 2135 CURLOPT(CURLOPT_HSTSREADDATA, CURLOPTTYPE_CBPOINT, 302), 2136 2137 /* HSTS write callback */ 2138 CURLOPT(CURLOPT_HSTSWRITEFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 303), 2139 CURLOPT(CURLOPT_HSTSWRITEDATA, CURLOPTTYPE_CBPOINT, 304), 2140 2141 /* Parameters for V4 signature */ 2142 CURLOPT(CURLOPT_AWS_SIGV4, CURLOPTTYPE_STRINGPOINT, 305), 2143 2144 /* Same as CURLOPT_SSL_VERIFYPEER but for DoH (DNS-over-HTTPS) servers. */ 2145 CURLOPT(CURLOPT_DOH_SSL_VERIFYPEER, CURLOPTTYPE_LONG, 306), 2146 2147 /* Same as CURLOPT_SSL_VERIFYHOST but for DoH (DNS-over-HTTPS) servers. */ 2148 CURLOPT(CURLOPT_DOH_SSL_VERIFYHOST, CURLOPTTYPE_LONG, 307), 2149 2150 /* Same as CURLOPT_SSL_VERIFYSTATUS but for DoH (DNS-over-HTTPS) servers. */ 2151 CURLOPT(CURLOPT_DOH_SSL_VERIFYSTATUS, CURLOPTTYPE_LONG, 308), 2152 2153 /* The CA certificates as "blob" used to validate the peer certificate 2154 this option is used only if SSL_VERIFYPEER is true */ 2155 CURLOPT(CURLOPT_CAINFO_BLOB, CURLOPTTYPE_BLOB, 309), 2156 2157 /* The CA certificates as "blob" used to validate the proxy certificate 2158 this option is used only if PROXY_SSL_VERIFYPEER is true */ 2159 CURLOPT(CURLOPT_PROXY_CAINFO_BLOB, CURLOPTTYPE_BLOB, 310), 2160 2161 /* used by scp/sftp to verify the host's public key */ 2162 CURLOPT(CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256, CURLOPTTYPE_STRINGPOINT, 311), 2163 2164 /* Function that will be called immediately before the initial request 2165 is made on a connection (after any protocol negotiation step). */ 2166 CURLOPT(CURLOPT_PREREQFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 312), 2167 2168 /* Data passed to the CURLOPT_PREREQFUNCTION callback */ 2169 CURLOPT(CURLOPT_PREREQDATA, CURLOPTTYPE_CBPOINT, 313), 2170 2171 /* maximum age (since creation) of a connection to consider it for reuse 2172 * (in seconds) */ 2173 CURLOPT(CURLOPT_MAXLIFETIME_CONN, CURLOPTTYPE_LONG, 314), 2174 2175 /* Set MIME option flags. */ 2176 CURLOPT(CURLOPT_MIME_OPTIONS, CURLOPTTYPE_LONG, 315), 2177 2178 /* set the SSH host key callback, must point to a curl_sshkeycallback 2179 function */ 2180 CURLOPT(CURLOPT_SSH_HOSTKEYFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 316), 2181 2182 /* set the SSH host key callback custom pointer */ 2183 CURLOPT(CURLOPT_SSH_HOSTKEYDATA, CURLOPTTYPE_CBPOINT, 317), 2184 2185 /* specify which protocols that are allowed to be used for the transfer, 2186 which thus helps the app which takes URLs from users or other external 2187 inputs and want to restrict what protocol(s) to deal with. Defaults to 2188 all built-in protocols. */ 2189 CURLOPT(CURLOPT_PROTOCOLS_STR, CURLOPTTYPE_STRINGPOINT, 318), 2190 2191 /* specify which protocols that libcurl is allowed to follow directs to */ 2192 CURLOPT(CURLOPT_REDIR_PROTOCOLS_STR, CURLOPTTYPE_STRINGPOINT, 319), 2193 2194 /* websockets options */ 2195 CURLOPT(CURLOPT_WS_OPTIONS, CURLOPTTYPE_LONG, 320), 2196 2197 /* CA cache timeout */ 2198 CURLOPT(CURLOPT_CA_CACHE_TIMEOUT, CURLOPTTYPE_LONG, 321), 2199 2200 /* Can leak things, gonna exit() soon */ 2201 CURLOPT(CURLOPT_QUICK_EXIT, CURLOPTTYPE_LONG, 322), 2202 2203 /* set a specific client IP for HAProxy PROXY protocol header? */ 2204 CURLOPT(CURLOPT_HAPROXY_CLIENT_IP, CURLOPTTYPE_STRINGPOINT, 323), 2205 2206 /* millisecond version */ 2207 CURLOPT(CURLOPT_SERVER_RESPONSE_TIMEOUT_MS, CURLOPTTYPE_LONG, 324), 2208 2209 CURLOPT_LASTENTRY /* the last unused */ 2210 } CURLoption; 2211 2212 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all 2213 the obsolete stuff removed! */ 2214 2215 /* Backwards compatibility with older names */ 2216 /* These are scheduled to disappear by 2011 */ 2217 2218 /* This was added in version 7.19.1 */ 2219 #define CURLOPT_POST301 CURLOPT_POSTREDIR 2220 2221 /* These are scheduled to disappear by 2009 */ 2222 2223 /* The following were added in 7.17.0 */ 2224 #define CURLOPT_SSLKEYPASSWD CURLOPT_KEYPASSWD 2225 #define CURLOPT_FTPAPPEND CURLOPT_APPEND 2226 #define CURLOPT_FTPLISTONLY CURLOPT_DIRLISTONLY 2227 #define CURLOPT_FTP_SSL CURLOPT_USE_SSL 2228 2229 /* The following were added earlier */ 2230 2231 #define CURLOPT_SSLCERTPASSWD CURLOPT_KEYPASSWD 2232 #define CURLOPT_KRB4LEVEL CURLOPT_KRBLEVEL 2233 2234 /* */ 2235 #define CURLOPT_FTP_RESPONSE_TIMEOUT CURLOPT_SERVER_RESPONSE_TIMEOUT 2236 2237 /* Added in 8.2.0 */ 2238 #define CURLOPT_MAIL_RCPT_ALLLOWFAILS CURLOPT_MAIL_RCPT_ALLOWFAILS 2239 2240 #else 2241 /* This is set if CURL_NO_OLDIES is defined at compile-time */ 2242 #undef CURLOPT_DNS_USE_GLOBAL_CACHE /* soon obsolete */ 2243 #endif 2244 2245 2246 /* Below here follows defines for the CURLOPT_IPRESOLVE option. If a host 2247 name resolves addresses using more than one IP protocol version, this 2248 option might be handy to force libcurl to use a specific IP version. */ 2249 #define CURL_IPRESOLVE_WHATEVER 0 /* default, uses addresses to all IP 2250 versions that your system allows */ 2251 #define CURL_IPRESOLVE_V4 1 /* uses only IPv4 addresses/connections */ 2252 #define CURL_IPRESOLVE_V6 2 /* uses only IPv6 addresses/connections */ 2253 2254 /* Convenient "aliases" */ 2255 #define CURLOPT_RTSPHEADER CURLOPT_HTTPHEADER 2256 2257 /* These enums are for use with the CURLOPT_HTTP_VERSION option. */ 2258 enum { 2259 CURL_HTTP_VERSION_NONE, /* setting this means we don't care, and that we'd 2260 like the library to choose the best possible 2261 for us! */ 2262 CURL_HTTP_VERSION_1_0, /* please use HTTP 1.0 in the request */ 2263 CURL_HTTP_VERSION_1_1, /* please use HTTP 1.1 in the request */ 2264 CURL_HTTP_VERSION_2_0, /* please use HTTP 2 in the request */ 2265 CURL_HTTP_VERSION_2TLS, /* use version 2 for HTTPS, version 1.1 for HTTP */ 2266 CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE, /* please use HTTP 2 without HTTP/1.1 2267 Upgrade */ 2268 CURL_HTTP_VERSION_3 = 30, /* Use HTTP/3, fallback to HTTP/2 or HTTP/1 if 2269 needed. For HTTPS only. For HTTP, this option 2270 makes libcurl return error. */ 2271 CURL_HTTP_VERSION_3ONLY = 31, /* Use HTTP/3 without fallback. For HTTPS 2272 only. For HTTP, this makes libcurl 2273 return error. */ 2274 2275 CURL_HTTP_VERSION_LAST /* *ILLEGAL* http version */ 2276 }; 2277 2278 /* Convenience definition simple because the name of the version is HTTP/2 and 2279 not 2.0. The 2_0 version of the enum name was set while the version was 2280 still planned to be 2.0 and we stick to it for compatibility. */ 2281 #define CURL_HTTP_VERSION_2 CURL_HTTP_VERSION_2_0 2282 2283 /* 2284 * Public API enums for RTSP requests 2285 */ 2286 enum { 2287 CURL_RTSPREQ_NONE, /* first in list */ 2288 CURL_RTSPREQ_OPTIONS, 2289 CURL_RTSPREQ_DESCRIBE, 2290 CURL_RTSPREQ_ANNOUNCE, 2291 CURL_RTSPREQ_SETUP, 2292 CURL_RTSPREQ_PLAY, 2293 CURL_RTSPREQ_PAUSE, 2294 CURL_RTSPREQ_TEARDOWN, 2295 CURL_RTSPREQ_GET_PARAMETER, 2296 CURL_RTSPREQ_SET_PARAMETER, 2297 CURL_RTSPREQ_RECORD, 2298 CURL_RTSPREQ_RECEIVE, 2299 CURL_RTSPREQ_LAST /* last in list */ 2300 }; 2301 2302 /* These enums are for use with the CURLOPT_NETRC option. */ 2303 enum CURL_NETRC_OPTION { 2304 CURL_NETRC_IGNORED, /* The .netrc will never be read. 2305 * This is the default. */ 2306 CURL_NETRC_OPTIONAL, /* A user:password in the URL will be preferred 2307 * to one in the .netrc. */ 2308 CURL_NETRC_REQUIRED, /* A user:password in the URL will be ignored. 2309 * Unless one is set programmatically, the .netrc 2310 * will be queried. */ 2311 CURL_NETRC_LAST 2312 }; 2313 2314 enum { 2315 CURL_SSLVERSION_DEFAULT, 2316 CURL_SSLVERSION_TLSv1, /* TLS 1.x */ 2317 CURL_SSLVERSION_SSLv2, 2318 CURL_SSLVERSION_SSLv3, 2319 CURL_SSLVERSION_TLSv1_0, 2320 CURL_SSLVERSION_TLSv1_1, 2321 CURL_SSLVERSION_TLSv1_2, 2322 CURL_SSLVERSION_TLSv1_3, 2323 2324 CURL_SSLVERSION_LAST /* never use, keep last */ 2325 }; 2326 2327 enum { 2328 CURL_SSLVERSION_MAX_NONE = 0, 2329 CURL_SSLVERSION_MAX_DEFAULT = (CURL_SSLVERSION_TLSv1 << 16), 2330 CURL_SSLVERSION_MAX_TLSv1_0 = (CURL_SSLVERSION_TLSv1_0 << 16), 2331 CURL_SSLVERSION_MAX_TLSv1_1 = (CURL_SSLVERSION_TLSv1_1 << 16), 2332 CURL_SSLVERSION_MAX_TLSv1_2 = (CURL_SSLVERSION_TLSv1_2 << 16), 2333 CURL_SSLVERSION_MAX_TLSv1_3 = (CURL_SSLVERSION_TLSv1_3 << 16), 2334 2335 /* never use, keep last */ 2336 CURL_SSLVERSION_MAX_LAST = (CURL_SSLVERSION_LAST << 16) 2337 }; 2338 2339 enum CURL_TLSAUTH { 2340 CURL_TLSAUTH_NONE, 2341 CURL_TLSAUTH_SRP, 2342 CURL_TLSAUTH_LAST /* never use, keep last */ 2343 }; 2344 2345 /* symbols to use with CURLOPT_POSTREDIR. 2346 CURL_REDIR_POST_301, CURL_REDIR_POST_302 and CURL_REDIR_POST_303 2347 can be bitwise ORed so that CURL_REDIR_POST_301 | CURL_REDIR_POST_302 2348 | CURL_REDIR_POST_303 == CURL_REDIR_POST_ALL */ 2349 2350 #define CURL_REDIR_GET_ALL 0 2351 #define CURL_REDIR_POST_301 1 2352 #define CURL_REDIR_POST_302 2 2353 #define CURL_REDIR_POST_303 4 2354 #define CURL_REDIR_POST_ALL \ 2355 (CURL_REDIR_POST_301|CURL_REDIR_POST_302|CURL_REDIR_POST_303) 2356 2357 typedef enum { 2358 CURL_TIMECOND_NONE, 2359 2360 CURL_TIMECOND_IFMODSINCE, 2361 CURL_TIMECOND_IFUNMODSINCE, 2362 CURL_TIMECOND_LASTMOD, 2363 2364 CURL_TIMECOND_LAST 2365 } curl_TimeCond; 2366 2367 /* Special size_t value signaling a null-terminated string. */ 2368 #define CURL_ZERO_TERMINATED ((size_t) -1) 2369 2370 /* curl_strequal() and curl_strnequal() are subject for removal in a future 2371 release */ 2372 CURL_EXTERN int curl_strequal(const char *s1, const char *s2); 2373 CURL_EXTERN int curl_strnequal(const char *s1, const char *s2, size_t n); 2374 2375 /* Mime/form handling support. */ 2376 typedef struct curl_mime curl_mime; /* Mime context. */ 2377 typedef struct curl_mimepart curl_mimepart; /* Mime part context. */ 2378 2379 /* CURLMIMEOPT_ defines are for the CURLOPT_MIME_OPTIONS option. */ 2380 #define CURLMIMEOPT_FORMESCAPE (1<<0) /* Use backslash-escaping for forms. */ 2381 2382 /* 2383 * NAME curl_mime_init() 2384 * 2385 * DESCRIPTION 2386 * 2387 * Create a mime context and return its handle. The easy parameter is the 2388 * target handle. 2389 */ 2390 CURL_EXTERN curl_mime *curl_mime_init(CURL *easy); 2391 2392 /* 2393 * NAME curl_mime_free() 2394 * 2395 * DESCRIPTION 2396 * 2397 * release a mime handle and its substructures. 2398 */ 2399 CURL_EXTERN void curl_mime_free(curl_mime *mime); 2400 2401 /* 2402 * NAME curl_mime_addpart() 2403 * 2404 * DESCRIPTION 2405 * 2406 * Append a new empty part to the given mime context and return a handle to 2407 * the created part. 2408 */ 2409 CURL_EXTERN curl_mimepart *curl_mime_addpart(curl_mime *mime); 2410 2411 /* 2412 * NAME curl_mime_name() 2413 * 2414 * DESCRIPTION 2415 * 2416 * Set mime/form part name. 2417 */ 2418 CURL_EXTERN CURLcode curl_mime_name(curl_mimepart *part, const char *name); 2419 2420 /* 2421 * NAME curl_mime_filename() 2422 * 2423 * DESCRIPTION 2424 * 2425 * Set mime part remote file name. 2426 */ 2427 CURL_EXTERN CURLcode curl_mime_filename(curl_mimepart *part, 2428 const char *filename); 2429 2430 /* 2431 * NAME curl_mime_type() 2432 * 2433 * DESCRIPTION 2434 * 2435 * Set mime part type. 2436 */ 2437 CURL_EXTERN CURLcode curl_mime_type(curl_mimepart *part, const char *mimetype); 2438 2439 /* 2440 * NAME curl_mime_encoder() 2441 * 2442 * DESCRIPTION 2443 * 2444 * Set mime data transfer encoder. 2445 */ 2446 CURL_EXTERN CURLcode curl_mime_encoder(curl_mimepart *part, 2447 const char *encoding); 2448 2449 /* 2450 * NAME curl_mime_data() 2451 * 2452 * DESCRIPTION 2453 * 2454 * Set mime part data source from memory data, 2455 */ 2456 CURL_EXTERN CURLcode curl_mime_data(curl_mimepart *part, 2457 const char *data, size_t datasize); 2458 2459 /* 2460 * NAME curl_mime_filedata() 2461 * 2462 * DESCRIPTION 2463 * 2464 * Set mime part data source from named file. 2465 */ 2466 CURL_EXTERN CURLcode curl_mime_filedata(curl_mimepart *part, 2467 const char *filename); 2468 2469 /* 2470 * NAME curl_mime_data_cb() 2471 * 2472 * DESCRIPTION 2473 * 2474 * Set mime part data source from callback function. 2475 */ 2476 CURL_EXTERN CURLcode curl_mime_data_cb(curl_mimepart *part, 2477 curl_off_t datasize, 2478 curl_read_callback readfunc, 2479 curl_seek_callback seekfunc, 2480 curl_free_callback freefunc, 2481 void *arg); 2482 2483 /* 2484 * NAME curl_mime_subparts() 2485 * 2486 * DESCRIPTION 2487 * 2488 * Set mime part data source from subparts. 2489 */ 2490 CURL_EXTERN CURLcode curl_mime_subparts(curl_mimepart *part, 2491 curl_mime *subparts); 2492 /* 2493 * NAME curl_mime_headers() 2494 * 2495 * DESCRIPTION 2496 * 2497 * Set mime part headers. 2498 */ 2499 CURL_EXTERN CURLcode curl_mime_headers(curl_mimepart *part, 2500 struct curl_slist *headers, 2501 int take_ownership); 2502 2503 typedef enum { 2504 /********* the first one is unused ************/ 2505 CURLFORM_NOTHING CURL_DEPRECATED(7.56.0, ""), 2506 CURLFORM_COPYNAME CURL_DEPRECATED(7.56.0, "Use curl_mime_name()"), 2507 CURLFORM_PTRNAME CURL_DEPRECATED(7.56.0, "Use curl_mime_name()"), 2508 CURLFORM_NAMELENGTH CURL_DEPRECATED(7.56.0, ""), 2509 CURLFORM_COPYCONTENTS CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"), 2510 CURLFORM_PTRCONTENTS CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"), 2511 CURLFORM_CONTENTSLENGTH CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"), 2512 CURLFORM_FILECONTENT CURL_DEPRECATED(7.56.0, "Use curl_mime_data_cb()"), 2513 CURLFORM_ARRAY CURL_DEPRECATED(7.56.0, ""), 2514 CURLFORM_OBSOLETE, 2515 CURLFORM_FILE CURL_DEPRECATED(7.56.0, "Use curl_mime_filedata()"), 2516 2517 CURLFORM_BUFFER CURL_DEPRECATED(7.56.0, "Use curl_mime_filename()"), 2518 CURLFORM_BUFFERPTR CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"), 2519 CURLFORM_BUFFERLENGTH CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"), 2520 2521 CURLFORM_CONTENTTYPE CURL_DEPRECATED(7.56.0, "Use curl_mime_type()"), 2522 CURLFORM_CONTENTHEADER CURL_DEPRECATED(7.56.0, "Use curl_mime_headers()"), 2523 CURLFORM_FILENAME CURL_DEPRECATED(7.56.0, "Use curl_mime_filename()"), 2524 CURLFORM_END, 2525 CURLFORM_OBSOLETE2, 2526 2527 CURLFORM_STREAM CURL_DEPRECATED(7.56.0, "Use curl_mime_data_cb()"), 2528 CURLFORM_CONTENTLEN /* added in 7.46.0, provide a curl_off_t length */ 2529 CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"), 2530 2531 CURLFORM_LASTENTRY /* the last unused */ 2532 } CURLformoption; 2533 2534 /* structure to be used as parameter for CURLFORM_ARRAY */ 2535 struct curl_forms { 2536 CURLformoption option; 2537 const char *value; 2538 }; 2539 2540 /* use this for multipart formpost building */ 2541 /* Returns code for curl_formadd() 2542 * 2543 * Returns: 2544 * CURL_FORMADD_OK on success 2545 * CURL_FORMADD_MEMORY if the FormInfo allocation fails 2546 * CURL_FORMADD_OPTION_TWICE if one option is given twice for one Form 2547 * CURL_FORMADD_NULL if a null pointer was given for a char 2548 * CURL_FORMADD_MEMORY if the allocation of a FormInfo struct failed 2549 * CURL_FORMADD_UNKNOWN_OPTION if an unknown option was used 2550 * CURL_FORMADD_INCOMPLETE if the some FormInfo is not complete (or error) 2551 * CURL_FORMADD_MEMORY if a curl_httppost struct cannot be allocated 2552 * CURL_FORMADD_MEMORY if some allocation for string copying failed. 2553 * CURL_FORMADD_ILLEGAL_ARRAY if an illegal option is used in an array 2554 * 2555 ***************************************************************************/ 2556 typedef enum { 2557 CURL_FORMADD_OK CURL_DEPRECATED(7.56.0, ""), /* 1st, no error */ 2558 2559 CURL_FORMADD_MEMORY CURL_DEPRECATED(7.56.0, ""), 2560 CURL_FORMADD_OPTION_TWICE CURL_DEPRECATED(7.56.0, ""), 2561 CURL_FORMADD_NULL CURL_DEPRECATED(7.56.0, ""), 2562 CURL_FORMADD_UNKNOWN_OPTION CURL_DEPRECATED(7.56.0, ""), 2563 CURL_FORMADD_INCOMPLETE CURL_DEPRECATED(7.56.0, ""), 2564 CURL_FORMADD_ILLEGAL_ARRAY CURL_DEPRECATED(7.56.0, ""), 2565 /* libcurl was built with form api disabled */ 2566 CURL_FORMADD_DISABLED CURL_DEPRECATED(7.56.0, ""), 2567 2568 CURL_FORMADD_LAST /* last */ 2569 } CURLFORMcode; 2570 2571 /* 2572 * NAME curl_formadd() 2573 * 2574 * DESCRIPTION 2575 * 2576 * Pretty advanced function for building multi-part formposts. Each invoke 2577 * adds one part that together construct a full post. Then use 2578 * CURLOPT_HTTPPOST to send it off to libcurl. 2579 */ 2580 CURL_EXTERN CURLFORMcode CURL_DEPRECATED(7.56.0, "Use curl_mime_init()") 2581 curl_formadd(struct curl_httppost **httppost, 2582 struct curl_httppost **last_post, 2583 ...); 2584 2585 /* 2586 * callback function for curl_formget() 2587 * The void *arg pointer will be the one passed as second argument to 2588 * curl_formget(). 2589 * The character buffer passed to it must not be freed. 2590 * Should return the buffer length passed to it as the argument "len" on 2591 * success. 2592 */ 2593 typedef size_t (*curl_formget_callback)(void *arg, const char *buf, 2594 size_t len); 2595 2596 /* 2597 * NAME curl_formget() 2598 * 2599 * DESCRIPTION 2600 * 2601 * Serialize a curl_httppost struct built with curl_formadd(). 2602 * Accepts a void pointer as second argument which will be passed to 2603 * the curl_formget_callback function. 2604 * Returns 0 on success. 2605 */ 2606 CURL_EXTERN int CURL_DEPRECATED(7.56.0, "") 2607 curl_formget(struct curl_httppost *form, void *arg, 2608 curl_formget_callback append); 2609 /* 2610 * NAME curl_formfree() 2611 * 2612 * DESCRIPTION 2613 * 2614 * Free a multipart formpost previously built with curl_formadd(). 2615 */ 2616 CURL_EXTERN void CURL_DEPRECATED(7.56.0, "Use curl_mime_free()") 2617 curl_formfree(struct curl_httppost *form); 2618 2619 /* 2620 * NAME curl_getenv() 2621 * 2622 * DESCRIPTION 2623 * 2624 * Returns a malloc()'ed string that MUST be curl_free()ed after usage is 2625 * complete. DEPRECATED - see lib/README.curlx 2626 */ 2627 CURL_EXTERN char *curl_getenv(const char *variable); 2628 2629 /* 2630 * NAME curl_version() 2631 * 2632 * DESCRIPTION 2633 * 2634 * Returns a static ascii string of the libcurl version. 2635 */ 2636 CURL_EXTERN char *curl_version(void); 2637 2638 /* 2639 * NAME curl_easy_escape() 2640 * 2641 * DESCRIPTION 2642 * 2643 * Escapes URL strings (converts all letters consider illegal in URLs to their 2644 * %XX versions). This function returns a new allocated string or NULL if an 2645 * error occurred. 2646 */ 2647 CURL_EXTERN char *curl_easy_escape(CURL *handle, 2648 const char *string, 2649 int length); 2650 2651 /* the previous version: */ 2652 CURL_EXTERN char *curl_escape(const char *string, 2653 int length); 2654 2655 2656 /* 2657 * NAME curl_easy_unescape() 2658 * 2659 * DESCRIPTION 2660 * 2661 * Unescapes URL encoding in strings (converts all %XX codes to their 8bit 2662 * versions). This function returns a new allocated string or NULL if an error 2663 * occurred. 2664 * Conversion Note: On non-ASCII platforms the ASCII %XX codes are 2665 * converted into the host encoding. 2666 */ 2667 CURL_EXTERN char *curl_easy_unescape(CURL *handle, 2668 const char *string, 2669 int length, 2670 int *outlength); 2671 2672 /* the previous version */ 2673 CURL_EXTERN char *curl_unescape(const char *string, 2674 int length); 2675 2676 /* 2677 * NAME curl_free() 2678 * 2679 * DESCRIPTION 2680 * 2681 * Provided for de-allocation in the same translation unit that did the 2682 * allocation. Added in libcurl 7.10 2683 */ 2684 CURL_EXTERN void curl_free(void *p); 2685 2686 /* 2687 * NAME curl_global_init() 2688 * 2689 * DESCRIPTION 2690 * 2691 * curl_global_init() should be invoked exactly once for each application that 2692 * uses libcurl and before any call of other libcurl functions. 2693 2694 * This function is thread-safe if CURL_VERSION_THREADSAFE is set in the 2695 * curl_version_info_data.features flag (fetch by curl_version_info()). 2696 2697 */ 2698 CURL_EXTERN CURLcode curl_global_init(long flags); 2699 2700 /* 2701 * NAME curl_global_init_mem() 2702 * 2703 * DESCRIPTION 2704 * 2705 * curl_global_init() or curl_global_init_mem() should be invoked exactly once 2706 * for each application that uses libcurl. This function can be used to 2707 * initialize libcurl and set user defined memory management callback 2708 * functions. Users can implement memory management routines to check for 2709 * memory leaks, check for mis-use of the curl library etc. User registered 2710 * callback routines will be invoked by this library instead of the system 2711 * memory management routines like malloc, free etc. 2712 */ 2713 CURL_EXTERN CURLcode curl_global_init_mem(long flags, 2714 curl_malloc_callback m, 2715 curl_free_callback f, 2716 curl_realloc_callback r, 2717 curl_strdup_callback s, 2718 curl_calloc_callback c); 2719 2720 /* 2721 * NAME curl_global_cleanup() 2722 * 2723 * DESCRIPTION 2724 * 2725 * curl_global_cleanup() should be invoked exactly once for each application 2726 * that uses libcurl 2727 */ 2728 CURL_EXTERN void curl_global_cleanup(void); 2729 2730 /* 2731 * NAME curl_global_trace() 2732 * 2733 * DESCRIPTION 2734 * 2735 * curl_global_trace() can be invoked at application start to 2736 * configure which components in curl should participate in tracing. 2737 2738 * This function is thread-safe if CURL_VERSION_THREADSAFE is set in the 2739 * curl_version_info_data.features flag (fetch by curl_version_info()). 2740 2741 */ 2742 CURL_EXTERN CURLcode curl_global_trace(const char *config); 2743 2744 /* linked-list structure for the CURLOPT_QUOTE option (and other) */ 2745 struct curl_slist { 2746 char *data; 2747 struct curl_slist *next; 2748 }; 2749 2750 /* 2751 * NAME curl_global_sslset() 2752 * 2753 * DESCRIPTION 2754 * 2755 * When built with multiple SSL backends, curl_global_sslset() allows to 2756 * choose one. This function can only be called once, and it must be called 2757 * *before* curl_global_init(). 2758 * 2759 * The backend can be identified by the id (e.g. CURLSSLBACKEND_OPENSSL). The 2760 * backend can also be specified via the name parameter (passing -1 as id). 2761 * If both id and name are specified, the name will be ignored. If neither id 2762 * nor name are specified, the function will fail with 2763 * CURLSSLSET_UNKNOWN_BACKEND and set the "avail" pointer to the 2764 * NULL-terminated list of available backends. 2765 * 2766 * Upon success, the function returns CURLSSLSET_OK. 2767 * 2768 * If the specified SSL backend is not available, the function returns 2769 * CURLSSLSET_UNKNOWN_BACKEND and sets the "avail" pointer to a NULL-terminated 2770 * list of available SSL backends. 2771 * 2772 * The SSL backend can be set only once. If it has already been set, a 2773 * subsequent attempt to change it will result in a CURLSSLSET_TOO_LATE. 2774 */ 2775 2776 struct curl_ssl_backend { 2777 curl_sslbackend id; 2778 const char *name; 2779 }; 2780 typedef struct curl_ssl_backend curl_ssl_backend; 2781 2782 typedef enum { 2783 CURLSSLSET_OK = 0, 2784 CURLSSLSET_UNKNOWN_BACKEND, 2785 CURLSSLSET_TOO_LATE, 2786 CURLSSLSET_NO_BACKENDS /* libcurl was built without any SSL support */ 2787 } CURLsslset; 2788 2789 CURL_EXTERN CURLsslset curl_global_sslset(curl_sslbackend id, const char *name, 2790 const curl_ssl_backend ***avail); 2791 2792 /* 2793 * NAME curl_slist_append() 2794 * 2795 * DESCRIPTION 2796 * 2797 * Appends a string to a linked list. If no list exists, it will be created 2798 * first. Returns the new list, after appending. 2799 */ 2800 CURL_EXTERN struct curl_slist *curl_slist_append(struct curl_slist *list, 2801 const char *data); 2802 2803 /* 2804 * NAME curl_slist_free_all() 2805 * 2806 * DESCRIPTION 2807 * 2808 * free a previously built curl_slist. 2809 */ 2810 CURL_EXTERN void curl_slist_free_all(struct curl_slist *list); 2811 2812 /* 2813 * NAME curl_getdate() 2814 * 2815 * DESCRIPTION 2816 * 2817 * Returns the time, in seconds since 1 Jan 1970 of the time string given in 2818 * the first argument. The time argument in the second parameter is unused 2819 * and should be set to NULL. 2820 */ 2821 CURL_EXTERN time_t curl_getdate(const char *p, const time_t *unused); 2822 2823 /* info about the certificate chain, for SSL backends that support it. Asked 2824 for with CURLOPT_CERTINFO / CURLINFO_CERTINFO */ 2825 struct curl_certinfo { 2826 int num_of_certs; /* number of certificates with information */ 2827 struct curl_slist **certinfo; /* for each index in this array, there's a 2828 linked list with textual information for a 2829 certificate in the format "name:content". 2830 eg "Subject:foo", "Issuer:bar", etc. */ 2831 }; 2832 2833 /* Information about the SSL library used and the respective internal SSL 2834 handle, which can be used to obtain further information regarding the 2835 connection. Asked for with CURLINFO_TLS_SSL_PTR or CURLINFO_TLS_SESSION. */ 2836 struct curl_tlssessioninfo { 2837 curl_sslbackend backend; 2838 void *internals; 2839 }; 2840 2841 #define CURLINFO_STRING 0x100000 2842 #define CURLINFO_LONG 0x200000 2843 #define CURLINFO_DOUBLE 0x300000 2844 #define CURLINFO_SLIST 0x400000 2845 #define CURLINFO_PTR 0x400000 /* same as SLIST */ 2846 #define CURLINFO_SOCKET 0x500000 2847 #define CURLINFO_OFF_T 0x600000 2848 #define CURLINFO_MASK 0x0fffff 2849 #define CURLINFO_TYPEMASK 0xf00000 2850 2851 typedef enum { 2852 CURLINFO_NONE, /* first, never use this */ 2853 CURLINFO_EFFECTIVE_URL = CURLINFO_STRING + 1, 2854 CURLINFO_RESPONSE_CODE = CURLINFO_LONG + 2, 2855 CURLINFO_TOTAL_TIME = CURLINFO_DOUBLE + 3, 2856 CURLINFO_NAMELOOKUP_TIME = CURLINFO_DOUBLE + 4, 2857 CURLINFO_CONNECT_TIME = CURLINFO_DOUBLE + 5, 2858 CURLINFO_PRETRANSFER_TIME = CURLINFO_DOUBLE + 6, 2859 CURLINFO_SIZE_UPLOAD CURL_DEPRECATED(7.55.0, "Use CURLINFO_SIZE_UPLOAD_T") 2860 = CURLINFO_DOUBLE + 7, 2861 CURLINFO_SIZE_UPLOAD_T = CURLINFO_OFF_T + 7, 2862 CURLINFO_SIZE_DOWNLOAD 2863 CURL_DEPRECATED(7.55.0, "Use CURLINFO_SIZE_DOWNLOAD_T") 2864 = CURLINFO_DOUBLE + 8, 2865 CURLINFO_SIZE_DOWNLOAD_T = CURLINFO_OFF_T + 8, 2866 CURLINFO_SPEED_DOWNLOAD 2867 CURL_DEPRECATED(7.55.0, "Use CURLINFO_SPEED_DOWNLOAD_T") 2868 = CURLINFO_DOUBLE + 9, 2869 CURLINFO_SPEED_DOWNLOAD_T = CURLINFO_OFF_T + 9, 2870 CURLINFO_SPEED_UPLOAD 2871 CURL_DEPRECATED(7.55.0, "Use CURLINFO_SPEED_UPLOAD_T") 2872 = CURLINFO_DOUBLE + 10, 2873 CURLINFO_SPEED_UPLOAD_T = CURLINFO_OFF_T + 10, 2874 CURLINFO_HEADER_SIZE = CURLINFO_LONG + 11, 2875 CURLINFO_REQUEST_SIZE = CURLINFO_LONG + 12, 2876 CURLINFO_SSL_VERIFYRESULT = CURLINFO_LONG + 13, 2877 CURLINFO_FILETIME = CURLINFO_LONG + 14, 2878 CURLINFO_FILETIME_T = CURLINFO_OFF_T + 14, 2879 CURLINFO_CONTENT_LENGTH_DOWNLOAD 2880 CURL_DEPRECATED(7.55.0, 2881 "Use CURLINFO_CONTENT_LENGTH_DOWNLOAD_T") 2882 = CURLINFO_DOUBLE + 15, 2883 CURLINFO_CONTENT_LENGTH_DOWNLOAD_T = CURLINFO_OFF_T + 15, 2884 CURLINFO_CONTENT_LENGTH_UPLOAD 2885 CURL_DEPRECATED(7.55.0, 2886 "Use CURLINFO_CONTENT_LENGTH_UPLOAD_T") 2887 = CURLINFO_DOUBLE + 16, 2888 CURLINFO_CONTENT_LENGTH_UPLOAD_T = CURLINFO_OFF_T + 16, 2889 CURLINFO_STARTTRANSFER_TIME = CURLINFO_DOUBLE + 17, 2890 CURLINFO_CONTENT_TYPE = CURLINFO_STRING + 18, 2891 CURLINFO_REDIRECT_TIME = CURLINFO_DOUBLE + 19, 2892 CURLINFO_REDIRECT_COUNT = CURLINFO_LONG + 20, 2893 CURLINFO_PRIVATE = CURLINFO_STRING + 21, 2894 CURLINFO_HTTP_CONNECTCODE = CURLINFO_LONG + 22, 2895 CURLINFO_HTTPAUTH_AVAIL = CURLINFO_LONG + 23, 2896 CURLINFO_PROXYAUTH_AVAIL = CURLINFO_LONG + 24, 2897 CURLINFO_OS_ERRNO = CURLINFO_LONG + 25, 2898 CURLINFO_NUM_CONNECTS = CURLINFO_LONG + 26, 2899 CURLINFO_SSL_ENGINES = CURLINFO_SLIST + 27, 2900 CURLINFO_COOKIELIST = CURLINFO_SLIST + 28, 2901 CURLINFO_LASTSOCKET CURL_DEPRECATED(7.45.0, "Use CURLINFO_ACTIVESOCKET") 2902 = CURLINFO_LONG + 29, 2903 CURLINFO_FTP_ENTRY_PATH = CURLINFO_STRING + 30, 2904 CURLINFO_REDIRECT_URL = CURLINFO_STRING + 31, 2905 CURLINFO_PRIMARY_IP = CURLINFO_STRING + 32, 2906 CURLINFO_APPCONNECT_TIME = CURLINFO_DOUBLE + 33, 2907 CURLINFO_CERTINFO = CURLINFO_PTR + 34, 2908 CURLINFO_CONDITION_UNMET = CURLINFO_LONG + 35, 2909 CURLINFO_RTSP_SESSION_ID = CURLINFO_STRING + 36, 2910 CURLINFO_RTSP_CLIENT_CSEQ = CURLINFO_LONG + 37, 2911 CURLINFO_RTSP_SERVER_CSEQ = CURLINFO_LONG + 38, 2912 CURLINFO_RTSP_CSEQ_RECV = CURLINFO_LONG + 39, 2913 CURLINFO_PRIMARY_PORT = CURLINFO_LONG + 40, 2914 CURLINFO_LOCAL_IP = CURLINFO_STRING + 41, 2915 CURLINFO_LOCAL_PORT = CURLINFO_LONG + 42, 2916 CURLINFO_TLS_SESSION CURL_DEPRECATED(7.48.0, "Use CURLINFO_TLS_SSL_PTR") 2917 = CURLINFO_PTR + 43, 2918 CURLINFO_ACTIVESOCKET = CURLINFO_SOCKET + 44, 2919 CURLINFO_TLS_SSL_PTR = CURLINFO_PTR + 45, 2920 CURLINFO_HTTP_VERSION = CURLINFO_LONG + 46, 2921 CURLINFO_PROXY_SSL_VERIFYRESULT = CURLINFO_LONG + 47, 2922 CURLINFO_PROTOCOL CURL_DEPRECATED(7.85.0, "Use CURLINFO_SCHEME") 2923 = CURLINFO_LONG + 48, 2924 CURLINFO_SCHEME = CURLINFO_STRING + 49, 2925 CURLINFO_TOTAL_TIME_T = CURLINFO_OFF_T + 50, 2926 CURLINFO_NAMELOOKUP_TIME_T = CURLINFO_OFF_T + 51, 2927 CURLINFO_CONNECT_TIME_T = CURLINFO_OFF_T + 52, 2928 CURLINFO_PRETRANSFER_TIME_T = CURLINFO_OFF_T + 53, 2929 CURLINFO_STARTTRANSFER_TIME_T = CURLINFO_OFF_T + 54, 2930 CURLINFO_REDIRECT_TIME_T = CURLINFO_OFF_T + 55, 2931 CURLINFO_APPCONNECT_TIME_T = CURLINFO_OFF_T + 56, 2932 CURLINFO_RETRY_AFTER = CURLINFO_OFF_T + 57, 2933 CURLINFO_EFFECTIVE_METHOD = CURLINFO_STRING + 58, 2934 CURLINFO_PROXY_ERROR = CURLINFO_LONG + 59, 2935 CURLINFO_REFERER = CURLINFO_STRING + 60, 2936 CURLINFO_CAINFO = CURLINFO_STRING + 61, 2937 CURLINFO_CAPATH = CURLINFO_STRING + 62, 2938 CURLINFO_XFER_ID = CURLINFO_OFF_T + 63, 2939 CURLINFO_CONN_ID = CURLINFO_OFF_T + 64, 2940 CURLINFO_QUEUE_TIME_T = CURLINFO_OFF_T + 65, 2941 CURLINFO_LASTONE = 65 2942 } CURLINFO; 2943 2944 /* CURLINFO_RESPONSE_CODE is the new name for the option previously known as 2945 CURLINFO_HTTP_CODE */ 2946 #define CURLINFO_HTTP_CODE CURLINFO_RESPONSE_CODE 2947 2948 typedef enum { 2949 CURLCLOSEPOLICY_NONE, /* first, never use this */ 2950 2951 CURLCLOSEPOLICY_OLDEST, 2952 CURLCLOSEPOLICY_LEAST_RECENTLY_USED, 2953 CURLCLOSEPOLICY_LEAST_TRAFFIC, 2954 CURLCLOSEPOLICY_SLOWEST, 2955 CURLCLOSEPOLICY_CALLBACK, 2956 2957 CURLCLOSEPOLICY_LAST /* last, never use this */ 2958 } curl_closepolicy; 2959 2960 #define CURL_GLOBAL_SSL (1<<0) /* no purpose since 7.57.0 */ 2961 #define CURL_GLOBAL_WIN32 (1<<1) 2962 #define CURL_GLOBAL_ALL (CURL_GLOBAL_SSL|CURL_GLOBAL_WIN32) 2963 #define CURL_GLOBAL_NOTHING 0 2964 #define CURL_GLOBAL_DEFAULT CURL_GLOBAL_ALL 2965 #define CURL_GLOBAL_ACK_EINTR (1<<2) 2966 2967 2968 /***************************************************************************** 2969 * Setup defines, protos etc for the sharing stuff. 2970 */ 2971 2972 /* Different data locks for a single share */ 2973 typedef enum { 2974 CURL_LOCK_DATA_NONE = 0, 2975 /* CURL_LOCK_DATA_SHARE is used internally to say that 2976 * the locking is just made to change the internal state of the share 2977 * itself. 2978 */ 2979 CURL_LOCK_DATA_SHARE, 2980 CURL_LOCK_DATA_COOKIE, 2981 CURL_LOCK_DATA_DNS, 2982 CURL_LOCK_DATA_SSL_SESSION, 2983 CURL_LOCK_DATA_CONNECT, 2984 CURL_LOCK_DATA_PSL, 2985 CURL_LOCK_DATA_HSTS, 2986 CURL_LOCK_DATA_LAST 2987 } curl_lock_data; 2988 2989 /* Different lock access types */ 2990 typedef enum { 2991 CURL_LOCK_ACCESS_NONE = 0, /* unspecified action */ 2992 CURL_LOCK_ACCESS_SHARED = 1, /* for read perhaps */ 2993 CURL_LOCK_ACCESS_SINGLE = 2, /* for write perhaps */ 2994 CURL_LOCK_ACCESS_LAST /* never use */ 2995 } curl_lock_access; 2996 2997 typedef void (*curl_lock_function)(CURL *handle, 2998 curl_lock_data data, 2999 curl_lock_access locktype, 3000 void *userptr); 3001 typedef void (*curl_unlock_function)(CURL *handle, 3002 curl_lock_data data, 3003 void *userptr); 3004 3005 3006 typedef enum { 3007 CURLSHE_OK, /* all is fine */ 3008 CURLSHE_BAD_OPTION, /* 1 */ 3009 CURLSHE_IN_USE, /* 2 */ 3010 CURLSHE_INVALID, /* 3 */ 3011 CURLSHE_NOMEM, /* 4 out of memory */ 3012 CURLSHE_NOT_BUILT_IN, /* 5 feature not present in lib */ 3013 CURLSHE_LAST /* never use */ 3014 } CURLSHcode; 3015 3016 typedef enum { 3017 CURLSHOPT_NONE, /* don't use */ 3018 CURLSHOPT_SHARE, /* specify a data type to share */ 3019 CURLSHOPT_UNSHARE, /* specify which data type to stop sharing */ 3020 CURLSHOPT_LOCKFUNC, /* pass in a 'curl_lock_function' pointer */ 3021 CURLSHOPT_UNLOCKFUNC, /* pass in a 'curl_unlock_function' pointer */ 3022 CURLSHOPT_USERDATA, /* pass in a user data pointer used in the lock/unlock 3023 callback functions */ 3024 CURLSHOPT_LAST /* never use */ 3025 } CURLSHoption; 3026 3027 CURL_EXTERN CURLSH *curl_share_init(void); 3028 CURL_EXTERN CURLSHcode curl_share_setopt(CURLSH *share, CURLSHoption option, 3029 ...); 3030 CURL_EXTERN CURLSHcode curl_share_cleanup(CURLSH *share); 3031 3032 /**************************************************************************** 3033 * Structures for querying information about the curl library at runtime. 3034 */ 3035 3036 typedef enum { 3037 CURLVERSION_FIRST, 3038 CURLVERSION_SECOND, 3039 CURLVERSION_THIRD, 3040 CURLVERSION_FOURTH, 3041 CURLVERSION_FIFTH, 3042 CURLVERSION_SIXTH, 3043 CURLVERSION_SEVENTH, 3044 CURLVERSION_EIGHTH, 3045 CURLVERSION_NINTH, 3046 CURLVERSION_TENTH, 3047 CURLVERSION_ELEVENTH, 3048 CURLVERSION_LAST /* never actually use this */ 3049 } CURLversion; 3050 3051 /* The 'CURLVERSION_NOW' is the symbolic name meant to be used by 3052 basically all programs ever that want to get version information. It is 3053 meant to be a built-in version number for what kind of struct the caller 3054 expects. If the struct ever changes, we redefine the NOW to another enum 3055 from above. */ 3056 #define CURLVERSION_NOW CURLVERSION_ELEVENTH 3057 3058 struct curl_version_info_data { 3059 CURLversion age; /* age of the returned struct */ 3060 const char *version; /* LIBCURL_VERSION */ 3061 unsigned int version_num; /* LIBCURL_VERSION_NUM */ 3062 const char *host; /* OS/host/cpu/machine when configured */ 3063 int features; /* bitmask, see defines below */ 3064 const char *ssl_version; /* human readable string */ 3065 long ssl_version_num; /* not used anymore, always 0 */ 3066 const char *libz_version; /* human readable string */ 3067 /* protocols is terminated by an entry with a NULL protoname */ 3068 const char * const *protocols; 3069 3070 /* The fields below this were added in CURLVERSION_SECOND */ 3071 const char *ares; 3072 int ares_num; 3073 3074 /* This field was added in CURLVERSION_THIRD */ 3075 const char *libidn; 3076 3077 /* These field were added in CURLVERSION_FOURTH */ 3078 3079 /* Same as '_libiconv_version' if built with HAVE_ICONV */ 3080 int iconv_ver_num; 3081 3082 const char *libssh_version; /* human readable string */ 3083 3084 /* These fields were added in CURLVERSION_FIFTH */ 3085 unsigned int brotli_ver_num; /* Numeric Brotli version 3086 (MAJOR << 24) | (MINOR << 12) | PATCH */ 3087 const char *brotli_version; /* human readable string. */ 3088 3089 /* These fields were added in CURLVERSION_SIXTH */ 3090 unsigned int nghttp2_ver_num; /* Numeric nghttp2 version 3091 (MAJOR << 16) | (MINOR << 8) | PATCH */ 3092 const char *nghttp2_version; /* human readable string. */ 3093 const char *quic_version; /* human readable quic (+ HTTP/3) library + 3094 version or NULL */ 3095 3096 /* These fields were added in CURLVERSION_SEVENTH */ 3097 const char *cainfo; /* the built-in default CURLOPT_CAINFO, might 3098 be NULL */ 3099 const char *capath; /* the built-in default CURLOPT_CAPATH, might 3100 be NULL */ 3101 3102 /* These fields were added in CURLVERSION_EIGHTH */ 3103 unsigned int zstd_ver_num; /* Numeric Zstd version 3104 (MAJOR << 24) | (MINOR << 12) | PATCH */ 3105 const char *zstd_version; /* human readable string. */ 3106 3107 /* These fields were added in CURLVERSION_NINTH */ 3108 const char *hyper_version; /* human readable string. */ 3109 3110 /* These fields were added in CURLVERSION_TENTH */ 3111 const char *gsasl_version; /* human readable string. */ 3112 3113 /* These fields were added in CURLVERSION_ELEVENTH */ 3114 /* feature_names is terminated by an entry with a NULL feature name */ 3115 const char * const *feature_names; 3116 }; 3117 typedef struct curl_version_info_data curl_version_info_data; 3118 3119 #define CURL_VERSION_IPV6 (1<<0) /* IPv6-enabled */ 3120 #define CURL_VERSION_KERBEROS4 (1<<1) /* Kerberos V4 auth is supported 3121 (deprecated) */ 3122 #define CURL_VERSION_SSL (1<<2) /* SSL options are present */ 3123 #define CURL_VERSION_LIBZ (1<<3) /* libz features are present */ 3124 #define CURL_VERSION_NTLM (1<<4) /* NTLM auth is supported */ 3125 #define CURL_VERSION_GSSNEGOTIATE (1<<5) /* Negotiate auth is supported 3126 (deprecated) */ 3127 #define CURL_VERSION_DEBUG (1<<6) /* Built with debug capabilities */ 3128 #define CURL_VERSION_ASYNCHDNS (1<<7) /* Asynchronous DNS resolves */ 3129 #define CURL_VERSION_SPNEGO (1<<8) /* SPNEGO auth is supported */ 3130 #define CURL_VERSION_LARGEFILE (1<<9) /* Supports files larger than 2GB */ 3131 #define CURL_VERSION_IDN (1<<10) /* Internationized Domain Names are 3132 supported */ 3133 #define CURL_VERSION_SSPI (1<<11) /* Built against Windows SSPI */ 3134 #define CURL_VERSION_CONV (1<<12) /* Character conversions supported */ 3135 #define CURL_VERSION_CURLDEBUG (1<<13) /* Debug memory tracking supported */ 3136 #define CURL_VERSION_TLSAUTH_SRP (1<<14) /* TLS-SRP auth is supported */ 3137 #define CURL_VERSION_NTLM_WB (1<<15) /* NTLM delegation to winbind helper 3138 is supported */ 3139 #define CURL_VERSION_HTTP2 (1<<16) /* HTTP2 support built-in */ 3140 #define CURL_VERSION_GSSAPI (1<<17) /* Built against a GSS-API library */ 3141 #define CURL_VERSION_KERBEROS5 (1<<18) /* Kerberos V5 auth is supported */ 3142 #define CURL_VERSION_UNIX_SOCKETS (1<<19) /* Unix domain sockets support */ 3143 #define CURL_VERSION_PSL (1<<20) /* Mozilla's Public Suffix List, used 3144 for cookie domain verification */ 3145 #define CURL_VERSION_HTTPS_PROXY (1<<21) /* HTTPS-proxy support built-in */ 3146 #define CURL_VERSION_MULTI_SSL (1<<22) /* Multiple SSL backends available */ 3147 #define CURL_VERSION_BROTLI (1<<23) /* Brotli features are present. */ 3148 #define CURL_VERSION_ALTSVC (1<<24) /* Alt-Svc handling built-in */ 3149 #define CURL_VERSION_HTTP3 (1<<25) /* HTTP3 support built-in */ 3150 #define CURL_VERSION_ZSTD (1<<26) /* zstd features are present */ 3151 #define CURL_VERSION_UNICODE (1<<27) /* Unicode support on Windows */ 3152 #define CURL_VERSION_HSTS (1<<28) /* HSTS is supported */ 3153 #define CURL_VERSION_GSASL (1<<29) /* libgsasl is supported */ 3154 #define CURL_VERSION_THREADSAFE (1<<30) /* libcurl API is thread-safe */ 3155 3156 /* 3157 * NAME curl_version_info() 3158 * 3159 * DESCRIPTION 3160 * 3161 * This function returns a pointer to a static copy of the version info 3162 * struct. See above. 3163 */ 3164 CURL_EXTERN curl_version_info_data *curl_version_info(CURLversion); 3165 3166 /* 3167 * NAME curl_easy_strerror() 3168 * 3169 * DESCRIPTION 3170 * 3171 * The curl_easy_strerror function may be used to turn a CURLcode value 3172 * into the equivalent human readable error string. This is useful 3173 * for printing meaningful error messages. 3174 */ 3175 CURL_EXTERN const char *curl_easy_strerror(CURLcode); 3176 3177 /* 3178 * NAME curl_share_strerror() 3179 * 3180 * DESCRIPTION 3181 * 3182 * The curl_share_strerror function may be used to turn a CURLSHcode value 3183 * into the equivalent human readable error string. This is useful 3184 * for printing meaningful error messages. 3185 */ 3186 CURL_EXTERN const char *curl_share_strerror(CURLSHcode); 3187 3188 /* 3189 * NAME curl_easy_pause() 3190 * 3191 * DESCRIPTION 3192 * 3193 * The curl_easy_pause function pauses or unpauses transfers. Select the new 3194 * state by setting the bitmask, use the convenience defines below. 3195 * 3196 */ 3197 CURL_EXTERN CURLcode curl_easy_pause(CURL *handle, int bitmask); 3198 3199 #define CURLPAUSE_RECV (1<<0) 3200 #define CURLPAUSE_RECV_CONT (0) 3201 3202 #define CURLPAUSE_SEND (1<<2) 3203 #define CURLPAUSE_SEND_CONT (0) 3204 3205 #define CURLPAUSE_ALL (CURLPAUSE_RECV|CURLPAUSE_SEND) 3206 #define CURLPAUSE_CONT (CURLPAUSE_RECV_CONT|CURLPAUSE_SEND_CONT) 3207 3208 #ifdef __cplusplus 3209 } /* end of extern "C" */ 3210 #endif 3211 3212 /* unfortunately, the easy.h and multi.h include files need options and info 3213 stuff before they can be included! */ 3214 #include "easy.h" /* nothing in curl is fun without the easy stuff */ 3215 #include "multi.h" 3216 #include "urlapi.h" 3217 #include "options.h" 3218 #include "header.h" 3219 #include "websockets.h" 3220 #include "mprintf.h" 3221 3222 /* the typechecker doesn't work in C++ (yet) */ 3223 #if defined(__GNUC__) && defined(__GNUC_MINOR__) && \ 3224 ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && \ 3225 !defined(__cplusplus) && !defined(CURL_DISABLE_TYPECHECK) 3226 #include "typecheck-gcc.h" 3227 #else 3228 #if defined(__STDC__) && (__STDC__ >= 1) 3229 /* This preprocessor magic that replaces a call with the exact same call is 3230 only done to make sure application authors pass exactly three arguments 3231 to these functions. */ 3232 #define curl_easy_setopt(handle,opt,param) curl_easy_setopt(handle,opt,param) 3233 #define curl_easy_getinfo(handle,info,arg) curl_easy_getinfo(handle,info,arg) 3234 #define curl_share_setopt(share,opt,param) curl_share_setopt(share,opt,param) 3235 #define curl_multi_setopt(handle,opt,param) curl_multi_setopt(handle,opt,param) 3236 #endif /* __STDC__ >= 1 */ 3237 #endif /* gcc >= 4.3 && !__cplusplus && !CURL_DISABLE_TYPECHECK */ 3238 3239 #endif /* CURLINC_CURL_H */ 3240