VirtualBox

source: vbox/trunk/src/libs/curl-7.83.1/include/curl/curl.h@ 96762

Last change on this file since 96762 was 95312, checked in by vboxsync, 3 years ago

libs/{curl,libxml2}: OSE export fixes, bugref:8515

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette