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