xref: /freebsd/include/netdb.h (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * SPDX-License-Identifier: (BSD-3-Clause AND ISC)
3  *
4  * Copyright (c) 1980, 1983, 1988, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  * -
32  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
33  *
34  * Permission to use, copy, modify, and distribute this software for any
35  * purpose with or without fee is hereby granted, provided that the above
36  * copyright notice and this permission notice appear in all copies, and that
37  * the name of Digital Equipment Corporation not be used in advertising or
38  * publicity pertaining to distribution of the document or software without
39  * specific, written prior permission.
40  *
41  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
42  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
43  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
44  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
45  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
46  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
47  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
48  * SOFTWARE.
49  * -
50  * --Copyright--
51  */
52 
53 /*
54  *      @(#)netdb.h	8.1 (Berkeley) 6/2/93
55  *      From: Id: netdb.h,v 8.9 1996/11/19 08:39:29 vixie Exp $
56  */
57 
58 #ifndef _NETDB_H_
59 #define _NETDB_H_
60 
61 #include <sys/cdefs.h>
62 #include <sys/_types.h>
63 
64 #ifndef _IN_ADDR_T_DECLARED
65 typedef	__uint32_t	in_addr_t;
66 #define	_IN_ADDR_T_DECLARED
67 #endif
68 
69 #ifndef _IN_PORT_T_DECLARED
70 typedef	__uint16_t	in_port_t;
71 #define	_IN_PORT_T_DECLARED
72 #endif
73 
74 #ifndef _SIZE_T_DECLARED
75 typedef	__size_t	size_t;
76 #define	_SIZE_T_DECLARED
77 #endif
78 
79 #ifndef _SOCKLEN_T_DECLARED
80 typedef	__socklen_t	socklen_t;
81 #define	_SOCKLEN_T_DECLARED
82 #endif
83 
84 #ifndef _UINT32_T_DECLARED
85 typedef	__uint32_t	uint32_t;
86 #define	_UINT32_T_DECLARED
87 #endif
88 
89 #ifndef _PATH_HEQUIV
90 # define	_PATH_HEQUIV	"/etc/hosts.equiv"
91 #endif
92 #define	_PATH_HOSTS	"/etc/hosts"
93 #define	_PATH_NETWORKS	"/etc/networks"
94 #define	_PATH_PROTOCOLS	"/etc/protocols"
95 #define	_PATH_SERVICES	"/etc/services"
96 #define	_PATH_SERVICES_DB "/var/db/services.db"
97 
98 #define	h_errno (*__h_errno())
99 
100 /*
101  * Structures returned by network data base library.  All addresses are
102  * supplied in host order, and returned in network order (suitable for
103  * use in system calls).
104  */
105 struct hostent {
106 	char	*h_name;	/* official name of host */
107 	char	**h_aliases;	/* alias list */
108 	int	h_addrtype;	/* host address type */
109 	int	h_length;	/* length of address */
110 	char	**h_addr_list;	/* list of addresses from name server */
111 #define	h_addr	h_addr_list[0]	/* address, for backward compatibility */
112 };
113 
114 struct netent {
115 	char		*n_name;	/* official name of net */
116 	char		**n_aliases;	/* alias list */
117 	int		n_addrtype;	/* net address type */
118 	uint32_t	n_net;		/* network # */
119 };
120 
121 struct servent {
122 	char	*s_name;	/* official service name */
123 	char	**s_aliases;	/* alias list */
124 	int	s_port;		/* port # */
125 	char	*s_proto;	/* protocol to use */
126 };
127 
128 struct protoent {
129 	char	*p_name;	/* official protocol name */
130 	char	**p_aliases;	/* alias list */
131 	int	p_proto;	/* protocol # */
132 };
133 
134 struct addrinfo {
135 	int	ai_flags;	/* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
136 	int	ai_family;	/* AF_xxx */
137 	int	ai_socktype;	/* SOCK_xxx */
138 	int	ai_protocol;	/* 0 or IPPROTO_xxx for IPv4 and IPv6 */
139 	socklen_t ai_addrlen;	/* length of ai_addr */
140 	char	*ai_canonname;	/* canonical name for hostname */
141 	struct	sockaddr *ai_addr;	/* binary address */
142 	struct	addrinfo *ai_next;	/* next structure in linked list */
143 };
144 
145 #define	IPPORT_RESERVED	1024
146 
147 /*
148  * Error return codes from gethostbyname() and gethostbyaddr()
149  * (left in h_errno).
150  */
151 
152 #define	NETDB_INTERNAL	-1	/* see errno */
153 #define	NETDB_SUCCESS	0	/* no problem */
154 #define	HOST_NOT_FOUND	1 /* Authoritative Answer Host not found */
155 #define	TRY_AGAIN	2 /* Non-Authoritative Host not found, or SERVERFAIL */
156 #define	NO_RECOVERY	3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
157 #define	NO_DATA		4 /* Valid name, no data record of requested type */
158 #define	NO_ADDRESS	NO_DATA		/* no address, look for MX record */
159 
160 /*
161  * Error return codes from gai_strerror(3), see RFC 3493.
162  */
163 #if __BSD_VISIBLE	/* not in POSIX */
164 /* EAI_ADDRFAMILY was obsoleted by RFC 3493, used as extension */
165 #define	EAI_ADDRFAMILY	 1	/* address family for hostname not supported */
166 #endif
167 #define	EAI_AGAIN	 2	/* name could not be resolved at this time */
168 #define	EAI_BADFLAGS	 3	/* flags parameter had an invalid value */
169 #define	EAI_FAIL	 4	/* non-recoverable failure in name resolution */
170 #define	EAI_FAMILY	 5	/* address family not recognized */
171 #define	EAI_MEMORY	 6	/* memory allocation failure */
172 #if __BSD_VISIBLE	/* not in POSIX */
173 /* EAI_NODATA was obsoleted by RFC 3493, retained here as extension */
174 #define	EAI_NODATA	 7	/* no address associated with hostname */
175 #endif
176 #define	EAI_NONAME	 8	/* name does not resolve */
177 #define	EAI_SERVICE	 9	/* service not recognized for socket type */
178 #define	EAI_SOCKTYPE	10	/* intended socket type was not recognized */
179 #define	EAI_SYSTEM	11	/* system error returned in errno */
180 #if __BSD_VISIBLE	/* not in POSIX */
181 /* The following 3 are not in RFC 3493 or POSIX, retained for compatibility */
182 #define	EAI_BADHINTS	12	/* invalid value for hints */
183 #define	EAI_PROTOCOL	13	/* resolved protocol is unknown */
184 #define	EAI_OVERFLOW	14	/* argument buffer overflow */
185 #endif
186 #define	EAI_MAX		15
187 
188 /*
189  * Flag values for getaddrinfo()
190  */
191 #define	AI_PASSIVE	0x00000001 /* get address to use bind() */
192 #define	AI_CANONNAME	0x00000002 /* fill ai_canonname */
193 #define	AI_NUMERICHOST	0x00000004 /* prevent host name resolution */
194 #define	AI_NUMERICSERV	0x00000008 /* prevent service name resolution */
195 /* valid flags for addrinfo (not a standard def, apps should not use it) */
196 #define AI_MASK \
197     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \
198     AI_ADDRCONFIG | AI_ALL | AI_V4MAPPED)
199 
200 #define	AI_ALL		0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
201 #define	AI_V4MAPPED_CFG	0x00000200 /* accept IPv4-mapped if kernel supports */
202 #define	AI_ADDRCONFIG	0x00000400 /* only if any address is assigned */
203 #define	AI_V4MAPPED	0x00000800 /* accept IPv4-mapped IPv6 address */
204 /* special recommended flags for getipnodebyname */
205 #define	AI_DEFAULT	(AI_V4MAPPED_CFG | AI_ADDRCONFIG)
206 
207 /*
208  * Constants for getnameinfo()
209  */
210 #define	NI_MAXHOST	1025
211 #define	NI_MAXSERV	32
212 
213 /*
214  * Flag values for getnameinfo()
215  */
216 #define	NI_NOFQDN	0x00000001
217 #define	NI_NUMERICHOST	0x00000002
218 #define	NI_NAMEREQD	0x00000004
219 #define	NI_NUMERICSERV	0x00000008
220 #define	NI_DGRAM	0x00000010
221 #define	NI_NUMERICSCOPE	0x00000020
222 
223 /*
224  * Scope delimit character
225  */
226 #define	SCOPE_DELIMITER	'%'
227 
228 __BEGIN_DECLS
229 void		endhostent(void);
230 void		endnetent(void);
231 void		endprotoent(void);
232 void		endservent(void);
233 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE <= 200112)
234 struct hostent	*gethostbyaddr(const void *, socklen_t, int);
235 struct hostent	*gethostbyname(const char *);
236 #endif
237 struct hostent	*gethostent(void);
238 struct netent	*getnetbyaddr(uint32_t, int);
239 struct netent	*getnetbyname(const char *);
240 struct netent	*getnetent(void);
241 struct protoent	*getprotobyname(const char *);
242 struct protoent	*getprotobynumber(int);
243 struct protoent	*getprotoent(void);
244 struct servent	*getservbyname(const char *, const char *);
245 struct servent	*getservbyport(int, const char *);
246 struct servent	*getservent(void);
247 void		sethostent(int);
248 /* void		sethostfile(const char *); */
249 void		setnetent(int);
250 void		setprotoent(int);
251 int		getaddrinfo(const char *, const char *,
252 			    const struct addrinfo *, struct addrinfo **);
253 int		getnameinfo(const struct sockaddr *, socklen_t, char *,
254 			    size_t, char *, size_t, int);
255 void		freeaddrinfo(struct addrinfo *);
256 const char	*gai_strerror(int);
257 void		setservent(int);
258 
259 #if __BSD_VISIBLE
260 void		endnetgrent(void);
261 void		freehostent(struct hostent *);
262 int		gethostbyaddr_r(const void *, socklen_t, int, struct hostent *,
263     char *, size_t, struct hostent **, int *);
264 int		gethostbyname_r(const char *, struct hostent *, char *, size_t,
265     struct hostent **, int *);
266 struct hostent	*gethostbyname2(const char *, int);
267 int		gethostbyname2_r(const char *, int, struct hostent *, char *,
268     size_t, struct hostent **, int *);
269 int		gethostent_r(struct hostent *, char *, size_t,
270     struct hostent **, int *);
271 struct hostent	*getipnodebyaddr(const void *, size_t, int, int *);
272 struct hostent	*getipnodebyname(const char *, int, int, int *);
273 int		getnetbyaddr_r(uint32_t, int, struct netent *, char *, size_t,
274     struct netent**, int *);
275 int		getnetbyname_r(const char *, struct netent *, char *, size_t,
276     struct netent **, int *);
277 int		getnetent_r(struct netent *, char *, size_t, struct netent **,
278     int *);
279 int		getnetgrent(char **, char **, char **);
280 int		getnetgrent_r(char **, char **, char **, char *, size_t);
281 int		getprotobyname_r(const char *, struct protoent *, char *,
282     size_t, struct protoent **);
283 int		getprotobynumber_r(int, struct protoent *, char *, size_t,
284     struct protoent **);
285 int		getprotoent_r(struct protoent *, char *, size_t,
286     struct protoent **);
287 int		getservbyname_r(const char *, const char *, struct servent *,
288     char *, size_t, struct servent **);
289 int		getservbyport_r(int, const char *, struct servent *, char *,
290     size_t, struct servent **);
291 int		getservent_r(struct servent *, char *, size_t,
292     struct servent **);
293 void		herror(const char *);
294 const char	*hstrerror(int);
295 int		innetgr(const char *, const char *, const char *, const char *);
296 void		setnetgrent(const char *);
297 #endif
298 
299 
300 /*
301  * PRIVATE functions specific to the FreeBSD implementation
302  */
303 
304 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
305 int	* __h_errno(void);
306 __END_DECLS
307 
308 #endif /* !_NETDB_H_ */
309