hostip.h 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. #ifndef HEADER_CURL_HOSTIP_H
  2. #define HEADER_CURL_HOSTIP_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2020, 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.haxx.se/docs/copyright.html.
  15. *
  16. * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17. * copies of the Software, and permit persons to whom the Software is
  18. * furnished to do so, under the terms of the COPYING file.
  19. *
  20. * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21. * KIND, either express or implied.
  22. *
  23. ***************************************************************************/
  24. #include "curl_setup.h"
  25. #include "hash.h"
  26. #include "curl_addrinfo.h"
  27. #include "timeval.h" /* for timediff_t */
  28. #include "asyn.h"
  29. #ifdef HAVE_SETJMP_H
  30. #include <setjmp.h>
  31. #endif
  32. #ifdef NETWARE
  33. #undef in_addr_t
  34. #define in_addr_t unsigned long
  35. #endif
  36. /* Allocate enough memory to hold the full name information structs and
  37. * everything. OSF1 is known to require at least 8872 bytes. The buffer
  38. * required for storing all possible aliases and IP numbers is according to
  39. * Stevens' Unix Network Programming 2nd edition, p. 304: 8192 bytes!
  40. */
  41. #define CURL_HOSTENT_SIZE 9000
  42. #define CURL_TIMEOUT_RESOLVE 300 /* when using asynch methods, we allow this
  43. many seconds for a name resolve */
  44. #define CURL_ASYNC_SUCCESS CURLE_OK
  45. struct addrinfo;
  46. struct hostent;
  47. struct Curl_easy;
  48. struct connectdata;
  49. /*
  50. * Curl_global_host_cache_init() initializes and sets up a global DNS cache.
  51. * Global DNS cache is general badness. Do not use. This will be removed in
  52. * a future version. Use the share interface instead!
  53. *
  54. * Returns a struct curl_hash pointer on success, NULL on failure.
  55. */
  56. struct curl_hash *Curl_global_host_cache_init(void);
  57. struct Curl_dns_entry {
  58. struct Curl_addrinfo *addr;
  59. /* timestamp == 0 -- CURLOPT_RESOLVE entry, doesn't timeout */
  60. time_t timestamp;
  61. /* use-counter, use Curl_resolv_unlock to release reference */
  62. long inuse;
  63. };
  64. /*
  65. * Curl_resolv() returns an entry with the info for the specified host
  66. * and port.
  67. *
  68. * The returned data *MUST* be "unlocked" with Curl_resolv_unlock() after
  69. * use, or we'll leak memory!
  70. */
  71. /* return codes */
  72. enum resolve_t {
  73. CURLRESOLV_TIMEDOUT = -2,
  74. CURLRESOLV_ERROR = -1,
  75. CURLRESOLV_RESOLVED = 0,
  76. CURLRESOLV_PENDING = 1
  77. };
  78. enum resolve_t Curl_resolv(struct connectdata *conn,
  79. const char *hostname,
  80. int port,
  81. bool allowDOH,
  82. struct Curl_dns_entry **dnsentry);
  83. enum resolve_t Curl_resolv_timeout(struct connectdata *conn,
  84. const char *hostname, int port,
  85. struct Curl_dns_entry **dnsentry,
  86. timediff_t timeoutms);
  87. #ifdef CURLRES_IPV6
  88. /*
  89. * Curl_ipv6works() returns TRUE if IPv6 seems to work.
  90. */
  91. bool Curl_ipv6works(struct connectdata *conn);
  92. #else
  93. #define Curl_ipv6works(x) FALSE
  94. #endif
  95. /*
  96. * Curl_ipvalid() checks what CURL_IPRESOLVE_* requirements that might've
  97. * been set and returns TRUE if they are OK.
  98. */
  99. bool Curl_ipvalid(struct connectdata *conn);
  100. /*
  101. * Curl_getaddrinfo() is the generic low-level name resolve API within this
  102. * source file. There are several versions of this function - for different
  103. * name resolve layers (selected at build-time). They all take this same set
  104. * of arguments
  105. */
  106. struct Curl_addrinfo *Curl_getaddrinfo(struct connectdata *conn,
  107. const char *hostname,
  108. int port,
  109. int *waitp);
  110. /* unlock a previously resolved dns entry */
  111. void Curl_resolv_unlock(struct Curl_easy *data,
  112. struct Curl_dns_entry *dns);
  113. /* init a new dns cache and return success */
  114. int Curl_mk_dnscache(struct curl_hash *hash);
  115. /* prune old entries from the DNS cache */
  116. void Curl_hostcache_prune(struct Curl_easy *data);
  117. /* Return # of addresses in a Curl_addrinfo struct */
  118. int Curl_num_addresses(const struct Curl_addrinfo *addr);
  119. #if defined(CURLDEBUG) && defined(HAVE_GETNAMEINFO)
  120. int curl_dogetnameinfo(GETNAMEINFO_QUAL_ARG1 GETNAMEINFO_TYPE_ARG1 sa,
  121. GETNAMEINFO_TYPE_ARG2 salen,
  122. char *host, GETNAMEINFO_TYPE_ARG46 hostlen,
  123. char *serv, GETNAMEINFO_TYPE_ARG46 servlen,
  124. GETNAMEINFO_TYPE_ARG7 flags,
  125. int line, const char *source);
  126. #endif
  127. /* IPv4 threadsafe resolve function used for synch and asynch builds */
  128. struct Curl_addrinfo *Curl_ipv4_resolve_r(const char *hostname, int port);
  129. CURLcode Curl_once_resolved(struct connectdata *conn, bool *protocol_connect);
  130. /*
  131. * Curl_addrinfo_callback() is used when we build with any asynch specialty.
  132. * Handles end of async request processing. Inserts ai into hostcache when
  133. * status is CURL_ASYNC_SUCCESS. Twiddles fields in conn to indicate async
  134. * request completed whether successful or failed.
  135. */
  136. CURLcode Curl_addrinfo_callback(struct connectdata *conn,
  137. int status,
  138. struct Curl_addrinfo *ai);
  139. /*
  140. * Curl_printable_address() returns a printable version of the 1st address
  141. * given in the 'ip' argument. The result will be stored in the buf that is
  142. * bufsize bytes big.
  143. */
  144. void Curl_printable_address(const struct Curl_addrinfo *ip,
  145. char *buf, size_t bufsize);
  146. /*
  147. * Curl_fetch_addr() fetches a 'Curl_dns_entry' already in the DNS cache.
  148. *
  149. * Returns the Curl_dns_entry entry pointer or NULL if not in the cache.
  150. *
  151. * The returned data *MUST* be "unlocked" with Curl_resolv_unlock() after
  152. * use, or we'll leak memory!
  153. */
  154. struct Curl_dns_entry *
  155. Curl_fetch_addr(struct connectdata *conn,
  156. const char *hostname,
  157. int port);
  158. /*
  159. * Curl_cache_addr() stores a 'Curl_addrinfo' struct in the DNS cache.
  160. *
  161. * Returns the Curl_dns_entry entry pointer or NULL if the storage failed.
  162. */
  163. struct Curl_dns_entry *
  164. Curl_cache_addr(struct Curl_easy *data, struct Curl_addrinfo *addr,
  165. const char *hostname, int port);
  166. #ifndef INADDR_NONE
  167. #define CURL_INADDR_NONE (in_addr_t) ~0
  168. #else
  169. #define CURL_INADDR_NONE INADDR_NONE
  170. #endif
  171. #ifdef HAVE_SIGSETJMP
  172. /* Forward-declaration of variable defined in hostip.c. Beware this
  173. * is a global and unique instance. This is used to store the return
  174. * address that we can jump back to from inside a signal handler.
  175. * This is not thread-safe stuff.
  176. */
  177. extern sigjmp_buf curl_jmpenv;
  178. #endif
  179. /*
  180. * Function provided by the resolver backend to set DNS servers to use.
  181. */
  182. CURLcode Curl_set_dns_servers(struct Curl_easy *data, char *servers);
  183. /*
  184. * Function provided by the resolver backend to set
  185. * outgoing interface to use for DNS requests
  186. */
  187. CURLcode Curl_set_dns_interface(struct Curl_easy *data,
  188. const char *interf);
  189. /*
  190. * Function provided by the resolver backend to set
  191. * local IPv4 address to use as source address for DNS requests
  192. */
  193. CURLcode Curl_set_dns_local_ip4(struct Curl_easy *data,
  194. const char *local_ip4);
  195. /*
  196. * Function provided by the resolver backend to set
  197. * local IPv6 address to use as source address for DNS requests
  198. */
  199. CURLcode Curl_set_dns_local_ip6(struct Curl_easy *data,
  200. const char *local_ip6);
  201. /*
  202. * Clean off entries from the cache
  203. */
  204. void Curl_hostcache_clean(struct Curl_easy *data, struct curl_hash *hash);
  205. /*
  206. * Populate the cache with specified entries from CURLOPT_RESOLVE.
  207. */
  208. CURLcode Curl_loadhostpairs(struct Curl_easy *data);
  209. CURLcode Curl_resolv_check(struct connectdata *conn,
  210. struct Curl_dns_entry **dns);
  211. int Curl_resolv_getsock(struct connectdata *conn,
  212. curl_socket_t *socks);
  213. #endif /* HEADER_CURL_HOSTIP_H */