src/nat/nat_mini.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file nat/nat_mini.c
  23  * @brief functions for interaction with miniupnp; tested with miniupnpc 1.5
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_nat_lib.h"
  29 #include "nat.h"
  30
  31 #define LOG(kind,...) GNUNET_log_from (kind, "nat", __VA_ARGS__)
  32
  33 /**
  34  * How long do we give upnpc to create a mapping?
  35  */
  36 #define MAP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
  37
  38 /**
  39  * How long do we give upnpc to remove a mapping?
  40  */
  41 #define UNMAP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
  42
  43 /**
  44  * How often do we check for changes in the mapping?
  45  */
  46 #define MAP_REFRESH_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
  47
  48
  49
  50 /**
  51  * Opaque handle to cancel "GNUNET_NAT_mini_get_external_ipv4" operation.
  52  */
  53 struct GNUNET_NAT_ExternalHandle
  54 {
  55
  56   /**
  57    * Function to call with the result.
  58    */
  59   GNUNET_NAT_IPCallback cb;
  60
  61   /**
  62    * Closure for 'cb'.
  63    */
  64   void *cb_cls;
  65
  66   /**
  67    * Read task.
  68    */
  69   GNUNET_SCHEDULER_TaskIdentifier task;
  70
  71   /**
  72    * Handle to 'external-ip' process.
  73    */
  74   struct GNUNET_OS_Process *eip;
  75
  76   /**
  77    * Handle to stdout pipe of 'external-ip'.
  78    */
  79   struct GNUNET_DISK_PipeHandle *opipe;
  80
  81   /**
  82    * Read handle of 'opipe'.
  83    */
  84   const struct GNUNET_DISK_FileHandle *r;
  85
  86   /**
  87    * When should this operation time out?
  88    */
  89   struct GNUNET_TIME_Absolute timeout;
  90
  91   /**
  92    * Number of bytes in 'buf' that are valid.
  93    */
  94   size_t off;
  95
  96   /**
  97    * Destination of our read operation (output of 'external-ip').
  98    */
  99   char buf[17];
 100
 101 };
 102
 103
 104 /**
 105  * Read the output of 'external-ip' into buf.  When complete, parse the
 106  * address and call our callback.
 107  *
 108  * @param cls the 'struct GNUNET_NAT_ExternalHandle'
 109  * @param tc scheduler context
 110  */
 111 static void
 112 read_external_ipv4 (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 113 {
 114   struct GNUNET_NAT_ExternalHandle *eh = cls;
 115   ssize_t ret;
 116   struct in_addr addr;
 117   int iret;
 118
 119   eh->task = GNUNET_SCHEDULER_NO_TASK;
 120   if (GNUNET_YES == GNUNET_NETWORK_fdset_handle_isset (tc->read_ready, eh->r))
 121     ret =
 122         GNUNET_DISK_file_read (eh->r, &eh->buf[eh->off],
 123                                sizeof (eh->buf) - eh->off);
 124   else
 125     ret = -1;                   /* error reading, timeout, etc. */
 126   if (ret > 0)
 127   {
 128     /* try to read more */
 129     eh->off += ret;
 130     eh->task =
 131         GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_absolute_get_remaining
 132                                         (eh->timeout), eh->r,
 133                                         &read_external_ipv4, eh);
 134     return;
 135   }
 136   iret = GNUNET_NO;
 137   if ((eh->off > 7) && (eh->buf[eh->off - 1] == '\n'))
 138   {
 139     eh->buf[eh->off - 1] = '\0';
 140     if (1 == inet_pton (AF_INET, eh->buf, &addr))
 141     {
 142       if (addr.s_addr == 0)
 143         iret = GNUNET_NO;       /* got 0.0.0.0 */
 144       else
 145         iret = GNUNET_OK;
 146     }
 147   }
 148   eh->cb (eh->cb_cls, (iret == GNUNET_OK) ? &addr : NULL);
 149   GNUNET_NAT_mini_get_external_ipv4_cancel (eh);
 150 }
 151
 152
 153 /**
 154  * Try to get the external IPv4 address of this peer.
 155  *
 156  * @param timeout when to fail
 157  * @param cb function to call with result
 158  * @param cb_cls closure for 'cb'
 159  * @return handle for cancellation (can only be used until 'cb' is called), NULL on error
 160  */
 161 struct GNUNET_NAT_ExternalHandle *
 162 GNUNET_NAT_mini_get_external_ipv4 (struct GNUNET_TIME_Relative timeout,
 163                                    GNUNET_NAT_IPCallback cb, void *cb_cls)
 164 {
 165   struct GNUNET_NAT_ExternalHandle *eh;
 166
 167   if (GNUNET_SYSERR == GNUNET_OS_check_helper_binary ("external-ip"))
 168     return NULL;
 169   eh = GNUNET_malloc (sizeof (struct GNUNET_NAT_ExternalHandle));
 170   eh->cb = cb;
 171   eh->cb_cls = cb_cls;
 172   eh->opipe = GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_NO, GNUNET_YES);
 173   if (NULL == eh->opipe)
 174   {
 175     GNUNET_free (eh);
 176     return NULL;
 177   }
 178   eh->eip =
 179     GNUNET_OS_start_process (GNUNET_NO, 0, NULL, eh->opipe, "external-ip", "external-ip",
 180                                NULL);
 181   if (NULL == eh->eip)
 182   {
 183     GNUNET_DISK_pipe_close (eh->opipe);
 184     GNUNET_free (eh);
 185     return NULL;
 186   }
 187   GNUNET_DISK_pipe_close_end (eh->opipe, GNUNET_DISK_PIPE_END_WRITE);
 188   eh->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 189   eh->r = GNUNET_DISK_pipe_handle (eh->opipe, GNUNET_DISK_PIPE_END_READ);
 190   eh->task =
 191       GNUNET_SCHEDULER_add_read_file (timeout, eh->r, &read_external_ipv4, eh);
 192   return eh;
 193 }
 194
 195
 196 /**
 197  * Cancel operation.
 198  *
 199  * @param eh operation to cancel
 200  */
 201 void
 202 GNUNET_NAT_mini_get_external_ipv4_cancel (struct GNUNET_NAT_ExternalHandle *eh)
 203 {
 204   (void) GNUNET_OS_process_kill (eh->eip, SIGKILL);
 205   GNUNET_OS_process_destroy (eh->eip);
 206   GNUNET_DISK_pipe_close (eh->opipe);
 207   if (GNUNET_SCHEDULER_NO_TASK != eh->task)
 208     GNUNET_SCHEDULER_cancel (eh->task);
 209   GNUNET_free (eh);
 210 }
 211
 212
 213 /**
 214  * Handle to a mapping created with upnpc.
 215  */
 216 struct GNUNET_NAT_MiniHandle
 217 {
 218
 219   /**
 220    * Function to call on mapping changes.
 221    */
 222   GNUNET_NAT_AddressCallback ac;
 223
 224   /**
 225    * Closure for 'ac'.
 226    */
 227   void *ac_cls;
 228
 229   /**
 230    * Command used to install the map.
 231    */
 232   struct GNUNET_OS_CommandHandle *map_cmd;
 233
 234   /**
 235    * Command used to refresh our map information.
 236    */
 237   struct GNUNET_OS_CommandHandle *refresh_cmd;
 238
 239   /**
 240    * Command used to remove the mapping.
 241    */
 242   struct GNUNET_OS_CommandHandle *unmap_cmd;
 243
 244   /**
 245    * Our current external mapping (if we have one).
 246    */
 247   struct sockaddr_in current_addr;
 248
 249   /**
 250    * We check the mapping periodically to see if it
 251    * still works.  This task triggers the check.
 252    */
 253   GNUNET_SCHEDULER_TaskIdentifier refresh_task;
 254
 255   /**
 256    * Are we mapping TCP or UDP?
 257    */
 258   int is_tcp;
 259
 260   /**
 261    * Did we succeed with creating a mapping?
 262    */
 263   int did_map;
 264
 265   /**
 266    * Did we find our mapping during refresh scan?
 267    */
 268   int found;
 269
 270   /**
 271    * Which port are we mapping?
 272    */
 273   uint16_t port;
 274
 275 };
 276
 277
 278 /**
 279  * Run upnpc -l to find out if our mapping changed.
 280  *
 281  * @param cls the 'struct GNUNET_NAT_MiniHandle'
 282  * @param tc scheduler context
 283  */
 284 static void
 285 do_refresh (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 286
 287
 288 /**
 289  * Process the output from the 'upnpc -r' command.
 290  *
 291  * @param cls the 'struct GNUNET_NAT_MiniHandle'
 292  * @param line line of output, NULL at the end
 293  */
 294 static void
 295 process_map_output (void *cls, const char *line);
 296
 297
 298 /**
 299  * Process the output from 'upnpc -l' to see if our
 300  * external mapping changed.  If so, do the notifications.
 301  *
 302  * @param cls the 'struct GNUNET_NAT_MiniHandle'
 303  * @param line line of output, NULL at the end
 304  */
 305 static void
 306 process_refresh_output (void *cls, const char *line)
 307 {
 308   struct GNUNET_NAT_MiniHandle *mini = cls;
 309   char pstr[9];
 310   const char *s;
 311   unsigned int nport;
 312   struct in_addr exip;
 313
 314   if (NULL == line)
 315   {
 316     GNUNET_OS_command_stop (mini->refresh_cmd);
 317     mini->refresh_cmd = NULL;
 318     if (mini->found == GNUNET_NO)
 319     {
 320       /* mapping disappeared, try to re-create */
 321       if (mini->did_map)
 322       {
 323         mini->ac (mini->ac_cls, GNUNET_NO,
 324                   (const struct sockaddr *) &mini->current_addr,
 325                   sizeof (mini->current_addr));
 326         mini->did_map = GNUNET_NO;
 327       }
 328       GNUNET_snprintf (pstr, sizeof (pstr), "%u", (unsigned int) mini->port);
 329       mini->map_cmd =
 330           GNUNET_OS_command_run (&process_map_output, mini, MAP_TIMEOUT,
 331                                  "upnpc", "upnpc", "-r", pstr,
 332                                  mini->is_tcp ? "tcp" : "udp", NULL);
 333       if (NULL != mini->map_cmd)
 334         return;
 335     }
 336     mini->refresh_task =
 337         GNUNET_SCHEDULER_add_delayed (MAP_REFRESH_FREQ, &do_refresh, mini);
 338     return;
 339   }
 340   if (!mini->did_map)
 341     return;                     /* never mapped, won't find our mapping anyway */
 342
 343   /* we're looking for output of the form:
 344    * "ExternalIPAddress = 12.134.41.124" */
 345
 346   s = strstr (line, "ExternalIPAddress = ");
 347   if (NULL != s)
 348   {
 349     s += strlen ("ExternalIPAddress = ");
 350     if (1 != inet_pton (AF_INET, s, &exip))
 351       return;                   /* skip */
 352     if (exip.s_addr == mini->current_addr.sin_addr.s_addr)
 353       return;                   /* no change */
 354     /* update mapping */
 355     mini->ac (mini->ac_cls, GNUNET_NO,
 356               (const struct sockaddr *) &mini->current_addr,
 357               sizeof (mini->current_addr));
 358     mini->current_addr.sin_addr = exip;
 359     mini->ac (mini->ac_cls, GNUNET_YES,
 360               (const struct sockaddr *) &mini->current_addr,
 361               sizeof (mini->current_addr));
 362     return;
 363   }
 364   /*
 365    * we're looking for output of the form:
 366    *
 367    * "0 TCP  3000->192.168.2.150:3000  'libminiupnpc' ''"
 368    * "1 UDP  3001->192.168.2.150:3001  'libminiupnpc' ''"
 369    *
 370    * the pattern we look for is:
 371    *
 372    * "%s TCP  PORT->STRING:OURPORT *" or
 373    * "%s UDP  PORT->STRING:OURPORT *"
 374    */
 375   GNUNET_snprintf (pstr, sizeof (pstr), ":%u ", mini->port);
 376   if (NULL == (s = strstr (line, "->")))
 377     return;                     /* skip */
 378   if (NULL == strstr (s, pstr))
 379     return;                     /* skip */
 380   if (1 !=
 381       SSCANF (line,
 382               (mini->is_tcp) ? "%*u TCP  %u->%*s:%*u %*s" :
 383               "%*u UDP  %u->%*s:%*u %*s", &nport))
 384     return;                     /* skip */
 385   mini->found = GNUNET_YES;
 386   if (nport == ntohs (mini->current_addr.sin_port))
 387     return;                     /* no change */
 388
 389   /* external port changed, update mapping */
 390   mini->ac (mini->ac_cls, GNUNET_NO,
 391             (const struct sockaddr *) &mini->current_addr,
 392             sizeof (mini->current_addr));
 393   mini->current_addr.sin_port = htons ((uint16_t) nport);
 394   mini->ac (mini->ac_cls, GNUNET_YES,
 395             (const struct sockaddr *) &mini->current_addr,
 396             sizeof (mini->current_addr));
 397 }
 398
 399
 400 /**
 401  * Run upnpc -l to find out if our mapping changed.
 402  *
 403  * @param cls the 'struct GNUNET_NAT_MiniHandle'
 404  * @param tc scheduler context
 405  */
 406 static void
 407 do_refresh (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 408 {
 409   struct GNUNET_NAT_MiniHandle *mini = cls;
 410
 411   mini->refresh_task = GNUNET_SCHEDULER_NO_TASK;
 412   mini->found = GNUNET_NO;
 413   mini->refresh_cmd =
 414       GNUNET_OS_command_run (&process_refresh_output, mini, MAP_TIMEOUT,
 415                              "upnpc", "upnpc", "-l", NULL);
 416 }
 417
 418
 419 /**
 420  * Process the output from the 'upnpc -r' command.
 421  *
 422  * @param cls the 'struct GNUNET_NAT_MiniHandle'
 423  * @param line line of output, NULL at the end
 424  */
 425 static void
 426 process_map_output (void *cls, const char *line)
 427 {
 428   struct GNUNET_NAT_MiniHandle *mini = cls;
 429   const char *ipaddr;
 430   char *ipa;
 431   const char *pstr;
 432   unsigned int port;
 433
 434   if (NULL == line)
 435   {
 436     GNUNET_OS_command_stop (mini->map_cmd);
 437     mini->map_cmd = NULL;
 438     mini->refresh_task =
 439         GNUNET_SCHEDULER_add_delayed (MAP_REFRESH_FREQ, &do_refresh, mini);
 440     return;
 441   }
 442   /*
 443    * The upnpc output we're after looks like this:
 444    *
 445    * "external 87.123.42.204:3000 TCP is redirected to internal 192.168.2.150:3000"
 446    */
 447   if ((NULL == (ipaddr = strstr (line, " "))) ||
 448       (NULL == (pstr = strstr (ipaddr, ":"))) ||
 449       (1 != SSCANF (pstr + 1, "%u", &port)))
 450   {
 451     return;                     /* skip line */
 452   }
 453   ipa = GNUNET_strdup (ipaddr + 1);
 454   strstr (ipa, ":")[0] = '\0';
 455   if (1 != inet_pton (AF_INET, ipa, &mini->current_addr.sin_addr))
 456   {
 457     GNUNET_free (ipa);
 458     return;                     /* skip line */
 459   }
 460   GNUNET_free (ipa);
 461
 462   mini->current_addr.sin_port = htons (port);
 463   mini->current_addr.sin_family = AF_INET;
 464 #if HAVE_SOCKADDR_IN_SIN_LEN
 465   mini->current_addr.sin_len = sizeof (struct sockaddr_in);
 466 #endif
 467   mini->did_map = GNUNET_YES;
 468   mini->ac (mini->ac_cls, GNUNET_YES,
 469             (const struct sockaddr *) &mini->current_addr,
 470             sizeof (mini->current_addr));
 471 }
 472
 473
 474 /**
 475  * Start mapping the given port using (mini)upnpc.  This function
 476  * should typically not be used directly (it is used within the
 477  * general-purpose 'GNUNET_NAT_register' code).  However, it can be
 478  * used if specifically UPnP-based NAT traversal is to be used or
 479  * tested.
 480  *
 481  * @param port port to map
 482  * @param is_tcp GNUNET_YES to map TCP, GNUNET_NO for UDP
 483  * @param ac function to call with mapping result
 484  * @param ac_cls closure for 'ac'
 485  * @return NULL on error (no 'upnpc' installed)
 486  */
 487 struct GNUNET_NAT_MiniHandle *
 488 GNUNET_NAT_mini_map_start (uint16_t port, int is_tcp,
 489                            GNUNET_NAT_AddressCallback ac, void *ac_cls)
 490 {
 491   struct GNUNET_NAT_MiniHandle *ret;
 492   char pstr[6];
 493
 494   if (GNUNET_SYSERR == GNUNET_OS_check_helper_binary ("upnpc"))
 495     return NULL;
 496   ret = GNUNET_malloc (sizeof (struct GNUNET_NAT_MiniHandle));
 497   ret->ac = ac;
 498   ret->ac_cls = ac_cls;
 499   ret->is_tcp = is_tcp;
 500   ret->port = port;
 501   GNUNET_snprintf (pstr, sizeof (pstr), "%u", (unsigned int) port);
 502   ret->map_cmd =
 503       GNUNET_OS_command_run (&process_map_output, ret, MAP_TIMEOUT, "upnpc",
 504                              "upnpc", "-r", pstr, is_tcp ? "tcp" : "udp", NULL);
 505   if (NULL != ret->map_cmd)
 506     return ret;
 507   ret->refresh_task =
 508       GNUNET_SCHEDULER_add_delayed (MAP_REFRESH_FREQ, &do_refresh, ret);
 509
 510   return ret;
 511 }
 512
 513
 514 /**
 515  * Process output from our 'unmap' command.
 516  *
 517  * @param cls the 'struct GNUNET_NAT_MiniHandle'
 518  * @param line line of output, NULL at the end
 519  */
 520 static void
 521 process_unmap_output (void *cls, const char *line)
 522 {
 523   struct GNUNET_NAT_MiniHandle *mini = cls;
 524
 525   if (NULL == line)
 526   {
 527     LOG (GNUNET_ERROR_TYPE_DEBUG, "UPnP unmap done\n");
 528     GNUNET_OS_command_stop (mini->unmap_cmd);
 529     mini->unmap_cmd = NULL;
 530     GNUNET_free (mini);
 531     return;
 532   }
 533   /* we don't really care about the output... */
 534 }
 535
 536
 537 /**
 538  * Remove a mapping created with (mini)upnpc.  Calling
 539  * this function will give 'upnpc' 1s to remove tha mapping,
 540  * so while this function is non-blocking, a task will be
 541  * left with the scheduler for up to 1s past this call.
 542  *
 543  * @param mini the handle
 544  */
 545 void
 546 GNUNET_NAT_mini_map_stop (struct GNUNET_NAT_MiniHandle *mini)
 547 {
 548   char pstr[6];
 549
 550   if (GNUNET_SCHEDULER_NO_TASK != mini->refresh_task)
 551   {
 552     GNUNET_SCHEDULER_cancel (mini->refresh_task);
 553     mini->refresh_task = GNUNET_SCHEDULER_NO_TASK;
 554   }
 555   if (mini->refresh_cmd != NULL)
 556   {
 557     GNUNET_OS_command_stop (mini->refresh_cmd);
 558     mini->refresh_cmd = NULL;
 559   }
 560   if (!mini->did_map)
 561   {
 562     if (mini->map_cmd != NULL)
 563     {
 564       GNUNET_OS_command_stop (mini->map_cmd);
 565       mini->map_cmd = NULL;
 566     }
 567     GNUNET_free (mini);
 568     return;
 569   }
 570   mini->ac (mini->ac_cls, GNUNET_NO,
 571             (const struct sockaddr *) &mini->current_addr,
 572             sizeof (mini->current_addr));
 573   /* Note: oddly enough, deletion uses the external port whereas
 574    * addition uses the internal port; this rarely matters since they
 575    * often are the same, but it might... */
 576   GNUNET_snprintf (pstr, sizeof (pstr), "%u",
 577                    (unsigned int) ntohs (mini->current_addr.sin_port));
 578   LOG (GNUNET_ERROR_TYPE_DEBUG, "Unmapping port %u with UPnP\n",
 579        ntohs (mini->current_addr.sin_port));
 580   mini->unmap_cmd =
 581       GNUNET_OS_command_run (&process_unmap_output, mini, UNMAP_TIMEOUT,
 582                              "upnpc", "upnpc", "-d", pstr,
 583                              mini->is_tcp ? "tcp" : "udp", NULL);
 584 }
 585
 586
 587 /* end of nat_mini.c */