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