xref: /freebsd/include/netdb.h (revision 97759ccc715c4b365432c16d763c50eecfcb1100)
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  *      From: Id: netdb.h,v 8.9 1996/11/19 08:39:29 vixie Exp $
55  */
56 
57 #ifndef _NETDB_H_
58 #define _NETDB_H_
59 
60 #include <sys/cdefs.h>
61 #include <sys/_types.h>
62 
63 #ifndef _IN_ADDR_T_DECLARED
64 typedef	__uint32_t	in_addr_t;
65 #define	_IN_ADDR_T_DECLARED
66 #endif
67 
68 #ifndef _IN_PORT_T_DECLARED
69 typedef	__uint16_t	in_port_t;
70 #define	_IN_PORT_T_DECLARED
71 #endif
72 
73 #ifndef _SIZE_T_DECLARED
74 typedef	__size_t	size_t;
75 #define	_SIZE_T_DECLARED
76 #endif
77 
78 #ifndef _SOCKLEN_T_DECLARED
79 typedef	__socklen_t	socklen_t;
80 #define	_SOCKLEN_T_DECLARED
81 #endif
82 
83 #ifndef _UINT32_T_DECLARED
84 typedef	__uint32_t	uint32_t;
85 #define	_UINT32_T_DECLARED
86 #endif
87 
88 #ifndef _PATH_HEQUIV
89 # define	_PATH_HEQUIV	"/etc/hosts.equiv"
90 #endif
91 #define	_PATH_HOSTS	"/etc/hosts"
92 #define	_PATH_NETWORKS	"/etc/networks"
93 #define	_PATH_PROTOCOLS	"/etc/protocols"
94 #define	_PATH_SERVICES	"/etc/services"
95 #define	_PATH_SERVICES_DB "/var/db/services.db"
96 
97 #define	h_errno (*__h_errno())
98 
99 /*
100  * Structures returned by network data base library.  All addresses are
101  * supplied in host order, and returned in network order (suitable for
102  * use in system calls).
103  */
104 struct hostent {
105 	char	*h_name;	/* official name of host */
106 	char	**h_aliases;	/* alias list */
107 	int	h_addrtype;	/* host address type */
108 	int	h_length;	/* length of address */
109 	char	**h_addr_list;	/* list of addresses from name server */
110 #define	h_addr	h_addr_list[0]	/* address, for backward compatibility */
111 };
112 
113 struct netent {
114 	char		*n_name;	/* official name of net */
115 	char		**n_aliases;	/* alias list */
116 	int		n_addrtype;	/* net address type */
117 	uint32_t	n_net;		/* network # */
118 };
119 
120 struct servent {
121 	char	*s_name;	/* official service name */
122 	char	**s_aliases;	/* alias list */
123 	int	s_port;		/* port # */
124 	char	*s_proto;	/* protocol to use */
125 };
126 
127 struct protoent {
128 	char	*p_name;	/* official protocol name */
129 	char	**p_aliases;	/* alias list */
130 	int	p_proto;	/* protocol # */
131 };
132 
133 struct addrinfo {
134 	int	ai_flags;	/* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
135 	int	ai_family;	/* AF_xxx */
136 	int	ai_socktype;	/* SOCK_xxx */
137 	int	ai_protocol;	/* 0 or IPPROTO_xxx for IPv4 and IPv6 */
138 	socklen_t ai_addrlen;	/* length of ai_addr */
139 	char	*ai_canonname;	/* canonical name for hostname */
140 	struct	sockaddr *ai_addr;	/* binary address */
141 	struct	addrinfo *ai_next;	/* next structure in linked list */
142 };
143 
144 #define	IPPORT_RESERVED	1024
145 
146 /*
147  * Error return codes from gethostbyname() and gethostbyaddr()
148  * (left in h_errno).
149  */
150 
151 #define	NETDB_INTERNAL	-1	/* see errno */
152 #define	NETDB_SUCCESS	0	/* no problem */
153 #define	HOST_NOT_FOUND	1 /* Authoritative Answer Host not found */
154 #define	TRY_AGAIN	2 /* Non-Authoritative Host not found, or SERVERFAIL */
155 #define	NO_RECOVERY	3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
156 #define	NO_DATA		4 /* Valid name, no data record of requested type */
157 #define	NO_ADDRESS	NO_DATA		/* no address, look for MX record */
158 
159 /*
160  * Error return codes from gai_strerror(3), see RFC 3493.
161  */
162 #if __BSD_VISIBLE	/* not in POSIX */
163 /* EAI_ADDRFAMILY was obsoleted by RFC 3493, used as extension */
164 #define	EAI_ADDRFAMILY	 1	/* address family for hostname not supported */
165 #endif
166 #define	EAI_AGAIN	 2	/* name could not be resolved at this time */
167 #define	EAI_BADFLAGS	 3	/* flags parameter had an invalid value */
168 #define	EAI_FAIL	 4	/* non-recoverable failure in name resolution */
169 #define	EAI_FAMILY	 5	/* address family not recognized */
170 #define	EAI_MEMORY	 6	/* memory allocation failure */
171 #if __BSD_VISIBLE	/* not in POSIX */
172 /* EAI_NODATA was obsoleted by RFC 3493, retained here as extension */
173 #define	EAI_NODATA	 7	/* no address associated with hostname */
174 #endif
175 #define	EAI_NONAME	 8	/* name does not resolve */
176 #define	EAI_SERVICE	 9	/* service not recognized for socket type */
177 #define	EAI_SOCKTYPE	10	/* intended socket type was not recognized */
178 #define	EAI_SYSTEM	11	/* system error returned in errno */
179 #if __BSD_VISIBLE	/* not in POSIX */
180 /* The following 3 are not in RFC 3493 or POSIX, retained for compatibility */
181 #define	EAI_BADHINTS	12	/* invalid value for hints */
182 #define	EAI_PROTOCOL	13	/* resolved protocol is unknown */
183 #define	EAI_OVERFLOW	14	/* argument buffer overflow */
184 #endif
185 #define	EAI_MAX		15
186 
187 /*
188  * Flag values for getaddrinfo()
189  */
190 #define	AI_PASSIVE	0x00000001 /* get address to use bind() */
191 #define	AI_CANONNAME	0x00000002 /* fill ai_canonname */
192 #define	AI_NUMERICHOST	0x00000004 /* prevent host name resolution */
193 #define	AI_NUMERICSERV	0x00000008 /* prevent service name resolution */
194 /* valid flags for addrinfo (not a standard def, apps should not use it) */
195 #define AI_MASK \
196     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \
197     AI_ADDRCONFIG | AI_ALL | AI_V4MAPPED)
198 
199 #define	AI_ALL		0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
200 #define	AI_V4MAPPED_CFG	0x00000200 /* accept IPv4-mapped if kernel supports */
201 #define	AI_ADDRCONFIG	0x00000400 /* only if any address is assigned */
202 #define	AI_V4MAPPED	0x00000800 /* accept IPv4-mapped IPv6 address */
203 /* special recommended flags for getipnodebyname */
204 #define	AI_DEFAULT	(AI_V4MAPPED_CFG | AI_ADDRCONFIG)
205 
206 /*
207  * Constants for getnameinfo()
208  */
209 #define	NI_MAXHOST	1025
210 #define	NI_MAXSERV	32
211 
212 /*
213  * Flag values for getnameinfo()
214  */
215 #define	NI_NOFQDN	0x00000001
216 #define	NI_NUMERICHOST	0x00000002
217 #define	NI_NAMEREQD	0x00000004
218 #define	NI_NUMERICSERV	0x00000008
219 #define	NI_DGRAM	0x00000010
220 #define	NI_NUMERICSCOPE	0x00000020
221 
222 /*
223  * Scope delimit character
224  */
225 #define	SCOPE_DELIMITER	'%'
226 
227 __BEGIN_DECLS
228 void		endhostent(void);
229 void		endnetent(void);
230 void		endprotoent(void);
231 void		endservent(void);
232 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE <= 200112)
233 struct hostent	*gethostbyaddr(const void *, socklen_t, int);
234 struct hostent	*gethostbyname(const char *);
235 #endif
236 struct hostent	*gethostent(void);
237 struct netent	*getnetbyaddr(uint32_t, int);
238 struct netent	*getnetbyname(const char *);
239 struct netent	*getnetent(void);
240 struct protoent	*getprotobyname(const char *);
241 struct protoent	*getprotobynumber(int);
242 struct protoent	*getprotoent(void);
243 struct servent	*getservbyname(const char *, const char *);
244 struct servent	*getservbyport(int, const char *);
245 struct servent	*getservent(void);
246 void		sethostent(int);
247 /* void		sethostfile(const char *); */
248 void		setnetent(int);
249 void		setprotoent(int);
250 int		getaddrinfo(const char *, const char *,
251 			    const struct addrinfo *, struct addrinfo **);
252 int		getnameinfo(const struct sockaddr *, socklen_t, char *,
253 			    size_t, char *, size_t, int);
254 void		freeaddrinfo(struct addrinfo *);
255 const char	*gai_strerror(int);
256 void		setservent(int);
257 
258 #if __BSD_VISIBLE
259 void		endnetgrent(void);
260 void		freehostent(struct hostent *);
261 int		gethostbyaddr_r(const void *, socklen_t, int, struct hostent *,
262     char *, size_t, struct hostent **, int *);
263 int		gethostbyname_r(const char *, struct hostent *, char *, size_t,
264     struct hostent **, int *);
265 struct hostent	*gethostbyname2(const char *, int);
266 int		gethostbyname2_r(const char *, int, struct hostent *, char *,
267     size_t, struct hostent **, int *);
268 int		gethostent_r(struct hostent *, char *, size_t,
269     struct hostent **, int *);
270 struct hostent	*getipnodebyaddr(const void *, size_t, int, int *);
271 struct hostent	*getipnodebyname(const char *, int, int, int *);
272 int		getnetbyaddr_r(uint32_t, int, struct netent *, char *, size_t,
273     struct netent**, int *);
274 int		getnetbyname_r(const char *, struct netent *, char *, size_t,
275     struct netent **, int *);
276 int		getnetent_r(struct netent *, char *, size_t, struct netent **,
277     int *);
278 int		getnetgrent(char **, char **, char **);
279 int		getnetgrent_r(char **, char **, char **, char *, size_t);
280 int		getprotobyname_r(const char *, struct protoent *, char *,
281     size_t, struct protoent **);
282 int		getprotobynumber_r(int, struct protoent *, char *, size_t,
283     struct protoent **);
284 int		getprotoent_r(struct protoent *, char *, size_t,
285     struct protoent **);
286 int		getservbyname_r(const char *, const char *, struct servent *,
287     char *, size_t, struct servent **);
288 int		getservbyport_r(int, const char *, struct servent *, char *,
289     size_t, struct servent **);
290 int		getservent_r(struct servent *, char *, size_t,
291     struct servent **);
292 void		herror(const char *);
293 const char	*hstrerror(int);
294 int		innetgr(const char *, const char *, const char *, const char *);
295 void		setnetgrent(const char *);
296 #endif
297 
298 
299 /*
300  * PRIVATE functions specific to the FreeBSD implementation
301  */
302 
303 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
304 int	* __h_errno(void);
305 __END_DECLS
306 
307 #endif /* !_NETDB_H_ */
308