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