|
|
|
/* MIT License
|
|
|
|
*
|
|
|
|
* Copyright (c) Massachusetts Institute of Technology
|
|
|
|
* Copyright (c) Daniel Stenberg
|
|
|
|
*
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
|
|
* in the Software without restriction, including without limitation the rights
|
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
|
|
* furnished to do so, subject to the following conditions:
|
|
|
|
*
|
|
|
|
* The above copyright notice and this permission notice (including the next
|
|
|
|
* paragraph) shall be included in all copies or substantial portions of the
|
|
|
|
* Software.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
|
* SOFTWARE.
|
|
|
|
*
|
|
|
|
* SPDX-License-Identifier: MIT
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef ARES__H
|
|
|
|
#define ARES__H
|
|
|
|
|
|
|
|
#include "ares_version.h" /* c-ares version defines */
|
|
|
|
#include "ares_build.h" /* c-ares build definitions */
|
|
|
|
#include "ares_rules.h" /* c-ares rules enforcement */
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Define WIN32 when build target is Win32 API
|
|
|
|
*/
|
|
|
|
|
|
|
|
#if (defined(_WIN32) || defined(__WIN32__)) && \
|
|
|
|
!defined(WIN32) && !defined(__SYMBIAN32__)
|
|
|
|
# define WIN32
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#include <sys/types.h>
|
|
|
|
|
|
|
|
/* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish
|
|
|
|
libc5-based Linux systems. Only include it on system that are known to
|
|
|
|
require it! */
|
|
|
|
#if defined(_AIX) || defined(__NOVELL_LIBC__) || defined(__NetBSD__) || \
|
|
|
|
defined(__minix) || defined(__SYMBIAN32__) || defined(__INTEGRITY) || \
|
|
|
|
defined(ANDROID) || defined(__ANDROID__) || defined(__OpenBSD__) || \
|
|
|
|
defined(__QNXNTO__) || defined(__MVS__) || defined(__HAIKU__)
|
|
|
|
#include <sys/select.h>
|
|
|
|
#endif
|
|
|
|
#if (defined(NETWARE) && !defined(__NOVELL_LIBC__))
|
|
|
|
#include <sys/bsdskt.h>
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#if defined(WATT32)
|
|
|
|
# include <netinet/in.h>
|
|
|
|
# include <sys/socket.h>
|
|
|
|
# include <tcp.h>
|
|
|
|
#elif defined(_WIN32_WCE)
|
|
|
|
# ifndef WIN32_LEAN_AND_MEAN
|
|
|
|
# define WIN32_LEAN_AND_MEAN
|
|
|
|
# endif
|
|
|
|
# include <windows.h>
|
|
|
|
# include <winsock.h>
|
|
|
|
#elif defined(WIN32)
|
|
|
|
# ifndef WIN32_LEAN_AND_MEAN
|
|
|
|
# define WIN32_LEAN_AND_MEAN
|
|
|
|
# endif
|
|
|
|
# include <windows.h>
|
|
|
|
# include <winsock2.h>
|
|
|
|
# include <ws2tcpip.h>
|
|
|
|
/* To aid with linking against a static c-ares build, lets tell the microsoft
|
|
|
|
* compiler to pull in needed dependencies */
|
|
|
|
# ifdef _MSC_VER
|
|
|
|
# pragma comment(lib, "ws2_32")
|
|
|
|
# pragma comment(lib, "advapi32")
|
|
|
|
# pragma comment(lib, "iphlpapi")
|
|
|
|
# endif
|
|
|
|
#else
|
|
|
|
# include <sys/socket.h>
|
|
|
|
# include <netinet/in.h>
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#if defined(ANDROID) || defined(__ANDROID__)
|
|
|
|
#include <jni.h>
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/*
|
|
|
|
** c-ares external API function linkage decorations.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifdef CARES_STATICLIB
|
|
|
|
# define CARES_EXTERN
|
|
|
|
#elif defined(WIN32) || defined(_WIN32) || defined(__SYMBIAN32__)
|
|
|
|
# if defined(CARES_BUILDING_LIBRARY)
|
|
|
|
# define CARES_EXTERN __declspec(dllexport)
|
|
|
|
# else
|
|
|
|
# define CARES_EXTERN __declspec(dllimport)
|
|
|
|
# endif
|
|
|
|
#elif defined(CARES_BUILDING_LIBRARY) && defined(CARES_SYMBOL_HIDING)
|
|
|
|
# define CARES_EXTERN CARES_SYMBOL_SCOPE_EXTERN
|
|
|
|
#else
|
|
|
|
# define CARES_EXTERN
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
ARES_SUCCESS = 0,
|
|
|
|
|
|
|
|
/* Server error codes (ARES_ENODATA indicates no relevant answer) */
|
|
|
|
ARES_ENODATA = 1,
|
|
|
|
ARES_EFORMERR = 2,
|
|
|
|
ARES_ESERVFAIL = 3,
|
|
|
|
ARES_ENOTFOUND = 4,
|
|
|
|
ARES_ENOTIMP = 5,
|
|
|
|
ARES_EREFUSED = 6,
|
|
|
|
|
|
|
|
/* Locally generated error codes */
|
|
|
|
ARES_EBADQUERY = 7,
|
|
|
|
ARES_EBADNAME = 8,
|
|
|
|
ARES_EBADFAMILY = 9,
|
|
|
|
ARES_EBADRESP = 10,
|
|
|
|
ARES_ECONNREFUSED = 11,
|
|
|
|
ARES_ETIMEOUT = 12,
|
|
|
|
ARES_EOF = 13,
|
|
|
|
ARES_EFILE = 14,
|
|
|
|
ARES_ENOMEM = 15,
|
|
|
|
ARES_EDESTRUCTION = 16,
|
|
|
|
ARES_EBADSTR = 17,
|
|
|
|
|
|
|
|
/* ares_getnameinfo error codes */
|
|
|
|
ARES_EBADFLAGS = 18,
|
|
|
|
|
|
|
|
/* ares_getaddrinfo error codes */
|
|
|
|
ARES_ENONAME = 19,
|
|
|
|
ARES_EBADHINTS = 20,
|
|
|
|
|
|
|
|
/* Uninitialized library error code */
|
|
|
|
ARES_ENOTINITIALIZED = 21, /* introduced in 1.7.0 */
|
|
|
|
|
|
|
|
/* ares_library_init error codes */
|
|
|
|
ARES_ELOADIPHLPAPI = 22, /* introduced in 1.7.0 */
|
|
|
|
ARES_EADDRGETNETWORKPARAMS = 23, /* introduced in 1.7.0 */
|
|
|
|
|
|
|
|
/* More error codes */
|
|
|
|
ARES_ECANCELLED = 24, /* introduced in 1.7.0 */
|
|
|
|
|
|
|
|
/* More ares_getaddrinfo error codes */
|
|
|
|
ARES_ESERVICE = 25 /* introduced in 1.?.0 */
|
|
|
|
} ares_status_t;
|
|
|
|
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
ARES_FALSE = 0,
|
|
|
|
ARES_TRUE = 1
|
|
|
|
} ares_bool_t;
|
|
|
|
|
|
|
|
/* Flag values */
|
|
|
|
#define ARES_FLAG_USEVC (1 << 0)
|
|
|
|
#define ARES_FLAG_PRIMARY (1 << 1)
|
|
|
|
#define ARES_FLAG_IGNTC (1 << 2)
|
|
|
|
#define ARES_FLAG_NORECURSE (1 << 3)
|
|
|
|
#define ARES_FLAG_STAYOPEN (1 << 4)
|
|
|
|
#define ARES_FLAG_NOSEARCH (1 << 5)
|
|
|
|
#define ARES_FLAG_NOALIASES (1 << 6)
|
|
|
|
#define ARES_FLAG_NOCHECKRESP (1 << 7)
|
|
|
|
#define ARES_FLAG_EDNS (1 << 8)
|
|
|
|
|
|
|
|
/* Option mask values */
|
|
|
|
#define ARES_OPT_FLAGS (1 << 0)
|
|
|
|
#define ARES_OPT_TIMEOUT (1 << 1)
|
|
|
|
#define ARES_OPT_TRIES (1 << 2)
|
|
|
|
#define ARES_OPT_NDOTS (1 << 3)
|
|
|
|
#define ARES_OPT_UDP_PORT (1 << 4)
|
|
|
|
#define ARES_OPT_TCP_PORT (1 << 5)
|
|
|
|
#define ARES_OPT_SERVERS (1 << 6)
|
|
|
|
#define ARES_OPT_DOMAINS (1 << 7)
|
|
|
|
#define ARES_OPT_LOOKUPS (1 << 8)
|
|
|
|
#define ARES_OPT_SOCK_STATE_CB (1 << 9)
|
|
|
|
#define ARES_OPT_SORTLIST (1 << 10)
|
|
|
|
#define ARES_OPT_SOCK_SNDBUF (1 << 11)
|
|
|
|
#define ARES_OPT_SOCK_RCVBUF (1 << 12)
|
|
|
|
#define ARES_OPT_TIMEOUTMS (1 << 13)
|
|
|
|
#define ARES_OPT_ROTATE (1 << 14)
|
|
|
|
#define ARES_OPT_EDNSPSZ (1 << 15)
|
|
|
|
#define ARES_OPT_NOROTATE (1 << 16)
|
|
|
|
#define ARES_OPT_RESOLVCONF (1 << 17)
|
|
|
|
#define ARES_OPT_HOSTS_FILE (1 << 18)
|
|
|
|
#define ARES_OPT_UDP_MAX_QUERIES (1 << 19)
|
|
|
|
|
|
|
|
/* Nameinfo flag values */
|
|
|
|
#define ARES_NI_NOFQDN (1 << 0)
|
|
|
|
#define ARES_NI_NUMERICHOST (1 << 1)
|
|
|
|
#define ARES_NI_NAMEREQD (1 << 2)
|
|
|
|
#define ARES_NI_NUMERICSERV (1 << 3)
|
|
|
|
#define ARES_NI_DGRAM (1 << 4)
|
|
|
|
#define ARES_NI_TCP 0
|
|
|
|
#define ARES_NI_UDP ARES_NI_DGRAM
|
|
|
|
#define ARES_NI_SCTP (1 << 5)
|
|
|
|
#define ARES_NI_DCCP (1 << 6)
|
|
|
|
#define ARES_NI_NUMERICSCOPE (1 << 7)
|
|
|
|
#define ARES_NI_LOOKUPHOST (1 << 8)
|
|
|
|
#define ARES_NI_LOOKUPSERVICE (1 << 9)
|
|
|
|
/* Reserved for future use */
|
|
|
|
#define ARES_NI_IDN (1 << 10)
|
|
|
|
#define ARES_NI_IDN_ALLOW_UNASSIGNED (1 << 11)
|
|
|
|
#define ARES_NI_IDN_USE_STD3_ASCII_RULES (1 << 12)
|
|
|
|
|
|
|
|
/* Addrinfo flag values */
|
|
|
|
#define ARES_AI_CANONNAME (1 << 0)
|
|
|
|
#define ARES_AI_NUMERICHOST (1 << 1)
|
|
|
|
#define ARES_AI_PASSIVE (1 << 2)
|
|
|
|
#define ARES_AI_NUMERICSERV (1 << 3)
|
|
|
|
#define ARES_AI_V4MAPPED (1 << 4)
|
|
|
|
#define ARES_AI_ALL (1 << 5)
|
|
|
|
#define ARES_AI_ADDRCONFIG (1 << 6)
|
|
|
|
#define ARES_AI_NOSORT (1 << 7)
|
|
|
|
#define ARES_AI_ENVHOSTS (1 << 8)
|
|
|
|
/* Reserved for future use */
|
|
|
|
#define ARES_AI_IDN (1 << 10)
|
|
|
|
#define ARES_AI_IDN_ALLOW_UNASSIGNED (1 << 11)
|
|
|
|
#define ARES_AI_IDN_USE_STD3_ASCII_RULES (1 << 12)
|
|
|
|
#define ARES_AI_CANONIDN (1 << 13)
|
|
|
|
|
|
|
|
#define ARES_AI_MASK (ARES_AI_CANONNAME|ARES_AI_NUMERICHOST|ARES_AI_PASSIVE| \
|
|
|
|
ARES_AI_NUMERICSERV|ARES_AI_V4MAPPED|ARES_AI_ALL| \
|
|
|
|
ARES_AI_ADDRCONFIG)
|
|
|
|
#define ARES_GETSOCK_MAXNUM 16 /* ares_getsock() can return info about this
|
|
|
|
many sockets */
|
|
|
|
#define ARES_GETSOCK_READABLE(bits,num) (bits & (1<< (num)))
|
|
|
|
#define ARES_GETSOCK_WRITABLE(bits,num) (bits & (1 << ((num) + \
|
|
|
|
ARES_GETSOCK_MAXNUM)))
|
|
|
|
|
|
|
|
/* c-ares library initialization flag values */
|
|
|
|
#define ARES_LIB_INIT_NONE (0)
|
|
|
|
#define ARES_LIB_INIT_WIN32 (1 << 0)
|
|
|
|
#define ARES_LIB_INIT_ALL (ARES_LIB_INIT_WIN32)
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Typedef our socket type
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef ares_socket_typedef
|
|
|
|
#ifdef WIN32
|
|
|
|
typedef SOCKET ares_socket_t;
|
|
|
|
#define ARES_SOCKET_BAD INVALID_SOCKET
|
|
|
|
#else
|
|
|
|
typedef int ares_socket_t;
|
|
|
|
#define ARES_SOCKET_BAD -1
|
|
|
|
#endif
|
|
|
|
#define ares_socket_typedef
|
|
|
|
#endif /* ares_socket_typedef */
|
|
|
|
|
|
|
|
typedef void (*ares_sock_state_cb)(void *data,
|
|
|
|
ares_socket_t socket_fd,
|
|
|
|
int readable,
|
|
|
|
int writable);
|
|
|
|
|
|
|
|
struct apattern;
|
|
|
|
|
|
|
|
/* NOTE about the ares_options struct to users and developers.
|
|
|
|
|
|
|
|
This struct will remain looking like this. It will not be extended nor
|
|
|
|
shrunk in future releases, but all new options will be set by ares_set_*()
|
|
|
|
options instead of with the ares_init_options() function.
|
|
|
|
|
|
|
|
Eventually (in a galaxy far far away), all options will be settable by
|
|
|
|
ares_set_*() options and the ares_init_options() function will become
|
|
|
|
deprecated.
|
|
|
|
|
|
|
|
When new options are added to c-ares, they are not added to this
|
|
|
|
struct. And they are not "saved" with the ares_save_options() function but
|
|
|
|
instead we encourage the use of the ares_dup() function. Needless to say,
|
|
|
|
if you add config options to c-ares you need to make sure ares_dup()
|
|
|
|
duplicates this new option.
|
|
|
|
|
|
|
|
*/
|
|
|
|
struct ares_options {
|
|
|
|
int flags;
|
|
|
|
int timeout; /* in seconds or milliseconds, depending on options */
|
|
|
|
int tries;
|
|
|
|
int ndots;
|
|
|
|
unsigned short udp_port;
|
|
|
|
unsigned short tcp_port;
|
|
|
|
int socket_send_buffer_size;
|
|
|
|
int socket_receive_buffer_size;
|
|
|
|
struct in_addr *servers;
|
|
|
|
int nservers;
|
|
|
|
char **domains;
|
|
|
|
int ndomains;
|
|
|
|
char *lookups;
|
|
|
|
ares_sock_state_cb sock_state_cb;
|
|
|
|
void *sock_state_cb_data;
|
|
|
|
struct apattern *sortlist;
|
|
|
|
int nsort;
|
|
|
|
int ednspsz;
|
|
|
|
char *resolvconf_path;
|
|
|
|
char *hosts_path;
|
|
|
|
int udp_max_queries;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct hostent;
|
|
|
|
struct timeval;
|
|
|
|
struct sockaddr;
|
|
|
|
struct ares_channeldata;
|
|
|
|
struct ares_addrinfo;
|
|
|
|
struct ares_addrinfo_hints;
|
|
|
|
|
|
|
|
typedef struct ares_channeldata *ares_channel;
|
|
|
|
|
|
|
|
typedef void (*ares_callback)(void *arg,
|
|
|
|
int status,
|
|
|
|
int timeouts,
|
|
|
|
unsigned char *abuf,
|
|
|
|
int alen);
|
|
|
|
|
|
|
|
typedef void (*ares_host_callback)(void *arg,
|
|
|
|
int status,
|
|
|
|
int timeouts,
|
|
|
|
struct hostent *hostent);
|
|
|
|
|
|
|
|
typedef void (*ares_nameinfo_callback)(void *arg,
|
|
|
|
int status,
|
|
|
|
int timeouts,
|
|
|
|
char *node,
|
|
|
|
char *service);
|
|
|
|
|
|
|
|
typedef int (*ares_sock_create_callback)(ares_socket_t socket_fd,
|
|
|
|
int type,
|
|
|
|
void *data);
|
|
|
|
|
|
|
|
typedef int (*ares_sock_config_callback)(ares_socket_t socket_fd,
|
|
|
|
int type,
|
|
|
|
void *data);
|
|
|
|
|
|
|
|
typedef void (*ares_addrinfo_callback)(void *arg,
|
|
|
|
int status,
|
|
|
|
int timeouts,
|
|
|
|
struct ares_addrinfo *res);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_library_init(int flags);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_library_init_mem(int flags,
|
|
|
|
void *(*amalloc)(size_t size),
|
|
|
|
void (*afree)(void *ptr),
|
|
|
|
void *(*arealloc)(void *ptr, size_t size));
|
|
|
|
|
|
|
|
#if defined(ANDROID) || defined(__ANDROID__)
|
|
|
|
CARES_EXTERN void ares_library_init_jvm(JavaVM *jvm);
|
|
|
|
CARES_EXTERN int ares_library_init_android(jobject connectivity_manager);
|
|
|
|
CARES_EXTERN int ares_library_android_initialized(void);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_library_initialized(void);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_library_cleanup(void);
|
|
|
|
|
|
|
|
CARES_EXTERN const char *ares_version(int *version);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_init(ares_channel *channelptr);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_init_options(ares_channel *channelptr,
|
|
|
|
struct ares_options *options,
|
|
|
|
int optmask);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_save_options(ares_channel channel,
|
|
|
|
struct ares_options *options,
|
|
|
|
int *optmask);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_destroy_options(struct ares_options *options);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_dup(ares_channel *dest,
|
|
|
|
ares_channel src);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_destroy(ares_channel channel);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_cancel(ares_channel channel);
|
|
|
|
|
|
|
|
/* These next 3 configure local binding for the out-going socket
|
|
|
|
* connection. Use these to specify source IP and/or network device
|
|
|
|
* on multi-homed systems.
|
|
|
|
*/
|
|
|
|
CARES_EXTERN void ares_set_local_ip4(ares_channel channel, unsigned int local_ip);
|
|
|
|
|
|
|
|
/* local_ip6 should be 16 bytes in length */
|
|
|
|
CARES_EXTERN void ares_set_local_ip6(ares_channel channel,
|
|
|
|
const unsigned char* local_ip6);
|
|
|
|
|
|
|
|
/* local_dev_name should be null terminated. */
|
|
|
|
CARES_EXTERN void ares_set_local_dev(ares_channel channel,
|
|
|
|
const char* local_dev_name);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_set_socket_callback(ares_channel channel,
|
|
|
|
ares_sock_create_callback callback,
|
|
|
|
void *user_data);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_set_socket_configure_callback(ares_channel channel,
|
|
|
|
ares_sock_config_callback callback,
|
|
|
|
void *user_data);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_set_sortlist(ares_channel channel,
|
|
|
|
const char *sortstr);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_getaddrinfo(ares_channel channel,
|
|
|
|
const char* node,
|
|
|
|
const char* service,
|
|
|
|
const struct ares_addrinfo_hints* hints,
|
|
|
|
ares_addrinfo_callback callback,
|
|
|
|
void* arg);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_freeaddrinfo(struct ares_addrinfo* ai);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Virtual function set to have user-managed socket IO.
|
|
|
|
* Note that all functions need to be defined, and when
|
|
|
|
* set, the library will not do any bind nor set any
|
|
|
|
* socket options, assuming the client handles these
|
|
|
|
* through either socket creation or the
|
|
|
|
* ares_sock_config_callback call.
|
|
|
|
*/
|
|
|
|
struct iovec;
|
|
|
|
struct ares_socket_functions {
|
|
|
|
ares_socket_t(*asocket)(int, int, int, void *);
|
|
|
|
int(*aclose)(ares_socket_t, void *);
|
|
|
|
int(*aconnect)(ares_socket_t, const struct sockaddr *, ares_socklen_t, void *);
|
|
|
|
ares_ssize_t(*arecvfrom)(ares_socket_t, void *, size_t, int, struct sockaddr *, ares_socklen_t *, void *);
|
|
|
|
ares_ssize_t(*asendv)(ares_socket_t, const struct iovec *, int, void *);
|
|
|
|
};
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_set_socket_functions(ares_channel channel,
|
|
|
|
const struct ares_socket_functions * funcs,
|
|
|
|
void *user_data);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_send(ares_channel channel,
|
|
|
|
const unsigned char *qbuf,
|
|
|
|
int qlen,
|
|
|
|
ares_callback callback,
|
|
|
|
void *arg);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_query(ares_channel channel,
|
|
|
|
const char *name,
|
|
|
|
int dnsclass,
|
|
|
|
int type,
|
|
|
|
ares_callback callback,
|
|
|
|
void *arg);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_search(ares_channel channel,
|
|
|
|
const char *name,
|
|
|
|
int dnsclass,
|
|
|
|
int type,
|
|
|
|
ares_callback callback,
|
|
|
|
void *arg);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_gethostbyname(ares_channel channel,
|
|
|
|
const char *name,
|
|
|
|
int family,
|
|
|
|
ares_host_callback callback,
|
|
|
|
void *arg);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_gethostbyname_file(ares_channel channel,
|
|
|
|
const char *name,
|
|
|
|
int family,
|
|
|
|
struct hostent **host);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_gethostbyaddr(ares_channel channel,
|
|
|
|
const void *addr,
|
|
|
|
int addrlen,
|
|
|
|
int family,
|
|
|
|
ares_host_callback callback,
|
|
|
|
void *arg);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_getnameinfo(ares_channel channel,
|
|
|
|
const struct sockaddr *sa,
|
|
|
|
ares_socklen_t salen,
|
|
|
|
int flags,
|
|
|
|
ares_nameinfo_callback callback,
|
|
|
|
void *arg);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_fds(ares_channel channel,
|
|
|
|
fd_set *read_fds,
|
|
|
|
fd_set *write_fds);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_getsock(ares_channel channel,
|
|
|
|
ares_socket_t *socks,
|
|
|
|
int numsocks);
|
|
|
|
|
|
|
|
CARES_EXTERN struct timeval *ares_timeout(ares_channel channel,
|
|
|
|
struct timeval *maxtv,
|
|
|
|
struct timeval *tv);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_process(ares_channel channel,
|
|
|
|
fd_set *read_fds,
|
|
|
|
fd_set *write_fds);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_process_fd(ares_channel channel,
|
|
|
|
ares_socket_t read_fd,
|
|
|
|
ares_socket_t write_fd);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_create_query(const char *name,
|
|
|
|
int dnsclass,
|
|
|
|
int type,
|
|
|
|
unsigned short id,
|
|
|
|
int rd,
|
|
|
|
unsigned char **buf,
|
|
|
|
int *buflen,
|
|
|
|
int max_udp_size);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_mkquery(const char *name,
|
|
|
|
int dnsclass,
|
|
|
|
int type,
|
|
|
|
unsigned short id,
|
|
|
|
int rd,
|
|
|
|
unsigned char **buf,
|
|
|
|
int *buflen);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_expand_name(const unsigned char *encoded,
|
|
|
|
const unsigned char *abuf,
|
|
|
|
int alen,
|
|
|
|
char **s,
|
|
|
|
long *enclen);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_expand_string(const unsigned char *encoded,
|
|
|
|
const unsigned char *abuf,
|
|
|
|
int alen,
|
|
|
|
unsigned char **s,
|
|
|
|
long *enclen);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* NOTE: before c-ares 1.7.0 we would most often use the system in6_addr
|
|
|
|
* struct below when ares itself was built, but many apps would use this
|
|
|
|
* private version since the header checked a HAVE_* define for it. Starting
|
|
|
|
* with 1.7.0 we always declare and use our own to stop relying on the
|
|
|
|
* system's one.
|
|
|
|
*/
|
|
|
|
struct ares_in6_addr {
|
|
|
|
union {
|
|
|
|
unsigned char _S6_u8[16];
|
|
|
|
} _S6_un;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ares_addrttl {
|
|
|
|
struct in_addr ipaddr;
|
|
|
|
int ttl;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ares_addr6ttl {
|
|
|
|
struct ares_in6_addr ip6addr;
|
|
|
|
int ttl;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ares_caa_reply {
|
|
|
|
struct ares_caa_reply *next;
|
|
|
|
int critical;
|
|
|
|
unsigned char *property;
|
|
|
|
size_t plength; /* plength excludes null termination */
|
|
|
|
unsigned char *value;
|
|
|
|
size_t length; /* length excludes null termination */
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ares_srv_reply {
|
|
|
|
struct ares_srv_reply *next;
|
|
|
|
char *host;
|
|
|
|
unsigned short priority;
|
|
|
|
unsigned short weight;
|
|
|
|
unsigned short port;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ares_mx_reply {
|
|
|
|
struct ares_mx_reply *next;
|
|
|
|
char *host;
|
|
|
|
unsigned short priority;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ares_txt_reply {
|
|
|
|
struct ares_txt_reply *next;
|
|
|
|
unsigned char *txt;
|
|
|
|
size_t length; /* length excludes null termination */
|
|
|
|
};
|
|
|
|
|
|
|
|
/* NOTE: This structure is a superset of ares_txt_reply
|
|
|
|
*/
|
|
|
|
struct ares_txt_ext {
|
|
|
|
struct ares_txt_ext *next;
|
|
|
|
unsigned char *txt;
|
|
|
|
size_t length;
|
|
|
|
/* 1 - if start of new record
|
|
|
|
* 0 - if a chunk in the same record */
|
|
|
|
unsigned char record_start;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ares_naptr_reply {
|
|
|
|
struct ares_naptr_reply *next;
|
|
|
|
unsigned char *flags;
|
|
|
|
unsigned char *service;
|
|
|
|
unsigned char *regexp;
|
|
|
|
char *replacement;
|
|
|
|
unsigned short order;
|
|
|
|
unsigned short preference;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ares_soa_reply {
|
|
|
|
char *nsname;
|
|
|
|
char *hostmaster;
|
|
|
|
unsigned int serial;
|
|
|
|
unsigned int refresh;
|
|
|
|
unsigned int retry;
|
|
|
|
unsigned int expire;
|
|
|
|
unsigned int minttl;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ares_uri_reply {
|
|
|
|
struct ares_uri_reply *next;
|
|
|
|
unsigned short priority;
|
|
|
|
unsigned short weight;
|
|
|
|
char *uri;
|
|
|
|
int ttl;
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Similar to addrinfo, but with extra ttl and missing canonname.
|
|
|
|
*/
|
|
|
|
struct ares_addrinfo_node {
|
|
|
|
int ai_ttl;
|
|
|
|
int ai_flags;
|
|
|
|
int ai_family;
|
|
|
|
int ai_socktype;
|
|
|
|
int ai_protocol;
|
|
|
|
ares_socklen_t ai_addrlen;
|
|
|
|
struct sockaddr *ai_addr;
|
|
|
|
struct ares_addrinfo_node *ai_next;
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* alias - label of the resource record.
|
|
|
|
* name - value (canonical name) of the resource record.
|
|
|
|
* See RFC2181 10.1.1. CNAME terminology.
|
|
|
|
*/
|
|
|
|
struct ares_addrinfo_cname {
|
|
|
|
int ttl;
|
|
|
|
char *alias;
|
|
|
|
char *name;
|
|
|
|
struct ares_addrinfo_cname *next;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ares_addrinfo {
|
|
|
|
struct ares_addrinfo_cname *cnames;
|
|
|
|
struct ares_addrinfo_node *nodes;
|
Reimplement ares_gethostbyname() by wrapping ares_getaddrinfo() (#428)
ares_gethostbyname() and ares_getaddrinfo() do a lot of similar things, however ares_getaddrinfo() has some desirable behaviors that should be imported into ares_gethostbyname(). For one, it sorts the address lists for the most likely to succeed based on the current system routes. Next, when AF_UNSPEC is specified, it properly handles search lists instead of first searching all of AF_INET6 then AF_INET, since ares_gethostbyname() searches in parallel. Therefore, this PR should also resolve the issues attempted in #94.
A few things this PR does:
1. ares_parse_a_reply() and ares_parse_aaaa_reply() had very similar code to translate struct ares_addrinfo into a struct hostent as well as into struct ares_addrttl/ares_addr6ttl this has been split out into helper functions of ares__addrinfo2hostent() and ares__addrinfo2addrttl() to prevent this duplicative code.
2. ares_getaddrinfo() was apparently never honoring HOSTALIASES, and this was discovered once ares_gethostbyname() was turned into a wrapper, the affected test cases started failing.
3. A slight API modification to save the query hostname into struct ares_addrinfo as the last element of name. Since this is the last element, and all user-level instances of struct ares_addrinfo are allocated internally by c-ares, this is not an ABI-breaking change nor would it impact any API compatibility. This was needed since struct hostent has an h_name element.
4. Test Framework: MockServer tests via TCP would fail if more than 1 request was received at a time which is common when ares_getaddrinfo() queries for both A and AAAA records simultaneously. Infact, this was a long standing issue in which the ares_getaddrinfo() test were bypassing TCP alltogether. This has been corrected, the message is now processed in a loop.
5. Some tests had to be updated for overall correctness as they were invalid but somehow passing prior to this change.
Change By: Brad House (@bradh352)
3 years ago
|
|
|
char *name;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ares_addrinfo_hints {
|
|
|
|
int ai_flags;
|
|
|
|
int ai_family;
|
|
|
|
int ai_socktype;
|
|
|
|
int ai_protocol;
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
** Parse the buffer, starting at *abuf and of length alen bytes, previously
|
|
|
|
** obtained from an ares_search call. Put the results in *host, if nonnull.
|
|
|
|
** Also, if addrttls is nonnull, put up to *naddrttls IPv4 addresses along with
|
|
|
|
** their TTLs in that array, and set *naddrttls to the number of addresses
|
|
|
|
** so written.
|
|
|
|
*/
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_parse_a_reply(const unsigned char *abuf,
|
|
|
|
int alen,
|
|
|
|
struct hostent **host,
|
|
|
|
struct ares_addrttl *addrttls,
|
|
|
|
int *naddrttls);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_parse_aaaa_reply(const unsigned char *abuf,
|
|
|
|
int alen,
|
|
|
|
struct hostent **host,
|
|
|
|
struct ares_addr6ttl *addrttls,
|
|
|
|
int *naddrttls);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_parse_caa_reply(const unsigned char* abuf,
|
|
|
|
int alen,
|
|
|
|
struct ares_caa_reply** caa_out);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_parse_ptr_reply(const unsigned char *abuf,
|
|
|
|
int alen,
|
|
|
|
const void *addr,
|
|
|
|
int addrlen,
|
|
|
|
int family,
|
|
|
|
struct hostent **host);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_parse_ns_reply(const unsigned char *abuf,
|
|
|
|
int alen,
|
|
|
|
struct hostent **host);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_parse_srv_reply(const unsigned char* abuf,
|
|
|
|
int alen,
|
|
|
|
struct ares_srv_reply** srv_out);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_parse_mx_reply(const unsigned char* abuf,
|
|
|
|
int alen,
|
|
|
|
struct ares_mx_reply** mx_out);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_parse_txt_reply(const unsigned char* abuf,
|
|
|
|
int alen,
|
|
|
|
struct ares_txt_reply** txt_out);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_parse_txt_reply_ext(const unsigned char* abuf,
|
|
|
|
int alen,
|
|
|
|
struct ares_txt_ext** txt_out);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_parse_naptr_reply(const unsigned char* abuf,
|
|
|
|
int alen,
|
|
|
|
struct ares_naptr_reply** naptr_out);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_parse_soa_reply(const unsigned char* abuf,
|
|
|
|
int alen,
|
|
|
|
struct ares_soa_reply** soa_out);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_parse_uri_reply(const unsigned char* abuf,
|
|
|
|
int alen,
|
|
|
|
struct ares_uri_reply** uri_out);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_free_string(void *str);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_free_hostent(struct hostent *host);
|
|
|
|
|
|
|
|
CARES_EXTERN void ares_free_data(void *dataptr);
|
|
|
|
|
|
|
|
CARES_EXTERN const char *ares_strerror(int code);
|
|
|
|
|
|
|
|
struct ares_addr_node {
|
|
|
|
struct ares_addr_node *next;
|
|
|
|
int family;
|
|
|
|
union {
|
|
|
|
struct in_addr addr4;
|
|
|
|
struct ares_in6_addr addr6;
|
|
|
|
} addr;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ares_addr_port_node {
|
|
|
|
struct ares_addr_port_node *next;
|
|
|
|
int family;
|
|
|
|
union {
|
|
|
|
struct in_addr addr4;
|
|
|
|
struct ares_in6_addr addr6;
|
|
|
|
} addr;
|
|
|
|
int udp_port;
|
|
|
|
int tcp_port;
|
|
|
|
};
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_set_servers(ares_channel channel,
|
|
|
|
struct ares_addr_node *servers);
|
|
|
|
CARES_EXTERN int ares_set_servers_ports(ares_channel channel,
|
|
|
|
struct ares_addr_port_node *servers);
|
|
|
|
|
|
|
|
/* Incomming string format: host[:port][,host[:port]]... */
|
|
|
|
CARES_EXTERN int ares_set_servers_csv(ares_channel channel,
|
|
|
|
const char* servers);
|
|
|
|
CARES_EXTERN int ares_set_servers_ports_csv(ares_channel channel,
|
|
|
|
const char* servers);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_get_servers(ares_channel channel,
|
|
|
|
struct ares_addr_node **servers);
|
|
|
|
CARES_EXTERN int ares_get_servers_ports(ares_channel channel,
|
|
|
|
struct ares_addr_port_node **servers);
|
|
|
|
|
|
|
|
CARES_EXTERN const char *ares_inet_ntop(int af, const void *src, char *dst,
|
|
|
|
ares_socklen_t size);
|
|
|
|
|
|
|
|
CARES_EXTERN int ares_inet_pton(int af, const char *src, void *dst);
|
|
|
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* ARES__H */
|