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