net: Remove pointless initialization in makesock_addrinfo().
[paraslash.git] / net.c
1 /*
2 * Copyright (C) 2005-2013 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 static void flowopt_cleanup(struct flowopts *fo)
337 {
338 struct pre_conn_opt *cur, *next;
339
340 if (fo == NULL)
341 return;
342
343 list_for_each_entry_safe(cur, next, &fo->sockopts, node) {
344 free(cur->opt_name);
345 free(cur->opt_val);
346 free(cur);
347 }
348 free(fo);
349 }
350
351 /*
352 * Resolve an IPv4/IPv6 address.
353 *
354 * \param l4type The layer-4 type (\p IPPROTO_xxx).
355 * \param passive Whether \p AI_PASSIVE should be included as hint.
356 * \param host Remote or local hostname or IPv/6 address string.
357 * \param port_number Used to set the port in each returned address structure.
358 * \param result addrinfo structures are returned here.
359 *
360 * The interpretation of \a host depends on the value of \a passive. On a
361 * passive socket host is interpreted as an interface IPv4/6 address (can be
362 * left NULL). On an active socket, \a host is the peer DNS name or IPv4/6
363 * address to connect to.
364 *
365 * \return Standard.
366 *
367 * \sa getaddrinfo(3).
368 */
369 static int lookup_address(unsigned l4type, bool passive, const char *host,
370 int port_number, struct addrinfo **result)
371 {
372 int ret;
373 char port[6]; /* port number has at most 5 digits */
374 struct addrinfo *addr = NULL, hints;
375
376 *result = NULL;
377 sprintf(port, "%u", port_number & 0xffff);
378 /* Set up address hint structure */
379 memset(&hints, 0, sizeof(hints));
380 hints.ai_family = AF_UNSPEC;
381 hints.ai_socktype = sock_type(l4type);
382 /*
383 * getaddrinfo does not support SOCK_DCCP, so for the sake of lookup
384 * (and only then) pretend to be UDP.
385 */
386 if (l4type == IPPROTO_DCCP)
387 hints.ai_socktype = SOCK_DGRAM;
388 /* only use addresses available on the host */
389 hints.ai_flags = AI_ADDRCONFIG;
390 if (passive && host == NULL)
391 hints.ai_flags |= AI_PASSIVE;
392 /* Obtain local/remote address information */
393 ret = getaddrinfo(host, port, &hints, &addr);
394 if (ret != 0) {
395 PARA_ERROR_LOG("can not resolve %s address %s#%s: %s\n",
396 layer4_name(l4type),
397 host? host : (passive? "[loopback]" : "[localhost]"),
398 port, gai_strerror(ret));
399 return -E_ADDRESS_LOOKUP;
400 }
401 *result = addr;
402 return 1;
403 }
404
405 /*
406 * Create an active or passive socket.
407 *
408 * \param l4type \p IPPROTO_TCP, \p IPPROTO_UDP, or \p IPPROTO_DCCP.
409 * \param passive Whether to call bind(2) or connect(2).
410 * \param ai Address information as obtained from \ref lookup_address().
411 * \param fo Socket options to be set before making the connection.
412 *
413 * bind(2) is called on passive sockets, and connect(2) on active sockets. The
414 * algorithm tries all possible address combinations until it succeeds. If \a
415 * fo is supplied, options are set and cleanup is performed.
416 *
417 * \return File descriptor on success, \p E_MAKESOCK on errors.
418 *
419 * \sa \ref lookup_address(), \ref makesock(), ip(7), ipv6(7), bind(2),
420 * connect(2).
421 */
422 static int makesock_addrinfo(unsigned l4type, bool passive, struct addrinfo *ai,
423 struct flowopts *fo)
424 {
425 struct addrinfo *local, *remote, *src, *dst;
426 int ret = -E_MAKESOCK, on = 1, sockfd = -1;
427
428 if (passive) {
429 local = ai;
430 remote = NULL;
431 } else {
432 local = NULL;
433 remote = ai;
434 }
435
436 /* Iterate over all src/dst combination, exhausting dst first */
437 for (src = local, dst = remote; src != NULL || dst != NULL; /* no op */ ) {
438 ret = socket(src ? src->ai_family : dst->ai_family,
439 sock_type(l4type), l4type);
440 if (ret < 0)
441 goto get_next_dst;
442 sockfd = ret;
443 /*
444 * Reuse the address on passive sockets to avoid failure on
445 * restart (protocols using listen()) and when creating
446 * multiple listener instances (UDP multicast).
447 */
448 if (passive && setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR,
449 &on, sizeof(on)) == -1) {
450 ret = -ERRNO_TO_PARA_ERROR(errno);
451 close(sockfd);
452 PARA_ERROR_LOG("can not set SO_REUSEADDR: %s\n",
453 para_strerror(-ret));
454 break;
455 }
456 flowopt_setopts(sockfd, fo);
457
458 if (src) {
459 if (bind(sockfd, src->ai_addr, src->ai_addrlen) < 0) {
460 close(sockfd);
461 goto get_next_src;
462 }
463 if (!dst) /* bind-only completed successfully */
464 break;
465 }
466
467 if (dst && connect(sockfd, dst->ai_addr, dst->ai_addrlen) == 0)
468 break; /* connection completed successfully */
469 close(sockfd);
470 get_next_dst:
471 if (dst && (dst = dst->ai_next))
472 continue;
473 get_next_src:
474 if (src && (src = src->ai_next)) /* restart inner loop */
475 dst = remote;
476 }
477 if (src == NULL && dst == NULL)
478 return ret < 0? ret : -E_MAKESOCK;
479 return sockfd;
480 }
481
482 /**
483 * Resolve IPv4/IPv6 address and create a ready-to-use active or passive socket.
484 *
485 * \param l4type The layer-4 type (\p IPPROTO_xxx).
486 * \param passive Whether this is a passive or active socket.
487 * \param host Passed to \ref lookup_address().
488 * \param port_number Passed to \ref lookup_address().
489 * \param fo Passed to \ref makesock_addrinfo().
490 *
491 * This creates a ready-made IPv4/v6 socket structure after looking up the
492 * necessary parameters. The function first calls \ref lookup_address() and
493 * passes the address information to makesock_addrinfo() to create and
494 * initialize the socket.
495 *
496 * \return The newly created file descriptor on success, a negative error code
497 * on failure.
498 *
499 * \sa \ref lookup_address(), \ref makesock_addrinfo().
500 */
501 int makesock(unsigned l4type, bool passive, const char *host, uint16_t port_number,
502 struct flowopts *fo)
503 {
504 struct addrinfo *ai;
505 int ret = lookup_address(l4type, passive, host, port_number, &ai);
506
507 if (ret >= 0)
508 ret = makesock_addrinfo(l4type, passive, ai, fo);
509 if (ai)
510 freeaddrinfo(ai);
511 flowopt_cleanup(fo);
512 if (ret < 0) {
513 PARA_ERROR_LOG("can not create %s socket %s#%d.\n",
514 layer4_name(l4type), host? host : (passive?
515 "[loopback]" : "[localhost]"), port_number);
516 }
517 return ret;
518 }
519
520 /**
521 * Create a passive / listening socket.
522 *
523 * \param l4type The transport-layer type (\p IPPROTO_xxx).
524 * \param port The decimal port number to listen on.
525 * \param fo Flowopts (if any) to set before starting to listen.
526 *
527 * \return Positive integer (socket descriptor) on success, negative value
528 * otherwise.
529 *
530 * \sa makesock(), ip(7), ipv6(7), bind(2), listen(2).
531 */
532 int para_listen(unsigned l4type, uint16_t port, struct flowopts *fo)
533 {
534 int ret, fd = makesock(l4type, 1, NULL, port, fo);
535
536 if (fd > 0) {
537 ret = listen(fd, BACKLOG);
538 if (ret < 0) {
539 ret = errno;
540 close(fd);
541 return -ERRNO_TO_PARA_ERROR(ret);
542 }
543 PARA_INFO_LOG("listening on %s port %u, fd %d\n",
544 layer4_name(l4type), port, fd);
545 }
546 return fd;
547 }
548
549 /**
550 * Determine IPv4/v6 socket address length.
551 * \param sa Container of IPv4 or IPv6 address.
552 * \return Address-family dependent address length.
553 */
554 static socklen_t salen(const struct sockaddr *sa)
555 {
556 assert(sa->sa_family == AF_INET || sa->sa_family == AF_INET6);
557
558 return sa->sa_family == AF_INET6
559 ? sizeof(struct sockaddr_in6)
560 : sizeof(struct sockaddr_in);
561 }
562
563 /** True if @ss holds a v6-mapped-v4 address (RFC 4291, 2.5.5.2) */
564 static bool SS_IS_ADDR_V4MAPPED(const struct sockaddr_storage *ss)
565 {
566 const struct sockaddr_in6 *ia6 = (const struct sockaddr_in6 *)ss;
567
568 return ss->ss_family == AF_INET6 && IN6_IS_ADDR_V4MAPPED(&ia6->sin6_addr);
569 }
570
571 /**
572 * Process IPv4/v6 address, turn v6-mapped-v4 address into normal IPv4 address.
573 * \param ss Container of IPv4/6 address.
574 * \return Pointer to normalized address (may be static storage).
575 *
576 * \sa RFC 3493
577 */
578 static const struct sockaddr *
579 normalize_ip_address(const struct sockaddr_storage *ss)
580 {
581 assert(ss->ss_family == AF_INET || ss->ss_family == AF_INET6);
582
583 if (SS_IS_ADDR_V4MAPPED(ss)) {
584 const struct sockaddr_in6 *ia6 = (const struct sockaddr_in6 *)ss;
585 static struct sockaddr_in ia;
586
587 ia.sin_family = AF_INET;
588 ia.sin_port = ia6->sin6_port;
589 memcpy(&ia.sin_addr.s_addr, &(ia6->sin6_addr.s6_addr[12]), 4);
590 return (const struct sockaddr *)&ia;
591 }
592 return (const struct sockaddr *)ss;
593 }
594
595 /**
596 * Generic/fallback MTU values
597 *
598 * These are taken from RFC 1122, RFC 2460, and RFC 5405.
599 * - RFC 1122, 3.3.3 defines EMTU_S ("Effective MTU for sending") and recommends
600 * to use an EMTU_S size of of 576 bytes if the IPv4 path MTU is unknown;
601 * - RFC 2460, 5. requires a minimum IPv6 MTU of 1280 bytes;
602 * - RFC 5405, 3.2 recommends that if path MTU discovery is not done,
603 * UDP senders should use the respective minimum values of EMTU_S.
604 */
605 static inline int generic_mtu(const int af_type)
606 {
607 return af_type == AF_INET6 ? 1280 : 576;
608 }
609
610 /** Crude approximation of IP header overhead - neglecting options. */
611 static inline int estimated_header_overhead(const int af_type)
612 {
613 return af_type == AF_INET6 ? 40 : 20;
614 }
615
616 /**
617 * Get the maximum transport-layer message size (MMS_S).
618 *
619 * \param sockfd The socket file descriptor.
620 *
621 * The socket must be connected. See RFC 1122, 3.3.3. If the protocol familiy
622 * could not be determined, \p AF_INET is assumed.
623 *
624 * \return The maximum message size of the address family type.
625 */
626 int generic_max_transport_msg_size(int sockfd)
627 {
628 struct sockaddr_storage ss;
629 socklen_t sslen = sizeof(ss);
630 int af_type = AF_INET;
631
632 if (getpeername(sockfd, (struct sockaddr *)&ss, &sslen) < 0) {
633 PARA_ERROR_LOG("can not determine remote address type: %s\n",
634 strerror(errno));
635 } else if (!SS_IS_ADDR_V4MAPPED(&ss)) {
636 af_type = ss.ss_family;
637 }
638 return generic_mtu(af_type) - estimated_header_overhead(af_type);
639 }
640
641 /**
642 * Look up the local or remote side of a connected socket structure.
643 *
644 * \param fd The socket descriptor of the connected socket.
645 * \param getname Either \p getsockname() for local, or \p getpeername() for
646 * remote side.
647 *
648 * \return A static character string identifying hostname and port of the
649 * chosen side in numeric host:port format.
650 *
651 * \sa getsockname(2), getpeername(2), parse_url(), getnameinfo(3),
652 * services(5), nsswitch.conf(5).
653 */
654 static char *__get_sock_name(int fd, typeof(getsockname) getname)
655 {
656 struct sockaddr_storage ss;
657 const struct sockaddr *sa;
658 socklen_t sslen = sizeof(ss);
659 char hbuf[NI_MAXHOST], sbuf[NI_MAXSERV];
660 static char output[sizeof(hbuf) + sizeof(sbuf) + 4];
661 int ret;
662
663 if (getname(fd, (struct sockaddr *)&ss, &sslen) < 0) {
664 PARA_ERROR_LOG("can not determine address from fd %d: %s\n",
665 fd, strerror(errno));
666 snprintf(output, sizeof(output), "(unknown)");
667 return output;
668 }
669 sa = normalize_ip_address(&ss);
670 ret = getnameinfo(sa, salen(sa), hbuf, sizeof(hbuf), sbuf,
671 sizeof(sbuf), NI_NUMERICHOST | NI_NUMERICSERV);
672 if (ret) {
673 PARA_WARNING_LOG("hostname lookup error (%s).\n",
674 gai_strerror(ret));
675 snprintf(output, sizeof(output), "(lookup error)");
676 } else if (sa->sa_family == AF_INET6)
677 snprintf(output, sizeof(output), "[%s]:%s", hbuf, sbuf);
678 else
679 snprintf(output, sizeof(output), "%s:%s", hbuf, sbuf);
680 return output;
681 }
682
683 /**
684 * Look up the local side of a connected socket structure.
685 *
686 * \param sockfd The file descriptor of the socket.
687 *
688 * \return A pointer to a static buffer containing hostname an port. This
689 * buffer must not be freed by the caller.
690 *
691 * \sa remote_name().
692 */
693 char *local_name(int sockfd)
694 {
695 return __get_sock_name(sockfd, getsockname);
696 }
697
698 /**
699 * Look up the remote side of a connected socket structure.
700 *
701 * \param sockfd The file descriptor of the socket.
702 *
703 * \return Analogous to the return value of \ref local_name() but for the
704 * remote side.
705 *
706 * \sa local_name().
707 */
708 char *remote_name(int sockfd)
709 {
710 return __get_sock_name(sockfd, getpeername);
711 }
712
713 /**
714 * Extract IPv4 or IPv6-mapped-IPv4 address from sockaddr_storage.
715 *
716 * \param ss Container of IPv4/6 address.
717 * \param ia Extracted IPv4 address (different from 0) or 0 if unsuccessful.
718 *
719 * \sa RFC 3493.
720 */
721 void extract_v4_addr(const struct sockaddr_storage *ss, struct in_addr *ia)
722 {
723 const struct sockaddr *sa = normalize_ip_address(ss);
724
725 memset(ia, 0, sizeof(*ia));
726 if (sa->sa_family == AF_INET)
727 *ia = ((struct sockaddr_in *)sa)->sin_addr;
728 }
729
730 /**
731 * Receive data from a file descriptor.
732 *
733 * \param fd The file descriptor.
734 * \param buf The buffer to write the data to.
735 * \param size The size of \a buf.
736 *
737 * Receive at most \a size bytes from file descriptor \a fd.
738 *
739 * \return The number of bytes received on success, negative on errors, zero if
740 * the peer has performed an orderly shutdown.
741 *
742 * \sa recv(2).
743 */
744 __must_check int recv_bin_buffer(int fd, char *buf, size_t size)
745 {
746 ssize_t n;
747
748 n = recv(fd, buf, size, 0);
749 if (n == -1)
750 return -ERRNO_TO_PARA_ERROR(errno);
751 return n;
752 }
753
754 /**
755 * Receive and write terminating NULL byte.
756 *
757 * \param fd The file descriptor.
758 * \param buf The buffer to write the data to.
759 * \param size The size of \a buf.
760 *
761 * Read at most \a size - 1 bytes from file descriptor \a fd and
762 * write a NULL byte at the end of the received data.
763 *
764 * \return The return value of the underlying call to \a recv_bin_buffer().
765 *
766 * \sa recv_bin_buffer()
767 */
768 int recv_buffer(int fd, char *buf, size_t size)
769 {
770 int n;
771
772 assert(size);
773 n = recv_bin_buffer(fd, buf, size - 1);
774 if (n >= 0)
775 buf[n] = '\0';
776 else
777 *buf = '\0';
778 return n;
779 }
780
781 /**
782 * Wrapper around the accept system call.
783 *
784 * \param fd The listening socket.
785 * \param rfds An optional fd_set pointer.
786 * \param addr Structure which is filled in with the address of the peer socket.
787 * \param size Should contain the size of the structure pointed to by \a addr.
788 * \param new_fd Result pointer.
789 *
790 * Accept incoming connections on \a addr, retry if interrupted. If \a rfds is
791 * not \p NULL, return 0 if \a fd is not set in \a rfds without calling accept().
792 *
793 * \return Negative on errors, zero if no connections are present to be accepted,
794 * one otherwise.
795 *
796 * \sa accept(2).
797 */
798 int para_accept(int fd, fd_set *rfds, void *addr, socklen_t size, int *new_fd)
799 {
800 int ret;
801
802 if (rfds && !FD_ISSET(fd, rfds))
803 return 0;
804 do
805 ret = accept(fd, (struct sockaddr *) addr, &size);
806 while (ret < 0 && errno == EINTR);
807
808 if (ret >= 0) {
809 *new_fd = ret;
810 return 1;
811 }
812 if (errno == EAGAIN || errno == EWOULDBLOCK)
813 return 0;
814 return -ERRNO_TO_PARA_ERROR(errno);
815 }
816
817 /**
818 * Probe the list of DCCP CCIDs configured on this host.
819 * \param ccid_array Pointer to return statically allocated array in.
820 * \return Number of elements returned in \a ccid_array or error.
821 *
822 * NB: This feature is only available on Linux > 2.6.30; on older kernels
823 * ENOPROTOOPT ("Protocol not available") will be returned.
824 */
825 int dccp_available_ccids(uint8_t **ccid_array)
826 {
827 static uint8_t ccids[DCCP_MAX_HOST_CCIDS];
828 socklen_t nccids = sizeof(ccids);
829 int ret, fd;
830
831 ret = fd = makesock(IPPROTO_DCCP, 1, NULL, 0, NULL);
832 if (ret < 0)
833 return ret;
834
835 if (getsockopt(fd, SOL_DCCP, DCCP_SOCKOPT_AVAILABLE_CCIDS,
836 ccids, &nccids) < 0) {
837 ret = errno;
838 close(fd);
839 PARA_ERROR_LOG("No DCCP_SOCKOPT_AVAILABLE_CCIDS: %s\n",
840 strerror(ret));
841 return -ERRNO_TO_PARA_ERROR(ret);
842 }
843
844 close(fd);
845 *ccid_array = ccids;
846 return nccids;
847 }
848
849 /**
850 * Prepare a structure for \p AF_UNIX socket addresses.
851 *
852 * \param u Pointer to the struct to be prepared.
853 * \param name The socket pathname.
854 *
855 * This just copies \a name to the sun_path component of \a u.
856 *
857 * \return Positive on success, \p -E_NAME_TOO_LONG if \a name is longer
858 * than \p UNIX_PATH_MAX.
859 */
860 static int init_unix_addr(struct sockaddr_un *u, const char *name)
861 {
862 if (strlen(name) >= UNIX_PATH_MAX)
863 return -E_NAME_TOO_LONG;
864 memset(u->sun_path, 0, UNIX_PATH_MAX);
865 u->sun_family = PF_UNIX;
866 strcpy(u->sun_path, name);
867 return 1;
868 }
869
870 /**
871 * Prepare, create, and bind a socket for local communication.
872 *
873 * \param name The socket pathname.
874 * \param unix_addr Pointer to the \p AF_UNIX socket structure.
875 * \param mode The desired mode of the socket.
876 *
877 * This function creates a local socket for sequenced, reliable,
878 * two-way, connection-based byte streams.
879 *
880 * \return The file descriptor, on success, negative on errors.
881 *
882 * \sa socket(2)
883 * \sa bind(2)
884 * \sa chmod(2)
885 */
886 int create_local_socket(const char *name, struct sockaddr_un *unix_addr,
887 mode_t mode)
888 {
889 int fd, ret;
890
891 ret = init_unix_addr(unix_addr, name);
892 if (ret < 0)
893 return ret;
894 ret = socket(PF_UNIX, SOCK_STREAM, 0);
895 if (ret < 0)
896 return -ERRNO_TO_PARA_ERROR(errno);
897 fd = ret;
898 ret = bind(fd, (struct sockaddr *) unix_addr, UNIX_PATH_MAX);
899 if (ret < 0) {
900 ret = -ERRNO_TO_PARA_ERROR(errno);
901 goto err;
902 }
903 ret = -E_CHMOD;
904 if (chmod(name, mode) < 0)
905 goto err;
906 return fd;
907 err:
908 close(fd);
909 return ret;
910 }
911
912 /**
913 * Prepare, create, and connect to a Unix domain socket for local communication.
914 *
915 * \param name The socket pathname.
916 *
917 * This function creates a local socket for sequenced, reliable, two-way,
918 * connection-based byte streams.
919 *
920 * \return The file descriptor of the connected socket on success, negative on
921 * errors.
922 *
923 * \sa create_local_socket(), unix(7), connect(2).
924 */
925 int connect_local_socket(const char *name)
926 {
927 struct sockaddr_un unix_addr;
928 int fd, ret;
929
930 PARA_DEBUG_LOG("connecting to %s\n", name);
931 ret = init_unix_addr(&unix_addr, name);
932 if (ret < 0)
933 return ret;
934 fd = socket(PF_UNIX, SOCK_STREAM, 0);
935 if (fd < 0)
936 return -ERRNO_TO_PARA_ERROR(errno);
937 if (connect(fd, (struct sockaddr *)&unix_addr, sizeof(unix_addr)) == -1) {
938 ret = -ERRNO_TO_PARA_ERROR(errno);
939 goto err;
940 }
941 return fd;
942 err:
943 close(fd);
944 return ret;
945 }
946
947 #ifndef HAVE_UCRED
948 ssize_t send_cred_buffer(int sock, char *buf)
949 {
950 return write_buffer(sock, buf);
951 }
952 int recv_cred_buffer(int fd, char *buf, size_t size)
953 {
954 return recv_buffer(fd, buf, size) > 0? 1 : -E_RECVMSG;
955 }
956 #else /* HAVE_UCRED */
957 /**
958 * Send \p NULL-terminated buffer and Unix credentials of the current process.
959 *
960 * \param sock The socket file descriptor.
961 * \param buf The buffer to be sent.
962 *
963 * \return On success, this call returns the number of characters sent. On
964 * error, \p -E_SENDMSG is returned.
965 *
966 * \sa sendmsg(2), okir's Black Hats Manual.
967 */
968 ssize_t send_cred_buffer(int sock, char *buf)
969 {
970 char control[sizeof(struct cmsghdr) + sizeof(struct ucred)];
971 struct msghdr msg;
972 struct cmsghdr *cmsg;
973 static struct iovec iov;
974 struct ucred c;
975 int ret;
976
977 /* Response data */
978 iov.iov_base = buf;
979 iov.iov_len = strlen(buf);
980 c.pid = getpid();
981 c.uid = getuid();
982 c.gid = getgid();
983 /* compose the message */
984 memset(&msg, 0, sizeof(msg));
985 msg.msg_iov = &iov;
986 msg.msg_iovlen = 1;
987 msg.msg_control = control;
988 msg.msg_controllen = sizeof(control);
989 /* attach the ucred struct */
990 cmsg = CMSG_FIRSTHDR(&msg);
991 cmsg->cmsg_level = SOL_SOCKET;
992 cmsg->cmsg_type = SCM_CREDENTIALS;
993 cmsg->cmsg_len = CMSG_LEN(sizeof(struct ucred));
994 *(struct ucred *)CMSG_DATA(cmsg) = c;
995 msg.msg_controllen = cmsg->cmsg_len;
996 ret = sendmsg(sock, &msg, 0);
997 if (ret < 0)
998 ret = -E_SENDMSG;
999 return ret;
1000 }
1001
1002 static void dispose_fds(int *fds, unsigned num)
1003 {
1004 int i;
1005
1006 for (i = 0; i < num; i++)
1007 close(fds[i]);
1008 }
1009
1010 /**
1011 * Receive a buffer and the Unix credentials of the sending process.
1012 *
1013 * \param fd the socket file descriptor.
1014 * \param buf the buffer to store the message.
1015 * \param size the size of \a buffer.
1016 *
1017 * \return negative on errors, the user id on success.
1018 *
1019 * \sa recvmsg(2), okir's Black Hats Manual.
1020 */
1021 int recv_cred_buffer(int fd, char *buf, size_t size)
1022 {
1023 char control[255];
1024 struct msghdr msg;
1025 struct cmsghdr *cmsg;
1026 struct iovec iov;
1027 int result = 0;
1028 int yes = 1;
1029 struct ucred cred;
1030
1031 setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &yes, sizeof(int));
1032 memset(&msg, 0, sizeof(msg));
1033 memset(buf, 0, size);
1034 iov.iov_base = buf;
1035 iov.iov_len = size;
1036 msg.msg_iov = &iov;
1037 msg.msg_iovlen = 1;
1038 msg.msg_control = control;
1039 msg.msg_controllen = sizeof(control);
1040 if (recvmsg(fd, &msg, 0) < 0)
1041 return -E_RECVMSG;
1042 result = -E_SCM_CREDENTIALS;
1043 cmsg = CMSG_FIRSTHDR(&msg);
1044 while (cmsg) {
1045 if (cmsg->cmsg_level == SOL_SOCKET && cmsg->cmsg_type
1046 == SCM_CREDENTIALS) {
1047 memcpy(&cred, CMSG_DATA(cmsg), sizeof(struct ucred));
1048 result = cred.uid;
1049 } else
1050 if (cmsg->cmsg_level == SOL_SOCKET
1051 && cmsg->cmsg_type == SCM_RIGHTS) {
1052 dispose_fds((int *) CMSG_DATA(cmsg),
1053 (cmsg->cmsg_len - CMSG_LEN(0))
1054 / sizeof(int));
1055 }
1056 cmsg = CMSG_NXTHDR(&msg, cmsg);
1057 }
1058 return result;
1059 }
1060 #endif /* HAVE_UCRED */