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