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   GNUNET_assert (NULL != expected_rd);
 222
 223   ncqe = NULL;
 224   ncqe_shadow = NULL;
 225   if (endbadly_task != NULL)
 226   {
 227     GNUNET_SCHEDULER_cancel (endbadly_task);
 228     endbadly_task = NULL;
 229   }
 230
 231   if (NULL == block)
 232   {
 233     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 234               _("Namestore returned no block\n"));
 235     if (endbadly_task != NULL)
 236       GNUNET_SCHEDULER_cancel (endbadly_task);
 237     endbadly_task =  GNUNET_SCHEDULER_add_now (&endbadly, NULL);
 238     return;
 239   }
 240
 241   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 242               "Namestore returned block, decrypting \n");
 243   GNUNET_assert (GNUNET_OK == GNUNET_GNSRECORD_block_decrypt(block,
 244                 &pubkey, TEST_NAME, &rd_decrypt_cb, expected_rd));
 245 }
 246
 247
 248 static void
 249 name_lookup_shadow (void *cls)
 250 {
 251   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 252               "Performing lookup for shadow record \n");
 253   delayed_lookup_task = NULL;
 254   ncqe_shadow = GNUNET_NAMECACHE_lookup_block (nch, &derived_hash,
 255       &name_lookup_active_proc, &records[1]);
 256 }
 257
 258
 259 static void
 260 put_cont (void *cls, int32_t success, const char *emsg)
 261 {
 262   nsqe = NULL;
 263
 264   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 265               "Name store added record for `%s': %s\n",
 266               TEST_NAME,
 267               (success == GNUNET_OK) ? "SUCCESS" : "FAIL");
 268
 269   /* Create derived hash */
 270   GNUNET_CRYPTO_ecdsa_key_get_public (privkey, &pubkey);
 271   GNUNET_GNSRECORD_query_from_public_key (&pubkey, TEST_NAME, &derived_hash);
 272
 273   if (0 == GNUNET_TIME_absolute_get_remaining(record_expiration).rel_value_us )
 274   {
 275     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 276                 "Test to too long to store records, cannot run test!\n");
 277     GNUNET_SCHEDULER_add_now (&end, NULL );
 278     return;
 279   }
 280   /* Lookup active record now */
 281   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 282               "Performing lookup for active record \n");
 283   ncqe = GNUNET_NAMECACHE_lookup_block (nch, &derived_hash,
 284                                         &name_lookup_active_proc, &records[0]);
 285
 286   delayed_lookup_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply (EXPIRATION, 2), &name_lookup_shadow, NULL);
 287 }
 288
 289
 290 static void
 291 run (void *cls,
 292      const struct GNUNET_CONFIGURATION_Handle *cfg,
 293      struct GNUNET_TESTING_Peer *peer)
 294 {
 295   endbadly_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
 296                                                 &endbadly,
 297                                                 NULL);
 298   privkey = GNUNET_CRYPTO_ecdsa_key_create ();
 299   GNUNET_assert (privkey != NULL);
 300   GNUNET_CRYPTO_ecdsa_key_get_public (privkey,
 301                                       &pubkey);
 302
 303   record_expiration = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(),
 304                                                 EXPIRATION);
 305   records[0].expiration_time = record_expiration.abs_value_us;
 306   records[0].record_type = TEST_RECORD_TYPE;
 307   records[0].data_size = TEST_RECORD_DATALEN;
 308   records[0].data = GNUNET_malloc (TEST_RECORD_DATALEN);
 309   records[0].flags = GNUNET_GNSRECORD_RF_NONE;
 310   memset ((char *) records[0].data, TEST_RECORD_DATA, TEST_RECORD_DATALEN);
 311
 312   records[1].expiration_time = GNUNET_TIME_absolute_get().abs_value_us + 1000000000;
 313   records[1].record_type = TEST_RECORD_TYPE;
 314   records[1].data_size = TEST_RECORD_DATALEN;
 315   records[1].data = GNUNET_malloc (TEST_RECORD_DATALEN);
 316   records[1].flags = GNUNET_GNSRECORD_RF_SHADOW_RECORD;
 317   memset ((char *) records[1].data, TEST_SHADOW_RECORD_DATA, TEST_RECORD_DATALEN);
 318
 319   nsh = GNUNET_NAMESTORE_connect (cfg);
 320   nch = GNUNET_NAMECACHE_connect (cfg);
 321   GNUNET_break (NULL != nsh);
 322   GNUNET_break (NULL != nch);
 323   nsqe = GNUNET_NAMESTORE_records_store (nsh, privkey, TEST_NAME,
 324                                       2, records, &put_cont, NULL);
 325   if (NULL == nsqe)
 326   {
 327     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 328               _("Namestore cannot store no block\n"));
 329   }
 330
 331   GNUNET_free ((void *) records[0].data);
 332   GNUNET_free ((void *) records[1].data);
 333 }
 334
 335
 336 int
 337 main (int argc, char *argv[])
 338 {
 339   const char *plugin_name;
 340   char *cfg_name;
 341
 342   plugin_name = GNUNET_TESTING_get_testname_from_underscore (argv[0]);
 343   GNUNET_asprintf (&cfg_name,
 344                    "test_namestore_api_%s.conf",
 345                    plugin_name);
 346   GNUNET_DISK_purge_cfg_dir (cfg_name,
 347                              "GNUNET_TEST_HOME");
 348   res = 1;
 349   if (0 !=
 350       GNUNET_TESTING_peer_run ("test-namestore-api-lookup-shadow-filter",
 351                                cfg_name,
 352                                &run,
 353                                NULL))
 354   {
 355     res = 1;
 356   }
 357   GNUNET_DISK_purge_cfg_dir (cfg_name,
 358                              "GNUNET_TEST_HOME");
 359   GNUNET_free (cfg_name);
 360   return res;
 361 }
 362
 363
 364 /* end of test_namestore_api_lookup_shadow_filter.c */