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