libatalk/util/socket.c

   1 /*
   2    Copyright (c) 2009 Frank Lahm <franklahm@gmail.com>
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13 */
  14
  15 /*!
  16  * @file
  17  * Netatalk utility functions
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #include "config.h"
  22 #endif /* HAVE_CONFIG_H */
  23
  24 #include <unistd.h>
  25 #include <fcntl.h>
  26 #include <sys/types.h>
  27 #include <sys/socket.h>
  28 #include <arpa/inet.h>
  29 #include <netinet/in.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32 #include <errno.h>
  33 #include <sys/time.h>
  34 #include <time.h>
  35
  36 #include <atalk/logger.h>
  37
  38 static char ipv4mapprefix[] = {0,0,0,0,0,0,0,0,0,0,0xff,0xff};
  39
  40 /*!
  41  * @brief set or unset non-blocking IO on a fd
  42  *
  43  * @param     fd         (r) File descriptor
  44  * @param     cmd        (r) 0: disable non-blocking IO, ie block\n
  45  *                           <>0: enable non-blocking IO
  46  *
  47  * @returns   0 on success, -1 on failure
  48  */
  49 int setnonblock(int fd, int cmd)
  50 {
  51     int ofdflags;
  52     int fdflags;
  53
  54     if ((fdflags = ofdflags = fcntl(fd, F_GETFL, 0)) == -1)
  55         return -1;
  56
  57     if (cmd)
  58         fdflags |= O_NONBLOCK;
  59     else
  60         fdflags &= ~O_NONBLOCK;
  61
  62     if (fdflags != ofdflags)
  63         if (fcntl(fd, F_SETFL, fdflags) == -1)
  64             return -1;
  65
  66     return 0;
  67 }
  68
  69 /*!
  70  * non-blocking drop-in replacement for read with timeout using select
  71  *
  72  * @param socket          (r)  socket, if in blocking mode, pass "setnonblocking" arg as 1
  73  * @param data            (rw) buffer for the read data
  74  * @param lenght          (r)  how many bytes to read
  75  * @param setnonblocking  (r)  when non-zero this func will enable and disable non blocking
  76  *                             io mode for the socket
  77  * @param timeout         (r)  number of seconds to try reading
  78  *
  79  * @returns number of bytes actually read or -1 on fatal error
  80  */
  81 ssize_t readt(int socket, void *data, const size_t length, int setnonblocking, int timeout)
  82 {
  83     size_t stored;
  84     ssize_t len;
  85     struct timeval now, end, tv;
  86     fd_set rfds;
  87     int ret;
  88
  89     stored = 0;
  90
  91     if (setnonblocking) {
  92         if (setnonblock(socket, 1) != 0)
  93             return -1;
  94     }
  95
  96     /* Calculate end time */
  97     (void)gettimeofday(&now, NULL);
  98     end = now;
  99     end.tv_sec += timeout;
 100
 101     while (stored < length) {
 102         len = read(socket, (char *) data + stored, length - stored);
 103         if (len == -1) {
 104             switch (errno) {
 105             case EINTR:
 106                 continue;
 107             case EAGAIN:
 108                 FD_ZERO(&rfds);
 109                 FD_SET(socket, &rfds);
 110                 tv.tv_usec = 0;
 111                 tv.tv_sec  = timeout;
 112
 113                 while ((ret = select(socket + 1, &rfds, NULL, NULL, &tv)) < 1) {
 114                     switch (ret) {
 115                     case 0:
 116                         LOG(log_warning, logtype_afpd, "select timeout %d s", timeout);
 117                         goto exit;
 118
 119                     default: /* -1 */
 120                         if (errno == EINTR) {
 121                             (void)gettimeofday(&now, NULL);
 122                             if (now.tv_sec >= end.tv_sec && now.tv_usec >= end.tv_usec) {
 123                                 LOG(log_warning, logtype_afpd, "select timeout %d s", timeout);
 124                                 goto exit;
 125                             }
 126                             if (now.tv_usec > end.tv_usec) {
 127                                 tv.tv_usec = 1000000 + end.tv_usec - now.tv_usec;
 128                                 tv.tv_sec  = end.tv_sec - now.tv_sec - 1;
 129                             } else {
 130                                 tv.tv_usec = end.tv_usec - now.tv_usec;
 131                                 tv.tv_sec  = end.tv_sec - now.tv_sec;
 132                             }
 133                             FD_ZERO(&rfds);
 134                             FD_SET(socket, &rfds);
 135                             continue;
 136                         }
 137                         LOG(log_error, logtype_afpd, "select: %s", strerror(errno));
 138                         stored = -1;
 139                         goto exit;
 140                     }
 141                 } /* while (select) */
 142                 continue;
 143             } /* switch (errno) */
 144             LOG(log_error, logtype_afpd, "read: %s", strerror(errno));
 145             stored = -1;
 146             goto exit;
 147         } /* (len == -1) */
 148         else if (len > 0)
 149             stored += len;
 150         else
 151             break;
 152     } /* while (stored < length) */
 153
 154 exit:
 155     if (setnonblocking) {
 156         if (setnonblock(socket, 0) != 0)
 157             return -1;
 158     }
 159
 160     if (len == -1 && stored == 0)
 161         /* last read or select got an error and we haven't got yet anything => return -1*/
 162         return -1;
 163     return stored;
 164 }
 165
 166 /*!
 167  * @brief convert an IPv4 or IPv6 address to a static string using inet_ntop
 168  *
 169  * IPv6 mapped IPv4 addresses are returned as IPv4 addreses eg
 170  * ::ffff:10.0.0.0 is returned as "10.0.0.0".
 171  *
 172  * @param  sa        (r) pointer to an struct sockaddr
 173  *
 174  * @returns pointer to a static string cotaining the converted address as string.\n
 175  *          On error pointers to "0.0.0.0" or "::0" are returned.
 176  */
 177 const char *getip_string(const struct sockaddr *sa)
 178 {
 179     static char ip4[INET_ADDRSTRLEN];
 180     static char ip6[INET6_ADDRSTRLEN];
 181
 182     switch (sa->sa_family) {
 183
 184     case AF_INET: {
 185         const struct sockaddr_in *sai4 = (const struct sockaddr_in *)sa;
 186         if ((inet_ntop(AF_INET, &(sai4->sin_addr), ip4, INET_ADDRSTRLEN)) == NULL)
 187             return "0.0.0.0";
 188         return ip4;
 189     }
 190     case AF_INET6: {
 191         const struct sockaddr_in6 *sai6 = (const struct sockaddr_in6 *)sa;
 192         if ((inet_ntop(AF_INET6, &(sai6->sin6_addr), ip6, INET6_ADDRSTRLEN)) == NULL)
 193             return "::0";
 194
 195         /* Deal with IPv6 mapped IPv4 addresses*/
 196         if ((memcmp(sai6->sin6_addr.s6_addr, ipv4mapprefix, sizeof(ipv4mapprefix))) == 0)
 197             return (strrchr(ip6, ':') + 1);
 198         return ip6;
 199     }
 200     default:
 201         return "getip_string ERROR";
 202     }
 203
 204     /* We never get here */
 205 }
 206
 207 /*!
 208  * @brief return port number from struct sockaddr
 209  *
 210  * @param  sa        (r) pointer to an struct sockaddr
 211  *
 212  * @returns port as unsigned int
 213  */
 214 unsigned int getip_port(const struct sockaddr  *sa)
 215 {
 216     if (sa->sa_family == AF_INET) { /* IPv4 */
 217         const struct sockaddr_in *sai4 = (const struct sockaddr_in *)sa;
 218         return ntohs(sai4->sin_port);
 219     } else {                       /* IPv6 */
 220         const struct sockaddr_in6 *sai6 = (const struct sockaddr_in6 *)sa;
 221         return ntohs(sai6->sin6_port);
 222     }
 223
 224     /* We never get here */
 225 }
 226
 227 /*!
 228  * @brief apply netmask to IP (v4 or v6)
 229  *
 230  * Modifies IP address in sa->sin[6]_addr-s[6]_addr. The caller is responsible
 231  * for passing a value for mask that is sensible to the passed address,
 232  * eg 0 <= mask <= 32 for IPv4 or 0<= mask <= 128 for IPv6. mask > 32 for
 233  * IPv4 is treated as mask = 32, mask > 128 is set to 128 for IPv6.
 234  *
 235  * @param  ai        (rw) pointer to an struct sockaddr
 236  * @parma  mask      (r) number of maskbits
 237  */
 238 void apply_ip_mask(struct sockaddr *sa, uint32_t mask)
 239 {
 240
 241     switch (sa->sa_family) {
 242     case AF_INET: {
 243         if (mask >= 32)
 244             return;
 245
 246         struct sockaddr_in *si = (struct sockaddr_in *)sa;
 247         uint32_t nmask = mask ? ~((1 << (32 - mask)) - 1) : 0;
 248         si->sin_addr.s_addr &= htonl(nmask);
 249         break;
 250     }
 251     case AF_INET6: {
 252         if (mask >= 128)
 253             return;
 254
 255         int i, maskbytes, maskbits;
 256         struct sockaddr_in6 *si6 = (struct sockaddr_in6 *)sa;
 257
 258         /* Deal with IPv6 mapped IPv4 addresses*/
 259         if ((memcmp(si6->sin6_addr.s6_addr, ipv4mapprefix, sizeof(ipv4mapprefix))) == 0) {
 260             mask += 96;
 261             if (mask >= 128)
 262                 return;
 263         }
 264
 265         maskbytes = (128 - mask) / 8; /* maskbytes really are those that will be 0'ed */
 266         maskbits = mask % 8;
 267
 268         for (i = maskbytes - 1; i >= 0; i--)
 269             si6->sin6_addr.s6_addr[15 - i] = 0;
 270         if (maskbits)
 271             si6->sin6_addr.s6_addr[15 - maskbytes] &= ~((1 << (8 - maskbits)) - 1);
 272         break;
 273     }
 274     default:
 275         break;
 276     }
 277 }
 278
 279 /*!
 280  * @brief compare IP addresses for equality
 281  *
 282  * @param  sa1       (r) pointer to an struct sockaddr
 283  * @param  sa2       (r) pointer to an struct sockaddr
 284  *
 285  * @returns Addresses are converted to strings and compared with strcmp and
 286  *          the result of strcmp is returned.
 287  *
 288  * @note IPv6 mapped IPv4 addresses are treated as IPv4 addresses.
 289  */
 290 int compare_ip(const struct sockaddr *sa1, const struct sockaddr *sa2)
 291 {
 292     int ret;
 293     char *ip1;
 294     const char *ip2;
 295
 296     ip1 = strdup(getip_string(sa1));
 297     ip2 = getip_string(sa2);
 298
 299     ret = strcmp(ip1, ip2);
 300
 301     free(ip1);
 302
 303     return ret;
 304 }