2 * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file net.c Networking-related helper functions. */
17 /** Information about one encrypted connection. */
19 /** Function used to decrypt received data. */
21 /** Function used to encrypt data to be sent. */
24 * Context-dependent data (crypt keys), passed verbatim to the above
29 /** Array holding per fd crypt data. */
30 static struct crypt_data *crypt_data_array;
31 /** Current size of the crypt data array. */
32 static unsigned cda_size = 0;
35 * Activate encryption for one file descriptor.
37 * \param fd The file descriptor.
38 * \param recv_f The function used for decrypting received data.
39 * \param send_f The function used for encrypting before sending.
40 * \param private_data User data supplied by the caller.
42 void enable_crypt(int fd, crypt_function *recv_f, crypt_function *send_f,
45 if (fd + 1 > cda_size) {
46 crypt_data_array = para_realloc(crypt_data_array,
47 (fd + 1) * sizeof(struct crypt_data));
48 memset(crypt_data_array + cda_size, 0,
49 (fd + 1 - cda_size) * sizeof(struct crypt_data));
52 crypt_data_array[fd].recv = recv_f;
53 crypt_data_array[fd].send = send_f;
54 crypt_data_array[fd].private_data = private_data;
55 PARA_INFO_LOG("rc4 encryption activated for fd %d\n", fd);
59 * Deactivate encryption for a given fd.
61 * \param fd The file descriptor.
63 * This must be called if and only if \p fd was activated via enable_crypt().
65 void disable_crypt(int fd)
67 if (cda_size < fd + 1)
69 crypt_data_array[fd].recv = NULL;
70 crypt_data_array[fd].send = NULL;
71 crypt_data_array[fd].private_data = NULL;
76 * Initialize a struct sockaddr_in.
78 * \param addr A pointer to the struct to be initialized.
79 * \param port The port number to use.
80 * \param he The address to use.
82 * If \a he is null (server mode), \a addr->sin_addr is initialized with \p
83 * INADDR_ANY. Otherwise, the address given by \a he is copied to addr.
85 static void init_sockaddr(struct sockaddr_in *addr, int port, const struct hostent *he)
88 addr->sin_family = AF_INET;
89 /* short, network byte order */
90 addr->sin_port = htons(port);
92 addr->sin_addr = *((struct in_addr *)he->h_addr);
94 addr->sin_addr.s_addr = INADDR_ANY;
95 /* zero the rest of the struct */
96 memset(&addr->sin_zero, '\0', 8);
100 * Determine the socket type for a given layer-4 protocol.
102 * \param l4type The symbolic name of the transport-layer protocol.
104 * \sa ip(7), socket(2)
106 static inline int sock_type(const unsigned l4type)
109 case IPPROTO_UDP: return SOCK_DGRAM;
110 case IPPROTO_TCP: return SOCK_STREAM;
111 case IPPROTO_DCCP: return SOCK_DCCP;
113 return -1; /* not supported here */
117 * Pretty-print transport-layer name.
119 static const char *layer4_name(const unsigned l4type)
122 case IPPROTO_UDP: return "UDP";
123 case IPPROTO_TCP: return "TCP";
124 case IPPROTO_DCCP: return "DCCP";
126 return "UNKNOWN PROTOCOL";
130 * Resolve IPv4/IPv6 address and create a ready-to-use active or passive socket.
132 * @param l3type The layer-3 type (\p AF_INET, \p AF_INET6, \p AF_UNSPEC)
133 * @param l4type The layer-4 type (\p IPPROTO_xxx).
134 * @param passive Whether this is a passive (1) or active (0) socket/
135 * @param host Remote or local hostname or IPv/6 address string.
136 * @param port_number Decimal port number.
138 * This creates a ready-made IPv4/v6 socket structure after looking up the necessary
139 * parameters. The interpretation of \a host depends on the value of \a passive:
140 * - on a passive socket host is interpreted as an interface IPv4/6 address
141 * (can be left NULL);
142 * - on an active socket, \a host is the peer DNS name or IPv4/6 address to connect to;
143 * - \a port_number is in either case the numeric port number (not service string).
144 * Furthermore, bind(2) is called on passive sockets, and connect(2) on active sockets.
145 * The algorithm tries all possible address combinations until it succeeds.
147 * \return This function returns 1 on success and \a -E_ADDRESS_LOOKUP when no matching
148 * connection could be set up (with details in the error log).
150 * \sa ipv6(7), getaddrinfo(3), bind(2), connect(2)
152 int makesock(unsigned l3type, unsigned l4type, int passive,
153 const char *host, unsigned short port_number)
155 struct addrinfo *local = NULL, *src,
156 *remote = NULL, *dst, hints;
157 char *port = make_message("%u", port_number);
158 int rc, on = 1, sockfd = -1,
159 socktype = sock_type(l4type);
162 * Set up address hint structure
164 memset(&hints, 0, sizeof(hints));
165 hints.ai_family = l3type;
166 /* getaddrinfo does not really work well with SOCK_DCCP */
167 if (socktype == SOCK_DGRAM || socktype == SOCK_STREAM)
168 hints.ai_socktype = socktype;
170 /* only use addresses available on the host */
171 hints.ai_flags = AI_ADDRCONFIG;
172 if (l3type == AF_INET6)
173 /* use v4-mapped-v6 if no v6 addresses found */
174 hints.ai_flags |= AI_V4MAPPED | AI_ALL;
176 if (passive && host == NULL)
177 hints.ai_flags |= AI_PASSIVE;
180 * Obtain local/remote address information
182 if ((rc = getaddrinfo(host, port, &hints, passive ? &local : &remote))) {
183 PARA_ERROR_LOG("can not resolve %s address %s#%s: %s.\n",
185 host? : (passive? "[loopback]" : "[localhost]"),
186 port, gai_strerror(rc));
187 return -E_ADDRESS_LOOKUP;
191 * Iterate over all src/dst combination, exhausting dst first
193 for (src = local, dst = remote; src != NULL || dst != NULL; /* no op */ ) {
194 if (src && dst && src->ai_family == AF_INET
195 && dst->ai_family == AF_INET6) /* v4 -> v6 is not possible */
198 sockfd = socket(src ? src->ai_family : dst->ai_family, socktype, l4type);
203 * Set those options that need to be set before establishing the connection
205 /* Reuse the address on passive (listening) sockets to avoid failure on restart */
206 if (passive && setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on)) == -1) {
207 PARA_ERROR_LOG("can not set SO_REUSEADDR: %s\n", strerror(errno));
208 return -ERRNO_TO_PARA_ERROR(errno);
212 if (bind(sockfd, src->ai_addr, src->ai_addrlen) < 0) {
217 break; /* bind-only completed successfully */
220 if (dst && connect(sockfd, dst->ai_addr, dst->ai_addrlen) == 0)
221 break; /* connection completed successfully */
224 if (dst && (dst = dst->ai_next))
227 if (src && (src = src->ai_next))
228 dst = remote; /* restart inner loop */
233 freeaddrinfo(remote);
235 if (src == NULL && dst == NULL) {
236 PARA_ERROR_LOG("can not create %s socket %s#%s.\n", layer4_name(l4type),
237 host? : (passive? "[loopback]" : "[localhost]"), port);
238 return -ERRNO_TO_PARA_ERROR(errno);
244 * Create a passive / listening socket.
245 * \param l3type The network-layer type (\p AF_xxx)
246 * \param l4type The transport-layer type (\p IPPROTO_xxx).
247 * \param port The decimal port number to listen on.
249 * \return Positive integer (socket descriptor) on success, negative value otherwise.
250 * \sa makesock(), ip(7), ipv6(7), bind(2), listen(2).
252 int para_listen(unsigned l3type, unsigned l4type, unsigned short port)
254 int ret, fd = makesock(l3type, l4type, 1, NULL, port);
257 ret = listen(fd, BACKLOG);
260 return -ERRNO_TO_PARA_ERROR(errno);
262 PARA_INFO_LOG("listening on %s port %u, fd %d\n",
263 layer4_name(l4type), port, fd);
269 * Print numeric host and port number (beware - uses static char).
270 * \param sa The IPv4/IPv6 socket address to use.
271 * \param len The length of \p sa.
275 char *host_and_port(struct sockaddr *sa, socklen_t len)
277 static char output[NI_MAXHOST + NI_MAXSERV + 2];
278 char hbuf[NI_MAXHOST],
282 ret = getnameinfo(sa, len, hbuf, sizeof(hbuf), sbuf, sizeof(sbuf),
283 NI_NUMERICHOST | NI_NUMERICSERV);
285 PARA_WARNING_LOG("hostname lookup error (%s).\n", gai_strerror(ret));
286 sprintf(output, "(unknown)");
288 sprintf(output, "%s#%s", hbuf, sbuf);
294 * Look up the local or remote side of a connected socket structure.
295 * \param fd The socket descriptor of the connected socket.
296 * \param getname Either \fn getsockname() for local, or \fn getpeername() for remote side.
298 * \return A static character string identifying hostname and port of the chosen side
299 * \sa getsockname(2), getpeername(2)
301 static char *__get_sock_name(int fd, int (*getname)(int, struct sockaddr*, socklen_t *))
303 struct sockaddr_storage ss;
304 socklen_t sslen = sizeof(ss);
306 if (getname(fd, (struct sockaddr *)&ss, &sslen) < 0) {
307 static char *dont_know = "(don't know)";
308 PARA_ERROR_LOG("can not determine address from fd %d: %s\n", fd, strerror(errno));
312 return host_and_port((struct sockaddr *)&ss, sslen);
315 char *local_name(int sockfd)
317 return __get_sock_name(sockfd, getsockname);
320 char *remote_name(int sockfd)
322 return __get_sock_name(sockfd, getpeername);
326 * Send out a buffer, resend on short writes.
328 * \param fd The file descriptor.
329 * \param buf The buffer to be sent.
330 * \param len The length of \a buf.
332 * \return Standard. In any case, the number of bytes actually sent is stored
335 static int sendall(int fd, const char *buf, size_t *len)
341 while (*len < total) {
342 int ret = send(fd, buf + *len, total - *len, 0);
344 return -ERRNO_TO_PARA_ERROR(errno);
351 * Encrypt and send a binary buffer.
353 * \param fd The file descriptor.
354 * \param buf The buffer to be encrypted and sent.
355 * \param len The length of \a buf.
357 * Check if encryption is available. If yes, encrypt the given buffer. Send
358 * out the buffer, encrypted or not, and try to resend the remaing part in case
363 int send_bin_buffer(int fd, const char *buf, size_t len)
366 crypt_function *cf = NULL;
369 PARA_CRIT_LOG("%s", "len == 0\n");
370 if (fd + 1 <= cda_size)
371 cf = crypt_data_array[fd].send;
373 void *private = crypt_data_array[fd].private_data;
374 /* RC4 may write more than len to the output buffer */
375 unsigned char *outbuf = para_malloc(ROUND_UP(len, 8));
376 (*cf)(len, (unsigned char *)buf, outbuf, private);
377 ret = sendall(fd, (char *)outbuf, &len);
380 ret = sendall(fd, buf, &len);
385 * Encrypt and send null terminated buffer.
387 * \param fd The file descriptor.
388 * \param buf The null-terminated buffer to be send.
390 * This is equivalent to send_bin_buffer(fd, buf, strlen(buf)).
394 int send_buffer(int fd, const char *buf)
396 return send_bin_buffer(fd, buf, strlen(buf));
401 * Send and encrypt a buffer given by a format string.
403 * \param fd The file descriptor.
404 * \param fmt A format string.
408 __printf_2_3 int send_va_buffer(int fd, const char *fmt, ...)
413 PARA_VSPRINTF(fmt, msg);
414 ret = send_buffer(fd, msg);
420 * Receive and decrypt.
422 * \param fd The file descriptor.
423 * \param buf The buffer to write the decrypted data to.
424 * \param size The size of \a buf.
426 * Receive at most \a size bytes from file descriptor \a fd. If encryption is
427 * available, decrypt the received buffer.
429 * \return The number of bytes received on success, negative on errors.
433 __must_check int recv_bin_buffer(int fd, char *buf, size_t size)
436 crypt_function *cf = NULL;
438 if (fd + 1 <= cda_size)
439 cf = crypt_data_array[fd].recv;
441 unsigned char *tmp = para_malloc(size);
442 void *private = crypt_data_array[fd].private_data;
443 n = recv(fd, tmp, size, 0);
446 unsigned char *b = (unsigned char *)buf;
447 (*cf)(numbytes, tmp, b, private);
451 n = recv(fd, buf, size, 0);
453 return -ERRNO_TO_PARA_ERROR(errno);
458 * Receive, decrypt and write terminating NULL byte.
460 * \param fd The file descriptor.
461 * \param buf The buffer to write the decrypted data to.
462 * \param size The size of \a buf.
464 * Read and decrypt at most \a size - 1 bytes from file descriptor \a fd and
465 * write a NULL byte at the end of the received data.
467 * \return The return value of the underlying call to \a recv_bin_buffer().
469 * \sa recv_bin_buffer()
471 int recv_buffer(int fd, char *buf, size_t size)
476 n = recv_bin_buffer(fd, buf, size - 1);
485 * Establish a tcp connection.
487 * \param host Hostname or IPv4 address.
488 * \param port The tcp port.
490 * \return Negative on errors, a valid file descriptor on success.
492 int tcp_connect(char *host, int port)
494 struct sockaddr_in addr;
498 PARA_INFO_LOG("getting host info of %s\n", host);
499 /* FIXME: gethostbyname() is obsolete */
500 he = gethostbyname(host);
502 return -ERRNO_TO_PARA_ERROR(h_errno);
503 init_sockaddr(&addr, port, he);
504 ret = get_stream_socket(AF_INET);
508 ret = PARA_CONNECT(fd, &addr);
516 * A wrapper around socket(2).
518 * \param domain The communication domain that selects the protocol family.
520 * Create an IPv4 socket for sequenced, reliable, two-way, connection-based
523 * \return The socket fd on success, negative on errors.
527 int get_stream_socket(int domain)
529 int fd = socket(domain, SOCK_STREAM, 0);
532 return -ERRNO_TO_PARA_ERROR(errno);
537 * Wrapper around the accept system call.
539 * \param fd The listening socket.
540 * \param addr Structure which is filled in with the address of the peer socket.
541 * \param size Should contain the size of the structure pointed to by \a addr.
543 * Accept incoming connections on \a addr. Retry if interrupted.
545 * \return The new file descriptor on success, negative on errors.
549 int para_accept(int fd, void *addr, socklen_t size)
554 new_fd = accept(fd, (struct sockaddr *) addr, &size);
555 while (new_fd < 0 && errno == EINTR);
556 return new_fd < 0? -ERRNO_TO_PARA_ERROR(errno) : new_fd;
560 * prepare a structure for \p AF_UNIX socket addresses
562 * \param u pointer to the struct to be prepared
563 * \param name the socket pathname
565 * This just copies \a name to the sun_path component of \a u.
567 * \return Positive on success, \p -E_NAME_TOO_LONG if \a name is longer
568 * than \p UNIX_PATH_MAX.
570 int init_unix_addr(struct sockaddr_un *u, const char *name)
572 if (strlen(name) >= UNIX_PATH_MAX)
573 return -E_NAME_TOO_LONG;
574 memset(u->sun_path, 0, UNIX_PATH_MAX);
575 u->sun_family = PF_UNIX;
576 strcpy(u->sun_path, name);
581 * Prepare, create, and bind a socket for local communication.
583 * \param name The socket pathname.
584 * \param unix_addr Pointer to the \p AF_UNIX socket structure.
585 * \param mode The desired mode of the socket.
587 * This functions creates a local socket for sequenced, reliable,
588 * two-way, connection-based byte streams.
590 * \return The file descriptor, on success, negative on errors.
596 int create_local_socket(const char *name, struct sockaddr_un *unix_addr,
601 ret = init_unix_addr(unix_addr, name);
604 ret = socket(PF_UNIX, SOCK_STREAM, 0);
606 return -ERRNO_TO_PARA_ERROR(errno);
608 ret = bind(fd, (struct sockaddr *) unix_addr, UNIX_PATH_MAX);
610 ret = -ERRNO_TO_PARA_ERROR(errno);
614 if (chmod(name, mode) < 0)
623 ssize_t send_cred_buffer(int sock, char *buf)
625 return send_buffer(sock, buf);
627 int recv_cred_buffer(int fd, char *buf, size_t size)
629 return recv_buffer(fd, buf, size) > 0? 1 : -E_RECVMSG;
631 #else /* HAVE_UCRED */
633 * send NULL terminated buffer and Unix credentials of the current process
635 * \param sock the socket file descriptor
636 * \param buf the buffer to be sent
638 * \return On success, this call returns the number of characters sent. On
639 * error, \p -E_SENDMSG is returned.
641 * \sa okir's Black Hats Manual
644 ssize_t send_cred_buffer(int sock, char *buf)
646 char control[sizeof(struct cmsghdr) + 10];
648 struct cmsghdr *cmsg;
649 static struct iovec iov;
655 iov.iov_len = strlen(buf);
659 /* compose the message */
660 memset(&msg, 0, sizeof(msg));
663 msg.msg_control = control;
664 msg.msg_controllen = sizeof(control);
665 /* attach the ucred struct */
666 cmsg = CMSG_FIRSTHDR(&msg);
667 cmsg->cmsg_level = SOL_SOCKET;
668 cmsg->cmsg_type = SCM_CREDENTIALS;
669 cmsg->cmsg_len = CMSG_LEN(sizeof(struct ucred));
670 *(struct ucred *)CMSG_DATA(cmsg) = c;
671 msg.msg_controllen = cmsg->cmsg_len;
672 ret = sendmsg(sock, &msg, 0);
678 static void dispose_fds(int *fds, unsigned num)
682 for (i = 0; i < num; i++)
687 * receive a buffer and the Unix credentials of the sending process
689 * \param fd the socket file descriptor
690 * \param buf the buffer to store the message
691 * \param size the size of \a buffer
693 * \return negative on errors, the user id on success.
695 * \sa okir's Black Hats Manual
698 int recv_cred_buffer(int fd, char *buf, size_t size)
702 struct cmsghdr *cmsg;
708 setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &yes, sizeof(int));
709 memset(&msg, 0, sizeof(msg));
710 memset(buf, 0, size);
715 msg.msg_control = control;
716 msg.msg_controllen = sizeof(control);
717 if (recvmsg(fd, &msg, 0) < 0)
719 result = -E_SCM_CREDENTIALS;
720 cmsg = CMSG_FIRSTHDR(&msg);
722 if (cmsg->cmsg_level == SOL_SOCKET && cmsg->cmsg_type
723 == SCM_CREDENTIALS) {
724 memcpy(&cred, CMSG_DATA(cmsg), sizeof(struct ucred));
727 if (cmsg->cmsg_level == SOL_SOCKET
728 && cmsg->cmsg_type == SCM_RIGHTS) {
729 dispose_fds((int *) CMSG_DATA(cmsg),
730 (cmsg->cmsg_len - CMSG_LEN(0))
733 cmsg = CMSG_NXTHDR(&msg, cmsg);
737 #endif /* HAVE_UCRED */
740 * Create a tcp socket, bind it and listen on the given port.
742 * \param port The tcp port to listen on.
744 * \return The file descriptor of the created socket, negative on errors.
746 * \sa get_stream_socket()
751 int tcp_listen(int port)
753 struct sockaddr_in my_addr;
754 int fd, ret = get_stream_socket(AF_INET);
760 ret = setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &ret, sizeof(int));
762 ret = -ERRNO_TO_PARA_ERROR(errno);
765 init_sockaddr(&my_addr, port, NULL);
766 ret = bind(fd, (struct sockaddr *)&my_addr, sizeof(struct sockaddr));
768 ret = -ERRNO_TO_PARA_ERROR(errno);
771 ret = listen(fd, BACKLOG);
773 ret = -ERRNO_TO_PARA_ERROR(errno);
776 PARA_INFO_LOG("listening on port %d, fd %d\n", port, fd);
784 * receive a buffer and check for a pattern
786 * \param fd the file descriptor to receive from
787 * \param pattern the expected pattern
788 * \param bufsize the size of the internal buffer
790 * \return Positive if \a pattern was received, negative otherwise.
792 * This function creates a buffer of size \a bufsize and tries
793 * to receive at most \a bufsize bytes from file descriptor \a fd.
794 * If at least \p strlen(\a pattern) bytes were received, the beginning of
795 * the received buffer is compared with \a pattern, ignoring case.
800 int recv_pattern(int fd, const char *pattern, size_t bufsize)
802 size_t len = strlen(pattern);
803 char *buf = para_malloc(bufsize + 1);
804 int ret = -E_RECV_PATTERN, n = recv_buffer(fd, buf, bufsize);
808 if (strncasecmp(buf, pattern, len))
813 PARA_NOTICE_LOG("n = %d, did not receive pattern '%s'\n", n, pattern);
815 PARA_NOTICE_LOG("recvd: %s\n", buf);