1 /* Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
3 /** \file net.c Networking-related helper functions. */
7 #include <netinet/in.h>
10 #include <sys/types.h>
11 #include <sys/socket.h>
22 * Parse and validate IPv4 address/netmask string.
24 * \param cidr Address in CIDR notation
25 * \param addr Copy of the IPv4 address part of \a cidr
26 * \param addrlen Size of \a addr in bytes
27 * \param netmask Value of the netmask part in \a cidr or the
28 * default of 32 if not specified.
30 * \return Pointer to \a addr if successful, NULL on error.
33 char *parse_cidr(const char *cidr,
34 char *addr, ssize_t addrlen,
38 char *c = addr, *end = c + (addrlen - 1);
42 if (cidr == NULL || addrlen < 1)
45 for (o = cidr; (*c = *o == '/'? '\0' : *o); c++, o++)
50 if (para_atoi32(++o, netmask) < 0 ||
51 *netmask < 0 || *netmask > 0x20)
54 if (is_valid_ipv4_address(addr))
63 * Match string as a candidate IPv4 address.
65 * \param address The string to match.
66 * \return True if \a address has "dot-quad" format.
68 static bool is_v4_dot_quad(const char *address)
73 assert(para_regcomp(&r, "^([0-9]+\\.){3}[0-9]+$",
74 REG_EXTENDED | REG_NOSUB) >= 0);
75 result = regexec(&r, address, 0, NULL, 0) == 0;
81 * Perform basic syntax checking on the host-part of an URL:
83 * - Since ':' is invalid in IPv4 addresses and DNS names, the
84 * presence of ':' causes interpretation as IPv6 address;
85 * - next the first-match-wins algorithm from RFC 3986 is applied;
86 * - else the string is considered as DNS name, to be resolved later.
88 * \param host The host string to check.
89 * \return True if \a host passes the syntax checks.
91 * \sa RFC 3986, 3.2.2; RFC 1123, 2.1; RFC 1034, 3.5.
93 static bool host_string_ok(const char *host)
95 if (host == NULL || *host == '\0')
97 if (strchr(host, ':') != NULL)
98 return is_valid_ipv6_address(host);
99 if (is_v4_dot_quad(host))
100 return is_valid_ipv4_address(host);
105 * Parse and validate URL string.
107 * The URL syntax is loosely based on RFC 3986, supporting one of
108 * - "["host"]"[:port] for native IPv6 addresses and
109 * - host[:port] for IPv4 hostnames and DNS names.
111 * Native IPv6 addresses must be enclosed in square brackets, since
112 * otherwise there is an ambiguity with the port separator `:'.
113 * The 'port' part is always considered to be a number; if absent,
114 * it is set to -1, to indicate that a default port is to be used.
116 * The following are valid examples:
124 * \param url The URL string to take apart.
125 * \param host To return the copied host part of \a url.
126 * \param hostlen The maximum length of \a host.
127 * \param port To return the port number (if any) of \a url.
129 * \return Pointer to \a host, or \p NULL if failed. If \p NULL is returned,
130 * \a host and \a port are undefined. If no port number was present in \a url,
131 * \a port is set to -1.
133 * \sa RFC 3986, 3.2.2/3.2.3.
135 char *parse_url(const char *url,
136 char *host, ssize_t hostlen,
140 char *c = host, *end = c + (hostlen - 1);
144 if (o == NULL || hostlen < 1)
148 for (++o; (*c = *o == ']' ? '\0' : *o); c++, o++)
152 if (*o++ != ']' || (*o != '\0' && *o != ':'))
155 for (; (*c = *o == ':'? '\0' : *o); c++, o++) {
156 if (c == end && o[1])
162 if (para_atoi32(++o, port) < 0 || *port < 0 || *port > 0xffff)
164 if (host_string_ok(host))
172 * Pretty-print a host/port pair.
174 * \param url NULL, or any string accepted by \ref parse_url().
175 * \param default_port Applies if url has no port.
177 * If the url argument is NULL, the function returns the string
178 * 0.0.0.0:default_port. Otherwise it calls \ref parse_url() to check the
179 * syntax of the input string given by url. On errors the string "?" is
180 * returned. Otherwise, if url contains a port, a copy of url is returned. If
181 * no port was supplied, a colon and the default port are appended to url.
183 * \return In all cases the returned string is a allocated with malloc(3) and
184 * has to be freed by the caller.
186 char *format_url(const char *url, int default_port)
188 char host[MAX_HOSTLEN];
192 return make_message("0.0.0.0:%d", default_port);
193 if (!parse_url(url, host, sizeof(host), &url_port))
194 return make_message("?");
196 return make_message("%s:%d", url, default_port);
198 return para_strdup(url);
202 * Stringify port number, resolve into service name where defined.
204 * \param port 2-byte port number, in host-byte-order.
205 * \param transport Transport protocol name (e.g. "udp", "tcp"), or NULL.
206 * \return Pointer to static result buffer.
208 * \sa getservent(3), services(5), nsswitch.conf(5).
210 const char *stringify_port(int port, const char *transport)
212 static char service[NI_MAXSERV];
214 if (port < 0 || port > 0xFFFF) {
215 snprintf(service, sizeof(service), "undefined (%d)", port);
217 struct servent *se = getservbyport(htons(port), transport);
220 snprintf(service, sizeof(service), "%d", port);
222 snprintf(service, sizeof(service), "%s", se->s_name);
228 * Determine the socket type for a given layer-4 protocol.
230 * \param l4type The symbolic name of the transport-layer protocol.
232 * \sa ip(7), socket(2).
234 static inline int sock_type(const unsigned l4type)
237 case IPPROTO_UDP: return SOCK_DGRAM;
238 case IPPROTO_TCP: return SOCK_STREAM;
239 case IPPROTO_DCCP: return SOCK_DCCP;
241 return -1; /* not supported here */
245 * Pretty-print transport-layer name.
247 static const char *layer4_name(const unsigned l4type)
250 case IPPROTO_UDP: return "UDP";
251 case IPPROTO_TCP: return "TCP";
252 case IPPROTO_DCCP: return "DCCP";
254 return "UNKNOWN PROTOCOL";
258 * Flowopts: Transport-layer independent encapsulation of socket options.
260 * These collect individual socket options into a queue, which is disposed of
261 * directly after makesock(). The 'pre_conn_opt' structure is for internal use
262 * only and should not be visible elsewhere.
264 * \sa setsockopt(2), \ref makesock().
266 struct pre_conn_opt {
267 int sock_level; /**< Second argument to setsockopt() */
268 int sock_option; /**< Third argument to setsockopt() */
269 char *opt_name; /**< Stringified \a sock_option */
270 void *opt_val; /**< Fourth argument to setsockopt() */
271 socklen_t opt_len; /**< Fifth argument to setsockopt() */
273 struct list_head node; /**< FIFO, as sockopt order matters. */
277 * List of pre-connection socket options to be set.
279 * This list contains transport-layer independent encapsulation of socket
280 * options that need to be registered prior to setting up a connection.
283 struct list_head sockopts;
287 * Allocate and initialize a flowopt queue.
289 * \return A new structure to be passed to \ref flowopt_add(). It is
290 * automatically deallocated in \ref makesock().
292 struct flowopts *flowopt_new(void)
294 struct flowopts *new = alloc(sizeof(*new));
296 init_list_head(&new->sockopts);
301 * Append new socket option to flowopt queue.
303 * \param fo The flowopt queue to append to.
304 * \param lev Level at which \a opt resides.
305 * \param opt New option to add.
306 * \param name Stringified name of \a opt.
307 * \param val The value to set \a opt to.
308 * \param len Length of \a val.
312 void flowopt_add(struct flowopts *fo, int lev, int opt,
313 const char *name, const void *val, int len)
315 struct pre_conn_opt *new = alloc(sizeof(*new));
317 new->sock_option = opt;
318 new->sock_level = lev;
319 new->opt_name = para_strdup(name);
325 new->opt_val = alloc(len);
327 memcpy(new->opt_val, val, len);
330 list_add_tail(&new->node, &fo->sockopts);
333 /** Set the entire bunch of pre-connection options at once. */
334 static void flowopt_setopts(int sockfd, struct flowopts *fo)
336 struct pre_conn_opt *pc;
341 list_for_each_entry(pc, &fo->sockopts, node)
342 if (setsockopt(sockfd, pc->sock_level, pc->sock_option,
343 pc->opt_val, pc->opt_len) < 0) {
344 PARA_EMERG_LOG("Can not set %s socket option: %s",
345 pc->opt_name, strerror(errno));
351 * Deallocate all resources of a flowopts structure.
353 * \param fo A pointer as returned from flowopt_new().
355 * It's OK to pass \p NULL here in which case the function does nothing.
357 void flowopt_cleanup(struct flowopts *fo)
359 struct pre_conn_opt *cur, *next;
364 list_for_each_entry_safe(cur, next, &fo->sockopts, node) {
373 * Resolve an IPv4/IPv6 address.
375 * \param l4type The layer-4 type (\p IPPROTO_xxx).
376 * \param passive Whether \p AI_PASSIVE should be included as hint.
377 * \param host Remote or local hostname or IPv/6 address string.
378 * \param port_number Used to set the port in each returned address structure.
379 * \param result addrinfo structures are returned here.
381 * The interpretation of \a host depends on the value of \a passive. On a
382 * passive socket host is interpreted as an interface IPv4/6 address (can be
383 * left NULL). On an active socket, \a host is the peer DNS name or IPv4/6
384 * address to connect to.
388 * \sa getaddrinfo(3).
390 int lookup_address(unsigned l4type, bool passive, const char *host,
391 int port_number, struct addrinfo **result)
394 char port[6]; /* port number has at most 5 digits */
395 struct addrinfo *addr = NULL, hints;
398 sprintf(port, "%d", port_number & 0xffff);
399 /* Set up address hint structure */
400 memset(&hints, 0, sizeof(hints));
401 hints.ai_family = AF_UNSPEC;
402 hints.ai_socktype = sock_type(l4type);
404 * getaddrinfo does not support SOCK_DCCP, so for the sake of lookup
405 * (and only then) pretend to be UDP.
407 if (l4type == IPPROTO_DCCP)
408 hints.ai_socktype = SOCK_DGRAM;
409 /* only use addresses available on the host */
410 hints.ai_flags = AI_ADDRCONFIG;
411 if (passive && host == NULL)
412 hints.ai_flags |= AI_PASSIVE;
413 /* Obtain local/remote address information */
414 ret = getaddrinfo(host, port, &hints, &addr);
416 PARA_ERROR_LOG("can not resolve %s address %s#%s: %s\n",
418 host? host : (passive? "[loopback]" : "[localhost]"),
419 port, gai_strerror(ret));
420 return -E_ADDRESS_LOOKUP;
427 * Create an active or passive socket.
429 * \param l4type \p IPPROTO_TCP, \p IPPROTO_UDP, or \p IPPROTO_DCCP.
430 * \param passive Whether to call bind(2) or connect(2).
431 * \param ai Address information as obtained from \ref lookup_address().
432 * \param fo Socket options to be set before making the connection.
434 * bind(2) is called on passive sockets, and connect(2) on active sockets. The
435 * algorithm tries all possible address combinations until it succeeds. If \a
436 * fo is supplied, options are set but cleanup must be performed in the caller.
438 * \return File descriptor on success, \p E_MAKESOCK on errors.
440 * \sa \ref lookup_address(), \ref makesock(), ip(7), ipv6(7), bind(2),
443 int makesock_addrinfo(unsigned l4type, bool passive, struct addrinfo *ai,
446 int ret = -E_MAKESOCK, on = 1;
448 for (; ai; ai = ai->ai_next) {
450 ret = socket(ai->ai_family, sock_type(l4type), l4type);
452 PARA_NOTICE_LOG("socket(): %s\n", strerror(errno));
456 flowopt_setopts(fd, fo);
458 if (connect(fd, ai->ai_addr, ai->ai_addrlen) < 0) {
459 PARA_NOTICE_LOG("connect(): %s\n",
467 * Reuse the address on passive sockets to avoid failure on
468 * restart (protocols using listen()) and when creating
469 * multiple listener instances (UDP multicast).
471 if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &on,
473 PARA_NOTICE_LOG("setsockopt(): %s\n", strerror(errno));
477 if (bind(fd, ai->ai_addr, ai->ai_addrlen) < 0) {
478 PARA_NOTICE_LOG("bind(): %s\n", strerror(errno));
488 * Resolve IPv4/IPv6 address and create a ready-to-use active or passive socket.
490 * \param l4type The layer-4 type (\p IPPROTO_xxx).
491 * \param passive Whether this is a passive or active socket.
492 * \param host Passed to \ref lookup_address().
493 * \param port_number Passed to \ref lookup_address().
494 * \param fo Passed to \ref makesock_addrinfo().
496 * This creates a ready-made IPv4/v6 socket structure after looking up the
497 * necessary parameters. The function first calls \ref lookup_address() and
498 * passes the address information to makesock_addrinfo() to create and
499 * initialize the socket.
501 * \return The newly created file descriptor on success, a negative error code
504 * \sa \ref lookup_address(), \ref makesock_addrinfo().
506 int makesock(unsigned l4type, bool passive, const char *host, uint16_t port_number,
510 int ret = lookup_address(l4type, passive, host, port_number, &ai);
513 ret = makesock_addrinfo(l4type, passive, ai, fo);
517 PARA_ERROR_LOG("can not create %s socket %s#%d.\n",
518 layer4_name(l4type), host? host : (passive?
519 "[loopback]" : "[localhost]"), port_number);
525 * Create a passive / listening socket.
527 * \param l4type The transport-layer type (\p IPPROTO_xxx).
528 * \param addr Passed to \ref parse_url() if not NULL.
529 * \param port Ignored if addr contains a port number.
531 * \return Positive integer (socket descriptor) on success, negative value
534 * \sa \ref makesock(), ip(7), ipv6(7), bind(2), listen(2).
536 int para_listen(unsigned l4type, const char *addr, uint16_t port)
538 char host[MAX_HOSTLEN];
539 int ret, fd, addr_port;
542 if (!parse_url(addr, host, sizeof(host), &addr_port))
543 return -ERRNO_TO_PARA_ERROR(EINVAL);
548 fd = makesock(l4type, true /* passive */, addr, port,
549 NULL /* no flowopts */);
551 ret = listen(fd, BACKLOG);
555 return -ERRNO_TO_PARA_ERROR(ret);
557 PARA_INFO_LOG("listening on %s port %u, fd %d\n",
558 layer4_name(l4type), port, fd);
564 * Create a socket which listens on all network addresses.
566 * \param l4type See \ref para_listen().
567 * \param port See \ref para_listen().
569 * This is a simple wrapper for \ref para_listen() which passes a NULL pointer
570 * as the address information.
572 * \return See \ref para_listen().
574 int para_listen_simple(unsigned l4type, uint16_t port)
576 return para_listen(l4type, NULL, port);
580 * Determine IPv4/v6 socket address length.
581 * \param sa Container of IPv4 or IPv6 address.
582 * \return Address-family dependent address length.
584 static socklen_t salen(const struct sockaddr *sa)
586 assert(sa->sa_family == AF_INET || sa->sa_family == AF_INET6);
588 return sa->sa_family == AF_INET6
589 ? sizeof(struct sockaddr_in6)
590 : sizeof(struct sockaddr_in);
593 /** True if @ss holds a v6-mapped-v4 address (RFC 4291, 2.5.5.2) */
594 static bool SS_IS_ADDR_V4MAPPED(const struct sockaddr_storage *ss)
596 const struct sockaddr_in6 *ia6 = (const struct sockaddr_in6 *)ss;
598 return ss->ss_family == AF_INET6 && IN6_IS_ADDR_V4MAPPED(&ia6->sin6_addr);
602 * Process IPv4/v6 address, turn v6-mapped-v4 address into normal IPv4 address.
603 * \param ss Container of IPv4/6 address.
604 * \return Pointer to normalized address (may be static storage).
608 static const struct sockaddr *
609 normalize_ip_address(const struct sockaddr_storage *ss)
611 assert(ss->ss_family == AF_INET || ss->ss_family == AF_INET6);
613 if (SS_IS_ADDR_V4MAPPED(ss)) {
614 const struct sockaddr_in6 *ia6 = (const struct sockaddr_in6 *)ss;
615 static struct sockaddr_in ia;
617 ia.sin_family = AF_INET;
618 ia.sin_port = ia6->sin6_port;
619 memcpy(&ia.sin_addr.s_addr, &(ia6->sin6_addr.s6_addr[12]), 4);
620 return (const struct sockaddr *)&ia;
622 return (const struct sockaddr *)ss;
626 * Generic/fallback MTU values
628 * These are taken from RFC 1122, RFC 2460, and RFC 5405.
629 * - RFC 1122, 3.3.3 defines EMTU_S ("Effective MTU for sending") and recommends
630 * to use an EMTU_S size of of 576 bytes if the IPv4 path MTU is unknown;
631 * - RFC 2460, 5. requires a minimum IPv6 MTU of 1280 bytes;
632 * - RFC 5405, 3.2 recommends that if path MTU discovery is not done,
633 * UDP senders should use the respective minimum values of EMTU_S.
635 static inline int generic_mtu(const int af_type)
637 return af_type == AF_INET6 ? 1280 : 576;
640 /** Crude approximation of IP header overhead - neglecting options. */
641 static inline int estimated_header_overhead(const int af_type)
643 return af_type == AF_INET6 ? 40 : 20;
647 * Get the maximum transport-layer message size (MMS_S).
649 * \param sockfd The socket file descriptor.
651 * The socket must be connected. See RFC 1122, 3.3.3. If the protocol family
652 * could not be determined, \p AF_INET is assumed.
654 * \return The maximum message size of the address family type.
656 int generic_max_transport_msg_size(int sockfd)
658 struct sockaddr_storage ss = {.ss_family = 0};
659 socklen_t sslen = sizeof(ss);
660 int af_type = AF_INET;
662 if (getpeername(sockfd, (struct sockaddr *)&ss, &sslen) < 0) {
663 PARA_ERROR_LOG("can not determine remote address type: %s\n",
665 } else if (!SS_IS_ADDR_V4MAPPED(&ss)) {
666 af_type = ss.ss_family;
668 return generic_mtu(af_type) - estimated_header_overhead(af_type);
672 * Look up the remote side of a connected socket structure.
674 * \param fd The socket descriptor of the connected socket.
676 * \return A static character string identifying hostname and port of the
677 * chosen side in numeric host:port format.
679 * \sa getsockname(2), getpeername(2), \ref parse_url(), getnameinfo(3),
680 * services(5), nsswitch.conf(5).
682 char *remote_name(int fd)
684 struct sockaddr_storage ss = {.ss_family = 0};
685 const struct sockaddr *sa;
686 socklen_t sslen = sizeof(ss);
687 char hbuf[NI_MAXHOST], sbuf[NI_MAXSERV];
688 static char output[sizeof(hbuf) + sizeof(sbuf) + 4];
691 if (getpeername(fd, (struct sockaddr *)&ss, &sslen) < 0) {
692 PARA_ERROR_LOG("can not determine address from fd %d: %s\n",
693 fd, strerror(errno));
694 snprintf(output, sizeof(output), "(unknown)");
697 sa = normalize_ip_address(&ss);
698 ret = getnameinfo(sa, salen(sa), hbuf, sizeof(hbuf), sbuf,
699 sizeof(sbuf), NI_NUMERICHOST | NI_NUMERICSERV);
701 PARA_WARNING_LOG("hostname lookup error (%s).\n",
703 snprintf(output, sizeof(output), "(lookup error)");
704 } else if (sa->sa_family == AF_INET6)
705 snprintf(output, sizeof(output), "[%s]:%s", hbuf, sbuf);
707 snprintf(output, sizeof(output), "%s:%s", hbuf, sbuf);
712 * Extract IPv4 or IPv6-mapped-IPv4 address from sockaddr_storage.
714 * \param ss Container of IPv4/6 address.
715 * \param ia Extracted IPv4 address (different from 0) or 0 if unsuccessful.
719 void extract_v4_addr(const struct sockaddr_storage *ss, struct in_addr *ia)
721 const struct sockaddr *sa = normalize_ip_address(ss);
723 memset(ia, 0, sizeof(*ia));
724 if (sa->sa_family == AF_INET)
725 *ia = ((struct sockaddr_in *)sa)->sin_addr;
729 * Compare the address part of IPv4/6 addresses.
731 * \param sa1 First address.
732 * \param sa2 Second address.
734 * \return True iff the IP address of \a sa1 and \a sa2 match.
736 bool sockaddr_equal(const struct sockaddr *sa1, const struct sockaddr *sa2)
740 if (sa1->sa_family != sa2->sa_family)
742 if (sa1->sa_family == AF_INET) {
743 struct sockaddr_in *a1 = (typeof(a1))sa1,
744 *a2 = (typeof (a2))sa2;
745 return a1->sin_addr.s_addr == a2->sin_addr.s_addr;
746 } else if (sa1->sa_family == AF_INET6) {
747 struct sockaddr_in6 *a1 = (typeof(a1))sa1,
748 *a2 = (typeof (a2))sa2;
749 return !memcmp(a1, a2, sizeof(*a1));
755 * Receive data from a file descriptor.
757 * \param fd The file descriptor.
758 * \param buf The buffer to write the data to.
759 * \param size The size of \a buf.
761 * Receive at most \a size bytes from file descriptor \a fd.
763 * \return The number of bytes received on success, negative on errors, zero if
764 * the peer has performed an orderly shutdown.
768 __must_check int recv_bin_buffer(int fd, char *buf, size_t size)
772 n = recv(fd, buf, size, 0);
774 return -ERRNO_TO_PARA_ERROR(errno);
779 * Receive and write terminating NULL byte.
781 * \param fd The file descriptor.
782 * \param buf The buffer to write the data to.
783 * \param size The size of \a buf.
785 * Read at most \a size - 1 bytes from file descriptor \a fd and
786 * write a NULL byte at the end of the received data.
788 * \return The return value of the underlying call to \a recv_bin_buffer().
790 * \sa \ref recv_bin_buffer()
792 int recv_buffer(int fd, char *buf, size_t size)
797 n = recv_bin_buffer(fd, buf, size - 1);
806 * Wrapper around the accept system call.
808 * \param fd The listening socket.
809 * \param addr Structure which is filled in with the address of the peer socket.
810 * \param size Should contain the size of the structure pointed to by \a addr.
811 * \param new_fd Result pointer.
813 * Accept incoming connections on addr, retry if interrupted.
815 * \return Negative on errors, zero if no connections are present to be accepted,
820 int para_accept(int fd, void *addr, socklen_t size, int *new_fd)
825 ret = accept(fd, (struct sockaddr *) addr, &size);
826 while (ret < 0 && errno == EINTR);
832 if (errno == EAGAIN || errno == EWOULDBLOCK)
834 return -ERRNO_TO_PARA_ERROR(errno);
838 * Probe the list of DCCP CCIDs configured on this host.
839 * \param ccid_array Pointer to return statically allocated array in.
840 * \return Number of elements returned in \a ccid_array or error.
842 * NB: This feature is only available on Linux > 2.6.30; on older kernels
843 * ENOPROTOOPT ("Protocol not available") will be returned.
845 int dccp_available_ccids(uint8_t **ccid_array)
847 static uint8_t ccids[DCCP_MAX_HOST_CCIDS];
848 socklen_t nccids = sizeof(ccids);
851 ret = fd = makesock(IPPROTO_DCCP, 1, NULL, 0, NULL);
855 if (getsockopt(fd, SOL_DCCP, DCCP_SOCKOPT_AVAILABLE_CCIDS,
856 ccids, &nccids) < 0) {
859 PARA_ERROR_LOG("No DCCP_SOCKOPT_AVAILABLE_CCIDS: %s\n",
861 return -ERRNO_TO_PARA_ERROR(ret);
870 * Prepare a structure for AF_UNIX socket addresses.
872 * This just copies name to the sun_path component of u, prepending a zero byte
873 * if abstract sockets are supported.
875 * The first call to this function tries to bind a socket to the abstract name
876 * space. The result of this test is stored in a static variable. Subsequent
877 * calls read this variable and create abstract sockets on systems that support
878 * them. If a NULL pointer is passed as the name, the function only
879 * initializes the static variable.
881 static int init_unix_addr(struct sockaddr_un *u, const char *name)
883 static int use_abstract;
885 memset(u->sun_path, 0, UNIX_PATH_MAX);
886 u->sun_family = PF_UNIX;
887 if (use_abstract == 0) { /* executed only once */
888 int fd = socket(PF_UNIX, SOCK_STREAM, 0);
889 memcpy(u->sun_path, "\0x\0", 3);
890 if (bind(fd, (struct sockaddr *)u, sizeof(*u)) == 0)
891 use_abstract = 1; /* yes */
893 use_abstract = -1; /* no */
895 PARA_NOTICE_LOG("%susing abstract socket namespace\n",
896 use_abstract == 1? "" : "not ");
900 if (strlen(name) + 1 >= UNIX_PATH_MAX)
901 return -E_NAME_TOO_LONG;
902 strcpy(u->sun_path + (use_abstract == 1? 1 : 0), name);
907 * Create a socket for local communication and listen on it.
909 * \param name The socket pathname.
911 * This function creates a passive local socket for sequenced, reliable,
912 * two-way, connection-based byte streams. The socket file descriptor is set to
913 * nonblocking mode and listen(2) is called to prepare the socket for
914 * accepting incoming connection requests.
916 * \return The file descriptor on success, negative error code on failure.
918 * \sa socket(2), \sa bind(2), \sa chmod(2), listen(2), unix(7).
920 int create_local_socket(const char *name)
922 struct sockaddr_un unix_addr;
925 ret = init_unix_addr(&unix_addr, name);
926 if (ret <= 0) /* error, or name was NULL */
928 ret = socket(PF_UNIX, SOCK_STREAM, 0);
930 return -ERRNO_TO_PARA_ERROR(errno);
932 ret = mark_fd_nonblocking(fd);
935 ret = bind(fd, (struct sockaddr *)&unix_addr, sizeof(unix_addr));
937 ret = -ERRNO_TO_PARA_ERROR(errno);
940 if (unix_addr.sun_path[0] != 0) { /* pathname socket */
941 mode_t mode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP
944 if (chmod(name, mode) < 0)
947 if (listen(fd , 5) < 0) {
948 ret = -ERRNO_TO_PARA_ERROR(errno);
958 * Prepare, create, and connect to a Unix domain socket for local communication.
960 * \param name The socket pathname.
962 * This function creates a local socket for sequenced, reliable, two-way,
963 * connection-based byte streams.
965 * \return The file descriptor of the connected socket on success, negative on
968 * \sa \ref create_local_socket(), unix(7), connect(2).
970 int connect_local_socket(const char *name)
972 struct sockaddr_un unix_addr;
975 PARA_DEBUG_LOG("connecting to %s\n", name);
976 fd = socket(PF_UNIX, SOCK_STREAM, 0);
978 return -ERRNO_TO_PARA_ERROR(errno);
979 ret = init_unix_addr(&unix_addr, name);
982 if (connect(fd, (struct sockaddr *)&unix_addr, sizeof(unix_addr)) != -1)
984 ret = -ERRNO_TO_PARA_ERROR(errno);
991 ssize_t send_cred_buffer(int sock, char *buf)
993 return write_buffer(sock, buf);
995 int recv_cred_buffer(int fd, char *buf, size_t size)
997 return recv_buffer(fd, buf, size) > 0? 1 : -E_RECVMSG;
999 #else /* HAVE_UCRED */
1002 * Send a buffer and the credentials of the current process to a socket.
1004 * \param sock The file descriptor of the sending socket.
1005 * \param buf The zero-terminated buffer to send.
1007 * \return On success, this call returns the number of bytes sent. On errors,
1008 * \p -E_SENDMSG is returned.
1010 * \sa \ref recv_cred_buffer, sendmsg(2), socket(7), unix(7).
1012 ssize_t send_cred_buffer(int sock, char *buf)
1014 char control[sizeof(struct cmsghdr) + sizeof(struct ucred)];
1016 struct cmsghdr *cmsg;
1017 static struct iovec iov;
1023 iov.iov_len = strlen(buf);
1027 /* compose the message */
1028 memset(&msg, 0, sizeof(msg));
1031 msg.msg_control = control;
1032 msg.msg_controllen = sizeof(control);
1033 /* attach the ucred struct */
1034 cmsg = CMSG_FIRSTHDR(&msg);
1035 cmsg->cmsg_level = SOL_SOCKET;
1036 cmsg->cmsg_type = SCM_CREDENTIALS;
1037 cmsg->cmsg_len = CMSG_LEN(sizeof(struct ucred));
1038 *(struct ucred *)CMSG_DATA(cmsg) = c;
1039 msg.msg_controllen = cmsg->cmsg_len;
1040 ret = sendmsg(sock, &msg, 0);
1046 static void dispose_fds(int *fds, unsigned num)
1050 for (i = 0; i < num; i++)
1055 * Receive a buffer and the Unix credentials of the sending process.
1057 * \param fd The file descriptor of the receiving socket.
1058 * \param buf The buffer to store the received message.
1059 * \param size The length of \a buf in bytes.
1061 * \return Negative on errors, the user id of the sending process on success.
1063 * \sa \ref send_cred_buffer and the references given there.
1065 int recv_cred_buffer(int fd, char *buf, size_t size)
1067 char control[255] __a_aligned(8);
1069 struct cmsghdr *cmsg;
1075 setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &yes, sizeof(int));
1076 memset(&msg, 0, sizeof(msg));
1077 memset(buf, 0, size);
1082 msg.msg_control = control;
1083 msg.msg_controllen = sizeof(control);
1084 if (recvmsg(fd, &msg, 0) < 0)
1086 result = -E_SCM_CREDENTIALS;
1087 cmsg = CMSG_FIRSTHDR(&msg);
1089 if (cmsg->cmsg_level == SOL_SOCKET && cmsg->cmsg_type
1090 == SCM_CREDENTIALS) {
1091 memcpy(&cred, CMSG_DATA(cmsg), sizeof(struct ucred));
1094 if (cmsg->cmsg_level == SOL_SOCKET
1095 && cmsg->cmsg_type == SCM_RIGHTS) {
1096 dispose_fds((int *)CMSG_DATA(cmsg),
1097 (cmsg->cmsg_len - CMSG_LEN(0))
1100 cmsg = CMSG_NXTHDR(&msg, cmsg);
1104 #endif /* HAVE_UCRED */