2 * Copyright (C) 2004, 2005, 2007, 2013-2015 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 2000, 2001 Internet Software Consortium.
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: gethost.c,v 1.34 2007/06/19 23:47:22 tbox Exp $ */
23 * These functions provide hostname-to-address and address-to-hostname
24 * lookups by means of the lightweight resolver. They are similar to the
25 * standard gethostent(3) functions provided by most operating systems.
26 * They use a struct hostent which is usually defined in <namedb.h>.
30 * char *h_name; // official name of host
31 * char **h_aliases; // alias list
32 * int h_addrtype; // host address type
33 * int h_length; // length of address
34 * char **h_addr_list; // list of addresses from name server
36 * #define h_addr h_addr_list[0] // address, for backward compatibility
39 * The members of this structure are:
42 * The official (canonical) name of the host.
45 * A NULL-terminated array of alternate names (nicknames) for the
49 * The type of address being returned -- PF_INET or PF_INET6.
52 * The length of the address in bytes.
55 * A NULL terminated array of network addresses for the host. Host
56 * addresses are returned in network byte order.
58 * For backward compatibility with very old software, h_addr is the first
59 * address in h_addr_list.
61 * lwres_gethostent(), lwres_sethostent(), lwres_endhostent(),
62 * lwres_gethostent_r(), lwres_sethostent_r() and lwres_endhostent_r()
63 * provide iteration over the known host entries on systems that provide
64 * such functionality through facilities like /etc/hosts or NIS. The
65 * lightweight resolver does not currently implement these functions; it
66 * only provides them as stub functions that always return failure.
68 * lwres_gethostbyname() and lwres_gethostbyname2() look up the hostname
69 * name. lwres_gethostbyname() always looks for an IPv4 address while
70 * lwres_gethostbyname2() looks for an address of protocol family af:
71 * either PF_INET or PF_INET6 -- IPv4 or IPV6 addresses respectively.
72 * Successful calls of the functions return a struct hostent for the name
73 * that was looked up. NULL is returned if the lookups by
74 * lwres_gethostbyname() or lwres_gethostbyname2() fail.
76 * Reverse lookups of addresses are performed by lwres_gethostbyaddr().
77 * addr is an address of length len bytes and protocol family type --
78 * PF_INET or PF_INET6. lwres_gethostbyname_r() is a thread-safe function
79 * for forward lookups. If an error occurs, an error code is returned in
80 * *error. resbuf is a pointer to a struct hostent which is initialised
81 * by a successful call to lwres_gethostbyname_r() . buf is a buffer of
82 * length len bytes which is used to store the h_name, h_aliases, and
83 * h_addr_list elements of the struct hostent returned in resbuf.
84 * Successful calls to lwres_gethostbyname_r() return resbuf, which is a
85 * pointer to the struct hostent it created.
87 * lwres_gethostbyaddr_r() is a thread-safe function that performs a
88 * reverse lookup of address addr which is len bytes long and is of
89 * protocol family type -- PF_INET or PF_INET6. If an error occurs, the
90 * error code is returned in *error. The other function parameters are
91 * identical to those in lwres_gethostbyname_r(). resbuf is a pointer to
92 * a struct hostent which is initialised by a successful call to
93 * lwres_gethostbyaddr_r(). buf is a buffer of length len bytes which is
94 * used to store the h_name, h_aliases, and h_addr_list elements of the
95 * struct hostent returned in resbuf. Successful calls to
96 * lwres_gethostbyaddr_r() return resbuf, which is a pointer to the
97 * struct hostent it created.
99 * \section gethost_return Return Values
101 * The functions lwres_gethostbyname(), lwres_gethostbyname2(),
102 * lwres_gethostbyaddr(), and lwres_gethostent() return NULL to indicate
103 * an error. In this case the global variable lwres_h_errno will contain
104 * one of the following error codes defined in \link netdb.h <lwres/netdb.h>:\endlink
106 * \li #HOST_NOT_FOUND:
107 * The host or address was not found.
110 * A recoverable error occurred, e.g., a timeout. Retrying the
111 * lookup may succeed.
114 * A non-recoverable error occurred.
117 * The name exists, but has no address information associated with
118 * it (or vice versa in the case of a reverse lookup). The code
119 * NO_ADDRESS is accepted as a synonym for NO_DATA for backwards
122 * lwres_hstrerror() translates these error codes to suitable error
125 * lwres_gethostent() and lwres_gethostent_r() always return NULL.
127 * Successful calls to lwres_gethostbyname_r() and
128 * lwres_gethostbyaddr_r() return resbuf, a pointer to the struct hostent
129 * that was initialised by these functions. They return NULL if the
130 * lookups fail or if buf was too small to hold the list of addresses and
131 * names referenced by the h_name, h_aliases, and h_addr_list elements of
132 * the struct hostent. If buf was too small, both lwres_gethostbyname_r()
133 * and lwres_gethostbyaddr_r() set the global variable errno to ERANGE.
135 * \section gethost_see See Also
137 * gethostent(), \link getipnode.c getipnode\endlink, lwres_hstrerror()
139 * \section gethost_bugs Bugs
141 * lwres_gethostbyname(), lwres_gethostbyname2(), lwres_gethostbyaddr()
142 * and lwres_endhostent() are not thread safe; they return pointers to
143 * static data and provide error codes through a global variable.
144 * Thread-safe versions for name and address lookup are provided by
145 * lwres_gethostbyname_r(), and lwres_gethostbyaddr_r() respectively.
147 * The resolver daemon does not currently support any non-DNS name
148 * services such as /etc/hosts or NIS, consequently the above functions
156 #ifdef HAVE_INTTYPES_H
157 #include <inttypes.h> /* uintptr_t */
160 #include <lwres/net.h>
161 #include <lwres/netdb.h>
163 #include "assert_p.h"
165 #define LWRES_ALIGNBYTES (sizeof(char *) - 1)
166 #define LWRES_ALIGN(p) \
167 (((uintptr_t)(p) + LWRES_ALIGNBYTES) &~ LWRES_ALIGNBYTES)
169 static struct hostent *he = NULL;
170 static int copytobuf(struct hostent *, struct hostent *, char *, int);
172 /*% Always looks for an IPv4 address. */
174 lwres_gethostbyname(const char *name) {
177 lwres_freehostent(he);
179 he = lwres_getipnodebyname(name, AF_INET, 0, &lwres_h_errno);
183 /*% Looks for either an IPv4 or IPv6 address. */
185 lwres_gethostbyname2(const char *name, int af) {
187 lwres_freehostent(he);
189 he = lwres_getipnodebyname(name, af, 0, &lwres_h_errno);
193 /*% Reverse lookup of addresses. */
195 lwres_gethostbyaddr(const char *addr, int len, int type) {
198 lwres_freehostent(he);
200 he = lwres_getipnodebyaddr(addr, len, type, &lwres_h_errno);
204 /*% Stub function. Always returns failure. */
206 lwres_gethostent(void) {
208 lwres_freehostent(he);
213 /*% Stub function. Always returns failure. */
215 lwres_sethostent(int stayopen) {
222 /*% Stub function. Always returns failure. */
224 lwres_endhostent(void) {
230 /*% Thread-safe function for forward lookups. */
232 lwres_gethostbyname_r(const char *name, struct hostent *resbuf,
233 char *buf, int buflen, int *error)
235 struct hostent *myhe;
238 myhe = lwres_getipnodebyname(name, AF_INET, 0, error);
241 res = copytobuf(myhe, resbuf, buf, buflen);
242 lwres_freehostent(myhe);
250 /*% Thread-safe reverse lookup. */
252 lwres_gethostbyaddr_r(const char *addr, int len, int type,
253 struct hostent *resbuf, char *buf, int buflen,
256 struct hostent *myhe;
259 myhe = lwres_getipnodebyaddr(addr, len, type, error);
262 res = copytobuf(myhe, resbuf, buf, buflen);
263 lwres_freehostent(myhe);
271 /*% Stub function. Always returns failure. */
273 lwres_gethostent_r(struct hostent *resbuf, char *buf, int buflen, int *error) {
281 /*% Stub function. Always returns failure. */
283 lwres_sethostent_r(int stayopen) {
290 /*% Stub function. Always returns failure. */
292 lwres_endhostent_r(void) {
299 copytobuf(struct hostent *src, struct hostent *hptr, char *buf, int buflen) {
306 * Find out the amount of space required to store the answer.
308 nptr = 2; /* NULL ptrs */
309 len = (int)((char *)LWRES_ALIGN(buf) - buf);
310 for (i = 0; src->h_addr_list[i]; i++, nptr++) {
311 len += src->h_length;
313 for (i = 0; src->h_aliases[i]; i++, nptr++) {
314 len += strlen(src->h_aliases[i]) + 1;
316 len += strlen(src->h_name) + 1;
317 len += nptr * sizeof(char*);
324 * Copy address size and type.
326 hptr->h_addrtype = src->h_addrtype;
327 n = hptr->h_length = src->h_length;
329 ptr = (char **)LWRES_ALIGN(buf);
330 cp = (char *)LWRES_ALIGN(buf) + nptr * sizeof(char *);
335 hptr->h_addr_list = ptr;
336 for (i = 0; src->h_addr_list[i]; i++, ptr++) {
337 memmove(cp, src->h_addr_list[i], n);
338 hptr->h_addr_list[i] = cp;
341 hptr->h_addr_list[i] = NULL;
345 * Copy official name.
347 n = strlen(src->h_name) + 1;
348 strcpy(cp, src->h_name);
355 hptr->h_aliases = ptr;
356 for (i = 0; src->h_aliases[i]; i++) {
357 n = strlen(src->h_aliases[i]) + 1;
358 strcpy(cp, src->h_aliases[i]);
359 hptr->h_aliases[i] = cp;
362 hptr->h_aliases[i] = NULL;