xref: /openbsd/include/netdb.h (revision 404b540a)
1 /*	$OpenBSD: netdb.h,v 1.27 2009/06/02 16:47:50 jasper Exp $	*/
2 
3 /*
4  * ++Copyright++ 1980, 1983, 1988, 1993
5  * -
6  * Copyright (c) 1980, 1983, 1988, 1993
7  *	The Regents of the University of California.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  * -
33  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
34  *
35  * Permission to use, copy, modify, and distribute this software for any
36  * purpose with or without fee is hereby granted, provided that the above
37  * copyright notice and this permission notice appear in all copies, and that
38  * the name of Digital Equipment Corporation not be used in advertising or
39  * publicity pertaining to distribution of the document or software without
40  * specific, written prior permission.
41  *
42  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
43  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
44  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
45  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
46  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
47  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
48  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
49  * SOFTWARE.
50  * -
51  * --Copyright--
52  */
53 
54 /*
55  * Copyright (c) 1995, 1996, 1997, 1998, 1999 Craig Metz. All rights reserved.
56  *
57  * Redistribution and use in source and binary forms, with or without
58  * modification, are permitted provided that the following conditions
59  * are met:
60  * 1. Redistributions of source code must retain the above copyright
61  *    notice, this list of conditions and the following disclaimer.
62  * 2. Redistributions in binary form must reproduce the above copyright
63  *    notice, this list of conditions and the following disclaimer in the
64  *    documentation and/or other materials provided with the distribution.
65  * 3. Neither the name of the author nor the names of any contributors
66  *    may be used to endorse or promote products derived from this software
67  *    without specific prior written permission.
68  *
69  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
70  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
71  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
72  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
73  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
74  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
75  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
76  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
77  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
78  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
79  * SUCH DAMAGE.
80  */
81 
82 /*
83  *      @(#)netdb.h	8.1 (Berkeley) 6/2/93
84  *	$From: netdb.h,v 8.7 1996/05/09 05:59:09 vixie Exp $
85  */
86 
87 #ifndef _NETDB_H_
88 #define _NETDB_H_
89 
90 #include <sys/param.h>
91 #include <sys/cdefs.h>
92 
93 #define	_PATH_HEQUIV	"/etc/hosts.equiv"
94 #define	_PATH_HOSTS	"/etc/hosts"
95 #define	_PATH_NETWORKS	"/etc/networks"
96 #define	_PATH_PROTOCOLS	"/etc/protocols"
97 #define	_PATH_SERVICES	"/etc/services"
98 
99 extern int 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 /*
116  * Assumption here is that a network number
117  * fits in an in_addr_t -- probably a poor one.
118  */
119 struct	netent {
120 	char		*n_name;	/* official name of net */
121 	char		**n_aliases;	/* alias list */
122 	int		n_addrtype;	/* net address type */
123 	in_addr_t	n_net;		/* network # */
124 };
125 
126 struct	servent {
127 	char	*s_name;	/* official service name */
128 	char	**s_aliases;	/* alias list */
129 	int	s_port;		/* port # */
130 	char	*s_proto;	/* protocol to use */
131 };
132 
133 struct	protoent {
134 	char	*p_name;	/* official protocol name */
135 	char	**p_aliases;	/* alias list */
136 	int	p_proto;	/* protocol # */
137 };
138 
139 /*
140  * Error return codes from gethostbyname() and gethostbyaddr()
141  * (left in extern int h_errno).
142  */
143 
144 #define	NETDB_INTERNAL	-1	/* see errno */
145 #define	NETDB_SUCCESS	0	/* no problem */
146 #define	HOST_NOT_FOUND	1 /* Authoritative Answer Host not found */
147 #define	TRY_AGAIN	2 /* Non-Authoritive Host not found, or SERVERFAIL */
148 #define	NO_RECOVERY	3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
149 #define	NO_DATA		4 /* Valid name, no data record of requested type */
150 #define	NO_ADDRESS	NO_DATA		/* no address */
151 
152 /* Values for getaddrinfo() and getnameinfo() */
153 #define AI_PASSIVE	1	/* socket address is intended for bind() */
154 #define AI_CANONNAME	2	/* request for canonical name */
155 #define AI_NUMERICHOST	4	/* don't ever try hostname lookup */
156 #define AI_EXT		8	/* enable non-portable extensions */
157 #define AI_NUMERICSERV	16	/* don't ever try servname lookup */
158 /* valid flags for addrinfo */
159 #define AI_MASK \
160     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV)
161 
162 #define NI_NUMERICHOST	1	/* return the host address, not the name */
163 #define NI_NUMERICSERV	2	/* return the service address, not the name */
164 #define NI_NOFQDN	4	/* return a short name if in the local domain */
165 #define NI_NAMEREQD	8	/* fail if either host or service name is unknown */
166 #define NI_DGRAM	16	/* look up datagram service instead of stream */
167 
168 #define NI_MAXHOST	MAXHOSTNAMELEN	/* max host name returned by getnameinfo */
169 #define NI_MAXSERV	32	/* max serv. name length returned by getnameinfo */
170 
171 /*
172  * Scope delimit character (KAME hack)
173  */
174 #define SCOPE_DELIMITER '%'
175 
176 #define EAI_BADFLAGS	-1	/* invalid value for ai_flags */
177 #define EAI_NONAME	-2	/* name or service is not known */
178 #define EAI_AGAIN	-3	/* temporary failure in name resolution */
179 #define EAI_FAIL	-4	/* non-recoverable failure in name resolution */
180 #define EAI_NODATA	-5	/* no address associated with name */
181 #define EAI_FAMILY	-6	/* ai_family not supported */
182 #define EAI_SOCKTYPE	-7	/* ai_socktype not supported */
183 #define EAI_SERVICE	-8	/* service not supported for ai_socktype */
184 #define EAI_ADDRFAMILY	-9	/* address family for name not supported */
185 #define EAI_MEMORY	-10	/* memory allocation failure */
186 #define EAI_SYSTEM	-11	/* system error (code indicated in errno) */
187 #define EAI_BADHINTS	-12	/* invalid value for hints */
188 #define EAI_PROTOCOL	-13	/* resolved protocol is unknown */
189 #define EAI_OVERFLOW	-14	/* argument buffer overflow */
190 
191 struct addrinfo {
192 	int ai_flags;		/* input flags */
193 	int ai_family;		/* protocol family for socket */
194 	int ai_socktype;	/* socket type */
195 	int ai_protocol;	/* protocol for socket */
196 	socklen_t ai_addrlen;	/* length of socket-address */
197 	struct sockaddr *ai_addr; /* socket-address for socket */
198 	char *ai_canonname;	/* canonical name for service location (iff req) */
199 	struct addrinfo *ai_next; /* pointer to next in list */
200 };
201 
202 /*
203  * Flags for getrrsetbyname()
204  */
205 #define RRSET_VALIDATED		1
206 
207 /*
208  * Return codes for getrrsetbyname()
209  */
210 #define ERRSET_SUCCESS		0
211 #define ERRSET_NOMEMORY		1
212 #define ERRSET_FAIL		2
213 #define ERRSET_INVAL		3
214 #define ERRSET_NONAME		4
215 #define ERRSET_NODATA		5
216 
217 /*
218  * Structures used by getrrsetbyname() and freerrset()
219  */
220 struct rdatainfo {
221 	unsigned int		rdi_length;	/* length of data */
222 	unsigned char		*rdi_data;	/* record data */
223 };
224 
225 struct rrsetinfo {
226 	unsigned int		rri_flags;	/* RRSET_VALIDATED ... */
227 	unsigned int		rri_rdclass;	/* class number */
228 	unsigned int		rri_rdtype;	/* RR type number */
229 	unsigned int		rri_ttl;	/* time to live */
230 	unsigned int		rri_nrdatas;	/* size of rdatas array */
231 	unsigned int		rri_nsigs;	/* size of sigs array */
232 	char			*rri_name;	/* canonical name */
233 	struct rdatainfo	*rri_rdatas;	/* individual records */
234 	struct rdatainfo	*rri_sigs;	/* individual signatures */
235 };
236 
237 #if __BSD_VISIBLE
238 struct servent_data {
239 	void *fp;
240 	char **aliases;
241 	int maxaliases;
242 	int stayopen;
243 	char *line;
244 };
245 
246 struct protoent_data {
247 	void *fp;
248 	char **aliases;
249 	int maxaliases;
250 	int stayopen;
251 	char *line;
252 };
253 #endif
254 
255 __BEGIN_DECLS
256 void		endhostent(void);
257 void		endnetent(void);
258 void		endprotoent(void);
259 #if __BSD_VISIBLE
260 void		endprotoent_r(struct protoent_data *);
261 #endif
262 void		endservent(void);
263 #if __BSD_VISIBLE
264 void		endservent_r(struct servent_data *);
265 #endif
266 struct hostent	*gethostbyaddr(const void *, socklen_t, int);
267 struct hostent	*gethostbyname(const char *);
268 struct hostent	*gethostbyname2(const char *, int);
269 struct hostent	*gethostent(void);
270 struct netent	*getnetbyaddr(in_addr_t, int);
271 struct netent	*getnetbyname(const char *);
272 struct netent	*getnetent(void);
273 struct protoent	*getprotobyname(const char *);
274 struct protoent	*getprotobynumber(int);
275 struct protoent	*getprotoent(void);
276 #if __BSD_VISIBLE
277 int		getprotobyname_r(const char *, struct protoent *,
278 		    struct protoent_data *);
279 int		getprotobynumber_r(int, struct protoent *,
280 		    struct protoent_data *);
281 int		getprotoent_r(struct protoent *, struct protoent_data *);
282 #endif
283 struct servent	*getservbyname(const char *, const char *);
284 struct servent	*getservbyport(int, const char *);
285 struct servent	*getservent(void);
286 #if __BSD_VISIBLE
287 int		getservbyname_r(const char *, const char *, struct servent *,
288 		    struct servent_data *);
289 int		getservbyport_r(int, const char *, struct servent *,
290 		    struct servent_data *);
291 int		getservent_r(struct servent *, struct servent_data *);
292 #endif
293 void		herror(const char *);
294 const char	*hstrerror(int);
295 void		sethostent(int);
296 /* void		sethostfile(const char *); */
297 void		setnetent(int);
298 void		setprotoent(int);
299 #if __BSD_VISIBLE
300 void		setprotoent_r(int, struct protoent_data *);
301 #endif
302 void		setservent(int);
303 #if __BSD_VISIBLE
304 void		setservent_r(int, struct servent_data *);
305 #endif
306 
307 int		getaddrinfo(const char *, const char *,
308 		    const struct addrinfo *, struct addrinfo **);
309 void		freeaddrinfo(struct addrinfo *);
310 int		getnameinfo(const struct sockaddr *, socklen_t,
311 		    char *, size_t, char *, size_t, int);
312 const char	*gai_strerror(int);
313 int		net_addrcmp(struct sockaddr *, struct sockaddr *);
314 int		getrrsetbyname(const char *, unsigned int, unsigned int, unsigned int, struct rrsetinfo **);
315 void		freerrset(struct rrsetinfo *);
316 __END_DECLS
317 
318 /* This is nec'y to make this include file properly replace the sun version. */
319 #ifdef sun
320 #ifdef __GNU_LIBRARY__
321 #include <rpc/netdb.h>
322 #else
323 struct rpcent {
324 	char	*r_name;	/* name of server for this rpc program */
325 	char	**r_aliases;	/* alias list */
326 	int	r_number;	/* rpc program number */
327 };
328 struct rpcent	*getrpcbyname(), *getrpcbynumber(), *getrpcent();
329 #endif /* __GNU_LIBRARY__ */
330 #endif /* sun */
331 
332 #endif /* !_NETDB_H_ */
333