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