2 * This file is part of DisOrder.
3 * Copyright (C) 2004, 2007, 2008, 2013 Richard Kettlewell
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 * @brief Socket address support */
23 #include <sys/types.h>
25 # include <sys/socket.h>
28 # include <netinet/in.h>
31 # include <arpa/inet.h>
42 #include "configuration.h"
45 /** @brief Convert a pair of strings to an address
46 * @param a Pointer to string list
47 * @param pref Hints structure for getaddrinfo, or NULL
48 * @param namep Where to store address description, or NULL
49 * @return Address info structure or NULL on error
51 * This converts one or two strings into an address specification suitable
52 * for passing to socket(), bind() etc.
54 * If there is only one string then it is assumed to be the service
55 * name (port number). If there are two then the first is the host
56 * name and the second the service name.
58 * @p namep is used to return a description of the address suitable
59 * for use in log messages.
61 * If an error occurs a message is logged and a null pointer returned.
63 struct addrinfo
*get_address(const struct stringlist
*a
,
64 const struct addrinfo
*pref
,
73 byte_xasprintf(&name
, "host * service %s", a
->s
[0]);
74 if((rc
= getaddrinfo(0, a
->s
[0], pref
, &res
))) {
75 disorder_error(0, "getaddrinfo %s: %s", a
->s
[0],
76 format_error(ec_getaddrinfo
, rc
, errbuf
, sizeof errbuf
));
81 byte_xasprintf(&name
, "host %s service %s", a
->s
[0], a
->s
[1]);
82 if((rc
= getaddrinfo(a
->s
[0], a
->s
[1], pref
, &res
))) {
83 disorder_error(0, "getaddrinfo %s %s: %s",
85 format_error(ec_getaddrinfo
, rc
, errbuf
, sizeof errbuf
));
90 disorder_error(0, "invalid network address specification (n=%d)", a
->n
);
93 if(!res
|| (pref
&& res
->ai_socktype
!= pref
->ai_socktype
)) {
94 disorder_error(0, "getaddrinfo didn't give us a suitable socket address");
104 /** @brief Comparison function for address information
106 * Suitable for qsort().
108 int addrinfocmp(const struct addrinfo
*a
,
109 const struct addrinfo
*b
) {
110 if(a
->ai_family
!= b
->ai_family
) return a
->ai_family
- b
->ai_family
;
111 if(a
->ai_socktype
!= b
->ai_socktype
) return a
->ai_socktype
- b
->ai_socktype
;
112 if(a
->ai_protocol
!= b
->ai_protocol
) return a
->ai_protocol
- b
->ai_protocol
;
113 return sockaddrcmp(a
->ai_addr
, b
->ai_addr
);
116 /** @brief Comparison function for socket addresses
118 * Suitable for qsort().
120 int sockaddrcmp(const struct sockaddr
*a
,
121 const struct sockaddr
*b
) {
122 const struct sockaddr_in
*ina
, *inb
;
123 const struct sockaddr_in6
*in6a
, *in6b
;
125 if(a
->sa_family
!= b
->sa_family
) return a
->sa_family
- b
->sa_family
;
126 switch(a
->sa_family
) {
128 ina
= (const struct sockaddr_in
*)a
;
129 inb
= (const struct sockaddr_in
*)b
;
130 if(ina
->sin_port
!= inb
->sin_port
) return ina
->sin_port
- inb
->sin_port
;
131 return ina
->sin_addr
.s_addr
- inb
->sin_addr
.s_addr
;
134 in6a
= (const struct sockaddr_in6
*)a
;
135 in6b
= (const struct sockaddr_in6
*)b
;
136 if(in6a
->sin6_port
!= in6b
->sin6_port
)
137 return in6a
->sin6_port
- in6b
->sin6_port
;
138 return memcmp(&in6a
->sin6_addr
, &in6b
->sin6_addr
,
139 sizeof (struct in6_addr
));
141 disorder_fatal(0, "unsupported protocol family %d", a
->sa_family
);
145 /** @brief Return nonzero if @p sin4 is an IPv4 multicast address */
146 static inline int multicast4(const struct sockaddr_in
*sin4
) {
147 return IN_MULTICAST(ntohl(sin4
->sin_addr
.s_addr
));
150 /** @brief Return nonzero if @p sin6 is an IPv6 multicast address */
151 static inline int multicast6(const struct sockaddr_in6
*sin6
) {
152 return IN6_IS_ADDR_MULTICAST(&sin6
->sin6_addr
);
155 /** @brief Return true if @p sa represents a multicast address */
156 int multicast(const struct sockaddr
*sa
) {
157 switch(sa
->sa_family
) {
159 return multicast4((const struct sockaddr_in
*)sa
);
161 return multicast6((const struct sockaddr_in6
*)sa
);
167 /** @brief Format an IPv4 address */
168 static inline char *format_sockaddr4(const struct sockaddr_in
*sin4
) {
169 char buffer
[1024], *r
;
172 byte_xasprintf(&r
, "%s port %u",
173 inet_ntop(sin4
->sin_family
, &sin4
->sin_addr
,
174 buffer
, sizeof buffer
),
175 ntohs(sin4
->sin_port
));
177 byte_xasprintf(&r
, "%s",
178 inet_ntop(sin4
->sin_family
, &sin4
->sin_addr
,
179 buffer
, sizeof buffer
));
183 /** @brief Format an IPv6 address */
184 static inline char *format_sockaddr6(const struct sockaddr_in6
*sin6
) {
185 char buffer
[1024], *r
;
188 byte_xasprintf(&r
, "%s port %u",
189 inet_ntop(sin6
->sin6_family
, &sin6
->sin6_addr
,
190 buffer
, sizeof buffer
),
191 ntohs(sin6
->sin6_port
));
193 byte_xasprintf(&r
, "%s",
194 inet_ntop(sin6
->sin6_family
, &sin6
->sin6_addr
,
195 buffer
, sizeof buffer
));
200 /** @brief Format a UNIX socket address */
201 static inline char *format_sockaddrun(const struct sockaddr_un
*sun
) {
202 return xstrdup(sun
->sun_path
);
206 /** @brief Construct a text description a sockaddr
207 * @param sa Socket address
208 * @return Human-readable form of address
210 char *format_sockaddr(const struct sockaddr
*sa
) {
211 switch(sa
->sa_family
) {
213 return format_sockaddr4((const struct sockaddr_in
*)sa
);
215 return format_sockaddr6((const struct sockaddr_in6
*)sa
);
218 return format_sockaddrun((const struct sockaddr_un
*)sa
);
225 /** @brief Parse the text form of a network address
226 * @param na Where to store result
227 * @param nvec Number of strings
228 * @param vec List of strings
229 * @return 0 on success, -1 on syntax error
231 int netaddress_parse(struct netaddress
*na
,
239 if(nvec
> 0 && vec
[0][0] == '-') {
240 if(!strcmp(vec
[0], "-4"))
242 else if(!strcmp(vec
[0], "-6"))
244 else if(!strcmp(vec
[0], "-unix"))
246 else if(!strcmp(vec
[0], "-"))
255 /* Possibilities are:
257 * /path/to/unix/socket an AF_UNIX socket
258 * * PORT any address, specific port
259 * PORT any address, specific port
260 * ADDRESS PORT specific address, specific port
262 if(vec
[0][0] == '/' && na
->af
== AF_UNSPEC
)
264 if(na
->af
== AF_UNIX
) {
267 na
->address
= xstrdup(vec
[0]);
268 na
->port
= -1; /* makes no sense */
276 if(!strcmp(vec
[0], "*"))
279 na
->address
= xstrdup(vec
[0]);
285 if(port
[strspn(port
, "0123456789")])
287 e
= xstrtol(&p
, port
, NULL
, 10);
298 /** @brief Format a @ref netaddress structure
299 * @param na Network address to format
300 * @param nvecp Where to put string count, or NULL
301 * @param vecp Where to put strings
303 * The formatted form is suitable for passing to netaddress_parse().
305 void netaddress_format(const struct netaddress
*na
,
312 case AF_UNSPEC
: vector_append(v
, xstrdup("-")); break;
313 case AF_INET
: vector_append(v
, xstrdup("-4")); break;
314 case AF_INET6
: vector_append(v
, xstrdup("-6")); break;
315 case AF_UNIX
: vector_append(v
, xstrdup("-unix")); break;
318 vector_append(v
, xstrdup(na
->address
));
320 vector_append(v
, xstrdup("*"));
324 byte_snprintf(buffer
, sizeof buffer
, "%d", na
->port
);
325 vector_append(v
, xstrdup(buffer
));
334 /** @brief Resolve a network address
335 * @param na Address structure
336 * @param passive True if passive (bindable) address is desired
337 * @param protocol Protocol number desired (e.g. @c IPPROTO_TCP)
338 * @return List of suitable addresses or NULL
340 struct addrinfo
*netaddress_resolve(const struct netaddress
*na
,
343 struct addrinfo
*res
, hints
[1];
348 memset(hints
, 0, sizeof hints
);
349 hints
->ai_family
= na
->af
;
350 hints
->ai_protocol
= protocol
;
351 hints
->ai_flags
= passive ? AI_PASSIVE
: 0;
352 byte_snprintf(service
, sizeof service
, "%d", na
->port
);
353 rc
= getaddrinfo(na
->address
, service
, hints
, &res
);
355 disorder_error(0, "getaddrinfo %s %d: %s",
356 na
->address ? na
->address
: "*",
358 format_error(ec_getaddrinfo
, rc
, errbuf
, sizeof errbuf
));