src/testbed/gnunet-daemon-testbed-underlay.c

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2008--2013 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18       Boston, MA 02110-1301, USA.
  19 */
  20
  21
  22 /**
  23  * @file testbed/gnunet-daemon-testbed-blacklist.c
  24  * @brief daemon to restrict incoming connections from other peers at the
  25  *          transport layer of a peer
  26  * @author Sree Harsha Totakura <sreeharsha@totakura.in>
  27  */
  28
  29 #include "platform.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_transport_service.h"
  32 #include "gnunet_transport_manipulation_service.h"
  33 #include "gnunet_ats_service.h"
  34 #include "gnunet_testing_lib.h"
  35 #include <sqlite3.h>
  36
  37 /**
  38  * Logging shorthand
  39  */
  40 #define LOG(type,...)                           \
  41   GNUNET_log (type, __VA_ARGS__)
  42
  43 /**
  44  * Debug logging shorthand
  45  */
  46 #define DEBUG(...)                              \
  47   LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
  48
  49 /**
  50  * Log an error message at log-level 'level' that indicates
  51  * a failure of the command 'cmd' on file 'filename'
  52  * with the message given by strerror(errno).
  53  */
  54 #define LOG_SQLITE(db, msg, level, cmd)                                 \
  55   do {                                                                  \
  56     GNUNET_log_from (level, "sqlite", _("`%s' failed at %s:%d with error: %s\n"), \
  57                      cmd, __FILE__,__LINE__, sqlite3_errmsg(db));  \
  58     if (msg != NULL)                                                    \
  59       GNUNET_asprintf(msg, _("`%s' failed at %s:%u with error: %s"), cmd, \
  60                       __FILE__, __LINE__, sqlite3_errmsg(db));     \
  61   } while(0)
  62
  63
  64 /**
  65  * The map to store the peer identities to allow/deny
  66  */
  67 static struct GNUNET_CONTAINER_MultiPeerMap *map;
  68
  69 /**
  70  * The database connection
  71  */
  72 static struct sqlite3 *db;
  73
  74 /**
  75  * The blacklist handle we obtain from transport when we register ourselves for
  76  * access control
  77  */
  78 static struct GNUNET_TRANSPORT_Blacklist *bh;
  79
  80 /**
  81  * The hostkeys file
  82  */
  83 struct GNUNET_DISK_FileHandle *hostkeys_fd;
  84
  85 /**
  86  * The hostkeys map
  87  */
  88 static struct GNUNET_DISK_MapHandle *hostkeys_map;
  89
  90 /**
  91  * The hostkeys data
  92  */
  93 static void *hostkeys_data;
  94
  95 /**
  96  * Handle to the transport service.  This is used for setting link metrics
  97  */
  98 static struct GNUNET_TRANSPORT_ManipulationHandle *transport;
  99
 100 /**
 101  * The number of hostkeys in the hostkeys array
 102  */
 103 static unsigned int num_hostkeys;
 104
 105
 106 /**
 107  * @ingroup hashmap
 108  * Iterator over hash map entries.
 109  *
 110  * @param cls closure
 111  * @param key current key code
 112  * @param value value in the hash map
 113  * @return #GNUNET_YES if we should continue to
 114  *         iterate,
 115  *         #GNUNET_NO if not.
 116  */
 117 static int
 118 iterator (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
 119 {
 120   GNUNET_assert (GNUNET_YES == GNUNET_CONTAINER_multipeermap_remove (map, key,
 121                                                                      value));
 122   return GNUNET_YES;
 123 }
 124
 125
 126 /**
 127  * Cleaup and destroy the map
 128  */
 129 static void
 130 cleanup_map ()
 131 {
 132   if (NULL != map)
 133   {
 134     GNUNET_assert (GNUNET_SYSERR != GNUNET_CONTAINER_multipeermap_iterate (map,
 135                                                                            &iterator,
 136                                                                            NULL));
 137     GNUNET_CONTAINER_multipeermap_destroy (map);
 138     map = NULL;
 139   }
 140 }
 141
 142
 143 /**
 144  * Function that decides if a connection is acceptable or not.
 145  *
 146  * @param cls closure
 147  * @param pid peer to approve or disapproave
 148  * @return GNUNET_OK if the connection is allowed, GNUNET_SYSERR if not
 149  */
 150 static int
 151 check_access (void *cls, const struct GNUNET_PeerIdentity * pid)
 152 {
 153   int contains;
 154
 155   GNUNET_assert (NULL != map);
 156   contains = GNUNET_CONTAINER_multipeermap_contains (map, pid);
 157   if (GNUNET_YES == contains)
 158   {
 159     DEBUG ("Permitting `%s'\n", GNUNET_i2s (pid));
 160     return GNUNET_OK;
 161   }
 162   DEBUG ("Not permitting `%s'\n", GNUNET_i2s (pid));
 163   return GNUNET_SYSERR;
 164 }
 165
 166
 167 static int
 168 get_identity (unsigned int offset, struct GNUNET_PeerIdentity *id)
 169 {
 170   struct GNUNET_CRYPTO_EddsaPrivateKey private_key;
 171
 172   if (offset >= num_hostkeys)
 173     return GNUNET_SYSERR;
 174   GNUNET_memcpy (&private_key,
 175                  hostkeys_data + (offset * GNUNET_TESTING_HOSTKEYFILESIZE),
 176                  GNUNET_TESTING_HOSTKEYFILESIZE);
 177   GNUNET_CRYPTO_eddsa_key_get_public (&private_key, &id->public_key);
 178   return GNUNET_OK;
 179 }
 180
 181
 182 /**
 183  * Whilelist entry
 184  */
 185 struct WhiteListRow
 186 {
 187   /**
 188    * Next ptr
 189    */
 190   struct WhiteListRow *next;
 191
 192   /**
 193    * The offset where to find the hostkey for the peer
 194    */
 195   unsigned int id;
 196
 197   /**
 198    * Latency to be assigned to the link
 199    */
 200   int latency;
 201
 202 };
 203
 204
 205 /**
 206  * Function to load keys
 207  */
 208 static int
 209 load_keys (const struct GNUNET_CONFIGURATION_Handle *c)
 210 {
 211   char *data_dir;
 212   char *idfile;
 213   uint64_t fsize;
 214
 215   data_dir = NULL;
 216   idfile = NULL;
 217   fsize = 0;
 218   data_dir = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_DATADIR);
 219   GNUNET_asprintf (&idfile, "%s/testing_hostkeys.ecc", data_dir);
 220   GNUNET_free (data_dir);
 221   data_dir = NULL;
 222   if (GNUNET_OK !=
 223       GNUNET_DISK_file_size (idfile, &fsize, GNUNET_YES, GNUNET_YES))
 224   {
 225     GNUNET_free (idfile);
 226     return GNUNET_SYSERR;
 227   }
 228   if (0 != (fsize % GNUNET_TESTING_HOSTKEYFILESIZE))
 229   {
 230     LOG (GNUNET_ERROR_TYPE_ERROR,
 231          _("Incorrect hostkey file format: %s\n"), idfile);
 232     GNUNET_free (idfile);
 233     return GNUNET_SYSERR;
 234   }
 235   hostkeys_fd = GNUNET_DISK_file_open (idfile, GNUNET_DISK_OPEN_READ,
 236                                        GNUNET_DISK_PERM_NONE);
 237   if (NULL == hostkeys_fd)
 238   {
 239     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", idfile);
 240     GNUNET_free (idfile);
 241     return GNUNET_SYSERR;
 242   }
 243   GNUNET_free (idfile);
 244   idfile = NULL;
 245   hostkeys_data = GNUNET_DISK_file_map (hostkeys_fd,
 246                                         &hostkeys_map,
 247                                         GNUNET_DISK_MAP_TYPE_READ,
 248                                         fsize);
 249   if (NULL == hostkeys_data)
 250   {
 251
 252     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "mmap");
 253     return GNUNET_SYSERR;
 254   }
 255   num_hostkeys = fsize / GNUNET_TESTING_HOSTKEYFILESIZE;
 256   return GNUNET_OK;
 257 }
 258
 259
 260 /**
 261  * Function to unload keys
 262  */
 263 static void
 264 unload_keys ()
 265 {
 266   if (NULL != hostkeys_map)
 267   {
 268     GNUNET_assert (NULL != hostkeys_data);
 269     GNUNET_DISK_file_unmap (hostkeys_map);
 270     hostkeys_map = NULL;
 271     hostkeys_data = NULL;
 272   }
 273   if (NULL != hostkeys_fd)
 274   {
 275     GNUNET_DISK_file_close (hostkeys_fd);
 276     hostkeys_fd = NULL;
 277   }
 278 }
 279
 280
 281 /**
 282  * Shutdown task to cleanup our resources and exit.
 283  *
 284  * @param cls NULL
 285  */
 286 static void
 287 do_shutdown (void *cls)
 288 {
 289   if (NULL != transport)
 290   {
 291     GNUNET_TRANSPORT_manipulation_disconnect (transport);
 292     transport = NULL;
 293   }
 294   cleanup_map ();
 295   unload_keys ();
 296   if (NULL != bh)
 297     GNUNET_TRANSPORT_blacklist_cancel (bh);
 298 }
 299
 300
 301 /**
 302  * Function to read whitelist rows from the database
 303  *
 304  * @param db the database connection
 305  * @param pid the identity of this peer
 306  * @param wl_rows where to store the retrieved whitelist rows
 307  * @return GNUNET_SYSERR upon error OR the number of rows retrieved
 308  */
 309 static int
 310 db_read_whitelist (struct sqlite3 *db, int pid, struct WhiteListRow **wl_rows)
 311 {
 312   static const char *query_wl = "SELECT oid, latency FROM whitelist WHERE (id == ?);";
 313   struct sqlite3_stmt *stmt_wl;
 314   struct WhiteListRow *lr;
 315   int nrows;
 316   int ret;
 317
 318   if (SQLITE_OK != (ret = sqlite3_prepare_v2 (db, query_wl, -1, &stmt_wl, NULL)))
 319   {
 320     LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_prepare_v2");
 321     return GNUNET_SYSERR;
 322   }
 323   if (SQLITE_OK != (ret = sqlite3_bind_int (stmt_wl, 1, pid)))
 324   {
 325     LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_bind_int");
 326     sqlite3_finalize (stmt_wl);
 327     return GNUNET_SYSERR;
 328   }
 329   nrows = 0;
 330   do
 331   {
 332     ret = sqlite3_step (stmt_wl);
 333     if (SQLITE_ROW != ret)
 334       break;
 335     nrows++;
 336     lr = GNUNET_new (struct WhiteListRow);
 337     lr->id = sqlite3_column_int (stmt_wl, 0);
 338     lr->latency = sqlite3_column_int (stmt_wl, 1);
 339     lr->next = *wl_rows;
 340     *wl_rows = lr;
 341   } while (1);
 342   sqlite3_finalize (stmt_wl);
 343   return nrows;
 344 }
 345
 346
 347 /**
 348  * Main function that will be run.
 349  *
 350  * @param cls closure
 351  * @param args remaining command-line arguments
 352  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 353  * @param c configuration
 354  */
 355 static void
 356 run (void *cls, char *const *args, const char *cfgfile,
 357      const struct GNUNET_CONFIGURATION_Handle *c)
 358 {
 359   char *dbfile;
 360   struct WhiteListRow *wl_head;
 361   struct WhiteListRow *wl_entry;
 362   struct GNUNET_PeerIdentity identity;
 363   struct GNUNET_ATS_Properties prop;
 364   struct GNUNET_TIME_Relative delay;
 365   unsigned long long pid;
 366   unsigned int nrows;
 367   int ret;
 368
 369   if (GNUNET_OK !=
 370       GNUNET_CONFIGURATION_get_value_number (c, "TESTBED",
 371                                              "PEERID", &pid))
 372   {
 373     GNUNET_break (0);
 374     return;
 375   }
 376   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c, "TESTBED-UNDERLAY",
 377                                                             "DBFILE",
 378                                                             &dbfile))
 379   {
 380     GNUNET_break (0);
 381     return;
 382   }
 383   if (SQLITE_OK != (ret = sqlite3_open_v2 (dbfile, &db, SQLITE_OPEN_READONLY, NULL)))
 384   {
 385     if (NULL != db)
 386     {
 387       LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite_open_v2");
 388       GNUNET_break (SQLITE_OK == sqlite3_close (db));
 389     }
 390     else
 391       LOG (GNUNET_ERROR_TYPE_ERROR, "Cannot open sqlite file %s\n", dbfile);
 392     GNUNET_free (dbfile);
 393     return;
 394   }
 395   DEBUG ("Opened database %s\n", dbfile);
 396   GNUNET_free (dbfile);
 397   dbfile = NULL;
 398   wl_head = NULL;
 399   if (GNUNET_OK != load_keys (c))
 400       goto close_db;
 401
 402   transport = GNUNET_TRANSPORT_manipulation_connect (c);
 403   if (NULL == transport)
 404   {
 405     GNUNET_break (0);
 406     return;
 407   }
 408   /* read and process whitelist */
 409   nrows = 0;
 410   wl_head = NULL;
 411   nrows = db_read_whitelist (db, pid, &wl_head);
 412   if ((GNUNET_SYSERR == nrows) || (0 == nrows))
 413   {
 414     GNUNET_TRANSPORT_manipulation_disconnect (transport);
 415     goto close_db;
 416   }
 417   map = GNUNET_CONTAINER_multipeermap_create (nrows, GNUNET_NO);
 418   while (NULL != (wl_entry = wl_head))
 419   {
 420     wl_head = wl_entry->next;
 421     delay.rel_value_us = wl_entry->latency;
 422     memset (&prop, 0, sizeof (prop));
 423     GNUNET_assert (GNUNET_OK == get_identity (wl_entry->id, &identity));
 424     GNUNET_break (GNUNET_OK ==
 425                   GNUNET_CONTAINER_multipeermap_put (map, &identity, &identity,
 426                                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
 427     DEBUG ("Setting %u ms latency to peer `%s'\n",
 428            wl_entry->latency,
 429            GNUNET_i2s (&identity));
 430     GNUNET_TRANSPORT_manipulation_set (transport,
 431                                        &identity,
 432                                        &prop,
 433                                        delay,
 434                                        delay);
 435     GNUNET_free (wl_entry);
 436   }
 437   bh = GNUNET_TRANSPORT_blacklist (c, &check_access, NULL);
 438   GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
 439
 440  close_db:
 441   GNUNET_break (SQLITE_OK == sqlite3_close (db));
 442 }
 443
 444
 445 /**
 446  * The main function.
 447  *
 448  * @param argc number of arguments from the command line
 449  * @param argv command line arguments
 450  * @return 0 ok, 1 on error
 451  */
 452 int
 453 main (int argc, char *const *argv)
 454 {
 455   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 456     GNUNET_GETOPT_OPTION_END
 457   };
 458   int ret;
 459
 460   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 461     return 2;
 462 #ifdef SQLITE_CONFIG_MMAP_SIZE
 463   (void) sqlite3_config (SQLITE_CONFIG_MMAP_SIZE, 512000, 256000000);
 464 #endif
 465   ret =
 466       (GNUNET_OK ==
 467        GNUNET_PROGRAM_run (argc, argv, "testbed-underlay",
 468                            _
 469                            ("Daemon to restrict underlay network in testbed deployments"),
 470                            options, &run, NULL)) ? 0 : 1;
 471   GNUNET_free ((void*) argv);
 472   return ret;
 473 }