src/namestore/test_namestore_api_lookup_shadow_filter.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2012 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20 /**
  21  * @file namestore/test_namestore_api_lookup_shadow_filter.c
  22  * @brief testcase for namestore_api.c: store a record with short expiration
  23  *      and a shadow record, perform lookup:
  24  *      - when active record is valid, expect only active record
  25  *      - when active record is expired, expect shadow record only
  26  */
  27 #include "platform.h"
  28 #include "gnunet_namecache_service.h"
  29 #include "gnunet_namestore_service.h"
  30 #include "gnunet_testing_lib.h"
  31 #include "gnunet_dnsparser_lib.h"
  32
  33 #define TEST_RECORD_TYPE GNUNET_DNSPARSER_TYPE_TXT
  34
  35 #define TEST_NAME "dummy.dummy.gnunet"
  36 #define TEST_RECORD_DATALEN 123
  37 #define TEST_RECORD_DATA 'a'
  38 #define TEST_SHADOW_RECORD_DATA 'b'
  39
  40 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 100)
  41 #define EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  42
  43 static struct GNUNET_NAMESTORE_Handle *nsh;
  44
  45 static struct GNUNET_NAMECACHE_Handle *nch;
  46
  47 static struct GNUNET_SCHEDULER_Task *endbadly_task;
  48
  49 static struct GNUNET_SCHEDULER_Task *delayed_lookup_task;
  50
  51 static struct GNUNET_CRYPTO_EcdsaPrivateKey *privkey;
  52
  53 static struct GNUNET_CRYPTO_EcdsaPublicKey pubkey;
  54
  55 static int res;
  56
  57 static struct GNUNET_NAMESTORE_QueueEntry *nsqe;
  58
  59 static struct GNUNET_NAMECACHE_QueueEntry *ncqe;
  60
  61 static struct GNUNET_NAMECACHE_QueueEntry *ncqe_shadow;
  62
  63 static struct GNUNET_GNSRECORD_Data records[2];
  64
  65 static struct GNUNET_TIME_Absolute record_expiration;
  66
  67 static struct GNUNET_HashCode derived_hash;
  68
  69 static struct GNUNET_CRYPTO_EcdsaPublicKey pubkey;
  70
  71
  72 static void
  73 cleanup ()
  74 {
  75   if (NULL != nsh)
  76   {
  77     GNUNET_NAMESTORE_disconnect (nsh);
  78     nsh = NULL;
  79   }
  80   if (NULL != nch)
  81   {
  82     GNUNET_NAMECACHE_disconnect (nch);
  83     nch = NULL;
  84   }
  85   if (NULL != privkey)
  86   {
  87     GNUNET_free (privkey);
  88     privkey = NULL;
  89   }
  90   GNUNET_SCHEDULER_shutdown ();
  91 }
  92
  93
  94 /**
  95  * Re-establish the connection to the service.
  96  *
  97  * @param cls handle to use to re-connect.
  98  */
  99 static void
 100 endbadly (void *cls)
 101 {
 102   if (NULL != delayed_lookup_task)
 103   {
 104     GNUNET_SCHEDULER_cancel (delayed_lookup_task);
 105     delayed_lookup_task = NULL;
 106   }
 107   if (NULL != nsqe)
 108   {
 109     GNUNET_NAMESTORE_cancel (nsqe);
 110     nsqe = NULL;
 111   }
 112   if (NULL != ncqe)
 113   {
 114     GNUNET_NAMECACHE_cancel (ncqe);
 115     ncqe = NULL;
 116   }
 117   cleanup ();
 118   res = 1;
 119 }
 120
 121
 122 static void
 123 end (void *cls)
 124 {
 125   cleanup ();
 126   res = 0;
 127 }
 128
 129
 130 static void
 131 rd_decrypt_cb (void *cls,
 132                unsigned int rd_count,
 133                const struct GNUNET_GNSRECORD_Data *rd)
 134 {
 135   struct GNUNET_GNSRECORD_Data *expected_rd = cls;
 136   char rd_cmp_data[TEST_RECORD_DATALEN];
 137
 138   if (1 != rd_count)
 139   {
 140     GNUNET_SCHEDULER_add_now (&endbadly, NULL);
 141     GNUNET_break (0);
 142     return;
 143   }
 144   if (NULL == rd)
 145   {
 146     GNUNET_SCHEDULER_add_now (&endbadly, NULL);
 147     GNUNET_break (0);
 148     return;
 149   }
 150   if (expected_rd == &records[0])
 151   {
 152     /* Expecting active record */
 153     memset (rd_cmp_data, TEST_RECORD_DATA, TEST_RECORD_DATALEN);
 154     if (TEST_RECORD_TYPE != rd[0].record_type)
 155     {
 156       GNUNET_SCHEDULER_add_now (&endbadly, NULL);
 157       GNUNET_break (0);
 158       return;
 159     }
 160     if (TEST_RECORD_DATALEN != rd[0].data_size)
 161     {
 162       GNUNET_SCHEDULER_add_now (&endbadly, NULL);
 163       GNUNET_break (0);
 164       return;
 165     }
 166     if (0 != memcmp (&rd_cmp_data, rd[0].data, TEST_RECORD_DATALEN))
 167     {
 168       GNUNET_SCHEDULER_add_now (&endbadly, NULL);
 169       GNUNET_break (0);
 170       return;
 171     }
 172     if (0 != (GNUNET_GNSRECORD_RF_SHADOW_RECORD & rd[0].flags))
 173     {
 174       GNUNET_SCHEDULER_add_now (&endbadly, NULL);
 175       GNUNET_break (0);
 176       return;
 177     }
 178     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 179                 "Block was decrypted successfully with active record\n");
 180   }
 181   if (expected_rd == &records[1])
 182   {
 183     /* Expecting shadow record  but without shadow flag*/
 184     memset (rd_cmp_data, TEST_SHADOW_RECORD_DATA, TEST_RECORD_DATALEN);
 185     if (TEST_RECORD_TYPE != rd[0].record_type)
 186     {
 187       GNUNET_SCHEDULER_add_now (&endbadly, NULL);
 188       GNUNET_break (0);
 189       return;
 190     }
 191     if (TEST_RECORD_DATALEN != rd[0].data_size)
 192     {
 193       GNUNET_SCHEDULER_add_now (&endbadly, NULL);
 194       GNUNET_break (0);
 195       return;
 196     }
 197     if (0 != memcmp (&rd_cmp_data, rd[0].data, TEST_RECORD_DATALEN))
 198     {
 199       GNUNET_SCHEDULER_add_now (&endbadly, NULL);
 200       GNUNET_break (0);
 201       return;
 202     }
 203     if (0 != (GNUNET_GNSRECORD_RF_SHADOW_RECORD & rd[0].flags))
 204     {
 205       GNUNET_SCHEDULER_add_now (&endbadly, NULL);
 206       GNUNET_break (0);
 207       return;
 208     }
 209     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 210                 "Block was decrypted successfully with former shadow record \n");
 211     GNUNET_SCHEDULER_add_now (&end, NULL);
 212   }
 213 }
 214
 215
 216 static void
 217 name_lookup_active_proc (void *cls,
 218                          const struct GNUNET_GNSRECORD_Block *block)
 219 {
 220   struct GNUNET_GNSRECORD_Data *expected_rd = cls;
 221
 222   GNUNET_assert (NULL != expected_rd);
 223
 224   ncqe = NULL;
 225   ncqe_shadow = NULL;
 226   if (endbadly_task != NULL)
 227   {
 228     GNUNET_SCHEDULER_cancel (endbadly_task);
 229     endbadly_task = NULL;
 230   }
 231
 232   if (NULL == block)
 233   {
 234     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 235                 _ ("Namestore returned no block\n"));
 236     if (endbadly_task != NULL)
 237       GNUNET_SCHEDULER_cancel (endbadly_task);
 238     endbadly_task = GNUNET_SCHEDULER_add_now (&endbadly, NULL);
 239     return;
 240   }
 241
 242   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 243               "Namestore returned block, decrypting \n");
 244   GNUNET_assert (GNUNET_OK == GNUNET_GNSRECORD_block_decrypt (block,
 245                                                               &pubkey,
 246                                                               TEST_NAME,
 247                                                               &rd_decrypt_cb,
 248                                                               expected_rd));
 249 }
 250
 251
 252 static void
 253 name_lookup_shadow (void *cls)
 254 {
 255   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 256               "Performing lookup for shadow record \n");
 257   delayed_lookup_task = NULL;
 258   ncqe_shadow = GNUNET_NAMECACHE_lookup_block (nch, &derived_hash,
 259                                                &name_lookup_active_proc,
 260                                                &records[1]);
 261 }
 262
 263
 264 static void
 265 put_cont (void *cls, int32_t success, const char *emsg)
 266 {
 267   nsqe = NULL;
 268
 269   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 270               "Name store added record for `%s': %s\n",
 271               TEST_NAME,
 272               (success == GNUNET_OK) ? "SUCCESS" : "FAIL");
 273
 274   /* Create derived hash */
 275   GNUNET_CRYPTO_ecdsa_key_get_public (privkey, &pubkey);
 276   GNUNET_GNSRECORD_query_from_public_key (&pubkey, TEST_NAME, &derived_hash);
 277
 278   if (0 == GNUNET_TIME_absolute_get_remaining (record_expiration).rel_value_us)
 279   {
 280     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 281                 "Test to too long to store records, cannot run test!\n");
 282     GNUNET_SCHEDULER_add_now (&end, NULL);
 283     return;
 284   }
 285   /* Lookup active record now */
 286   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 287               "Performing lookup for active record \n");
 288   ncqe = GNUNET_NAMECACHE_lookup_block (nch, &derived_hash,
 289                                         &name_lookup_active_proc, &records[0]);
 290
 291   delayed_lookup_task = GNUNET_SCHEDULER_add_delayed (
 292     GNUNET_TIME_relative_multiply (EXPIRATION, 2), &name_lookup_shadow, NULL);
 293 }
 294
 295
 296 static void
 297 run (void *cls,
 298      const struct GNUNET_CONFIGURATION_Handle *cfg,
 299      struct GNUNET_TESTING_Peer *peer)
 300 {
 301   endbadly_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
 302                                                 &endbadly,
 303                                                 NULL);
 304   privkey = GNUNET_CRYPTO_ecdsa_key_create ();
 305   GNUNET_assert (privkey != NULL);
 306   GNUNET_CRYPTO_ecdsa_key_get_public (privkey,
 307                                       &pubkey);
 308
 309   record_expiration = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (),
 310                                                 EXPIRATION);
 311   records[0].expiration_time = record_expiration.abs_value_us;
 312   records[0].record_type = TEST_RECORD_TYPE;
 313   records[0].data_size = TEST_RECORD_DATALEN;
 314   records[0].data = GNUNET_malloc (TEST_RECORD_DATALEN);
 315   records[0].flags = GNUNET_GNSRECORD_RF_NONE;
 316   memset ((char *) records[0].data, TEST_RECORD_DATA, TEST_RECORD_DATALEN);
 317
 318   records[1].expiration_time = GNUNET_TIME_absolute_get ().abs_value_us
 319                                + 1000000000;
 320   records[1].record_type = TEST_RECORD_TYPE;
 321   records[1].data_size = TEST_RECORD_DATALEN;
 322   records[1].data = GNUNET_malloc (TEST_RECORD_DATALEN);
 323   records[1].flags = GNUNET_GNSRECORD_RF_SHADOW_RECORD;
 324   memset ((char *) records[1].data, TEST_SHADOW_RECORD_DATA,
 325           TEST_RECORD_DATALEN);
 326
 327   nsh = GNUNET_NAMESTORE_connect (cfg);
 328   nch = GNUNET_NAMECACHE_connect (cfg);
 329   GNUNET_break (NULL != nsh);
 330   GNUNET_break (NULL != nch);
 331   nsqe = GNUNET_NAMESTORE_records_store (nsh, privkey, TEST_NAME,
 332                                          2, records, &put_cont, NULL);
 333   if (NULL == nsqe)
 334   {
 335     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 336                 _ ("Namestore cannot store no block\n"));
 337   }
 338
 339   GNUNET_free ((void *) records[0].data);
 340   GNUNET_free ((void *) records[1].data);
 341 }
 342
 343
 344 #include "test_common.c"
 345
 346
 347 int
 348 main (int argc, char *argv[])
 349 {
 350   const char *plugin_name;
 351   char *cfg_name;
 352
 353   SETUP_CFG (plugin_name, cfg_name);
 354   res = 1;
 355   if (0 !=
 356       GNUNET_TESTING_peer_run ("test-namestore-api-lookup-shadow-filter",
 357                                cfg_name,
 358                                &run,
 359                                NULL))
 360   {
 361     res = 1;
 362   }
 363   GNUNET_DISK_purge_cfg_dir (cfg_name,
 364                              "GNUNET_TEST_HOME");
 365   GNUNET_free (cfg_name);
 366   return res;
 367 }
 368
 369
 370 /* end of test_namestore_api_lookup_shadow_filter.c */