Merge branch 't/test_man'
[paraslash.git] / net.c
1 /*
2 * Copyright (C) 2005-2014 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file net.c Networking-related helper functions. */
8
9 /*
10 * Since glibc 2.8, the _GNU_SOURCE feature test macro must be defined in order
11 * to obtain the definition of the ucred structure.
12 */
13 #define _GNU_SOURCE
14
15 #include <netinet/in.h>
16 #include <arpa/inet.h>
17 #include <sys/un.h>
18 #include <sys/types.h>
19 #include <sys/socket.h>
20 #include <netdb.h>
21
22 /* At least NetBSD needs these. */
23 #ifndef AI_V4MAPPED
24 #define AI_V4MAPPED 0
25 #endif
26 #ifndef AI_ALL
27 #define AI_ALL 0
28 #endif
29 #ifndef AI_ADDRCONFIG
30 #define AI_ADDRCONFIG 0
31 #endif
32
33 #include <regex.h>
34
35 #include "para.h"
36 #include "error.h"
37 #include "net.h"
38 #include "string.h"
39 #include "list.h"
40 #include "fd.h"
41
42 /**
43 * Parse and validate IPv4 address/netmask string.
44 *
45 * \param cidr Address in CIDR notation
46 * \param addr Copy of the IPv4 address part of \a cidr
47 * \param addrlen Size of \a addr in bytes
48 * \param netmask Value of the netmask part in \a cidr or the
49 * default of 32 if not specified.
50 *
51 * \return Pointer to \a addr if succesful, NULL on error.
52 * \sa RFC 4632
53 */
54 char *parse_cidr(const char *cidr,
55 char *addr, ssize_t addrlen,
56 int32_t *netmask)
57 {
58 const char *o = cidr;
59 char *c = addr, *end = c + (addrlen - 1);
60
61 *netmask = 0x20;
62
63 if (cidr == NULL || addrlen < 1)
64 goto failed;
65
66 for (o = cidr; (*c = *o == '/'? '\0' : *o); c++, o++)
67 if (c == end)
68 goto failed;
69
70 if (*o == '/')
71 if (para_atoi32(++o, netmask) < 0 ||
72 *netmask < 0 || *netmask > 0x20)
73 goto failed;
74
75 if (is_valid_ipv4_address(addr))
76 return addr;
77 failed:
78 *addr = '\0';
79 return NULL;
80 }
81
82
83 /**
84 * Match string as a candidate IPv4 address.
85 *
86 * \param address The string to match.
87 * \return True if \a address has "dot-quad" format.
88 */
89 static bool is_v4_dot_quad(const char *address)
90 {
91 bool result;
92 regex_t r;
93
94 assert(para_regcomp(&r, "^([0-9]+\\.){3}[0-9]+$",
95 REG_EXTENDED | REG_NOSUB) >= 0);
96 result = regexec(&r, address, 0, NULL, 0) == 0;
97 regfree(&r);
98 return result;
99 }
100
101 /**
102 * Perform basic syntax checking on the host-part of an URL:
103 *
104 * - Since ':' is invalid in IPv4 addresses and DNS names, the
105 * presence of ':' causes interpretation as IPv6 address;
106 * - next the first-match-wins algorithm from RFC 3986 is applied;
107 * - else the string is considered as DNS name, to be resolved later.
108 *
109 * \param host The host string to check.
110 * \return True if \a host passes the syntax checks.
111 *
112 * \sa RFC 3986, 3.2.2; RFC 1123, 2.1; RFC 1034, 3.5
113 */
114 static bool host_string_ok(const char *host)
115 {
116 if (host == NULL || *host == '\0')
117 return false;
118 if (strchr(host, ':') != NULL)
119 return is_valid_ipv6_address(host);
120 if (is_v4_dot_quad(host))
121 return is_valid_ipv4_address(host);
122 return true;
123 }
124
125 /**
126 * Parse and validate URL string.
127 *
128 * The URL syntax is loosely based on RFC 3986, supporting one of
129 * - "["host"]"[:port] for native IPv6 addresses and
130 * - host[:port] for IPv4 hostnames and DNS names.
131 *
132 * Native IPv6 addresses must be enclosed in square brackets, since
133 * otherwise there is an ambiguity with the port separator `:'.
134 * The 'port' part is always considered to be a number; if absent,
135 * it is set to -1, to indicate that a default port is to be used.
136 *
137 * The following are valid examples:
138 * - 10.10.1.1
139 * - 10.10.1.2:8000
140 * - localhost
141 * - localhost:8001
142 * - [::1]:8000
143 * - [badc0de::1]
144 *
145 * \param url The URL string to take apart.
146 * \param host To return the copied host part of \a url.
147 * \param hostlen The maximum length of \a host.
148 * \param port To return the port number (if any) of \a url.
149 *
150 * \return Pointer to \a host, or \p NULL if failed. If \p NULL is returned,
151 * \a host and \a port are undefined. If no port number was present in \a url,
152 * \a port is set to -1.
153 *
154 * \sa RFC 3986, 3.2.2/3.2.3
155 */
156 char *parse_url(const char *url,
157 char *host, ssize_t hostlen,
158 int32_t *port)
159 {
160 const char *o = url;
161 char *c = host, *end = c + (hostlen - 1);
162
163 *port = -1;
164
165 if (o == NULL || hostlen < 1)
166 goto failed;
167
168 if (*o == '[') {
169 for (++o; (*c = *o == ']' ? '\0' : *o); c++, o++)
170 if (c == end)
171 goto failed;
172
173 if (*o++ != ']' || (*o != '\0' && *o != ':'))
174 goto failed;
175 } else {
176 for (; (*c = *o == ':'? '\0' : *o); c++, o++) {
177 if (c == end && o[1])
178 goto failed;
179 }
180 }
181
182 if (*o == ':')
183 if (para_atoi32(++o, port) < 0 ||
184 *port < 0 || *port > 0xffff)
185 goto failed;
186 if (host_string_ok(host))
187 return host;
188 failed:
189 *host = '\0';
190 return NULL;
191 }
192
193 /**
194 * Stringify port number, resolve into service name where defined.
195 * \param port 2-byte port number, in host-byte-order.
196 * \param transport Transport protocol name (e.g. "udp", "tcp"), or NULL.
197 * \return Pointer to static result buffer.
198 *
199 * \sa getservent(3), services(5), nsswitch.conf(5)
200 */
201 const char *stringify_port(int port, const char *transport)
202 {
203 static char service[NI_MAXSERV];
204
205 if (port < 0 || port > 0xFFFF) {
206 snprintf(service, sizeof(service), "undefined (%d)", port);
207 } else {
208 struct servent *se = getservbyport(htons(port), transport);
209
210 if (se == NULL)
211 snprintf(service, sizeof(service), "%u", port);
212 else
213 snprintf(service, sizeof(service), "%s", se->s_name);
214 }
215 return service;
216 }
217
218 /**
219 * Determine the socket type for a given layer-4 protocol.
220 *
221 * \param l4type The symbolic name of the transport-layer protocol.
222 *
223 * \sa ip(7), socket(2)
224 */
225 static inline int sock_type(const unsigned l4type)
226 {
227 switch (l4type) {
228 case IPPROTO_UDP: return SOCK_DGRAM;
229 case IPPROTO_TCP: return SOCK_STREAM;
230 case IPPROTO_DCCP: return SOCK_DCCP;
231 }
232 return -1; /* not supported here */
233 }
234
235 /**
236 * Pretty-print transport-layer name.
237 */
238 static const char *layer4_name(const unsigned l4type)
239 {
240 switch (l4type) {
241 case IPPROTO_UDP: return "UDP";
242 case IPPROTO_TCP: return "TCP";
243 case IPPROTO_DCCP: return "DCCP";
244 }
245 return "UNKNOWN PROTOCOL";
246 }
247
248 /**
249 * Flowopts: Transport-layer independent encapsulation of socket options.
250 *
251 * These collect individual socket options into a queue, which is disposed of
252 * directly after makesock(). The 'pre_conn_opt' structure is for internal use
253 * only and should not be visible elsewhere.
254 *
255 * \sa setsockopt(2), makesock()
256 */
257 struct pre_conn_opt {
258 int sock_level; /**< Second argument to setsockopt() */
259 int sock_option; /**< Third argument to setsockopt() */
260 char *opt_name; /**< Stringified \a sock_option */
261 void *opt_val; /**< Fourth argument to setsockopt() */
262 socklen_t opt_len; /**< Fifth argument to setsockopt() */
263
264 struct list_head node; /**< FIFO, as sockopt order matters. */
265 };
266
267 /** FIFO list of pre-connection socket options to be set */
268 struct flowopts {
269 struct list_head sockopts;
270 };
271
272 /**
273 * Allocate and initialize a flowopt queue.
274 *
275 * \return A new structure to be passed to \ref flowopt_add(). It is
276 * automatically deallocated in \ref makesock().
277 */
278 struct flowopts *flowopt_new(void)
279 {
280 struct flowopts *new = para_malloc(sizeof(*new));
281
282 INIT_LIST_HEAD(&new->sockopts);
283 return new;
284 }
285
286 /**
287 * Append new socket option to flowopt queue.
288 *
289 * \param fo The flowopt queue to append to.
290 * \param lev Level at which \a opt resides.
291 * \param opt New option to add.
292 * \param name Stringified name of \a opt.
293 * \param val The value to set \a opt to.
294 * \param len Length of \a val.
295 *
296 * \sa setsockopt(2)
297 */
298 void flowopt_add(struct flowopts *fo, int lev, int opt,
299 const char *name, const void *val, int len)
300 {
301 struct pre_conn_opt *new = para_malloc(sizeof(*new));
302
303 new->sock_option = opt;
304 new->sock_level = lev;
305 new->opt_name = para_strdup(name);
306
307 if (val == NULL) {
308 new->opt_val = NULL;
309 new->opt_len = 0;
310 } else {
311 new->opt_val = para_malloc(len);
312 new->opt_len = len;
313 memcpy(new->opt_val, val, len);
314 }
315
316 list_add_tail(&new->node, &fo->sockopts);
317 }
318
319 /** Set the entire bunch of pre-connection options at once. */
320 static void flowopt_setopts(int sockfd, struct flowopts *fo)
321 {
322 struct pre_conn_opt *pc;
323
324 if (fo == NULL)
325 return;
326
327 list_for_each_entry(pc, &fo->sockopts, node)
328 if (setsockopt(sockfd, pc->sock_level, pc->sock_option,
329 pc->opt_val, pc->opt_len) < 0) {
330 PARA_EMERG_LOG("Can not set %s socket option: %s",
331 pc->opt_name, strerror(errno));
332 exit(EXIT_FAILURE);
333 }
334 }
335
336 /**
337 * Deallocate all resources of a flowopts structure.
338 *
339 * \param fo A pointer as returned from flowopt_new().
340 *
341 * It's OK to pass \p NULL here in which case the function does nothing.
342 */
343 void flowopt_cleanup(struct flowopts *fo)
344 {
345 struct pre_conn_opt *cur, *next;
346
347 if (fo == NULL)
348 return;
349
350 list_for_each_entry_safe(cur, next, &fo->sockopts, node) {
351 free(cur->opt_name);
352 free(cur->opt_val);
353 free(cur);
354 }
355 free(fo);
356 }
357
358 /**
359 * Resolve an IPv4/IPv6 address.
360 *
361 * \param l4type The layer-4 type (\p IPPROTO_xxx).
362 * \param passive Whether \p AI_PASSIVE should be included as hint.
363 * \param host Remote or local hostname or IPv/6 address string.
364 * \param port_number Used to set the port in each returned address structure.
365 * \param result addrinfo structures are returned here.
366 *
367 * The interpretation of \a host depends on the value of \a passive. On a
368 * passive socket host is interpreted as an interface IPv4/6 address (can be
369 * left NULL). On an active socket, \a host is the peer DNS name or IPv4/6
370 * address to connect to.
371 *
372 * \return Standard.
373 *
374 * \sa getaddrinfo(3).
375 */
376 int lookup_address(unsigned l4type, bool passive, const char *host,
377 int port_number, struct addrinfo **result)
378 {
379 int ret;
380 char port[6]; /* port number has at most 5 digits */
381 struct addrinfo *addr = NULL, hints;
382
383 *result = NULL;
384 sprintf(port, "%u", port_number & 0xffff);
385 /* Set up address hint structure */
386 memset(&hints, 0, sizeof(hints));
387 hints.ai_family = AF_UNSPEC;
388 hints.ai_socktype = sock_type(l4type);
389 /*
390 * getaddrinfo does not support SOCK_DCCP, so for the sake of lookup
391 * (and only then) pretend to be UDP.
392 */
393 if (l4type == IPPROTO_DCCP)
394 hints.ai_socktype = SOCK_DGRAM;
395 /* only use addresses available on the host */
396 hints.ai_flags = AI_ADDRCONFIG;
397 if (passive && host == NULL)
398 hints.ai_flags |= AI_PASSIVE;
399 /* Obtain local/remote address information */
400 ret = getaddrinfo(host, port, &hints, &addr);
401 if (ret != 0) {
402 PARA_ERROR_LOG("can not resolve %s address %s#%s: %s\n",
403 layer4_name(l4type),
404 host? host : (passive? "[loopback]" : "[localhost]"),
405 port, gai_strerror(ret));
406 return -E_ADDRESS_LOOKUP;
407 }
408 *result = addr;
409 return 1;
410 }
411
412 /**
413 * Create an active or passive socket.
414 *
415 * \param l4type \p IPPROTO_TCP, \p IPPROTO_UDP, or \p IPPROTO_DCCP.
416 * \param passive Whether to call bind(2) or connect(2).
417 * \param ai Address information as obtained from \ref lookup_address().
418 * \param fo Socket options to be set before making the connection.
419 *
420 * bind(2) is called on passive sockets, and connect(2) on active sockets. The
421 * algorithm tries all possible address combinations until it succeeds. If \a
422 * fo is supplied, options are set but cleanup must be performed in the caller.
423 *
424 * \return File descriptor on success, \p E_MAKESOCK on errors.
425 *
426 * \sa \ref lookup_address(), \ref makesock(), ip(7), ipv6(7), bind(2),
427 * connect(2).
428 */
429 int makesock_addrinfo(unsigned l4type, bool passive, struct addrinfo *ai,
430 struct flowopts *fo)
431 {
432 int ret = -E_MAKESOCK, on = 1;
433
434 for (; ai; ai = ai->ai_next) {
435 int fd;
436 ret = socket(ai->ai_family, sock_type(l4type), l4type);
437 if (ret < 0)
438 continue;
439 fd = ret;
440 flowopt_setopts(fd, fo);
441 if (!passive) {
442 if (connect(fd, ai->ai_addr, ai->ai_addrlen) == 0)
443 return fd;
444 close(fd);
445 continue;
446 }
447 /*
448 * Reuse the address on passive sockets to avoid failure on
449 * restart (protocols using listen()) and when creating
450 * multiple listener instances (UDP multicast).
451 */
452 if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &on,
453 sizeof(on)) == -1) {
454 close(fd);
455 continue;
456 }
457 if (bind(fd, ai->ai_addr, ai->ai_addrlen) < 0) {
458 close(fd);
459 continue;
460 }
461 return fd;
462 }
463 return -E_MAKESOCK;
464 }
465
466 /**
467 * Resolve IPv4/IPv6 address and create a ready-to-use active or passive socket.
468 *
469 * \param l4type The layer-4 type (\p IPPROTO_xxx).
470 * \param passive Whether this is a passive or active socket.
471 * \param host Passed to \ref lookup_address().
472 * \param port_number Passed to \ref lookup_address().
473 * \param fo Passed to \ref makesock_addrinfo().
474 *
475 * This creates a ready-made IPv4/v6 socket structure after looking up the
476 * necessary parameters. The function first calls \ref lookup_address() and
477 * passes the address information to makesock_addrinfo() to create and
478 * initialize the socket.
479 *
480 * \return The newly created file descriptor on success, a negative error code
481 * on failure.
482 *
483 * \sa \ref lookup_address(), \ref makesock_addrinfo().
484 */
485 int makesock(unsigned l4type, bool passive, const char *host, uint16_t port_number,
486 struct flowopts *fo)
487 {
488 struct addrinfo *ai;
489 int ret = lookup_address(l4type, passive, host, port_number, &ai);
490
491 if (ret >= 0)
492 ret = makesock_addrinfo(l4type, passive, ai, fo);
493 if (ai)
494 freeaddrinfo(ai);
495 if (ret < 0) {
496 PARA_ERROR_LOG("can not create %s socket %s#%d.\n",
497 layer4_name(l4type), host? host : (passive?
498 "[loopback]" : "[localhost]"), port_number);
499 }
500 return ret;
501 }
502
503 /**
504 * Create a passive / listening socket.
505 *
506 * \param l4type The transport-layer type (\p IPPROTO_xxx).
507 * \param port The decimal port number to listen on.
508 * \param fo Flowopts (if any) to set before starting to listen.
509 *
510 * \return Positive integer (socket descriptor) on success, negative value
511 * otherwise.
512 *
513 * \sa makesock(), ip(7), ipv6(7), bind(2), listen(2).
514 */
515 int para_listen(unsigned l4type, uint16_t port, struct flowopts *fo)
516 {
517 int ret, fd = makesock(l4type, 1, NULL, port, fo);
518
519 if (fd > 0) {
520 ret = listen(fd, BACKLOG);
521 if (ret < 0) {
522 ret = errno;
523 close(fd);
524 return -ERRNO_TO_PARA_ERROR(ret);
525 }
526 PARA_INFO_LOG("listening on %s port %u, fd %d\n",
527 layer4_name(l4type), port, fd);
528 }
529 return fd;
530 }
531
532 /**
533 * Determine IPv4/v6 socket address length.
534 * \param sa Container of IPv4 or IPv6 address.
535 * \return Address-family dependent address length.
536 */
537 static socklen_t salen(const struct sockaddr *sa)
538 {
539 assert(sa->sa_family == AF_INET || sa->sa_family == AF_INET6);
540
541 return sa->sa_family == AF_INET6
542 ? sizeof(struct sockaddr_in6)
543 : sizeof(struct sockaddr_in);
544 }
545
546 /** True if @ss holds a v6-mapped-v4 address (RFC 4291, 2.5.5.2) */
547 static bool SS_IS_ADDR_V4MAPPED(const struct sockaddr_storage *ss)
548 {
549 const struct sockaddr_in6 *ia6 = (const struct sockaddr_in6 *)ss;
550
551 return ss->ss_family == AF_INET6 && IN6_IS_ADDR_V4MAPPED(&ia6->sin6_addr);
552 }
553
554 /**
555 * Process IPv4/v6 address, turn v6-mapped-v4 address into normal IPv4 address.
556 * \param ss Container of IPv4/6 address.
557 * \return Pointer to normalized address (may be static storage).
558 *
559 * \sa RFC 3493
560 */
561 static const struct sockaddr *
562 normalize_ip_address(const struct sockaddr_storage *ss)
563 {
564 assert(ss->ss_family == AF_INET || ss->ss_family == AF_INET6);
565
566 if (SS_IS_ADDR_V4MAPPED(ss)) {
567 const struct sockaddr_in6 *ia6 = (const struct sockaddr_in6 *)ss;
568 static struct sockaddr_in ia;
569
570 ia.sin_family = AF_INET;
571 ia.sin_port = ia6->sin6_port;
572 memcpy(&ia.sin_addr.s_addr, &(ia6->sin6_addr.s6_addr[12]), 4);
573 return (const struct sockaddr *)&ia;
574 }
575 return (const struct sockaddr *)ss;
576 }
577
578 /**
579 * Generic/fallback MTU values
580 *
581 * These are taken from RFC 1122, RFC 2460, and RFC 5405.
582 * - RFC 1122, 3.3.3 defines EMTU_S ("Effective MTU for sending") and recommends
583 * to use an EMTU_S size of of 576 bytes if the IPv4 path MTU is unknown;
584 * - RFC 2460, 5. requires a minimum IPv6 MTU of 1280 bytes;
585 * - RFC 5405, 3.2 recommends that if path MTU discovery is not done,
586 * UDP senders should use the respective minimum values of EMTU_S.
587 */
588 static inline int generic_mtu(const int af_type)
589 {
590 return af_type == AF_INET6 ? 1280 : 576;
591 }
592
593 /** Crude approximation of IP header overhead - neglecting options. */
594 static inline int estimated_header_overhead(const int af_type)
595 {
596 return af_type == AF_INET6 ? 40 : 20;
597 }
598
599 /**
600 * Get the maximum transport-layer message size (MMS_S).
601 *
602 * \param sockfd The socket file descriptor.
603 *
604 * The socket must be connected. See RFC 1122, 3.3.3. If the protocol familiy
605 * could not be determined, \p AF_INET is assumed.
606 *
607 * \return The maximum message size of the address family type.
608 */
609 int generic_max_transport_msg_size(int sockfd)
610 {
611 struct sockaddr_storage ss;
612 socklen_t sslen = sizeof(ss);
613 int af_type = AF_INET;
614
615 if (getpeername(sockfd, (struct sockaddr *)&ss, &sslen) < 0) {
616 PARA_ERROR_LOG("can not determine remote address type: %s\n",
617 strerror(errno));
618 } else if (!SS_IS_ADDR_V4MAPPED(&ss)) {
619 af_type = ss.ss_family;
620 }
621 return generic_mtu(af_type) - estimated_header_overhead(af_type);
622 }
623
624 /**
625 * Look up the local or remote side of a connected socket structure.
626 *
627 * \param fd The socket descriptor of the connected socket.
628 * \param getname Either \p getsockname() for local, or \p getpeername() for
629 * remote side.
630 *
631 * \return A static character string identifying hostname and port of the
632 * chosen side in numeric host:port format.
633 *
634 * \sa getsockname(2), getpeername(2), parse_url(), getnameinfo(3),
635 * services(5), nsswitch.conf(5).
636 */
637 static char *__get_sock_name(int fd, typeof(getsockname) getname)
638 {
639 struct sockaddr_storage ss;
640 const struct sockaddr *sa;
641 socklen_t sslen = sizeof(ss);
642 char hbuf[NI_MAXHOST], sbuf[NI_MAXSERV];
643 static char output[sizeof(hbuf) + sizeof(sbuf) + 4];
644 int ret;
645
646 if (getname(fd, (struct sockaddr *)&ss, &sslen) < 0) {
647 PARA_ERROR_LOG("can not determine address from fd %d: %s\n",
648 fd, strerror(errno));
649 snprintf(output, sizeof(output), "(unknown)");
650 return output;
651 }
652 sa = normalize_ip_address(&ss);
653 ret = getnameinfo(sa, salen(sa), hbuf, sizeof(hbuf), sbuf,
654 sizeof(sbuf), NI_NUMERICHOST | NI_NUMERICSERV);
655 if (ret) {
656 PARA_WARNING_LOG("hostname lookup error (%s).\n",
657 gai_strerror(ret));
658 snprintf(output, sizeof(output), "(lookup error)");
659 } else if (sa->sa_family == AF_INET6)
660 snprintf(output, sizeof(output), "[%s]:%s", hbuf, sbuf);
661 else
662 snprintf(output, sizeof(output), "%s:%s", hbuf, sbuf);
663 return output;
664 }
665
666 /**
667 * Look up the local side of a connected socket structure.
668 *
669 * \param sockfd The file descriptor of the socket.
670 *
671 * \return A pointer to a static buffer containing hostname an port. This
672 * buffer must not be freed by the caller.
673 *
674 * \sa remote_name().
675 */
676 char *local_name(int sockfd)
677 {
678 return __get_sock_name(sockfd, getsockname);
679 }
680
681 /**
682 * Look up the remote side of a connected socket structure.
683 *
684 * \param sockfd The file descriptor of the socket.
685 *
686 * \return Analogous to the return value of \ref local_name() but for the
687 * remote side.
688 *
689 * \sa local_name().
690 */
691 char *remote_name(int sockfd)
692 {
693 return __get_sock_name(sockfd, getpeername);
694 }
695
696 /**
697 * Extract IPv4 or IPv6-mapped-IPv4 address from sockaddr_storage.
698 *
699 * \param ss Container of IPv4/6 address.
700 * \param ia Extracted IPv4 address (different from 0) or 0 if unsuccessful.
701 *
702 * \sa RFC 3493.
703 */
704 void extract_v4_addr(const struct sockaddr_storage *ss, struct in_addr *ia)
705 {
706 const struct sockaddr *sa = normalize_ip_address(ss);
707
708 memset(ia, 0, sizeof(*ia));
709 if (sa->sa_family == AF_INET)
710 *ia = ((struct sockaddr_in *)sa)->sin_addr;
711 }
712
713 /**
714 * Compare the address part of IPv4/6 addresses.
715 *
716 * \param sa1 First address.
717 * \param sa2 Second address.
718 *
719 * \return True iff the IP address of \a sa1 and \a sa2 match.
720 */
721 bool sockaddr_equal(const struct sockaddr *sa1, const struct sockaddr *sa2)
722 {
723 if (!sa1 || !sa2)
724 return false;
725 if (sa1->sa_family != sa2->sa_family)
726 return false;
727 if (sa1->sa_family == AF_INET) {
728 struct sockaddr_in *a1 = (typeof(a1))sa1,
729 *a2 = (typeof (a2))sa2;
730 return a1->sin_addr.s_addr == a2->sin_addr.s_addr;
731 } else if (sa1->sa_family == AF_INET6) {
732 struct sockaddr_in6 *a1 = (typeof(a1))sa1,
733 *a2 = (typeof (a2))sa2;
734 return !memcmp(a1, a2, sizeof(*a1));
735 } else
736 return false;
737 }
738
739 /**
740 * Receive data from a file descriptor.
741 *
742 * \param fd The file descriptor.
743 * \param buf The buffer to write the data to.
744 * \param size The size of \a buf.
745 *
746 * Receive at most \a size bytes from file descriptor \a fd.
747 *
748 * \return The number of bytes received on success, negative on errors, zero if
749 * the peer has performed an orderly shutdown.
750 *
751 * \sa recv(2).
752 */
753 __must_check int recv_bin_buffer(int fd, char *buf, size_t size)
754 {
755 ssize_t n;
756
757 n = recv(fd, buf, size, 0);
758 if (n == -1)
759 return -ERRNO_TO_PARA_ERROR(errno);
760 return n;
761 }
762
763 /**
764 * Receive and write terminating NULL byte.
765 *
766 * \param fd The file descriptor.
767 * \param buf The buffer to write the data to.
768 * \param size The size of \a buf.
769 *
770 * Read at most \a size - 1 bytes from file descriptor \a fd and
771 * write a NULL byte at the end of the received data.
772 *
773 * \return The return value of the underlying call to \a recv_bin_buffer().
774 *
775 * \sa recv_bin_buffer()
776 */
777 int recv_buffer(int fd, char *buf, size_t size)
778 {
779 int n;
780
781 assert(size);
782 n = recv_bin_buffer(fd, buf, size - 1);
783 if (n >= 0)
784 buf[n] = '\0';
785 else
786 *buf = '\0';
787 return n;
788 }
789
790 /**
791 * Wrapper around the accept system call.
792 *
793 * \param fd The listening socket.
794 * \param rfds An optional fd_set pointer.
795 * \param addr Structure which is filled in with the address of the peer socket.
796 * \param size Should contain the size of the structure pointed to by \a addr.
797 * \param new_fd Result pointer.
798 *
799 * Accept incoming connections on \a addr, retry if interrupted. If \a rfds is
800 * not \p NULL, return 0 if \a fd is not set in \a rfds without calling accept().
801 *
802 * \return Negative on errors, zero if no connections are present to be accepted,
803 * one otherwise.
804 *
805 * \sa accept(2).
806 */
807 int para_accept(int fd, fd_set *rfds, void *addr, socklen_t size, int *new_fd)
808 {
809 int ret;
810
811 if (rfds && !FD_ISSET(fd, rfds))
812 return 0;
813 do
814 ret = accept(fd, (struct sockaddr *) addr, &size);
815 while (ret < 0 && errno == EINTR);
816
817 if (ret >= 0) {
818 *new_fd = ret;
819 return 1;
820 }
821 if (errno == EAGAIN || errno == EWOULDBLOCK)
822 return 0;
823 return -ERRNO_TO_PARA_ERROR(errno);
824 }
825
826 /**
827 * Probe the list of DCCP CCIDs configured on this host.
828 * \param ccid_array Pointer to return statically allocated array in.
829 * \return Number of elements returned in \a ccid_array or error.
830 *
831 * NB: This feature is only available on Linux > 2.6.30; on older kernels
832 * ENOPROTOOPT ("Protocol not available") will be returned.
833 */
834 int dccp_available_ccids(uint8_t **ccid_array)
835 {
836 static uint8_t ccids[DCCP_MAX_HOST_CCIDS];
837 socklen_t nccids = sizeof(ccids);
838 int ret, fd;
839
840 ret = fd = makesock(IPPROTO_DCCP, 1, NULL, 0, NULL);
841 if (ret < 0)
842 return ret;
843
844 if (getsockopt(fd, SOL_DCCP, DCCP_SOCKOPT_AVAILABLE_CCIDS,
845 ccids, &nccids) < 0) {
846 ret = errno;
847 close(fd);
848 PARA_ERROR_LOG("No DCCP_SOCKOPT_AVAILABLE_CCIDS: %s\n",
849 strerror(ret));
850 return -ERRNO_TO_PARA_ERROR(ret);
851 }
852
853 close(fd);
854 *ccid_array = ccids;
855 return nccids;
856 }
857
858 /**
859 * Prepare a structure for \p AF_UNIX socket addresses.
860 *
861 * \param u Pointer to the struct to be prepared.
862 * \param name The socket pathname.
863 *
864 * This just copies \a name to the sun_path component of \a u.
865 *
866 * \return Positive on success, \p -E_NAME_TOO_LONG if \a name is longer
867 * than \p UNIX_PATH_MAX.
868 */
869 static int init_unix_addr(struct sockaddr_un *u, const char *name)
870 {
871 if (strlen(name) >= UNIX_PATH_MAX)
872 return -E_NAME_TOO_LONG;
873 memset(u->sun_path, 0, UNIX_PATH_MAX);
874 u->sun_family = PF_UNIX;
875 strcpy(u->sun_path, name);
876 return 1;
877 }
878
879 /**
880 * Prepare, create, and bind a socket for local communication.
881 *
882 * \param name The socket pathname.
883 * \param unix_addr Pointer to the \p AF_UNIX socket structure.
884 * \param mode The desired mode of the socket.
885 *
886 * This function creates a local socket for sequenced, reliable,
887 * two-way, connection-based byte streams.
888 *
889 * \return The file descriptor, on success, negative on errors.
890 *
891 * \sa socket(2)
892 * \sa bind(2)
893 * \sa chmod(2)
894 */
895 int create_local_socket(const char *name, struct sockaddr_un *unix_addr,
896 mode_t mode)
897 {
898 int fd, ret;
899
900 ret = init_unix_addr(unix_addr, name);
901 if (ret < 0)
902 return ret;
903 ret = socket(PF_UNIX, SOCK_STREAM, 0);
904 if (ret < 0)
905 return -ERRNO_TO_PARA_ERROR(errno);
906 fd = ret;
907 ret = bind(fd, (struct sockaddr *) unix_addr, UNIX_PATH_MAX);
908 if (ret < 0) {
909 ret = -ERRNO_TO_PARA_ERROR(errno);
910 goto err;
911 }
912 ret = -E_CHMOD;
913 if (chmod(name, mode) < 0)
914 goto err;
915 return fd;
916 err:
917 close(fd);
918 return ret;
919 }
920
921 /**
922 * Prepare, create, and connect to a Unix domain socket for local communication.
923 *
924 * \param name The socket pathname.
925 *
926 * This function creates a local socket for sequenced, reliable, two-way,
927 * connection-based byte streams.
928 *
929 * \return The file descriptor of the connected socket on success, negative on
930 * errors.
931 *
932 * \sa create_local_socket(), unix(7), connect(2).
933 */
934 int connect_local_socket(const char *name)
935 {
936 struct sockaddr_un unix_addr;
937 int fd, ret;
938
939 PARA_DEBUG_LOG("connecting to %s\n", name);
940 ret = init_unix_addr(&unix_addr, name);
941 if (ret < 0)
942 return ret;
943 fd = socket(PF_UNIX, SOCK_STREAM, 0);
944 if (fd < 0)
945 return -ERRNO_TO_PARA_ERROR(errno);
946 if (connect(fd, (struct sockaddr *)&unix_addr, sizeof(unix_addr)) == -1) {
947 ret = -ERRNO_TO_PARA_ERROR(errno);
948 goto err;
949 }
950 return fd;
951 err:
952 close(fd);
953 return ret;
954 }
955
956 #ifndef HAVE_UCRED
957 ssize_t send_cred_buffer(int sock, char *buf)
958 {
959 return write_buffer(sock, buf);
960 }
961 int recv_cred_buffer(int fd, char *buf, size_t size)
962 {
963 return recv_buffer(fd, buf, size) > 0? 1 : -E_RECVMSG;
964 }
965 #else /* HAVE_UCRED */
966 /**
967 * Send \p NULL-terminated buffer and Unix credentials of the current process.
968 *
969 * \param sock The socket file descriptor.
970 * \param buf The buffer to be sent.
971 *
972 * \return On success, this call returns the number of characters sent. On
973 * error, \p -E_SENDMSG is returned.
974 *
975 * \sa sendmsg(2), okir's Black Hats Manual.
976 */
977 ssize_t send_cred_buffer(int sock, char *buf)
978 {
979 char control[sizeof(struct cmsghdr) + sizeof(struct ucred)];
980 struct msghdr msg;
981 struct cmsghdr *cmsg;
982 static struct iovec iov;
983 struct ucred c;
984 int ret;
985
986 /* Response data */
987 iov.iov_base = buf;
988 iov.iov_len = strlen(buf);
989 c.pid = getpid();
990 c.uid = getuid();
991 c.gid = getgid();
992 /* compose the message */
993 memset(&msg, 0, sizeof(msg));
994 msg.msg_iov = &iov;
995 msg.msg_iovlen = 1;
996 msg.msg_control = control;
997 msg.msg_controllen = sizeof(control);
998 /* attach the ucred struct */
999 cmsg = CMSG_FIRSTHDR(&msg);
1000 cmsg->cmsg_level = SOL_SOCKET;
1001 cmsg->cmsg_type = SCM_CREDENTIALS;
1002 cmsg->cmsg_len = CMSG_LEN(sizeof(struct ucred));
1003 *(struct ucred *)CMSG_DATA(cmsg) = c;
1004 msg.msg_controllen = cmsg->cmsg_len;
1005 ret = sendmsg(sock, &msg, 0);
1006 if (ret < 0)
1007 ret = -E_SENDMSG;
1008 return ret;
1009 }
1010
1011 static void dispose_fds(int *fds, unsigned num)
1012 {
1013 int i;
1014
1015 for (i = 0; i < num; i++)
1016 close(fds[i]);
1017 }
1018
1019 /**
1020 * Receive a buffer and the Unix credentials of the sending process.
1021 *
1022 * \param fd the socket file descriptor.
1023 * \param buf the buffer to store the message.
1024 * \param size the size of \a buffer.
1025 *
1026 * \return negative on errors, the user id on success.
1027 *
1028 * \sa recvmsg(2), okir's Black Hats Manual.
1029 */
1030 int recv_cred_buffer(int fd, char *buf, size_t size)
1031 {
1032 char control[255];
1033 struct msghdr msg;
1034 struct cmsghdr *cmsg;
1035 struct iovec iov;
1036 int result = 0;
1037 int yes = 1;
1038 struct ucred cred;
1039
1040 setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &yes, sizeof(int));
1041 memset(&msg, 0, sizeof(msg));
1042 memset(buf, 0, size);
1043 iov.iov_base = buf;
1044 iov.iov_len = size;
1045 msg.msg_iov = &iov;
1046 msg.msg_iovlen = 1;
1047 msg.msg_control = control;
1048 msg.msg_controllen = sizeof(control);
1049 if (recvmsg(fd, &msg, 0) < 0)
1050 return -E_RECVMSG;
1051 result = -E_SCM_CREDENTIALS;
1052 cmsg = CMSG_FIRSTHDR(&msg);
1053 while (cmsg) {
1054 if (cmsg->cmsg_level == SOL_SOCKET && cmsg->cmsg_type
1055 == SCM_CREDENTIALS) {
1056 memcpy(&cred, CMSG_DATA(cmsg), sizeof(struct ucred));
1057 result = cred.uid;
1058 } else
1059 if (cmsg->cmsg_level == SOL_SOCKET
1060 && cmsg->cmsg_type == SCM_RIGHTS) {
1061 dispose_fds((int *) CMSG_DATA(cmsg),
1062 (cmsg->cmsg_len - CMSG_LEN(0))
1063 / sizeof(int));
1064 }
1065 cmsg = CMSG_NXTHDR(&msg, cmsg);
1066 }
1067 return result;
1068 }
1069 #endif /* HAVE_UCRED */